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 int nonascii_space_p
= 0;
6375 int nonascii_hyphen_p
= 0;
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 `nobreak-char-display' is non-nil, we display
6428 non-ASCII spaces and hyphens specially. */
6429 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6432 nonascii_space_p
= 1;
6433 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6434 nonascii_hyphen_p
= 1;
6437 /* Translate control characters into `\003' or `^C' form.
6438 Control characters coming from a display table entry are
6439 currently not translated because we use IT->dpvec to hold
6440 the translation. This could easily be changed but I
6441 don't believe that it is worth doing.
6443 The characters handled by `nobreak-char-display' must be
6446 Non-printable characters and raw-byte characters are also
6447 translated to octal form. */
6448 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6449 ? (it
->area
!= TEXT_AREA
6450 /* In mode line, treat \n, \t like other crl chars. */
6453 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6454 || (c
!= '\n' && c
!= '\t'))
6456 || nonascii_hyphen_p
6458 || ! CHAR_PRINTABLE_P (c
))))
6460 /* C is a control character, non-ASCII space/hyphen,
6461 raw-byte, or a non-printable character which must be
6462 displayed either as '\003' or as `^C' where the '\\'
6463 and '^' can be defined in the display table. Fill
6464 IT->ctl_chars with glyphs for what we have to
6465 display. Then, set IT->dpvec to these glyphs. */
6469 EMACS_INT lface_id
= 0;
6472 /* Handle control characters with ^. */
6474 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6478 g
= '^'; /* default glyph for Control */
6479 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6481 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6482 && GLYPH_CODE_CHAR_VALID_P (gc
))
6484 g
= GLYPH_CODE_CHAR (gc
);
6485 lface_id
= GLYPH_CODE_FACE (gc
);
6489 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6491 else if (it
->f
== last_escape_glyph_frame
6492 && it
->face_id
== last_escape_glyph_face_id
)
6494 face_id
= last_escape_glyph_merged_face_id
;
6498 /* Merge the escape-glyph face into the current face. */
6499 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6501 last_escape_glyph_frame
= it
->f
;
6502 last_escape_glyph_face_id
= it
->face_id
;
6503 last_escape_glyph_merged_face_id
= face_id
;
6506 XSETINT (it
->ctl_chars
[0], g
);
6507 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6509 goto display_control
;
6512 /* Handle non-ascii space in the mode where it only gets
6515 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6517 /* Merge `nobreak-space' into the current face. */
6518 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6520 XSETINT (it
->ctl_chars
[0], ' ');
6522 goto display_control
;
6525 /* Handle sequences that start with the "escape glyph". */
6527 /* the default escape glyph is \. */
6528 escape_glyph
= '\\';
6531 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6532 && GLYPH_CODE_CHAR_VALID_P (gc
))
6534 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6535 lface_id
= GLYPH_CODE_FACE (gc
);
6539 /* The display table specified a face.
6540 Merge it into face_id and also into escape_glyph. */
6541 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6544 else if (it
->f
== last_escape_glyph_frame
6545 && it
->face_id
== last_escape_glyph_face_id
)
6547 face_id
= last_escape_glyph_merged_face_id
;
6551 /* Merge the escape-glyph face into the current face. */
6552 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6554 last_escape_glyph_frame
= it
->f
;
6555 last_escape_glyph_face_id
= it
->face_id
;
6556 last_escape_glyph_merged_face_id
= face_id
;
6559 /* Draw non-ASCII hyphen with just highlighting: */
6561 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6563 XSETINT (it
->ctl_chars
[0], '-');
6565 goto display_control
;
6568 /* Draw non-ASCII space/hyphen with escape glyph: */
6570 if (nonascii_space_p
|| nonascii_hyphen_p
)
6572 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6573 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
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
8772 && !it
->continuation_lines_width
8773 && !STRINGP (it
->string
)
8774 && IT_CHARPOS (*it
) > BEGV
8775 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8778 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8780 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8782 bidi_unshelve_cache (it3data
, 1);
8786 /* The y-position we try to reach, relative to *IT.
8787 Note that H has been subtracted in front of the if-statement. */
8788 int target_y
= it
->current_y
+ h
- dy
;
8789 int y0
= it3
.current_y
;
8793 RESTORE_IT (&it3
, &it3
, it3data
);
8794 y1
= line_bottom_y (&it3
);
8795 line_height
= y1
- y0
;
8796 RESTORE_IT (it
, it
, it2data
);
8797 /* If we did not reach target_y, try to move further backward if
8798 we can. If we moved too far backward, try to move forward. */
8799 if (target_y
< it
->current_y
8800 /* This is heuristic. In a window that's 3 lines high, with
8801 a line height of 13 pixels each, recentering with point
8802 on the bottom line will try to move -39/2 = 19 pixels
8803 backward. Try to avoid moving into the first line. */
8804 && (it
->current_y
- target_y
8805 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8806 && IT_CHARPOS (*it
) > BEGV
)
8808 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8809 target_y
- it
->current_y
));
8810 dy
= it
->current_y
- target_y
;
8811 goto move_further_back
;
8813 else if (target_y
>= it
->current_y
+ line_height
8814 && IT_CHARPOS (*it
) < ZV
)
8816 /* Should move forward by at least one line, maybe more.
8818 Note: Calling move_it_by_lines can be expensive on
8819 terminal frames, where compute_motion is used (via
8820 vmotion) to do the job, when there are very long lines
8821 and truncate-lines is nil. That's the reason for
8822 treating terminal frames specially here. */
8824 if (!FRAME_WINDOW_P (it
->f
))
8825 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8830 move_it_by_lines (it
, 1);
8832 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8839 /* Move IT by a specified amount of pixel lines DY. DY negative means
8840 move backwards. DY = 0 means move to start of screen line. At the
8841 end, IT will be on the start of a screen line. */
8844 move_it_vertically (struct it
*it
, int dy
)
8847 move_it_vertically_backward (it
, -dy
);
8850 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8851 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8852 MOVE_TO_POS
| MOVE_TO_Y
);
8853 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8855 /* If buffer ends in ZV without a newline, move to the start of
8856 the line to satisfy the post-condition. */
8857 if (IT_CHARPOS (*it
) == ZV
8859 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8860 move_it_by_lines (it
, 0);
8865 /* Move iterator IT past the end of the text line it is in. */
8868 move_it_past_eol (struct it
*it
)
8870 enum move_it_result rc
;
8872 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8873 if (rc
== MOVE_NEWLINE_OR_CR
)
8874 set_iterator_to_next (it
, 0);
8878 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8879 negative means move up. DVPOS == 0 means move to the start of the
8882 Optimization idea: If we would know that IT->f doesn't use
8883 a face with proportional font, we could be faster for
8884 truncate-lines nil. */
8887 move_it_by_lines (struct it
*it
, int dvpos
)
8890 /* The commented-out optimization uses vmotion on terminals. This
8891 gives bad results, because elements like it->what, on which
8892 callers such as pos_visible_p rely, aren't updated. */
8893 /* struct position pos;
8894 if (!FRAME_WINDOW_P (it->f))
8896 struct text_pos textpos;
8898 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8899 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8900 reseat (it, textpos, 1);
8901 it->vpos += pos.vpos;
8902 it->current_y += pos.vpos;
8908 /* DVPOS == 0 means move to the start of the screen line. */
8909 move_it_vertically_backward (it
, 0);
8910 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8911 /* Let next call to line_bottom_y calculate real line height */
8916 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8917 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8918 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8923 void *it2data
= NULL
;
8924 EMACS_INT start_charpos
, i
;
8926 /* Start at the beginning of the screen line containing IT's
8927 position. This may actually move vertically backwards,
8928 in case of overlays, so adjust dvpos accordingly. */
8930 move_it_vertically_backward (it
, 0);
8933 /* Go back -DVPOS visible lines and reseat the iterator there. */
8934 start_charpos
= IT_CHARPOS (*it
);
8935 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8936 back_to_previous_visible_line_start (it
);
8937 reseat (it
, it
->current
.pos
, 1);
8939 /* Move further back if we end up in a string or an image. */
8940 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8942 /* First try to move to start of display line. */
8944 move_it_vertically_backward (it
, 0);
8946 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8948 /* If start of line is still in string or image,
8949 move further back. */
8950 back_to_previous_visible_line_start (it
);
8951 reseat (it
, it
->current
.pos
, 1);
8955 it
->current_x
= it
->hpos
= 0;
8957 /* Above call may have moved too far if continuation lines
8958 are involved. Scan forward and see if it did. */
8959 SAVE_IT (it2
, *it
, it2data
);
8960 it2
.vpos
= it2
.current_y
= 0;
8961 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8962 it
->vpos
-= it2
.vpos
;
8963 it
->current_y
-= it2
.current_y
;
8964 it
->current_x
= it
->hpos
= 0;
8966 /* If we moved too far back, move IT some lines forward. */
8967 if (it2
.vpos
> -dvpos
)
8969 int delta
= it2
.vpos
+ dvpos
;
8971 RESTORE_IT (&it2
, &it2
, it2data
);
8972 SAVE_IT (it2
, *it
, it2data
);
8973 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8974 /* Move back again if we got too far ahead. */
8975 if (IT_CHARPOS (*it
) >= start_charpos
)
8976 RESTORE_IT (it
, &it2
, it2data
);
8978 bidi_unshelve_cache (it2data
, 1);
8981 RESTORE_IT (it
, it
, it2data
);
8985 /* Return 1 if IT points into the middle of a display vector. */
8988 in_display_vector_p (struct it
*it
)
8990 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8991 && it
->current
.dpvec_index
> 0
8992 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8996 /***********************************************************************
8998 ***********************************************************************/
9001 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9005 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9007 Lisp_Object args
[3];
9008 Lisp_Object msg
, fmt
;
9011 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9014 /* Do nothing if called asynchronously. Inserting text into
9015 a buffer may call after-change-functions and alike and
9016 that would means running Lisp asynchronously. */
9017 if (handling_signal
)
9021 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9023 args
[0] = fmt
= build_string (format
);
9026 msg
= Fformat (3, args
);
9028 len
= SBYTES (msg
) + 1;
9029 SAFE_ALLOCA (buffer
, char *, len
);
9030 memcpy (buffer
, SDATA (msg
), len
);
9032 message_dolog (buffer
, len
- 1, 1, 0);
9039 /* Output a newline in the *Messages* buffer if "needs" one. */
9042 message_log_maybe_newline (void)
9044 if (message_log_need_newline
)
9045 message_dolog ("", 0, 1, 0);
9049 /* Add a string M of length NBYTES to the message log, optionally
9050 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9051 nonzero, means interpret the contents of M as multibyte. This
9052 function calls low-level routines in order to bypass text property
9053 hooks, etc. which might not be safe to run.
9055 This may GC (insert may run before/after change hooks),
9056 so the buffer M must NOT point to a Lisp string. */
9059 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9061 const unsigned char *msg
= (const unsigned char *) m
;
9063 if (!NILP (Vmemory_full
))
9066 if (!NILP (Vmessage_log_max
))
9068 struct buffer
*oldbuf
;
9069 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9070 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9071 EMACS_INT point_at_end
= 0;
9072 EMACS_INT zv_at_end
= 0;
9073 Lisp_Object old_deactivate_mark
, tem
;
9074 struct gcpro gcpro1
;
9076 old_deactivate_mark
= Vdeactivate_mark
;
9077 oldbuf
= current_buffer
;
9078 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9079 BVAR (current_buffer
, undo_list
) = Qt
;
9081 oldpoint
= message_dolog_marker1
;
9082 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9083 oldbegv
= message_dolog_marker2
;
9084 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9085 oldzv
= message_dolog_marker3
;
9086 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9087 GCPRO1 (old_deactivate_mark
);
9095 BEGV_BYTE
= BEG_BYTE
;
9098 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9100 /* Insert the string--maybe converting multibyte to single byte
9101 or vice versa, so that all the text fits the buffer. */
9103 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9109 /* Convert a multibyte string to single-byte
9110 for the *Message* buffer. */
9111 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9113 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9114 work
[0] = (ASCII_CHAR_P (c
)
9116 : multibyte_char_to_unibyte (c
));
9117 insert_1_both (work
, 1, 1, 1, 0, 0);
9120 else if (! multibyte
9121 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9125 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9126 /* Convert a single-byte string to multibyte
9127 for the *Message* buffer. */
9128 for (i
= 0; i
< nbytes
; i
++)
9131 MAKE_CHAR_MULTIBYTE (c
);
9132 char_bytes
= CHAR_STRING (c
, str
);
9133 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9137 insert_1 (m
, nbytes
, 1, 0, 0);
9141 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9143 insert_1 ("\n", 1, 1, 0, 0);
9145 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9147 this_bol_byte
= PT_BYTE
;
9149 /* See if this line duplicates the previous one.
9150 If so, combine duplicates. */
9153 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9155 prev_bol_byte
= PT_BYTE
;
9157 dups
= message_log_check_duplicate (prev_bol_byte
,
9161 del_range_both (prev_bol
, prev_bol_byte
,
9162 this_bol
, this_bol_byte
, 0);
9165 char dupstr
[sizeof " [ times]"
9166 + INT_STRLEN_BOUND (printmax_t
)];
9169 /* If you change this format, don't forget to also
9170 change message_log_check_duplicate. */
9171 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9172 duplen
= strlen (dupstr
);
9173 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9174 insert_1 (dupstr
, duplen
, 1, 0, 1);
9179 /* If we have more than the desired maximum number of lines
9180 in the *Messages* buffer now, delete the oldest ones.
9181 This is safe because we don't have undo in this buffer. */
9183 if (NATNUMP (Vmessage_log_max
))
9185 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9186 -XFASTINT (Vmessage_log_max
) - 1, 0);
9187 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9190 BEGV
= XMARKER (oldbegv
)->charpos
;
9191 BEGV_BYTE
= marker_byte_position (oldbegv
);
9200 ZV
= XMARKER (oldzv
)->charpos
;
9201 ZV_BYTE
= marker_byte_position (oldzv
);
9205 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9207 /* We can't do Fgoto_char (oldpoint) because it will run some
9209 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9210 XMARKER (oldpoint
)->bytepos
);
9213 unchain_marker (XMARKER (oldpoint
));
9214 unchain_marker (XMARKER (oldbegv
));
9215 unchain_marker (XMARKER (oldzv
));
9217 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9218 set_buffer_internal (oldbuf
);
9220 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9221 message_log_need_newline
= !nlflag
;
9222 Vdeactivate_mark
= old_deactivate_mark
;
9227 /* We are at the end of the buffer after just having inserted a newline.
9228 (Note: We depend on the fact we won't be crossing the gap.)
9229 Check to see if the most recent message looks a lot like the previous one.
9230 Return 0 if different, 1 if the new one should just replace it, or a
9231 value N > 1 if we should also append " [N times]". */
9234 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9237 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9239 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9240 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9242 for (i
= 0; i
< len
; i
++)
9244 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9252 if (*p1
++ == ' ' && *p1
++ == '[')
9255 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9256 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9263 /* Display an echo area message M with a specified length of NBYTES
9264 bytes. The string may include null characters. If M is 0, clear
9265 out any existing message, and let the mini-buffer text show
9268 This may GC, so the buffer M must NOT point to a Lisp string. */
9271 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9273 /* First flush out any partial line written with print. */
9274 message_log_maybe_newline ();
9276 message_dolog (m
, nbytes
, 1, multibyte
);
9277 message2_nolog (m
, nbytes
, multibyte
);
9281 /* The non-logging counterpart of message2. */
9284 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9286 struct frame
*sf
= SELECTED_FRAME ();
9287 message_enable_multibyte
= multibyte
;
9289 if (FRAME_INITIAL_P (sf
))
9291 if (noninteractive_need_newline
)
9292 putc ('\n', stderr
);
9293 noninteractive_need_newline
= 0;
9295 fwrite (m
, nbytes
, 1, stderr
);
9296 if (cursor_in_echo_area
== 0)
9297 fprintf (stderr
, "\n");
9300 /* A null message buffer means that the frame hasn't really been
9301 initialized yet. Error messages get reported properly by
9302 cmd_error, so this must be just an informative message; toss it. */
9303 else if (INTERACTIVE
9304 && sf
->glyphs_initialized_p
9305 && FRAME_MESSAGE_BUF (sf
))
9307 Lisp_Object mini_window
;
9310 /* Get the frame containing the mini-buffer
9311 that the selected frame is using. */
9312 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9313 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9315 FRAME_SAMPLE_VISIBILITY (f
);
9316 if (FRAME_VISIBLE_P (sf
)
9317 && ! FRAME_VISIBLE_P (f
))
9318 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9322 set_message (m
, Qnil
, nbytes
, multibyte
);
9323 if (minibuffer_auto_raise
)
9324 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9327 clear_message (1, 1);
9329 do_pending_window_change (0);
9330 echo_area_display (1);
9331 do_pending_window_change (0);
9332 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9333 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9338 /* Display an echo area message M with a specified length of NBYTES
9339 bytes. The string may include null characters. If M is not a
9340 string, clear out any existing message, and let the mini-buffer
9343 This function cancels echoing. */
9346 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9348 struct gcpro gcpro1
;
9351 clear_message (1,1);
9354 /* First flush out any partial line written with print. */
9355 message_log_maybe_newline ();
9361 SAFE_ALLOCA (buffer
, char *, nbytes
);
9362 memcpy (buffer
, SDATA (m
), nbytes
);
9363 message_dolog (buffer
, nbytes
, 1, multibyte
);
9366 message3_nolog (m
, nbytes
, multibyte
);
9372 /* The non-logging version of message3.
9373 This does not cancel echoing, because it is used for echoing.
9374 Perhaps we need to make a separate function for echoing
9375 and make this cancel echoing. */
9378 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9380 struct frame
*sf
= SELECTED_FRAME ();
9381 message_enable_multibyte
= multibyte
;
9383 if (FRAME_INITIAL_P (sf
))
9385 if (noninteractive_need_newline
)
9386 putc ('\n', stderr
);
9387 noninteractive_need_newline
= 0;
9389 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9390 if (cursor_in_echo_area
== 0)
9391 fprintf (stderr
, "\n");
9394 /* A null message buffer means that the frame hasn't really been
9395 initialized yet. Error messages get reported properly by
9396 cmd_error, so this must be just an informative message; toss it. */
9397 else if (INTERACTIVE
9398 && sf
->glyphs_initialized_p
9399 && FRAME_MESSAGE_BUF (sf
))
9401 Lisp_Object mini_window
;
9405 /* Get the frame containing the mini-buffer
9406 that the selected frame is using. */
9407 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9408 frame
= XWINDOW (mini_window
)->frame
;
9411 FRAME_SAMPLE_VISIBILITY (f
);
9412 if (FRAME_VISIBLE_P (sf
)
9413 && !FRAME_VISIBLE_P (f
))
9414 Fmake_frame_visible (frame
);
9416 if (STRINGP (m
) && SCHARS (m
) > 0)
9418 set_message (NULL
, m
, nbytes
, multibyte
);
9419 if (minibuffer_auto_raise
)
9420 Fraise_frame (frame
);
9421 /* Assume we are not echoing.
9422 (If we are, echo_now will override this.) */
9423 echo_message_buffer
= Qnil
;
9426 clear_message (1, 1);
9428 do_pending_window_change (0);
9429 echo_area_display (1);
9430 do_pending_window_change (0);
9431 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9432 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9437 /* Display a null-terminated echo area message M. If M is 0, clear
9438 out any existing message, and let the mini-buffer text show through.
9440 The buffer M must continue to exist until after the echo area gets
9441 cleared or some other message gets displayed there. Do not pass
9442 text that is stored in a Lisp string. Do not pass text in a buffer
9443 that was alloca'd. */
9446 message1 (const char *m
)
9448 message2 (m
, (m
? strlen (m
) : 0), 0);
9452 /* The non-logging counterpart of message1. */
9455 message1_nolog (const char *m
)
9457 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9460 /* Display a message M which contains a single %s
9461 which gets replaced with STRING. */
9464 message_with_string (const char *m
, Lisp_Object string
, int log
)
9466 CHECK_STRING (string
);
9472 if (noninteractive_need_newline
)
9473 putc ('\n', stderr
);
9474 noninteractive_need_newline
= 0;
9475 fprintf (stderr
, m
, SDATA (string
));
9476 if (!cursor_in_echo_area
)
9477 fprintf (stderr
, "\n");
9481 else if (INTERACTIVE
)
9483 /* The frame whose minibuffer we're going to display the message on.
9484 It may be larger than the selected frame, so we need
9485 to use its buffer, not the selected frame's buffer. */
9486 Lisp_Object mini_window
;
9487 struct frame
*f
, *sf
= SELECTED_FRAME ();
9489 /* Get the frame containing the minibuffer
9490 that the selected frame is using. */
9491 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9492 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9494 /* A null message buffer means that the frame hasn't really been
9495 initialized yet. Error messages get reported properly by
9496 cmd_error, so this must be just an informative message; toss it. */
9497 if (FRAME_MESSAGE_BUF (f
))
9499 Lisp_Object args
[2], msg
;
9500 struct gcpro gcpro1
, gcpro2
;
9502 args
[0] = build_string (m
);
9503 args
[1] = msg
= string
;
9504 GCPRO2 (args
[0], msg
);
9507 msg
= Fformat (2, args
);
9510 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9512 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9516 /* Print should start at the beginning of the message
9517 buffer next time. */
9518 message_buf_print
= 0;
9524 /* Dump an informative message to the minibuf. If M is 0, clear out
9525 any existing message, and let the mini-buffer text show through. */
9528 vmessage (const char *m
, va_list ap
)
9534 if (noninteractive_need_newline
)
9535 putc ('\n', stderr
);
9536 noninteractive_need_newline
= 0;
9537 vfprintf (stderr
, m
, ap
);
9538 if (cursor_in_echo_area
== 0)
9539 fprintf (stderr
, "\n");
9543 else if (INTERACTIVE
)
9545 /* The frame whose mini-buffer we're going to display the message
9546 on. It may be larger than the selected frame, so we need to
9547 use its buffer, not the selected frame's buffer. */
9548 Lisp_Object mini_window
;
9549 struct frame
*f
, *sf
= SELECTED_FRAME ();
9551 /* Get the frame containing the mini-buffer
9552 that the selected frame is using. */
9553 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9554 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9556 /* A null message buffer means that the frame hasn't really been
9557 initialized yet. Error messages get reported properly by
9558 cmd_error, so this must be just an informative message; toss
9560 if (FRAME_MESSAGE_BUF (f
))
9566 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9567 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9569 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9574 /* Print should start at the beginning of the message
9575 buffer next time. */
9576 message_buf_print
= 0;
9582 message (const char *m
, ...)
9592 /* The non-logging version of message. */
9595 message_nolog (const char *m
, ...)
9597 Lisp_Object old_log_max
;
9600 old_log_max
= Vmessage_log_max
;
9601 Vmessage_log_max
= Qnil
;
9603 Vmessage_log_max
= old_log_max
;
9609 /* Display the current message in the current mini-buffer. This is
9610 only called from error handlers in process.c, and is not time
9614 update_echo_area (void)
9616 if (!NILP (echo_area_buffer
[0]))
9619 string
= Fcurrent_message ();
9620 message3 (string
, SBYTES (string
),
9621 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9626 /* Make sure echo area buffers in `echo_buffers' are live.
9627 If they aren't, make new ones. */
9630 ensure_echo_area_buffers (void)
9634 for (i
= 0; i
< 2; ++i
)
9635 if (!BUFFERP (echo_buffer
[i
])
9636 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9639 Lisp_Object old_buffer
;
9642 old_buffer
= echo_buffer
[i
];
9643 sprintf (name
, " *Echo Area %d*", i
);
9644 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9645 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9646 /* to force word wrap in echo area -
9647 it was decided to postpone this*/
9648 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9650 for (j
= 0; j
< 2; ++j
)
9651 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9652 echo_area_buffer
[j
] = echo_buffer
[i
];
9657 /* Call FN with args A1..A4 with either the current or last displayed
9658 echo_area_buffer as current buffer.
9660 WHICH zero means use the current message buffer
9661 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9662 from echo_buffer[] and clear it.
9664 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9665 suitable buffer from echo_buffer[] and clear it.
9667 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9668 that the current message becomes the last displayed one, make
9669 choose a suitable buffer for echo_area_buffer[0], and clear it.
9671 Value is what FN returns. */
9674 with_echo_area_buffer (struct window
*w
, int which
,
9675 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9676 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9679 int this_one
, the_other
, clear_buffer_p
, rc
;
9680 int count
= SPECPDL_INDEX ();
9682 /* If buffers aren't live, make new ones. */
9683 ensure_echo_area_buffers ();
9688 this_one
= 0, the_other
= 1;
9690 this_one
= 1, the_other
= 0;
9693 this_one
= 0, the_other
= 1;
9696 /* We need a fresh one in case the current echo buffer equals
9697 the one containing the last displayed echo area message. */
9698 if (!NILP (echo_area_buffer
[this_one
])
9699 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9700 echo_area_buffer
[this_one
] = Qnil
;
9703 /* Choose a suitable buffer from echo_buffer[] is we don't
9705 if (NILP (echo_area_buffer
[this_one
]))
9707 echo_area_buffer
[this_one
]
9708 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9709 ? echo_buffer
[the_other
]
9710 : echo_buffer
[this_one
]);
9714 buffer
= echo_area_buffer
[this_one
];
9716 /* Don't get confused by reusing the buffer used for echoing
9717 for a different purpose. */
9718 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9721 record_unwind_protect (unwind_with_echo_area_buffer
,
9722 with_echo_area_buffer_unwind_data (w
));
9724 /* Make the echo area buffer current. Note that for display
9725 purposes, it is not necessary that the displayed window's buffer
9726 == current_buffer, except for text property lookup. So, let's
9727 only set that buffer temporarily here without doing a full
9728 Fset_window_buffer. We must also change w->pointm, though,
9729 because otherwise an assertions in unshow_buffer fails, and Emacs
9731 set_buffer_internal_1 (XBUFFER (buffer
));
9735 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9738 BVAR (current_buffer
, undo_list
) = Qt
;
9739 BVAR (current_buffer
, read_only
) = Qnil
;
9740 specbind (Qinhibit_read_only
, Qt
);
9741 specbind (Qinhibit_modification_hooks
, Qt
);
9743 if (clear_buffer_p
&& Z
> BEG
)
9746 xassert (BEGV
>= BEG
);
9747 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9749 rc
= fn (a1
, a2
, a3
, a4
);
9751 xassert (BEGV
>= BEG
);
9752 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9754 unbind_to (count
, Qnil
);
9759 /* Save state that should be preserved around the call to the function
9760 FN called in with_echo_area_buffer. */
9763 with_echo_area_buffer_unwind_data (struct window
*w
)
9766 Lisp_Object vector
, tmp
;
9768 /* Reduce consing by keeping one vector in
9769 Vwith_echo_area_save_vector. */
9770 vector
= Vwith_echo_area_save_vector
;
9771 Vwith_echo_area_save_vector
= Qnil
;
9774 vector
= Fmake_vector (make_number (7), Qnil
);
9776 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9777 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9778 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9782 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9783 ASET (vector
, i
, w
->buffer
); ++i
;
9784 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9785 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9790 for (; i
< end
; ++i
)
9791 ASET (vector
, i
, Qnil
);
9794 xassert (i
== ASIZE (vector
));
9799 /* Restore global state from VECTOR which was created by
9800 with_echo_area_buffer_unwind_data. */
9803 unwind_with_echo_area_buffer (Lisp_Object vector
)
9805 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9806 Vdeactivate_mark
= AREF (vector
, 1);
9807 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9809 if (WINDOWP (AREF (vector
, 3)))
9812 Lisp_Object buffer
, charpos
, bytepos
;
9814 w
= XWINDOW (AREF (vector
, 3));
9815 buffer
= AREF (vector
, 4);
9816 charpos
= AREF (vector
, 5);
9817 bytepos
= AREF (vector
, 6);
9820 set_marker_both (w
->pointm
, buffer
,
9821 XFASTINT (charpos
), XFASTINT (bytepos
));
9824 Vwith_echo_area_save_vector
= vector
;
9829 /* Set up the echo area for use by print functions. MULTIBYTE_P
9830 non-zero means we will print multibyte. */
9833 setup_echo_area_for_printing (int multibyte_p
)
9835 /* If we can't find an echo area any more, exit. */
9836 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9839 ensure_echo_area_buffers ();
9841 if (!message_buf_print
)
9843 /* A message has been output since the last time we printed.
9844 Choose a fresh echo area buffer. */
9845 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9846 echo_area_buffer
[0] = echo_buffer
[1];
9848 echo_area_buffer
[0] = echo_buffer
[0];
9850 /* Switch to that buffer and clear it. */
9851 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9852 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9856 int count
= SPECPDL_INDEX ();
9857 specbind (Qinhibit_read_only
, Qt
);
9858 /* Note that undo recording is always disabled. */
9860 unbind_to (count
, Qnil
);
9862 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9864 /* Set up the buffer for the multibyteness we need. */
9866 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9867 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9869 /* Raise the frame containing the echo area. */
9870 if (minibuffer_auto_raise
)
9872 struct frame
*sf
= SELECTED_FRAME ();
9873 Lisp_Object mini_window
;
9874 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9875 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9878 message_log_maybe_newline ();
9879 message_buf_print
= 1;
9883 if (NILP (echo_area_buffer
[0]))
9885 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9886 echo_area_buffer
[0] = echo_buffer
[1];
9888 echo_area_buffer
[0] = echo_buffer
[0];
9891 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9893 /* Someone switched buffers between print requests. */
9894 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9895 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9901 /* Display an echo area message in window W. Value is non-zero if W's
9902 height is changed. If display_last_displayed_message_p is
9903 non-zero, display the message that was last displayed, otherwise
9904 display the current message. */
9907 display_echo_area (struct window
*w
)
9909 int i
, no_message_p
, window_height_changed_p
, count
;
9911 /* Temporarily disable garbage collections while displaying the echo
9912 area. This is done because a GC can print a message itself.
9913 That message would modify the echo area buffer's contents while a
9914 redisplay of the buffer is going on, and seriously confuse
9916 count
= inhibit_garbage_collection ();
9918 /* If there is no message, we must call display_echo_area_1
9919 nevertheless because it resizes the window. But we will have to
9920 reset the echo_area_buffer in question to nil at the end because
9921 with_echo_area_buffer will sets it to an empty buffer. */
9922 i
= display_last_displayed_message_p
? 1 : 0;
9923 no_message_p
= NILP (echo_area_buffer
[i
]);
9925 window_height_changed_p
9926 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9927 display_echo_area_1
,
9928 (intptr_t) w
, Qnil
, 0, 0);
9931 echo_area_buffer
[i
] = Qnil
;
9933 unbind_to (count
, Qnil
);
9934 return window_height_changed_p
;
9938 /* Helper for display_echo_area. Display the current buffer which
9939 contains the current echo area message in window W, a mini-window,
9940 a pointer to which is passed in A1. A2..A4 are currently not used.
9941 Change the height of W so that all of the message is displayed.
9942 Value is non-zero if height of W was changed. */
9945 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9948 struct window
*w
= (struct window
*) i1
;
9950 struct text_pos start
;
9951 int window_height_changed_p
= 0;
9953 /* Do this before displaying, so that we have a large enough glyph
9954 matrix for the display. If we can't get enough space for the
9955 whole text, display the last N lines. That works by setting w->start. */
9956 window_height_changed_p
= resize_mini_window (w
, 0);
9958 /* Use the starting position chosen by resize_mini_window. */
9959 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9962 clear_glyph_matrix (w
->desired_matrix
);
9963 XSETWINDOW (window
, w
);
9964 try_window (window
, start
, 0);
9966 return window_height_changed_p
;
9970 /* Resize the echo area window to exactly the size needed for the
9971 currently displayed message, if there is one. If a mini-buffer
9972 is active, don't shrink it. */
9975 resize_echo_area_exactly (void)
9977 if (BUFFERP (echo_area_buffer
[0])
9978 && WINDOWP (echo_area_window
))
9980 struct window
*w
= XWINDOW (echo_area_window
);
9982 Lisp_Object resize_exactly
;
9984 if (minibuf_level
== 0)
9985 resize_exactly
= Qt
;
9987 resize_exactly
= Qnil
;
9989 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9990 (intptr_t) w
, resize_exactly
,
9994 ++windows_or_buffers_changed
;
9995 ++update_mode_lines
;
9996 redisplay_internal ();
10002 /* Callback function for with_echo_area_buffer, when used from
10003 resize_echo_area_exactly. A1 contains a pointer to the window to
10004 resize, EXACTLY non-nil means resize the mini-window exactly to the
10005 size of the text displayed. A3 and A4 are not used. Value is what
10006 resize_mini_window returns. */
10009 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10012 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10016 /* Resize mini-window W to fit the size of its contents. EXACT_P
10017 means size the window exactly to the size needed. Otherwise, it's
10018 only enlarged until W's buffer is empty.
10020 Set W->start to the right place to begin display. If the whole
10021 contents fit, start at the beginning. Otherwise, start so as
10022 to make the end of the contents appear. This is particularly
10023 important for y-or-n-p, but seems desirable generally.
10025 Value is non-zero if the window height has been changed. */
10028 resize_mini_window (struct window
*w
, int exact_p
)
10030 struct frame
*f
= XFRAME (w
->frame
);
10031 int window_height_changed_p
= 0;
10033 xassert (MINI_WINDOW_P (w
));
10035 /* By default, start display at the beginning. */
10036 set_marker_both (w
->start
, w
->buffer
,
10037 BUF_BEGV (XBUFFER (w
->buffer
)),
10038 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10040 /* Don't resize windows while redisplaying a window; it would
10041 confuse redisplay functions when the size of the window they are
10042 displaying changes from under them. Such a resizing can happen,
10043 for instance, when which-func prints a long message while
10044 we are running fontification-functions. We're running these
10045 functions with safe_call which binds inhibit-redisplay to t. */
10046 if (!NILP (Vinhibit_redisplay
))
10049 /* Nil means don't try to resize. */
10050 if (NILP (Vresize_mini_windows
)
10051 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10054 if (!FRAME_MINIBUF_ONLY_P (f
))
10057 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10058 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10059 int height
, max_height
;
10060 int unit
= FRAME_LINE_HEIGHT (f
);
10061 struct text_pos start
;
10062 struct buffer
*old_current_buffer
= NULL
;
10064 if (current_buffer
!= XBUFFER (w
->buffer
))
10066 old_current_buffer
= current_buffer
;
10067 set_buffer_internal (XBUFFER (w
->buffer
));
10070 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10072 /* Compute the max. number of lines specified by the user. */
10073 if (FLOATP (Vmax_mini_window_height
))
10074 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10075 else if (INTEGERP (Vmax_mini_window_height
))
10076 max_height
= XINT (Vmax_mini_window_height
);
10078 max_height
= total_height
/ 4;
10080 /* Correct that max. height if it's bogus. */
10081 max_height
= max (1, max_height
);
10082 max_height
= min (total_height
, max_height
);
10084 /* Find out the height of the text in the window. */
10085 if (it
.line_wrap
== TRUNCATE
)
10090 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10091 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10092 height
= it
.current_y
+ last_height
;
10094 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10095 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10096 height
= (height
+ unit
- 1) / unit
;
10099 /* Compute a suitable window start. */
10100 if (height
> max_height
)
10102 height
= max_height
;
10103 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10104 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10105 start
= it
.current
.pos
;
10108 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10109 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10111 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10113 /* Let it grow only, until we display an empty message, in which
10114 case the window shrinks again. */
10115 if (height
> WINDOW_TOTAL_LINES (w
))
10117 int old_height
= WINDOW_TOTAL_LINES (w
);
10118 freeze_window_starts (f
, 1);
10119 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10120 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10122 else if (height
< WINDOW_TOTAL_LINES (w
)
10123 && (exact_p
|| BEGV
== ZV
))
10125 int old_height
= WINDOW_TOTAL_LINES (w
);
10126 freeze_window_starts (f
, 0);
10127 shrink_mini_window (w
);
10128 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10133 /* Always resize to exact size needed. */
10134 if (height
> WINDOW_TOTAL_LINES (w
))
10136 int old_height
= WINDOW_TOTAL_LINES (w
);
10137 freeze_window_starts (f
, 1);
10138 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10139 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10141 else if (height
< WINDOW_TOTAL_LINES (w
))
10143 int old_height
= WINDOW_TOTAL_LINES (w
);
10144 freeze_window_starts (f
, 0);
10145 shrink_mini_window (w
);
10149 freeze_window_starts (f
, 1);
10150 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10153 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10157 if (old_current_buffer
)
10158 set_buffer_internal (old_current_buffer
);
10161 return window_height_changed_p
;
10165 /* Value is the current message, a string, or nil if there is no
10166 current message. */
10169 current_message (void)
10173 if (!BUFFERP (echo_area_buffer
[0]))
10177 with_echo_area_buffer (0, 0, current_message_1
,
10178 (intptr_t) &msg
, Qnil
, 0, 0);
10180 echo_area_buffer
[0] = Qnil
;
10188 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10191 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10194 *msg
= make_buffer_string (BEG
, Z
, 1);
10201 /* Push the current message on Vmessage_stack for later restauration
10202 by restore_message. Value is non-zero if the current message isn't
10203 empty. This is a relatively infrequent operation, so it's not
10204 worth optimizing. */
10207 push_message (void)
10210 msg
= current_message ();
10211 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10212 return STRINGP (msg
);
10216 /* Restore message display from the top of Vmessage_stack. */
10219 restore_message (void)
10223 xassert (CONSP (Vmessage_stack
));
10224 msg
= XCAR (Vmessage_stack
);
10226 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10228 message3_nolog (msg
, 0, 0);
10232 /* Handler for record_unwind_protect calling pop_message. */
10235 pop_message_unwind (Lisp_Object dummy
)
10241 /* Pop the top-most entry off Vmessage_stack. */
10246 xassert (CONSP (Vmessage_stack
));
10247 Vmessage_stack
= XCDR (Vmessage_stack
);
10251 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10252 exits. If the stack is not empty, we have a missing pop_message
10256 check_message_stack (void)
10258 if (!NILP (Vmessage_stack
))
10263 /* Truncate to NCHARS what will be displayed in the echo area the next
10264 time we display it---but don't redisplay it now. */
10267 truncate_echo_area (EMACS_INT nchars
)
10270 echo_area_buffer
[0] = Qnil
;
10271 /* A null message buffer means that the frame hasn't really been
10272 initialized yet. Error messages get reported properly by
10273 cmd_error, so this must be just an informative message; toss it. */
10274 else if (!noninteractive
10276 && !NILP (echo_area_buffer
[0]))
10278 struct frame
*sf
= SELECTED_FRAME ();
10279 if (FRAME_MESSAGE_BUF (sf
))
10280 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10285 /* Helper function for truncate_echo_area. Truncate the current
10286 message to at most NCHARS characters. */
10289 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10291 if (BEG
+ nchars
< Z
)
10292 del_range (BEG
+ nchars
, Z
);
10294 echo_area_buffer
[0] = Qnil
;
10299 /* Set the current message to a substring of S or STRING.
10301 If STRING is a Lisp string, set the message to the first NBYTES
10302 bytes from STRING. NBYTES zero means use the whole string. If
10303 STRING is multibyte, the message will be displayed multibyte.
10305 If S is not null, set the message to the first LEN bytes of S. LEN
10306 zero means use the whole string. MULTIBYTE_P non-zero means S is
10307 multibyte. Display the message multibyte in that case.
10309 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10310 to t before calling set_message_1 (which calls insert).
10314 set_message (const char *s
, Lisp_Object string
,
10315 EMACS_INT nbytes
, int multibyte_p
)
10317 message_enable_multibyte
10318 = ((s
&& multibyte_p
)
10319 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10321 with_echo_area_buffer (0, -1, set_message_1
,
10322 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10323 message_buf_print
= 0;
10324 help_echo_showing_p
= 0;
10328 /* Helper function for set_message. Arguments have the same meaning
10329 as there, with A1 corresponding to S and A2 corresponding to STRING
10330 This function is called with the echo area buffer being
10334 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10337 const char *s
= (const char *) i1
;
10338 const unsigned char *msg
= (const unsigned char *) s
;
10339 Lisp_Object string
= a2
;
10341 /* Change multibyteness of the echo buffer appropriately. */
10342 if (message_enable_multibyte
10343 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10344 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10346 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10347 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10348 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10350 /* Insert new message at BEG. */
10351 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10353 if (STRINGP (string
))
10358 nbytes
= SBYTES (string
);
10359 nchars
= string_byte_to_char (string
, nbytes
);
10361 /* This function takes care of single/multibyte conversion. We
10362 just have to ensure that the echo area buffer has the right
10363 setting of enable_multibyte_characters. */
10364 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10369 nbytes
= strlen (s
);
10371 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10373 /* Convert from multi-byte to single-byte. */
10378 /* Convert a multibyte string to single-byte. */
10379 for (i
= 0; i
< nbytes
; i
+= n
)
10381 c
= string_char_and_length (msg
+ i
, &n
);
10382 work
[0] = (ASCII_CHAR_P (c
)
10384 : multibyte_char_to_unibyte (c
));
10385 insert_1_both (work
, 1, 1, 1, 0, 0);
10388 else if (!multibyte_p
10389 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10391 /* Convert from single-byte to multi-byte. */
10394 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10396 /* Convert a single-byte string to multibyte. */
10397 for (i
= 0; i
< nbytes
; i
++)
10400 MAKE_CHAR_MULTIBYTE (c
);
10401 n
= CHAR_STRING (c
, str
);
10402 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10406 insert_1 (s
, nbytes
, 1, 0, 0);
10413 /* Clear messages. CURRENT_P non-zero means clear the current
10414 message. LAST_DISPLAYED_P non-zero means clear the message
10418 clear_message (int current_p
, int last_displayed_p
)
10422 echo_area_buffer
[0] = Qnil
;
10423 message_cleared_p
= 1;
10426 if (last_displayed_p
)
10427 echo_area_buffer
[1] = Qnil
;
10429 message_buf_print
= 0;
10432 /* Clear garbaged frames.
10434 This function is used where the old redisplay called
10435 redraw_garbaged_frames which in turn called redraw_frame which in
10436 turn called clear_frame. The call to clear_frame was a source of
10437 flickering. I believe a clear_frame is not necessary. It should
10438 suffice in the new redisplay to invalidate all current matrices,
10439 and ensure a complete redisplay of all windows. */
10442 clear_garbaged_frames (void)
10444 if (frame_garbaged
)
10446 Lisp_Object tail
, frame
;
10447 int changed_count
= 0;
10449 FOR_EACH_FRAME (tail
, frame
)
10451 struct frame
*f
= XFRAME (frame
);
10453 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10457 Fredraw_frame (frame
);
10458 f
->force_flush_display_p
= 1;
10460 clear_current_matrices (f
);
10467 frame_garbaged
= 0;
10469 ++windows_or_buffers_changed
;
10474 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10475 is non-zero update selected_frame. Value is non-zero if the
10476 mini-windows height has been changed. */
10479 echo_area_display (int update_frame_p
)
10481 Lisp_Object mini_window
;
10484 int window_height_changed_p
= 0;
10485 struct frame
*sf
= SELECTED_FRAME ();
10487 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10488 w
= XWINDOW (mini_window
);
10489 f
= XFRAME (WINDOW_FRAME (w
));
10491 /* Don't display if frame is invisible or not yet initialized. */
10492 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10495 #ifdef HAVE_WINDOW_SYSTEM
10496 /* When Emacs starts, selected_frame may be the initial terminal
10497 frame. If we let this through, a message would be displayed on
10499 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10501 #endif /* HAVE_WINDOW_SYSTEM */
10503 /* Redraw garbaged frames. */
10504 if (frame_garbaged
)
10505 clear_garbaged_frames ();
10507 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10509 echo_area_window
= mini_window
;
10510 window_height_changed_p
= display_echo_area (w
);
10511 w
->must_be_updated_p
= 1;
10513 /* Update the display, unless called from redisplay_internal.
10514 Also don't update the screen during redisplay itself. The
10515 update will happen at the end of redisplay, and an update
10516 here could cause confusion. */
10517 if (update_frame_p
&& !redisplaying_p
)
10521 /* If the display update has been interrupted by pending
10522 input, update mode lines in the frame. Due to the
10523 pending input, it might have been that redisplay hasn't
10524 been called, so that mode lines above the echo area are
10525 garbaged. This looks odd, so we prevent it here. */
10526 if (!display_completed
)
10527 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10529 if (window_height_changed_p
10530 /* Don't do this if Emacs is shutting down. Redisplay
10531 needs to run hooks. */
10532 && !NILP (Vrun_hooks
))
10534 /* Must update other windows. Likewise as in other
10535 cases, don't let this update be interrupted by
10537 int count
= SPECPDL_INDEX ();
10538 specbind (Qredisplay_dont_pause
, Qt
);
10539 windows_or_buffers_changed
= 1;
10540 redisplay_internal ();
10541 unbind_to (count
, Qnil
);
10543 else if (FRAME_WINDOW_P (f
) && n
== 0)
10545 /* Window configuration is the same as before.
10546 Can do with a display update of the echo area,
10547 unless we displayed some mode lines. */
10548 update_single_window (w
, 1);
10549 FRAME_RIF (f
)->flush_display (f
);
10552 update_frame (f
, 1, 1);
10554 /* If cursor is in the echo area, make sure that the next
10555 redisplay displays the minibuffer, so that the cursor will
10556 be replaced with what the minibuffer wants. */
10557 if (cursor_in_echo_area
)
10558 ++windows_or_buffers_changed
;
10561 else if (!EQ (mini_window
, selected_window
))
10562 windows_or_buffers_changed
++;
10564 /* Last displayed message is now the current message. */
10565 echo_area_buffer
[1] = echo_area_buffer
[0];
10566 /* Inform read_char that we're not echoing. */
10567 echo_message_buffer
= Qnil
;
10569 /* Prevent redisplay optimization in redisplay_internal by resetting
10570 this_line_start_pos. This is done because the mini-buffer now
10571 displays the message instead of its buffer text. */
10572 if (EQ (mini_window
, selected_window
))
10573 CHARPOS (this_line_start_pos
) = 0;
10575 return window_height_changed_p
;
10580 /***********************************************************************
10581 Mode Lines and Frame Titles
10582 ***********************************************************************/
10584 /* A buffer for constructing non-propertized mode-line strings and
10585 frame titles in it; allocated from the heap in init_xdisp and
10586 resized as needed in store_mode_line_noprop_char. */
10588 static char *mode_line_noprop_buf
;
10590 /* The buffer's end, and a current output position in it. */
10592 static char *mode_line_noprop_buf_end
;
10593 static char *mode_line_noprop_ptr
;
10595 #define MODE_LINE_NOPROP_LEN(start) \
10596 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10599 MODE_LINE_DISPLAY
= 0,
10603 } mode_line_target
;
10605 /* Alist that caches the results of :propertize.
10606 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10607 static Lisp_Object mode_line_proptrans_alist
;
10609 /* List of strings making up the mode-line. */
10610 static Lisp_Object mode_line_string_list
;
10612 /* Base face property when building propertized mode line string. */
10613 static Lisp_Object mode_line_string_face
;
10614 static Lisp_Object mode_line_string_face_prop
;
10617 /* Unwind data for mode line strings */
10619 static Lisp_Object Vmode_line_unwind_vector
;
10622 format_mode_line_unwind_data (struct buffer
*obuf
,
10624 int save_proptrans
)
10626 Lisp_Object vector
, tmp
;
10628 /* Reduce consing by keeping one vector in
10629 Vwith_echo_area_save_vector. */
10630 vector
= Vmode_line_unwind_vector
;
10631 Vmode_line_unwind_vector
= Qnil
;
10634 vector
= Fmake_vector (make_number (8), Qnil
);
10636 ASET (vector
, 0, make_number (mode_line_target
));
10637 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10638 ASET (vector
, 2, mode_line_string_list
);
10639 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10640 ASET (vector
, 4, mode_line_string_face
);
10641 ASET (vector
, 5, mode_line_string_face_prop
);
10644 XSETBUFFER (tmp
, obuf
);
10647 ASET (vector
, 6, tmp
);
10648 ASET (vector
, 7, owin
);
10654 unwind_format_mode_line (Lisp_Object vector
)
10656 mode_line_target
= XINT (AREF (vector
, 0));
10657 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10658 mode_line_string_list
= AREF (vector
, 2);
10659 if (! EQ (AREF (vector
, 3), Qt
))
10660 mode_line_proptrans_alist
= AREF (vector
, 3);
10661 mode_line_string_face
= AREF (vector
, 4);
10662 mode_line_string_face_prop
= AREF (vector
, 5);
10664 if (!NILP (AREF (vector
, 7)))
10665 /* Select window before buffer, since it may change the buffer. */
10666 Fselect_window (AREF (vector
, 7), Qt
);
10668 if (!NILP (AREF (vector
, 6)))
10670 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10671 ASET (vector
, 6, Qnil
);
10674 Vmode_line_unwind_vector
= vector
;
10679 /* Store a single character C for the frame title in mode_line_noprop_buf.
10680 Re-allocate mode_line_noprop_buf if necessary. */
10683 store_mode_line_noprop_char (char c
)
10685 /* If output position has reached the end of the allocated buffer,
10686 increase the buffer's size. */
10687 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10689 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10690 ptrdiff_t size
= len
;
10691 mode_line_noprop_buf
=
10692 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10693 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10694 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10697 *mode_line_noprop_ptr
++ = c
;
10701 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10702 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10703 characters that yield more columns than PRECISION; PRECISION <= 0
10704 means copy the whole string. Pad with spaces until FIELD_WIDTH
10705 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10706 pad. Called from display_mode_element when it is used to build a
10710 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10712 const unsigned char *str
= (const unsigned char *) string
;
10714 EMACS_INT dummy
, nbytes
;
10716 /* Copy at most PRECISION chars from STR. */
10717 nbytes
= strlen (string
);
10718 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10720 store_mode_line_noprop_char (*str
++);
10722 /* Fill up with spaces until FIELD_WIDTH reached. */
10723 while (field_width
> 0
10724 && n
< field_width
)
10726 store_mode_line_noprop_char (' ');
10733 /***********************************************************************
10735 ***********************************************************************/
10737 #ifdef HAVE_WINDOW_SYSTEM
10739 /* Set the title of FRAME, if it has changed. The title format is
10740 Vicon_title_format if FRAME is iconified, otherwise it is
10741 frame_title_format. */
10744 x_consider_frame_title (Lisp_Object frame
)
10746 struct frame
*f
= XFRAME (frame
);
10748 if (FRAME_WINDOW_P (f
)
10749 || FRAME_MINIBUF_ONLY_P (f
)
10750 || f
->explicit_name
)
10752 /* Do we have more than one visible frame on this X display? */
10755 ptrdiff_t title_start
;
10759 int count
= SPECPDL_INDEX ();
10761 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10763 Lisp_Object other_frame
= XCAR (tail
);
10764 struct frame
*tf
= XFRAME (other_frame
);
10767 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10768 && !FRAME_MINIBUF_ONLY_P (tf
)
10769 && !EQ (other_frame
, tip_frame
)
10770 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10774 /* Set global variable indicating that multiple frames exist. */
10775 multiple_frames
= CONSP (tail
);
10777 /* Switch to the buffer of selected window of the frame. Set up
10778 mode_line_target so that display_mode_element will output into
10779 mode_line_noprop_buf; then display the title. */
10780 record_unwind_protect (unwind_format_mode_line
,
10781 format_mode_line_unwind_data
10782 (current_buffer
, selected_window
, 0));
10784 Fselect_window (f
->selected_window
, Qt
);
10785 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10786 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10788 mode_line_target
= MODE_LINE_TITLE
;
10789 title_start
= MODE_LINE_NOPROP_LEN (0);
10790 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10791 NULL
, DEFAULT_FACE_ID
);
10792 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10793 len
= MODE_LINE_NOPROP_LEN (title_start
);
10794 title
= mode_line_noprop_buf
+ title_start
;
10795 unbind_to (count
, Qnil
);
10797 /* Set the title only if it's changed. This avoids consing in
10798 the common case where it hasn't. (If it turns out that we've
10799 already wasted too much time by walking through the list with
10800 display_mode_element, then we might need to optimize at a
10801 higher level than this.) */
10802 if (! STRINGP (f
->name
)
10803 || SBYTES (f
->name
) != len
10804 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10805 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10809 #endif /* not HAVE_WINDOW_SYSTEM */
10814 /***********************************************************************
10816 ***********************************************************************/
10819 /* Prepare for redisplay by updating menu-bar item lists when
10820 appropriate. This can call eval. */
10823 prepare_menu_bars (void)
10826 struct gcpro gcpro1
, gcpro2
;
10828 Lisp_Object tooltip_frame
;
10830 #ifdef HAVE_WINDOW_SYSTEM
10831 tooltip_frame
= tip_frame
;
10833 tooltip_frame
= Qnil
;
10836 /* Update all frame titles based on their buffer names, etc. We do
10837 this before the menu bars so that the buffer-menu will show the
10838 up-to-date frame titles. */
10839 #ifdef HAVE_WINDOW_SYSTEM
10840 if (windows_or_buffers_changed
|| update_mode_lines
)
10842 Lisp_Object tail
, frame
;
10844 FOR_EACH_FRAME (tail
, frame
)
10846 f
= XFRAME (frame
);
10847 if (!EQ (frame
, tooltip_frame
)
10848 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10849 x_consider_frame_title (frame
);
10852 #endif /* HAVE_WINDOW_SYSTEM */
10854 /* Update the menu bar item lists, if appropriate. This has to be
10855 done before any actual redisplay or generation of display lines. */
10856 all_windows
= (update_mode_lines
10857 || buffer_shared
> 1
10858 || windows_or_buffers_changed
);
10861 Lisp_Object tail
, frame
;
10862 int count
= SPECPDL_INDEX ();
10863 /* 1 means that update_menu_bar has run its hooks
10864 so any further calls to update_menu_bar shouldn't do so again. */
10865 int menu_bar_hooks_run
= 0;
10867 record_unwind_save_match_data ();
10869 FOR_EACH_FRAME (tail
, frame
)
10871 f
= XFRAME (frame
);
10873 /* Ignore tooltip frame. */
10874 if (EQ (frame
, tooltip_frame
))
10877 /* If a window on this frame changed size, report that to
10878 the user and clear the size-change flag. */
10879 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10881 Lisp_Object functions
;
10883 /* Clear flag first in case we get an error below. */
10884 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10885 functions
= Vwindow_size_change_functions
;
10886 GCPRO2 (tail
, functions
);
10888 while (CONSP (functions
))
10890 if (!EQ (XCAR (functions
), Qt
))
10891 call1 (XCAR (functions
), frame
);
10892 functions
= XCDR (functions
);
10898 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10899 #ifdef HAVE_WINDOW_SYSTEM
10900 update_tool_bar (f
, 0);
10903 if (windows_or_buffers_changed
10905 ns_set_doc_edited (f
, Fbuffer_modified_p
10906 (XWINDOW (f
->selected_window
)->buffer
));
10911 unbind_to (count
, Qnil
);
10915 struct frame
*sf
= SELECTED_FRAME ();
10916 update_menu_bar (sf
, 1, 0);
10917 #ifdef HAVE_WINDOW_SYSTEM
10918 update_tool_bar (sf
, 1);
10924 /* Update the menu bar item list for frame F. This has to be done
10925 before we start to fill in any display lines, because it can call
10928 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10930 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10931 already ran the menu bar hooks for this redisplay, so there
10932 is no need to run them again. The return value is the
10933 updated value of this flag, to pass to the next call. */
10936 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10938 Lisp_Object window
;
10939 register struct window
*w
;
10941 /* If called recursively during a menu update, do nothing. This can
10942 happen when, for instance, an activate-menubar-hook causes a
10944 if (inhibit_menubar_update
)
10947 window
= FRAME_SELECTED_WINDOW (f
);
10948 w
= XWINDOW (window
);
10950 if (FRAME_WINDOW_P (f
)
10952 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10953 || defined (HAVE_NS) || defined (USE_GTK)
10954 FRAME_EXTERNAL_MENU_BAR (f
)
10956 FRAME_MENU_BAR_LINES (f
) > 0
10958 : FRAME_MENU_BAR_LINES (f
) > 0)
10960 /* If the user has switched buffers or windows, we need to
10961 recompute to reflect the new bindings. But we'll
10962 recompute when update_mode_lines is set too; that means
10963 that people can use force-mode-line-update to request
10964 that the menu bar be recomputed. The adverse effect on
10965 the rest of the redisplay algorithm is about the same as
10966 windows_or_buffers_changed anyway. */
10967 if (windows_or_buffers_changed
10968 /* This used to test w->update_mode_line, but we believe
10969 there is no need to recompute the menu in that case. */
10970 || update_mode_lines
10971 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10972 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10973 != !NILP (w
->last_had_star
))
10974 || ((!NILP (Vtransient_mark_mode
)
10975 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10976 != !NILP (w
->region_showing
)))
10978 struct buffer
*prev
= current_buffer
;
10979 int count
= SPECPDL_INDEX ();
10981 specbind (Qinhibit_menubar_update
, Qt
);
10983 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10984 if (save_match_data
)
10985 record_unwind_save_match_data ();
10986 if (NILP (Voverriding_local_map_menu_flag
))
10988 specbind (Qoverriding_terminal_local_map
, Qnil
);
10989 specbind (Qoverriding_local_map
, Qnil
);
10994 /* Run the Lucid hook. */
10995 safe_run_hooks (Qactivate_menubar_hook
);
10997 /* If it has changed current-menubar from previous value,
10998 really recompute the menu-bar from the value. */
10999 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11000 call0 (Qrecompute_lucid_menubar
);
11002 safe_run_hooks (Qmenu_bar_update_hook
);
11007 XSETFRAME (Vmenu_updating_frame
, f
);
11008 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11010 /* Redisplay the menu bar in case we changed it. */
11011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11012 || defined (HAVE_NS) || defined (USE_GTK)
11013 if (FRAME_WINDOW_P (f
))
11015 #if defined (HAVE_NS)
11016 /* All frames on Mac OS share the same menubar. So only
11017 the selected frame should be allowed to set it. */
11018 if (f
== SELECTED_FRAME ())
11020 set_frame_menubar (f
, 0, 0);
11023 /* On a terminal screen, the menu bar is an ordinary screen
11024 line, and this makes it get updated. */
11025 w
->update_mode_line
= Qt
;
11026 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11027 /* In the non-toolkit version, the menu bar is an ordinary screen
11028 line, and this makes it get updated. */
11029 w
->update_mode_line
= Qt
;
11030 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11032 unbind_to (count
, Qnil
);
11033 set_buffer_internal_1 (prev
);
11042 /***********************************************************************
11044 ***********************************************************************/
11046 #ifdef HAVE_WINDOW_SYSTEM
11049 Nominal cursor position -- where to draw output.
11050 HPOS and VPOS are window relative glyph matrix coordinates.
11051 X and Y are window relative pixel coordinates. */
11053 struct cursor_pos output_cursor
;
11057 Set the global variable output_cursor to CURSOR. All cursor
11058 positions are relative to updated_window. */
11061 set_output_cursor (struct cursor_pos
*cursor
)
11063 output_cursor
.hpos
= cursor
->hpos
;
11064 output_cursor
.vpos
= cursor
->vpos
;
11065 output_cursor
.x
= cursor
->x
;
11066 output_cursor
.y
= cursor
->y
;
11071 Set a nominal cursor position.
11073 HPOS and VPOS are column/row positions in a window glyph matrix. X
11074 and Y are window text area relative pixel positions.
11076 If this is done during an update, updated_window will contain the
11077 window that is being updated and the position is the future output
11078 cursor position for that window. If updated_window is null, use
11079 selected_window and display the cursor at the given position. */
11082 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11086 /* If updated_window is not set, work on selected_window. */
11087 if (updated_window
)
11088 w
= updated_window
;
11090 w
= XWINDOW (selected_window
);
11092 /* Set the output cursor. */
11093 output_cursor
.hpos
= hpos
;
11094 output_cursor
.vpos
= vpos
;
11095 output_cursor
.x
= x
;
11096 output_cursor
.y
= y
;
11098 /* If not called as part of an update, really display the cursor.
11099 This will also set the cursor position of W. */
11100 if (updated_window
== NULL
)
11103 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11104 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11105 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11110 #endif /* HAVE_WINDOW_SYSTEM */
11113 /***********************************************************************
11115 ***********************************************************************/
11117 #ifdef HAVE_WINDOW_SYSTEM
11119 /* Where the mouse was last time we reported a mouse event. */
11121 FRAME_PTR last_mouse_frame
;
11123 /* Tool-bar item index of the item on which a mouse button was pressed
11126 int last_tool_bar_item
;
11130 update_tool_bar_unwind (Lisp_Object frame
)
11132 selected_frame
= frame
;
11136 /* Update the tool-bar item list for frame F. This has to be done
11137 before we start to fill in any display lines. Called from
11138 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11139 and restore it here. */
11142 update_tool_bar (struct frame
*f
, int save_match_data
)
11144 #if defined (USE_GTK) || defined (HAVE_NS)
11145 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11147 int do_update
= WINDOWP (f
->tool_bar_window
)
11148 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11153 Lisp_Object window
;
11156 window
= FRAME_SELECTED_WINDOW (f
);
11157 w
= XWINDOW (window
);
11159 /* If the user has switched buffers or windows, we need to
11160 recompute to reflect the new bindings. But we'll
11161 recompute when update_mode_lines is set too; that means
11162 that people can use force-mode-line-update to request
11163 that the menu bar be recomputed. The adverse effect on
11164 the rest of the redisplay algorithm is about the same as
11165 windows_or_buffers_changed anyway. */
11166 if (windows_or_buffers_changed
11167 || !NILP (w
->update_mode_line
)
11168 || update_mode_lines
11169 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11170 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11171 != !NILP (w
->last_had_star
))
11172 || ((!NILP (Vtransient_mark_mode
)
11173 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11174 != !NILP (w
->region_showing
)))
11176 struct buffer
*prev
= current_buffer
;
11177 int count
= SPECPDL_INDEX ();
11178 Lisp_Object frame
, new_tool_bar
;
11179 int new_n_tool_bar
;
11180 struct gcpro gcpro1
;
11182 /* Set current_buffer to the buffer of the selected
11183 window of the frame, so that we get the right local
11185 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11187 /* Save match data, if we must. */
11188 if (save_match_data
)
11189 record_unwind_save_match_data ();
11191 /* Make sure that we don't accidentally use bogus keymaps. */
11192 if (NILP (Voverriding_local_map_menu_flag
))
11194 specbind (Qoverriding_terminal_local_map
, Qnil
);
11195 specbind (Qoverriding_local_map
, Qnil
);
11198 GCPRO1 (new_tool_bar
);
11200 /* We must temporarily set the selected frame to this frame
11201 before calling tool_bar_items, because the calculation of
11202 the tool-bar keymap uses the selected frame (see
11203 `tool-bar-make-keymap' in tool-bar.el). */
11204 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11205 XSETFRAME (frame
, f
);
11206 selected_frame
= frame
;
11208 /* Build desired tool-bar items from keymaps. */
11209 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11212 /* Redisplay the tool-bar if we changed it. */
11213 if (new_n_tool_bar
!= f
->n_tool_bar_items
11214 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11216 /* Redisplay that happens asynchronously due to an expose event
11217 may access f->tool_bar_items. Make sure we update both
11218 variables within BLOCK_INPUT so no such event interrupts. */
11220 f
->tool_bar_items
= new_tool_bar
;
11221 f
->n_tool_bar_items
= new_n_tool_bar
;
11222 w
->update_mode_line
= Qt
;
11228 unbind_to (count
, Qnil
);
11229 set_buffer_internal_1 (prev
);
11235 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11236 F's desired tool-bar contents. F->tool_bar_items must have
11237 been set up previously by calling prepare_menu_bars. */
11240 build_desired_tool_bar_string (struct frame
*f
)
11242 int i
, size
, size_needed
;
11243 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11244 Lisp_Object image
, plist
, props
;
11246 image
= plist
= props
= Qnil
;
11247 GCPRO3 (image
, plist
, props
);
11249 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11250 Otherwise, make a new string. */
11252 /* The size of the string we might be able to reuse. */
11253 size
= (STRINGP (f
->desired_tool_bar_string
)
11254 ? SCHARS (f
->desired_tool_bar_string
)
11257 /* We need one space in the string for each image. */
11258 size_needed
= f
->n_tool_bar_items
;
11260 /* Reuse f->desired_tool_bar_string, if possible. */
11261 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11262 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11263 make_number (' '));
11266 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11267 Fremove_text_properties (make_number (0), make_number (size
),
11268 props
, f
->desired_tool_bar_string
);
11271 /* Put a `display' property on the string for the images to display,
11272 put a `menu_item' property on tool-bar items with a value that
11273 is the index of the item in F's tool-bar item vector. */
11274 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11276 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11278 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11279 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11280 int hmargin
, vmargin
, relief
, idx
, end
;
11282 /* If image is a vector, choose the image according to the
11284 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11285 if (VECTORP (image
))
11289 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11290 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11293 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11294 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11296 xassert (ASIZE (image
) >= idx
);
11297 image
= AREF (image
, idx
);
11302 /* Ignore invalid image specifications. */
11303 if (!valid_image_p (image
))
11306 /* Display the tool-bar button pressed, or depressed. */
11307 plist
= Fcopy_sequence (XCDR (image
));
11309 /* Compute margin and relief to draw. */
11310 relief
= (tool_bar_button_relief
>= 0
11311 ? tool_bar_button_relief
11312 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11313 hmargin
= vmargin
= relief
;
11315 if (INTEGERP (Vtool_bar_button_margin
)
11316 && XINT (Vtool_bar_button_margin
) > 0)
11318 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11319 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11321 else if (CONSP (Vtool_bar_button_margin
))
11323 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11324 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11325 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11327 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11328 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11329 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11332 if (auto_raise_tool_bar_buttons_p
)
11334 /* Add a `:relief' property to the image spec if the item is
11338 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11345 /* If image is selected, display it pressed, i.e. with a
11346 negative relief. If it's not selected, display it with a
11348 plist
= Fplist_put (plist
, QCrelief
,
11350 ? make_number (-relief
)
11351 : make_number (relief
)));
11356 /* Put a margin around the image. */
11357 if (hmargin
|| vmargin
)
11359 if (hmargin
== vmargin
)
11360 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11362 plist
= Fplist_put (plist
, QCmargin
,
11363 Fcons (make_number (hmargin
),
11364 make_number (vmargin
)));
11367 /* If button is not enabled, and we don't have special images
11368 for the disabled state, make the image appear disabled by
11369 applying an appropriate algorithm to it. */
11370 if (!enabled_p
&& idx
< 0)
11371 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11373 /* Put a `display' text property on the string for the image to
11374 display. Put a `menu-item' property on the string that gives
11375 the start of this item's properties in the tool-bar items
11377 image
= Fcons (Qimage
, plist
);
11378 props
= list4 (Qdisplay
, image
,
11379 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11381 /* Let the last image hide all remaining spaces in the tool bar
11382 string. The string can be longer than needed when we reuse a
11383 previous string. */
11384 if (i
+ 1 == f
->n_tool_bar_items
)
11385 end
= SCHARS (f
->desired_tool_bar_string
);
11388 Fadd_text_properties (make_number (i
), make_number (end
),
11389 props
, f
->desired_tool_bar_string
);
11397 /* Display one line of the tool-bar of frame IT->f.
11399 HEIGHT specifies the desired height of the tool-bar line.
11400 If the actual height of the glyph row is less than HEIGHT, the
11401 row's height is increased to HEIGHT, and the icons are centered
11402 vertically in the new height.
11404 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11405 count a final empty row in case the tool-bar width exactly matches
11410 display_tool_bar_line (struct it
*it
, int height
)
11412 struct glyph_row
*row
= it
->glyph_row
;
11413 int max_x
= it
->last_visible_x
;
11414 struct glyph
*last
;
11416 prepare_desired_row (row
);
11417 row
->y
= it
->current_y
;
11419 /* Note that this isn't made use of if the face hasn't a box,
11420 so there's no need to check the face here. */
11421 it
->start_of_box_run_p
= 1;
11423 while (it
->current_x
< max_x
)
11425 int x
, n_glyphs_before
, i
, nglyphs
;
11426 struct it it_before
;
11428 /* Get the next display element. */
11429 if (!get_next_display_element (it
))
11431 /* Don't count empty row if we are counting needed tool-bar lines. */
11432 if (height
< 0 && !it
->hpos
)
11437 /* Produce glyphs. */
11438 n_glyphs_before
= row
->used
[TEXT_AREA
];
11441 PRODUCE_GLYPHS (it
);
11443 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11445 x
= it_before
.current_x
;
11446 while (i
< nglyphs
)
11448 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11450 if (x
+ glyph
->pixel_width
> max_x
)
11452 /* Glyph doesn't fit on line. Backtrack. */
11453 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11455 /* If this is the only glyph on this line, it will never fit on the
11456 tool-bar, so skip it. But ensure there is at least one glyph,
11457 so we don't accidentally disable the tool-bar. */
11458 if (n_glyphs_before
== 0
11459 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11465 x
+= glyph
->pixel_width
;
11469 /* Stop at line end. */
11470 if (ITERATOR_AT_END_OF_LINE_P (it
))
11473 set_iterator_to_next (it
, 1);
11478 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11480 /* Use default face for the border below the tool bar.
11482 FIXME: When auto-resize-tool-bars is grow-only, there is
11483 no additional border below the possibly empty tool-bar lines.
11484 So to make the extra empty lines look "normal", we have to
11485 use the tool-bar face for the border too. */
11486 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11487 it
->face_id
= DEFAULT_FACE_ID
;
11489 extend_face_to_end_of_line (it
);
11490 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11491 last
->right_box_line_p
= 1;
11492 if (last
== row
->glyphs
[TEXT_AREA
])
11493 last
->left_box_line_p
= 1;
11495 /* Make line the desired height and center it vertically. */
11496 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11498 /* Don't add more than one line height. */
11499 height
%= FRAME_LINE_HEIGHT (it
->f
);
11500 it
->max_ascent
+= height
/ 2;
11501 it
->max_descent
+= (height
+ 1) / 2;
11504 compute_line_metrics (it
);
11506 /* If line is empty, make it occupy the rest of the tool-bar. */
11507 if (!row
->displays_text_p
)
11509 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11510 row
->visible_height
= row
->height
;
11511 row
->ascent
= row
->phys_ascent
= 0;
11512 row
->extra_line_spacing
= 0;
11515 row
->full_width_p
= 1;
11516 row
->continued_p
= 0;
11517 row
->truncated_on_left_p
= 0;
11518 row
->truncated_on_right_p
= 0;
11520 it
->current_x
= it
->hpos
= 0;
11521 it
->current_y
+= row
->height
;
11527 /* Max tool-bar height. */
11529 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11530 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11532 /* Value is the number of screen lines needed to make all tool-bar
11533 items of frame F visible. The number of actual rows needed is
11534 returned in *N_ROWS if non-NULL. */
11537 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11539 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11541 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11542 the desired matrix, so use (unused) mode-line row as temporary row to
11543 avoid destroying the first tool-bar row. */
11544 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11546 /* Initialize an iterator for iteration over
11547 F->desired_tool_bar_string in the tool-bar window of frame F. */
11548 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11549 it
.first_visible_x
= 0;
11550 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11551 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11552 it
.paragraph_embedding
= L2R
;
11554 while (!ITERATOR_AT_END_P (&it
))
11556 clear_glyph_row (temp_row
);
11557 it
.glyph_row
= temp_row
;
11558 display_tool_bar_line (&it
, -1);
11560 clear_glyph_row (temp_row
);
11562 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11564 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11566 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11570 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11572 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11573 (Lisp_Object frame
)
11580 frame
= selected_frame
;
11582 CHECK_FRAME (frame
);
11583 f
= XFRAME (frame
);
11585 if (WINDOWP (f
->tool_bar_window
)
11586 && (w
= XWINDOW (f
->tool_bar_window
),
11587 WINDOW_TOTAL_LINES (w
) > 0))
11589 update_tool_bar (f
, 1);
11590 if (f
->n_tool_bar_items
)
11592 build_desired_tool_bar_string (f
);
11593 nlines
= tool_bar_lines_needed (f
, NULL
);
11597 return make_number (nlines
);
11601 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11602 height should be changed. */
11605 redisplay_tool_bar (struct frame
*f
)
11609 struct glyph_row
*row
;
11611 #if defined (USE_GTK) || defined (HAVE_NS)
11612 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11613 update_frame_tool_bar (f
);
11617 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11618 do anything. This means you must start with tool-bar-lines
11619 non-zero to get the auto-sizing effect. Or in other words, you
11620 can turn off tool-bars by specifying tool-bar-lines zero. */
11621 if (!WINDOWP (f
->tool_bar_window
)
11622 || (w
= XWINDOW (f
->tool_bar_window
),
11623 WINDOW_TOTAL_LINES (w
) == 0))
11626 /* Set up an iterator for the tool-bar window. */
11627 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11628 it
.first_visible_x
= 0;
11629 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11630 row
= it
.glyph_row
;
11632 /* Build a string that represents the contents of the tool-bar. */
11633 build_desired_tool_bar_string (f
);
11634 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11635 /* FIXME: This should be controlled by a user option. But it
11636 doesn't make sense to have an R2L tool bar if the menu bar cannot
11637 be drawn also R2L, and making the menu bar R2L is tricky due
11638 toolkit-specific code that implements it. If an R2L tool bar is
11639 ever supported, display_tool_bar_line should also be augmented to
11640 call unproduce_glyphs like display_line and display_string
11642 it
.paragraph_embedding
= L2R
;
11644 if (f
->n_tool_bar_rows
== 0)
11648 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11649 nlines
!= WINDOW_TOTAL_LINES (w
)))
11652 int old_height
= WINDOW_TOTAL_LINES (w
);
11654 XSETFRAME (frame
, f
);
11655 Fmodify_frame_parameters (frame
,
11656 Fcons (Fcons (Qtool_bar_lines
,
11657 make_number (nlines
)),
11659 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11661 clear_glyph_matrix (w
->desired_matrix
);
11662 fonts_changed_p
= 1;
11668 /* Display as many lines as needed to display all tool-bar items. */
11670 if (f
->n_tool_bar_rows
> 0)
11672 int border
, rows
, height
, extra
;
11674 if (INTEGERP (Vtool_bar_border
))
11675 border
= XINT (Vtool_bar_border
);
11676 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11677 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11678 else if (EQ (Vtool_bar_border
, Qborder_width
))
11679 border
= f
->border_width
;
11685 rows
= f
->n_tool_bar_rows
;
11686 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11687 extra
= it
.last_visible_y
- border
- height
* rows
;
11689 while (it
.current_y
< it
.last_visible_y
)
11692 if (extra
> 0 && rows
-- > 0)
11694 h
= (extra
+ rows
- 1) / rows
;
11697 display_tool_bar_line (&it
, height
+ h
);
11702 while (it
.current_y
< it
.last_visible_y
)
11703 display_tool_bar_line (&it
, 0);
11706 /* It doesn't make much sense to try scrolling in the tool-bar
11707 window, so don't do it. */
11708 w
->desired_matrix
->no_scrolling_p
= 1;
11709 w
->must_be_updated_p
= 1;
11711 if (!NILP (Vauto_resize_tool_bars
))
11713 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11714 int change_height_p
= 0;
11716 /* If we couldn't display everything, change the tool-bar's
11717 height if there is room for more. */
11718 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11719 && it
.current_y
< max_tool_bar_height
)
11720 change_height_p
= 1;
11722 row
= it
.glyph_row
- 1;
11724 /* If there are blank lines at the end, except for a partially
11725 visible blank line at the end that is smaller than
11726 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11727 if (!row
->displays_text_p
11728 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11729 change_height_p
= 1;
11731 /* If row displays tool-bar items, but is partially visible,
11732 change the tool-bar's height. */
11733 if (row
->displays_text_p
11734 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11735 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11736 change_height_p
= 1;
11738 /* Resize windows as needed by changing the `tool-bar-lines'
11739 frame parameter. */
11740 if (change_height_p
)
11743 int old_height
= WINDOW_TOTAL_LINES (w
);
11745 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11747 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11748 && !f
->minimize_tool_bar_window_p
)
11749 ? (nlines
> old_height
)
11750 : (nlines
!= old_height
));
11751 f
->minimize_tool_bar_window_p
= 0;
11753 if (change_height_p
)
11755 XSETFRAME (frame
, f
);
11756 Fmodify_frame_parameters (frame
,
11757 Fcons (Fcons (Qtool_bar_lines
,
11758 make_number (nlines
)),
11760 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11762 clear_glyph_matrix (w
->desired_matrix
);
11763 f
->n_tool_bar_rows
= nrows
;
11764 fonts_changed_p
= 1;
11771 f
->minimize_tool_bar_window_p
= 0;
11776 /* Get information about the tool-bar item which is displayed in GLYPH
11777 on frame F. Return in *PROP_IDX the index where tool-bar item
11778 properties start in F->tool_bar_items. Value is zero if
11779 GLYPH doesn't display a tool-bar item. */
11782 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11788 /* This function can be called asynchronously, which means we must
11789 exclude any possibility that Fget_text_property signals an
11791 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11792 charpos
= max (0, charpos
);
11794 /* Get the text property `menu-item' at pos. The value of that
11795 property is the start index of this item's properties in
11796 F->tool_bar_items. */
11797 prop
= Fget_text_property (make_number (charpos
),
11798 Qmenu_item
, f
->current_tool_bar_string
);
11799 if (INTEGERP (prop
))
11801 *prop_idx
= XINT (prop
);
11811 /* Get information about the tool-bar item at position X/Y on frame F.
11812 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11813 the current matrix of the tool-bar window of F, or NULL if not
11814 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11815 item in F->tool_bar_items. Value is
11817 -1 if X/Y is not on a tool-bar item
11818 0 if X/Y is on the same item that was highlighted before.
11822 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11823 int *hpos
, int *vpos
, int *prop_idx
)
11825 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11826 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11829 /* Find the glyph under X/Y. */
11830 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11831 if (*glyph
== NULL
)
11834 /* Get the start of this tool-bar item's properties in
11835 f->tool_bar_items. */
11836 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11839 /* Is mouse on the highlighted item? */
11840 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11841 && *vpos
>= hlinfo
->mouse_face_beg_row
11842 && *vpos
<= hlinfo
->mouse_face_end_row
11843 && (*vpos
> hlinfo
->mouse_face_beg_row
11844 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11845 && (*vpos
< hlinfo
->mouse_face_end_row
11846 || *hpos
< hlinfo
->mouse_face_end_col
11847 || hlinfo
->mouse_face_past_end
))
11855 Handle mouse button event on the tool-bar of frame F, at
11856 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11857 0 for button release. MODIFIERS is event modifiers for button
11861 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11862 unsigned int modifiers
)
11864 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11865 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11866 int hpos
, vpos
, prop_idx
;
11867 struct glyph
*glyph
;
11868 Lisp_Object enabled_p
;
11870 /* If not on the highlighted tool-bar item, return. */
11871 frame_to_window_pixel_xy (w
, &x
, &y
);
11872 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11875 /* If item is disabled, do nothing. */
11876 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11877 if (NILP (enabled_p
))
11882 /* Show item in pressed state. */
11883 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11884 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11885 last_tool_bar_item
= prop_idx
;
11889 Lisp_Object key
, frame
;
11890 struct input_event event
;
11891 EVENT_INIT (event
);
11893 /* Show item in released state. */
11894 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11895 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11897 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11899 XSETFRAME (frame
, f
);
11900 event
.kind
= TOOL_BAR_EVENT
;
11901 event
.frame_or_window
= frame
;
11903 kbd_buffer_store_event (&event
);
11905 event
.kind
= TOOL_BAR_EVENT
;
11906 event
.frame_or_window
= frame
;
11908 event
.modifiers
= modifiers
;
11909 kbd_buffer_store_event (&event
);
11910 last_tool_bar_item
= -1;
11915 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11916 tool-bar window-relative coordinates X/Y. Called from
11917 note_mouse_highlight. */
11920 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11922 Lisp_Object window
= f
->tool_bar_window
;
11923 struct window
*w
= XWINDOW (window
);
11924 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11925 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11927 struct glyph
*glyph
;
11928 struct glyph_row
*row
;
11930 Lisp_Object enabled_p
;
11932 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11933 int mouse_down_p
, rc
;
11935 /* Function note_mouse_highlight is called with negative X/Y
11936 values when mouse moves outside of the frame. */
11937 if (x
<= 0 || y
<= 0)
11939 clear_mouse_face (hlinfo
);
11943 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11946 /* Not on tool-bar item. */
11947 clear_mouse_face (hlinfo
);
11951 /* On same tool-bar item as before. */
11952 goto set_help_echo
;
11954 clear_mouse_face (hlinfo
);
11956 /* Mouse is down, but on different tool-bar item? */
11957 mouse_down_p
= (dpyinfo
->grabbed
11958 && f
== last_mouse_frame
11959 && FRAME_LIVE_P (f
));
11961 && last_tool_bar_item
!= prop_idx
)
11964 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11965 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11967 /* If tool-bar item is not enabled, don't highlight it. */
11968 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11969 if (!NILP (enabled_p
))
11971 /* Compute the x-position of the glyph. In front and past the
11972 image is a space. We include this in the highlighted area. */
11973 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11974 for (i
= x
= 0; i
< hpos
; ++i
)
11975 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11977 /* Record this as the current active region. */
11978 hlinfo
->mouse_face_beg_col
= hpos
;
11979 hlinfo
->mouse_face_beg_row
= vpos
;
11980 hlinfo
->mouse_face_beg_x
= x
;
11981 hlinfo
->mouse_face_beg_y
= row
->y
;
11982 hlinfo
->mouse_face_past_end
= 0;
11984 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11985 hlinfo
->mouse_face_end_row
= vpos
;
11986 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11987 hlinfo
->mouse_face_end_y
= row
->y
;
11988 hlinfo
->mouse_face_window
= window
;
11989 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11991 /* Display it as active. */
11992 show_mouse_face (hlinfo
, draw
);
11993 hlinfo
->mouse_face_image_state
= draw
;
11998 /* Set help_echo_string to a help string to display for this tool-bar item.
11999 XTread_socket does the rest. */
12000 help_echo_object
= help_echo_window
= Qnil
;
12001 help_echo_pos
= -1;
12002 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12003 if (NILP (help_echo_string
))
12004 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12007 #endif /* HAVE_WINDOW_SYSTEM */
12011 /************************************************************************
12012 Horizontal scrolling
12013 ************************************************************************/
12015 static int hscroll_window_tree (Lisp_Object
);
12016 static int hscroll_windows (Lisp_Object
);
12018 /* For all leaf windows in the window tree rooted at WINDOW, set their
12019 hscroll value so that PT is (i) visible in the window, and (ii) so
12020 that it is not within a certain margin at the window's left and
12021 right border. Value is non-zero if any window's hscroll has been
12025 hscroll_window_tree (Lisp_Object window
)
12027 int hscrolled_p
= 0;
12028 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12029 int hscroll_step_abs
= 0;
12030 double hscroll_step_rel
= 0;
12032 if (hscroll_relative_p
)
12034 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12035 if (hscroll_step_rel
< 0)
12037 hscroll_relative_p
= 0;
12038 hscroll_step_abs
= 0;
12041 else if (INTEGERP (Vhscroll_step
))
12043 hscroll_step_abs
= XINT (Vhscroll_step
);
12044 if (hscroll_step_abs
< 0)
12045 hscroll_step_abs
= 0;
12048 hscroll_step_abs
= 0;
12050 while (WINDOWP (window
))
12052 struct window
*w
= XWINDOW (window
);
12054 if (WINDOWP (w
->hchild
))
12055 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12056 else if (WINDOWP (w
->vchild
))
12057 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12058 else if (w
->cursor
.vpos
>= 0)
12061 int text_area_width
;
12062 struct glyph_row
*current_cursor_row
12063 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12064 struct glyph_row
*desired_cursor_row
12065 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12066 struct glyph_row
*cursor_row
12067 = (desired_cursor_row
->enabled_p
12068 ? desired_cursor_row
12069 : current_cursor_row
);
12070 int row_r2l_p
= cursor_row
->reversed_p
;
12072 text_area_width
= window_box_width (w
, TEXT_AREA
);
12074 /* Scroll when cursor is inside this scroll margin. */
12075 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12077 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12078 /* For left-to-right rows, hscroll when cursor is either
12079 (i) inside the right hscroll margin, or (ii) if it is
12080 inside the left margin and the window is already
12083 && ((XFASTINT (w
->hscroll
)
12084 && w
->cursor
.x
<= h_margin
)
12085 || (cursor_row
->enabled_p
12086 && cursor_row
->truncated_on_right_p
12087 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12088 /* For right-to-left rows, the logic is similar,
12089 except that rules for scrolling to left and right
12090 are reversed. E.g., if cursor.x <= h_margin, we
12091 need to hscroll "to the right" unconditionally,
12092 and that will scroll the screen to the left so as
12093 to reveal the next portion of the row. */
12095 && ((cursor_row
->enabled_p
12096 /* FIXME: It is confusing to set the
12097 truncated_on_right_p flag when R2L rows
12098 are actually truncated on the left. */
12099 && cursor_row
->truncated_on_right_p
12100 && w
->cursor
.x
<= h_margin
)
12101 || (XFASTINT (w
->hscroll
)
12102 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12106 struct buffer
*saved_current_buffer
;
12110 /* Find point in a display of infinite width. */
12111 saved_current_buffer
= current_buffer
;
12112 current_buffer
= XBUFFER (w
->buffer
);
12114 if (w
== XWINDOW (selected_window
))
12118 pt
= marker_position (w
->pointm
);
12119 pt
= max (BEGV
, pt
);
12123 /* Move iterator to pt starting at cursor_row->start in
12124 a line with infinite width. */
12125 init_to_row_start (&it
, w
, cursor_row
);
12126 it
.last_visible_x
= INFINITY
;
12127 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12128 current_buffer
= saved_current_buffer
;
12130 /* Position cursor in window. */
12131 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12132 hscroll
= max (0, (it
.current_x
12133 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12134 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12135 : (text_area_width
/ 2))))
12136 / FRAME_COLUMN_WIDTH (it
.f
);
12137 else if ((!row_r2l_p
12138 && w
->cursor
.x
>= text_area_width
- h_margin
)
12139 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12141 if (hscroll_relative_p
)
12142 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12145 wanted_x
= text_area_width
12146 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12149 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12153 if (hscroll_relative_p
)
12154 wanted_x
= text_area_width
* hscroll_step_rel
12157 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12160 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12162 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12164 /* Don't prevent redisplay optimizations if hscroll
12165 hasn't changed, as it will unnecessarily slow down
12167 if (XFASTINT (w
->hscroll
) != hscroll
)
12169 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12170 w
->hscroll
= make_number (hscroll
);
12179 /* Value is non-zero if hscroll of any leaf window has been changed. */
12180 return hscrolled_p
;
12184 /* Set hscroll so that cursor is visible and not inside horizontal
12185 scroll margins for all windows in the tree rooted at WINDOW. See
12186 also hscroll_window_tree above. Value is non-zero if any window's
12187 hscroll has been changed. If it has, desired matrices on the frame
12188 of WINDOW are cleared. */
12191 hscroll_windows (Lisp_Object window
)
12193 int hscrolled_p
= hscroll_window_tree (window
);
12195 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12196 return hscrolled_p
;
12201 /************************************************************************
12203 ************************************************************************/
12205 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12206 to a non-zero value. This is sometimes handy to have in a debugger
12211 /* First and last unchanged row for try_window_id. */
12213 static int debug_first_unchanged_at_end_vpos
;
12214 static int debug_last_unchanged_at_beg_vpos
;
12216 /* Delta vpos and y. */
12218 static int debug_dvpos
, debug_dy
;
12220 /* Delta in characters and bytes for try_window_id. */
12222 static EMACS_INT debug_delta
, debug_delta_bytes
;
12224 /* Values of window_end_pos and window_end_vpos at the end of
12227 static EMACS_INT debug_end_vpos
;
12229 /* Append a string to W->desired_matrix->method. FMT is a printf
12230 format string. If trace_redisplay_p is non-zero also printf the
12231 resulting string to stderr. */
12233 static void debug_method_add (struct window
*, char const *, ...)
12234 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12237 debug_method_add (struct window
*w
, char const *fmt
, ...)
12240 char *method
= w
->desired_matrix
->method
;
12241 int len
= strlen (method
);
12242 int size
= sizeof w
->desired_matrix
->method
;
12243 int remaining
= size
- len
- 1;
12246 va_start (ap
, fmt
);
12247 vsprintf (buffer
, fmt
, ap
);
12249 if (len
&& remaining
)
12252 --remaining
, ++len
;
12255 strncpy (method
+ len
, buffer
, remaining
);
12257 if (trace_redisplay_p
)
12258 fprintf (stderr
, "%p (%s): %s\n",
12260 ((BUFFERP (w
->buffer
)
12261 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12262 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12267 #endif /* GLYPH_DEBUG */
12270 /* Value is non-zero if all changes in window W, which displays
12271 current_buffer, are in the text between START and END. START is a
12272 buffer position, END is given as a distance from Z. Used in
12273 redisplay_internal for display optimization. */
12276 text_outside_line_unchanged_p (struct window
*w
,
12277 EMACS_INT start
, EMACS_INT end
)
12279 int unchanged_p
= 1;
12281 /* If text or overlays have changed, see where. */
12282 if (XFASTINT (w
->last_modified
) < MODIFF
12283 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12285 /* Gap in the line? */
12286 if (GPT
< start
|| Z
- GPT
< end
)
12289 /* Changes start in front of the line, or end after it? */
12291 && (BEG_UNCHANGED
< start
- 1
12292 || END_UNCHANGED
< end
))
12295 /* If selective display, can't optimize if changes start at the
12296 beginning of the line. */
12298 && INTEGERP (BVAR (current_buffer
, selective_display
))
12299 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12300 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12303 /* If there are overlays at the start or end of the line, these
12304 may have overlay strings with newlines in them. A change at
12305 START, for instance, may actually concern the display of such
12306 overlay strings as well, and they are displayed on different
12307 lines. So, quickly rule out this case. (For the future, it
12308 might be desirable to implement something more telling than
12309 just BEG/END_UNCHANGED.) */
12312 if (BEG
+ BEG_UNCHANGED
== start
12313 && overlay_touches_p (start
))
12315 if (END_UNCHANGED
== end
12316 && overlay_touches_p (Z
- end
))
12320 /* Under bidi reordering, adding or deleting a character in the
12321 beginning of a paragraph, before the first strong directional
12322 character, can change the base direction of the paragraph (unless
12323 the buffer specifies a fixed paragraph direction), which will
12324 require to redisplay the whole paragraph. It might be worthwhile
12325 to find the paragraph limits and widen the range of redisplayed
12326 lines to that, but for now just give up this optimization. */
12327 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12328 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12332 return unchanged_p
;
12336 /* Do a frame update, taking possible shortcuts into account. This is
12337 the main external entry point for redisplay.
12339 If the last redisplay displayed an echo area message and that message
12340 is no longer requested, we clear the echo area or bring back the
12341 mini-buffer if that is in use. */
12346 redisplay_internal ();
12351 overlay_arrow_string_or_property (Lisp_Object var
)
12355 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12358 return Voverlay_arrow_string
;
12361 /* Return 1 if there are any overlay-arrows in current_buffer. */
12363 overlay_arrow_in_current_buffer_p (void)
12367 for (vlist
= Voverlay_arrow_variable_list
;
12369 vlist
= XCDR (vlist
))
12371 Lisp_Object var
= XCAR (vlist
);
12374 if (!SYMBOLP (var
))
12376 val
= find_symbol_value (var
);
12378 && current_buffer
== XMARKER (val
)->buffer
)
12385 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12389 overlay_arrows_changed_p (void)
12393 for (vlist
= Voverlay_arrow_variable_list
;
12395 vlist
= XCDR (vlist
))
12397 Lisp_Object var
= XCAR (vlist
);
12398 Lisp_Object val
, pstr
;
12400 if (!SYMBOLP (var
))
12402 val
= find_symbol_value (var
);
12403 if (!MARKERP (val
))
12405 if (! EQ (COERCE_MARKER (val
),
12406 Fget (var
, Qlast_arrow_position
))
12407 || ! (pstr
= overlay_arrow_string_or_property (var
),
12408 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12414 /* Mark overlay arrows to be updated on next redisplay. */
12417 update_overlay_arrows (int up_to_date
)
12421 for (vlist
= Voverlay_arrow_variable_list
;
12423 vlist
= XCDR (vlist
))
12425 Lisp_Object var
= XCAR (vlist
);
12427 if (!SYMBOLP (var
))
12430 if (up_to_date
> 0)
12432 Lisp_Object val
= find_symbol_value (var
);
12433 Fput (var
, Qlast_arrow_position
,
12434 COERCE_MARKER (val
));
12435 Fput (var
, Qlast_arrow_string
,
12436 overlay_arrow_string_or_property (var
));
12438 else if (up_to_date
< 0
12439 || !NILP (Fget (var
, Qlast_arrow_position
)))
12441 Fput (var
, Qlast_arrow_position
, Qt
);
12442 Fput (var
, Qlast_arrow_string
, Qt
);
12448 /* Return overlay arrow string to display at row.
12449 Return integer (bitmap number) for arrow bitmap in left fringe.
12450 Return nil if no overlay arrow. */
12453 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12457 for (vlist
= Voverlay_arrow_variable_list
;
12459 vlist
= XCDR (vlist
))
12461 Lisp_Object var
= XCAR (vlist
);
12464 if (!SYMBOLP (var
))
12467 val
= find_symbol_value (var
);
12470 && current_buffer
== XMARKER (val
)->buffer
12471 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12473 if (FRAME_WINDOW_P (it
->f
)
12474 /* FIXME: if ROW->reversed_p is set, this should test
12475 the right fringe, not the left one. */
12476 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12478 #ifdef HAVE_WINDOW_SYSTEM
12479 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12482 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12483 return make_number (fringe_bitmap
);
12486 return make_number (-1); /* Use default arrow bitmap */
12488 return overlay_arrow_string_or_property (var
);
12495 /* Return 1 if point moved out of or into a composition. Otherwise
12496 return 0. PREV_BUF and PREV_PT are the last point buffer and
12497 position. BUF and PT are the current point buffer and position. */
12500 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12501 struct buffer
*buf
, EMACS_INT pt
)
12503 EMACS_INT start
, end
;
12505 Lisp_Object buffer
;
12507 XSETBUFFER (buffer
, buf
);
12508 /* Check a composition at the last point if point moved within the
12510 if (prev_buf
== buf
)
12513 /* Point didn't move. */
12516 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12517 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12518 && COMPOSITION_VALID_P (start
, end
, prop
)
12519 && start
< prev_pt
&& end
> prev_pt
)
12520 /* The last point was within the composition. Return 1 iff
12521 point moved out of the composition. */
12522 return (pt
<= start
|| pt
>= end
);
12525 /* Check a composition at the current point. */
12526 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12527 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12528 && COMPOSITION_VALID_P (start
, end
, prop
)
12529 && start
< pt
&& end
> pt
);
12533 /* Reconsider the setting of B->clip_changed which is displayed
12537 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12539 if (b
->clip_changed
12540 && !NILP (w
->window_end_valid
)
12541 && w
->current_matrix
->buffer
== b
12542 && w
->current_matrix
->zv
== BUF_ZV (b
)
12543 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12544 b
->clip_changed
= 0;
12546 /* If display wasn't paused, and W is not a tool bar window, see if
12547 point has been moved into or out of a composition. In that case,
12548 we set b->clip_changed to 1 to force updating the screen. If
12549 b->clip_changed has already been set to 1, we can skip this
12551 if (!b
->clip_changed
12552 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12556 if (w
== XWINDOW (selected_window
))
12559 pt
= marker_position (w
->pointm
);
12561 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12562 || pt
!= XINT (w
->last_point
))
12563 && check_point_in_composition (w
->current_matrix
->buffer
,
12564 XINT (w
->last_point
),
12565 XBUFFER (w
->buffer
), pt
))
12566 b
->clip_changed
= 1;
12571 /* Select FRAME to forward the values of frame-local variables into C
12572 variables so that the redisplay routines can access those values
12576 select_frame_for_redisplay (Lisp_Object frame
)
12578 Lisp_Object tail
, tem
;
12579 Lisp_Object old
= selected_frame
;
12580 struct Lisp_Symbol
*sym
;
12582 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12584 selected_frame
= frame
;
12587 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12588 if (CONSP (XCAR (tail
))
12589 && (tem
= XCAR (XCAR (tail
)),
12591 && (sym
= indirect_variable (XSYMBOL (tem
)),
12592 sym
->redirect
== SYMBOL_LOCALIZED
)
12593 && sym
->val
.blv
->frame_local
)
12594 /* Use find_symbol_value rather than Fsymbol_value
12595 to avoid an error if it is void. */
12596 find_symbol_value (tem
);
12597 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12601 #define STOP_POLLING \
12602 do { if (! polling_stopped_here) stop_polling (); \
12603 polling_stopped_here = 1; } while (0)
12605 #define RESUME_POLLING \
12606 do { if (polling_stopped_here) start_polling (); \
12607 polling_stopped_here = 0; } while (0)
12610 /* Perhaps in the future avoid recentering windows if it
12611 is not necessary; currently that causes some problems. */
12614 redisplay_internal (void)
12616 struct window
*w
= XWINDOW (selected_window
);
12620 int must_finish
= 0;
12621 struct text_pos tlbufpos
, tlendpos
;
12622 int number_of_visible_frames
;
12625 int polling_stopped_here
= 0;
12626 Lisp_Object old_frame
= selected_frame
;
12628 /* Non-zero means redisplay has to consider all windows on all
12629 frames. Zero means, only selected_window is considered. */
12630 int consider_all_windows_p
;
12632 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12634 /* No redisplay if running in batch mode or frame is not yet fully
12635 initialized, or redisplay is explicitly turned off by setting
12636 Vinhibit_redisplay. */
12637 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12638 || !NILP (Vinhibit_redisplay
))
12641 /* Don't examine these until after testing Vinhibit_redisplay.
12642 When Emacs is shutting down, perhaps because its connection to
12643 X has dropped, we should not look at them at all. */
12644 fr
= XFRAME (w
->frame
);
12645 sf
= SELECTED_FRAME ();
12647 if (!fr
->glyphs_initialized_p
)
12650 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12651 if (popup_activated ())
12655 /* I don't think this happens but let's be paranoid. */
12656 if (redisplaying_p
)
12659 /* Record a function that resets redisplaying_p to its old value
12660 when we leave this function. */
12661 count
= SPECPDL_INDEX ();
12662 record_unwind_protect (unwind_redisplay
,
12663 Fcons (make_number (redisplaying_p
), selected_frame
));
12665 specbind (Qinhibit_free_realized_faces
, Qnil
);
12668 Lisp_Object tail
, frame
;
12670 FOR_EACH_FRAME (tail
, frame
)
12672 struct frame
*f
= XFRAME (frame
);
12673 f
->already_hscrolled_p
= 0;
12678 /* Remember the currently selected window. */
12681 if (!EQ (old_frame
, selected_frame
)
12682 && FRAME_LIVE_P (XFRAME (old_frame
)))
12683 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12684 selected_frame and selected_window to be temporarily out-of-sync so
12685 when we come back here via `goto retry', we need to resync because we
12686 may need to run Elisp code (via prepare_menu_bars). */
12687 select_frame_for_redisplay (old_frame
);
12690 reconsider_clip_changes (w
, current_buffer
);
12691 last_escape_glyph_frame
= NULL
;
12692 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12693 last_glyphless_glyph_frame
= NULL
;
12694 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12696 /* If new fonts have been loaded that make a glyph matrix adjustment
12697 necessary, do it. */
12698 if (fonts_changed_p
)
12700 adjust_glyphs (NULL
);
12701 ++windows_or_buffers_changed
;
12702 fonts_changed_p
= 0;
12705 /* If face_change_count is non-zero, init_iterator will free all
12706 realized faces, which includes the faces referenced from current
12707 matrices. So, we can't reuse current matrices in this case. */
12708 if (face_change_count
)
12709 ++windows_or_buffers_changed
;
12711 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12712 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12714 /* Since frames on a single ASCII terminal share the same
12715 display area, displaying a different frame means redisplay
12716 the whole thing. */
12717 windows_or_buffers_changed
++;
12718 SET_FRAME_GARBAGED (sf
);
12720 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12722 FRAME_TTY (sf
)->previous_frame
= sf
;
12725 /* Set the visible flags for all frames. Do this before checking
12726 for resized or garbaged frames; they want to know if their frames
12727 are visible. See the comment in frame.h for
12728 FRAME_SAMPLE_VISIBILITY. */
12730 Lisp_Object tail
, frame
;
12732 number_of_visible_frames
= 0;
12734 FOR_EACH_FRAME (tail
, frame
)
12736 struct frame
*f
= XFRAME (frame
);
12738 FRAME_SAMPLE_VISIBILITY (f
);
12739 if (FRAME_VISIBLE_P (f
))
12740 ++number_of_visible_frames
;
12741 clear_desired_matrices (f
);
12745 /* Notice any pending interrupt request to change frame size. */
12746 do_pending_window_change (1);
12748 /* do_pending_window_change could change the selected_window due to
12749 frame resizing which makes the selected window too small. */
12750 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12753 reconsider_clip_changes (w
, current_buffer
);
12756 /* Clear frames marked as garbaged. */
12757 if (frame_garbaged
)
12758 clear_garbaged_frames ();
12760 /* Build menubar and tool-bar items. */
12761 if (NILP (Vmemory_full
))
12762 prepare_menu_bars ();
12764 if (windows_or_buffers_changed
)
12765 update_mode_lines
++;
12767 /* Detect case that we need to write or remove a star in the mode line. */
12768 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12770 w
->update_mode_line
= Qt
;
12771 if (buffer_shared
> 1)
12772 update_mode_lines
++;
12775 /* Avoid invocation of point motion hooks by `current_column' below. */
12776 count1
= SPECPDL_INDEX ();
12777 specbind (Qinhibit_point_motion_hooks
, Qt
);
12779 /* If %c is in the mode line, update it if needed. */
12780 if (!NILP (w
->column_number_displayed
)
12781 /* This alternative quickly identifies a common case
12782 where no change is needed. */
12783 && !(PT
== XFASTINT (w
->last_point
)
12784 && XFASTINT (w
->last_modified
) >= MODIFF
12785 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12786 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12787 w
->update_mode_line
= Qt
;
12789 unbind_to (count1
, Qnil
);
12791 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12793 /* The variable buffer_shared is set in redisplay_window and
12794 indicates that we redisplay a buffer in different windows. See
12796 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12797 || cursor_type_changed
);
12799 /* If specs for an arrow have changed, do thorough redisplay
12800 to ensure we remove any arrow that should no longer exist. */
12801 if (overlay_arrows_changed_p ())
12802 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12804 /* Normally the message* functions will have already displayed and
12805 updated the echo area, but the frame may have been trashed, or
12806 the update may have been preempted, so display the echo area
12807 again here. Checking message_cleared_p captures the case that
12808 the echo area should be cleared. */
12809 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12810 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12811 || (message_cleared_p
12812 && minibuf_level
== 0
12813 /* If the mini-window is currently selected, this means the
12814 echo-area doesn't show through. */
12815 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12817 int window_height_changed_p
= echo_area_display (0);
12820 /* If we don't display the current message, don't clear the
12821 message_cleared_p flag, because, if we did, we wouldn't clear
12822 the echo area in the next redisplay which doesn't preserve
12824 if (!display_last_displayed_message_p
)
12825 message_cleared_p
= 0;
12827 if (fonts_changed_p
)
12829 else if (window_height_changed_p
)
12831 consider_all_windows_p
= 1;
12832 ++update_mode_lines
;
12833 ++windows_or_buffers_changed
;
12835 /* If window configuration was changed, frames may have been
12836 marked garbaged. Clear them or we will experience
12837 surprises wrt scrolling. */
12838 if (frame_garbaged
)
12839 clear_garbaged_frames ();
12842 else if (EQ (selected_window
, minibuf_window
)
12843 && (current_buffer
->clip_changed
12844 || XFASTINT (w
->last_modified
) < MODIFF
12845 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12846 && resize_mini_window (w
, 0))
12848 /* Resized active mini-window to fit the size of what it is
12849 showing if its contents might have changed. */
12851 /* FIXME: this causes all frames to be updated, which seems unnecessary
12852 since only the current frame needs to be considered. This function needs
12853 to be rewritten with two variables, consider_all_windows and
12854 consider_all_frames. */
12855 consider_all_windows_p
= 1;
12856 ++windows_or_buffers_changed
;
12857 ++update_mode_lines
;
12859 /* If window configuration was changed, frames may have been
12860 marked garbaged. Clear them or we will experience
12861 surprises wrt scrolling. */
12862 if (frame_garbaged
)
12863 clear_garbaged_frames ();
12867 /* If showing the region, and mark has changed, we must redisplay
12868 the whole window. The assignment to this_line_start_pos prevents
12869 the optimization directly below this if-statement. */
12870 if (((!NILP (Vtransient_mark_mode
)
12871 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12872 != !NILP (w
->region_showing
))
12873 || (!NILP (w
->region_showing
)
12874 && !EQ (w
->region_showing
,
12875 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12876 CHARPOS (this_line_start_pos
) = 0;
12878 /* Optimize the case that only the line containing the cursor in the
12879 selected window has changed. Variables starting with this_ are
12880 set in display_line and record information about the line
12881 containing the cursor. */
12882 tlbufpos
= this_line_start_pos
;
12883 tlendpos
= this_line_end_pos
;
12884 if (!consider_all_windows_p
12885 && CHARPOS (tlbufpos
) > 0
12886 && NILP (w
->update_mode_line
)
12887 && !current_buffer
->clip_changed
12888 && !current_buffer
->prevent_redisplay_optimizations_p
12889 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12890 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12891 /* Make sure recorded data applies to current buffer, etc. */
12892 && this_line_buffer
== current_buffer
12893 && current_buffer
== XBUFFER (w
->buffer
)
12894 && NILP (w
->force_start
)
12895 && NILP (w
->optional_new_start
)
12896 /* Point must be on the line that we have info recorded about. */
12897 && PT
>= CHARPOS (tlbufpos
)
12898 && PT
<= Z
- CHARPOS (tlendpos
)
12899 /* All text outside that line, including its final newline,
12900 must be unchanged. */
12901 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12902 CHARPOS (tlendpos
)))
12904 if (CHARPOS (tlbufpos
) > BEGV
12905 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12906 && (CHARPOS (tlbufpos
) == ZV
12907 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12908 /* Former continuation line has disappeared by becoming empty. */
12910 else if (XFASTINT (w
->last_modified
) < MODIFF
12911 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12912 || MINI_WINDOW_P (w
))
12914 /* We have to handle the case of continuation around a
12915 wide-column character (see the comment in indent.c around
12918 For instance, in the following case:
12920 -------- Insert --------
12921 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12922 J_I_ ==> J_I_ `^^' are cursors.
12926 As we have to redraw the line above, we cannot use this
12930 int line_height_before
= this_line_pixel_height
;
12932 /* Note that start_display will handle the case that the
12933 line starting at tlbufpos is a continuation line. */
12934 start_display (&it
, w
, tlbufpos
);
12936 /* Implementation note: It this still necessary? */
12937 if (it
.current_x
!= this_line_start_x
)
12940 TRACE ((stderr
, "trying display optimization 1\n"));
12941 w
->cursor
.vpos
= -1;
12942 overlay_arrow_seen
= 0;
12943 it
.vpos
= this_line_vpos
;
12944 it
.current_y
= this_line_y
;
12945 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12946 display_line (&it
);
12948 /* If line contains point, is not continued,
12949 and ends at same distance from eob as before, we win. */
12950 if (w
->cursor
.vpos
>= 0
12951 /* Line is not continued, otherwise this_line_start_pos
12952 would have been set to 0 in display_line. */
12953 && CHARPOS (this_line_start_pos
)
12954 /* Line ends as before. */
12955 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12956 /* Line has same height as before. Otherwise other lines
12957 would have to be shifted up or down. */
12958 && this_line_pixel_height
== line_height_before
)
12960 /* If this is not the window's last line, we must adjust
12961 the charstarts of the lines below. */
12962 if (it
.current_y
< it
.last_visible_y
)
12964 struct glyph_row
*row
12965 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12966 EMACS_INT delta
, delta_bytes
;
12968 /* We used to distinguish between two cases here,
12969 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12970 when the line ends in a newline or the end of the
12971 buffer's accessible portion. But both cases did
12972 the same, so they were collapsed. */
12974 - CHARPOS (tlendpos
)
12975 - MATRIX_ROW_START_CHARPOS (row
));
12976 delta_bytes
= (Z_BYTE
12977 - BYTEPOS (tlendpos
)
12978 - MATRIX_ROW_START_BYTEPOS (row
));
12980 increment_matrix_positions (w
->current_matrix
,
12981 this_line_vpos
+ 1,
12982 w
->current_matrix
->nrows
,
12983 delta
, delta_bytes
);
12986 /* If this row displays text now but previously didn't,
12987 or vice versa, w->window_end_vpos may have to be
12989 if ((it
.glyph_row
- 1)->displays_text_p
)
12991 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12992 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12994 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12995 && this_line_vpos
> 0)
12996 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12997 w
->window_end_valid
= Qnil
;
12999 /* Update hint: No need to try to scroll in update_window. */
13000 w
->desired_matrix
->no_scrolling_p
= 1;
13003 *w
->desired_matrix
->method
= 0;
13004 debug_method_add (w
, "optimization 1");
13006 #ifdef HAVE_WINDOW_SYSTEM
13007 update_window_fringes (w
, 0);
13014 else if (/* Cursor position hasn't changed. */
13015 PT
== XFASTINT (w
->last_point
)
13016 /* Make sure the cursor was last displayed
13017 in this window. Otherwise we have to reposition it. */
13018 && 0 <= w
->cursor
.vpos
13019 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13023 do_pending_window_change (1);
13024 /* If selected_window changed, redisplay again. */
13025 if (WINDOWP (selected_window
)
13026 && (w
= XWINDOW (selected_window
)) != sw
)
13029 /* We used to always goto end_of_redisplay here, but this
13030 isn't enough if we have a blinking cursor. */
13031 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13032 goto end_of_redisplay
;
13036 /* If highlighting the region, or if the cursor is in the echo area,
13037 then we can't just move the cursor. */
13038 else if (! (!NILP (Vtransient_mark_mode
)
13039 && !NILP (BVAR (current_buffer
, mark_active
)))
13040 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13041 || highlight_nonselected_windows
)
13042 && NILP (w
->region_showing
)
13043 && NILP (Vshow_trailing_whitespace
)
13044 && !cursor_in_echo_area
)
13047 struct glyph_row
*row
;
13049 /* Skip from tlbufpos to PT and see where it is. Note that
13050 PT may be in invisible text. If so, we will end at the
13051 next visible position. */
13052 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13053 NULL
, DEFAULT_FACE_ID
);
13054 it
.current_x
= this_line_start_x
;
13055 it
.current_y
= this_line_y
;
13056 it
.vpos
= this_line_vpos
;
13058 /* The call to move_it_to stops in front of PT, but
13059 moves over before-strings. */
13060 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13062 if (it
.vpos
== this_line_vpos
13063 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13066 xassert (this_line_vpos
== it
.vpos
);
13067 xassert (this_line_y
== it
.current_y
);
13068 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13070 *w
->desired_matrix
->method
= 0;
13071 debug_method_add (w
, "optimization 3");
13080 /* Text changed drastically or point moved off of line. */
13081 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13084 CHARPOS (this_line_start_pos
) = 0;
13085 consider_all_windows_p
|= buffer_shared
> 1;
13086 ++clear_face_cache_count
;
13087 #ifdef HAVE_WINDOW_SYSTEM
13088 ++clear_image_cache_count
;
13091 /* Build desired matrices, and update the display. If
13092 consider_all_windows_p is non-zero, do it for all windows on all
13093 frames. Otherwise do it for selected_window, only. */
13095 if (consider_all_windows_p
)
13097 Lisp_Object tail
, frame
;
13099 FOR_EACH_FRAME (tail
, frame
)
13100 XFRAME (frame
)->updated_p
= 0;
13102 /* Recompute # windows showing selected buffer. This will be
13103 incremented each time such a window is displayed. */
13106 FOR_EACH_FRAME (tail
, frame
)
13108 struct frame
*f
= XFRAME (frame
);
13110 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13112 if (! EQ (frame
, selected_frame
))
13113 /* Select the frame, for the sake of frame-local
13115 select_frame_for_redisplay (frame
);
13117 /* Mark all the scroll bars to be removed; we'll redeem
13118 the ones we want when we redisplay their windows. */
13119 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13120 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13122 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13123 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13125 /* The X error handler may have deleted that frame. */
13126 if (!FRAME_LIVE_P (f
))
13129 /* Any scroll bars which redisplay_windows should have
13130 nuked should now go away. */
13131 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13132 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13134 /* If fonts changed, display again. */
13135 /* ??? rms: I suspect it is a mistake to jump all the way
13136 back to retry here. It should just retry this frame. */
13137 if (fonts_changed_p
)
13140 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13142 /* See if we have to hscroll. */
13143 if (!f
->already_hscrolled_p
)
13145 f
->already_hscrolled_p
= 1;
13146 if (hscroll_windows (f
->root_window
))
13150 /* Prevent various kinds of signals during display
13151 update. stdio is not robust about handling
13152 signals, which can cause an apparent I/O
13154 if (interrupt_input
)
13155 unrequest_sigio ();
13158 /* Update the display. */
13159 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13160 pending
|= update_frame (f
, 0, 0);
13166 if (!EQ (old_frame
, selected_frame
)
13167 && FRAME_LIVE_P (XFRAME (old_frame
)))
13168 /* We played a bit fast-and-loose above and allowed selected_frame
13169 and selected_window to be temporarily out-of-sync but let's make
13170 sure this stays contained. */
13171 select_frame_for_redisplay (old_frame
);
13172 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13176 /* Do the mark_window_display_accurate after all windows have
13177 been redisplayed because this call resets flags in buffers
13178 which are needed for proper redisplay. */
13179 FOR_EACH_FRAME (tail
, frame
)
13181 struct frame
*f
= XFRAME (frame
);
13184 mark_window_display_accurate (f
->root_window
, 1);
13185 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13186 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13191 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13193 Lisp_Object mini_window
;
13194 struct frame
*mini_frame
;
13196 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13197 /* Use list_of_error, not Qerror, so that
13198 we catch only errors and don't run the debugger. */
13199 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13201 redisplay_window_error
);
13203 /* Compare desired and current matrices, perform output. */
13206 /* If fonts changed, display again. */
13207 if (fonts_changed_p
)
13210 /* Prevent various kinds of signals during display update.
13211 stdio is not robust about handling signals,
13212 which can cause an apparent I/O error. */
13213 if (interrupt_input
)
13214 unrequest_sigio ();
13217 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13219 if (hscroll_windows (selected_window
))
13222 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13223 pending
= update_frame (sf
, 0, 0);
13226 /* We may have called echo_area_display at the top of this
13227 function. If the echo area is on another frame, that may
13228 have put text on a frame other than the selected one, so the
13229 above call to update_frame would not have caught it. Catch
13231 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13232 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13234 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13236 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13237 pending
|= update_frame (mini_frame
, 0, 0);
13238 if (!pending
&& hscroll_windows (mini_window
))
13243 /* If display was paused because of pending input, make sure we do a
13244 thorough update the next time. */
13247 /* Prevent the optimization at the beginning of
13248 redisplay_internal that tries a single-line update of the
13249 line containing the cursor in the selected window. */
13250 CHARPOS (this_line_start_pos
) = 0;
13252 /* Let the overlay arrow be updated the next time. */
13253 update_overlay_arrows (0);
13255 /* If we pause after scrolling, some rows in the current
13256 matrices of some windows are not valid. */
13257 if (!WINDOW_FULL_WIDTH_P (w
)
13258 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13259 update_mode_lines
= 1;
13263 if (!consider_all_windows_p
)
13265 /* This has already been done above if
13266 consider_all_windows_p is set. */
13267 mark_window_display_accurate_1 (w
, 1);
13269 /* Say overlay arrows are up to date. */
13270 update_overlay_arrows (1);
13272 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13273 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13276 update_mode_lines
= 0;
13277 windows_or_buffers_changed
= 0;
13278 cursor_type_changed
= 0;
13281 /* Start SIGIO interrupts coming again. Having them off during the
13282 code above makes it less likely one will discard output, but not
13283 impossible, since there might be stuff in the system buffer here.
13284 But it is much hairier to try to do anything about that. */
13285 if (interrupt_input
)
13289 /* If a frame has become visible which was not before, redisplay
13290 again, so that we display it. Expose events for such a frame
13291 (which it gets when becoming visible) don't call the parts of
13292 redisplay constructing glyphs, so simply exposing a frame won't
13293 display anything in this case. So, we have to display these
13294 frames here explicitly. */
13297 Lisp_Object tail
, frame
;
13300 FOR_EACH_FRAME (tail
, frame
)
13302 int this_is_visible
= 0;
13304 if (XFRAME (frame
)->visible
)
13305 this_is_visible
= 1;
13306 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13307 if (XFRAME (frame
)->visible
)
13308 this_is_visible
= 1;
13310 if (this_is_visible
)
13314 if (new_count
!= number_of_visible_frames
)
13315 windows_or_buffers_changed
++;
13318 /* Change frame size now if a change is pending. */
13319 do_pending_window_change (1);
13321 /* If we just did a pending size change, or have additional
13322 visible frames, or selected_window changed, redisplay again. */
13323 if ((windows_or_buffers_changed
&& !pending
)
13324 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13327 /* Clear the face and image caches.
13329 We used to do this only if consider_all_windows_p. But the cache
13330 needs to be cleared if a timer creates images in the current
13331 buffer (e.g. the test case in Bug#6230). */
13333 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13335 clear_face_cache (0);
13336 clear_face_cache_count
= 0;
13339 #ifdef HAVE_WINDOW_SYSTEM
13340 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13342 clear_image_caches (Qnil
);
13343 clear_image_cache_count
= 0;
13345 #endif /* HAVE_WINDOW_SYSTEM */
13348 unbind_to (count
, Qnil
);
13353 /* Redisplay, but leave alone any recent echo area message unless
13354 another message has been requested in its place.
13356 This is useful in situations where you need to redisplay but no
13357 user action has occurred, making it inappropriate for the message
13358 area to be cleared. See tracking_off and
13359 wait_reading_process_output for examples of these situations.
13361 FROM_WHERE is an integer saying from where this function was
13362 called. This is useful for debugging. */
13365 redisplay_preserve_echo_area (int from_where
)
13367 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13369 if (!NILP (echo_area_buffer
[1]))
13371 /* We have a previously displayed message, but no current
13372 message. Redisplay the previous message. */
13373 display_last_displayed_message_p
= 1;
13374 redisplay_internal ();
13375 display_last_displayed_message_p
= 0;
13378 redisplay_internal ();
13380 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13381 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13382 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13386 /* Function registered with record_unwind_protect in
13387 redisplay_internal. Reset redisplaying_p to the value it had
13388 before redisplay_internal was called, and clear
13389 prevent_freeing_realized_faces_p. It also selects the previously
13390 selected frame, unless it has been deleted (by an X connection
13391 failure during redisplay, for example). */
13394 unwind_redisplay (Lisp_Object val
)
13396 Lisp_Object old_redisplaying_p
, old_frame
;
13398 old_redisplaying_p
= XCAR (val
);
13399 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13400 old_frame
= XCDR (val
);
13401 if (! EQ (old_frame
, selected_frame
)
13402 && FRAME_LIVE_P (XFRAME (old_frame
)))
13403 select_frame_for_redisplay (old_frame
);
13408 /* Mark the display of window W as accurate or inaccurate. If
13409 ACCURATE_P is non-zero mark display of W as accurate. If
13410 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13411 redisplay_internal is called. */
13414 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13416 if (BUFFERP (w
->buffer
))
13418 struct buffer
*b
= XBUFFER (w
->buffer
);
13421 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13422 w
->last_overlay_modified
13423 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13425 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13429 b
->clip_changed
= 0;
13430 b
->prevent_redisplay_optimizations_p
= 0;
13432 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13433 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13434 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13435 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13437 w
->current_matrix
->buffer
= b
;
13438 w
->current_matrix
->begv
= BUF_BEGV (b
);
13439 w
->current_matrix
->zv
= BUF_ZV (b
);
13441 w
->last_cursor
= w
->cursor
;
13442 w
->last_cursor_off_p
= w
->cursor_off_p
;
13444 if (w
== XWINDOW (selected_window
))
13445 w
->last_point
= make_number (BUF_PT (b
));
13447 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13453 w
->window_end_valid
= w
->buffer
;
13454 w
->update_mode_line
= Qnil
;
13459 /* Mark the display of windows in the window tree rooted at WINDOW as
13460 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13461 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13462 be redisplayed the next time redisplay_internal is called. */
13465 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13469 for (; !NILP (window
); window
= w
->next
)
13471 w
= XWINDOW (window
);
13472 mark_window_display_accurate_1 (w
, accurate_p
);
13474 if (!NILP (w
->vchild
))
13475 mark_window_display_accurate (w
->vchild
, accurate_p
);
13476 if (!NILP (w
->hchild
))
13477 mark_window_display_accurate (w
->hchild
, accurate_p
);
13482 update_overlay_arrows (1);
13486 /* Force a thorough redisplay the next time by setting
13487 last_arrow_position and last_arrow_string to t, which is
13488 unequal to any useful value of Voverlay_arrow_... */
13489 update_overlay_arrows (-1);
13494 /* Return value in display table DP (Lisp_Char_Table *) for character
13495 C. Since a display table doesn't have any parent, we don't have to
13496 follow parent. Do not call this function directly but use the
13497 macro DISP_CHAR_VECTOR. */
13500 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13504 if (ASCII_CHAR_P (c
))
13507 if (SUB_CHAR_TABLE_P (val
))
13508 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13514 XSETCHAR_TABLE (table
, dp
);
13515 val
= char_table_ref (table
, c
);
13524 /***********************************************************************
13526 ***********************************************************************/
13528 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13531 redisplay_windows (Lisp_Object window
)
13533 while (!NILP (window
))
13535 struct window
*w
= XWINDOW (window
);
13537 if (!NILP (w
->hchild
))
13538 redisplay_windows (w
->hchild
);
13539 else if (!NILP (w
->vchild
))
13540 redisplay_windows (w
->vchild
);
13541 else if (!NILP (w
->buffer
))
13543 displayed_buffer
= XBUFFER (w
->buffer
);
13544 /* Use list_of_error, not Qerror, so that
13545 we catch only errors and don't run the debugger. */
13546 internal_condition_case_1 (redisplay_window_0
, window
,
13548 redisplay_window_error
);
13556 redisplay_window_error (Lisp_Object ignore
)
13558 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13563 redisplay_window_0 (Lisp_Object window
)
13565 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13566 redisplay_window (window
, 0);
13571 redisplay_window_1 (Lisp_Object window
)
13573 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13574 redisplay_window (window
, 1);
13579 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13580 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13581 which positions recorded in ROW differ from current buffer
13584 Return 0 if cursor is not on this row, 1 otherwise. */
13587 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13588 struct glyph_matrix
*matrix
,
13589 EMACS_INT delta
, EMACS_INT delta_bytes
,
13592 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13593 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13594 struct glyph
*cursor
= NULL
;
13595 /* The last known character position in row. */
13596 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13598 EMACS_INT pt_old
= PT
- delta
;
13599 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13600 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13601 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13602 /* A glyph beyond the edge of TEXT_AREA which we should never
13604 struct glyph
*glyphs_end
= end
;
13605 /* Non-zero means we've found a match for cursor position, but that
13606 glyph has the avoid_cursor_p flag set. */
13607 int match_with_avoid_cursor
= 0;
13608 /* Non-zero means we've seen at least one glyph that came from a
13610 int string_seen
= 0;
13611 /* Largest and smalles buffer positions seen so far during scan of
13613 EMACS_INT bpos_max
= pos_before
;
13614 EMACS_INT bpos_min
= pos_after
;
13615 /* Last buffer position covered by an overlay string with an integer
13616 `cursor' property. */
13617 EMACS_INT bpos_covered
= 0;
13618 /* Non-zero means the display string on which to display the cursor
13619 comes from a text property, not from an overlay. */
13620 int string_from_text_prop
= 0;
13622 /* Skip over glyphs not having an object at the start and the end of
13623 the row. These are special glyphs like truncation marks on
13624 terminal frames. */
13625 if (row
->displays_text_p
)
13627 if (!row
->reversed_p
)
13630 && INTEGERP (glyph
->object
)
13631 && glyph
->charpos
< 0)
13633 x
+= glyph
->pixel_width
;
13637 && INTEGERP ((end
- 1)->object
)
13638 /* CHARPOS is zero for blanks and stretch glyphs
13639 inserted by extend_face_to_end_of_line. */
13640 && (end
- 1)->charpos
<= 0)
13642 glyph_before
= glyph
- 1;
13649 /* If the glyph row is reversed, we need to process it from back
13650 to front, so swap the edge pointers. */
13651 glyphs_end
= end
= glyph
- 1;
13652 glyph
+= row
->used
[TEXT_AREA
] - 1;
13654 while (glyph
> end
+ 1
13655 && INTEGERP (glyph
->object
)
13656 && glyph
->charpos
< 0)
13659 x
-= glyph
->pixel_width
;
13661 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13663 /* By default, in reversed rows we put the cursor on the
13664 rightmost (first in the reading order) glyph. */
13665 for (g
= end
+ 1; g
< glyph
; g
++)
13666 x
+= g
->pixel_width
;
13668 && INTEGERP ((end
+ 1)->object
)
13669 && (end
+ 1)->charpos
<= 0)
13671 glyph_before
= glyph
+ 1;
13675 else if (row
->reversed_p
)
13677 /* In R2L rows that don't display text, put the cursor on the
13678 rightmost glyph. Case in point: an empty last line that is
13679 part of an R2L paragraph. */
13681 /* Avoid placing the cursor on the last glyph of the row, where
13682 on terminal frames we hold the vertical border between
13683 adjacent windows. */
13684 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13685 && !WINDOW_RIGHTMOST_P (w
)
13686 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13688 x
= -1; /* will be computed below, at label compute_x */
13691 /* Step 1: Try to find the glyph whose character position
13692 corresponds to point. If that's not possible, find 2 glyphs
13693 whose character positions are the closest to point, one before
13694 point, the other after it. */
13695 if (!row
->reversed_p
)
13696 while (/* not marched to end of glyph row */
13698 /* glyph was not inserted by redisplay for internal purposes */
13699 && !INTEGERP (glyph
->object
))
13701 if (BUFFERP (glyph
->object
))
13703 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13705 if (glyph
->charpos
> bpos_max
)
13706 bpos_max
= glyph
->charpos
;
13707 if (glyph
->charpos
< bpos_min
)
13708 bpos_min
= glyph
->charpos
;
13709 if (!glyph
->avoid_cursor_p
)
13711 /* If we hit point, we've found the glyph on which to
13712 display the cursor. */
13715 match_with_avoid_cursor
= 0;
13718 /* See if we've found a better approximation to
13719 POS_BEFORE or to POS_AFTER. Note that we want the
13720 first (leftmost) glyph of all those that are the
13721 closest from below, and the last (rightmost) of all
13722 those from above. */
13723 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13725 pos_before
= glyph
->charpos
;
13726 glyph_before
= glyph
;
13728 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13730 pos_after
= glyph
->charpos
;
13731 glyph_after
= glyph
;
13734 else if (dpos
== 0)
13735 match_with_avoid_cursor
= 1;
13737 else if (STRINGP (glyph
->object
))
13739 Lisp_Object chprop
;
13740 EMACS_INT glyph_pos
= glyph
->charpos
;
13742 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13744 if (INTEGERP (chprop
))
13746 bpos_covered
= bpos_max
+ XINT (chprop
);
13747 /* If the `cursor' property covers buffer positions up
13748 to and including point, we should display cursor on
13749 this glyph. Note that overlays and text properties
13750 with string values stop bidi reordering, so every
13751 buffer position to the left of the string is always
13752 smaller than any position to the right of the
13753 string. Therefore, if a `cursor' property on one
13754 of the string's characters has an integer value, we
13755 will break out of the loop below _before_ we get to
13756 the position match above. IOW, integer values of
13757 the `cursor' property override the "exact match for
13758 point" strategy of positioning the cursor. */
13759 /* Implementation note: bpos_max == pt_old when, e.g.,
13760 we are in an empty line, where bpos_max is set to
13761 MATRIX_ROW_START_CHARPOS, see above. */
13762 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13771 x
+= glyph
->pixel_width
;
13774 else if (glyph
> end
) /* row is reversed */
13775 while (!INTEGERP (glyph
->object
))
13777 if (BUFFERP (glyph
->object
))
13779 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13781 if (glyph
->charpos
> bpos_max
)
13782 bpos_max
= glyph
->charpos
;
13783 if (glyph
->charpos
< bpos_min
)
13784 bpos_min
= glyph
->charpos
;
13785 if (!glyph
->avoid_cursor_p
)
13789 match_with_avoid_cursor
= 0;
13792 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13794 pos_before
= glyph
->charpos
;
13795 glyph_before
= glyph
;
13797 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13799 pos_after
= glyph
->charpos
;
13800 glyph_after
= glyph
;
13803 else if (dpos
== 0)
13804 match_with_avoid_cursor
= 1;
13806 else if (STRINGP (glyph
->object
))
13808 Lisp_Object chprop
;
13809 EMACS_INT glyph_pos
= glyph
->charpos
;
13811 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13813 if (INTEGERP (chprop
))
13815 bpos_covered
= bpos_max
+ XINT (chprop
);
13816 /* If the `cursor' property covers buffer positions up
13817 to and including point, we should display cursor on
13819 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13828 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13830 x
--; /* can't use any pixel_width */
13833 x
-= glyph
->pixel_width
;
13836 /* Step 2: If we didn't find an exact match for point, we need to
13837 look for a proper place to put the cursor among glyphs between
13838 GLYPH_BEFORE and GLYPH_AFTER. */
13839 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13840 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13841 && bpos_covered
< pt_old
)
13843 /* An empty line has a single glyph whose OBJECT is zero and
13844 whose CHARPOS is the position of a newline on that line.
13845 Note that on a TTY, there are more glyphs after that, which
13846 were produced by extend_face_to_end_of_line, but their
13847 CHARPOS is zero or negative. */
13849 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13850 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13852 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13854 EMACS_INT ellipsis_pos
;
13856 /* Scan back over the ellipsis glyphs. */
13857 if (!row
->reversed_p
)
13859 ellipsis_pos
= (glyph
- 1)->charpos
;
13860 while (glyph
> row
->glyphs
[TEXT_AREA
]
13861 && (glyph
- 1)->charpos
== ellipsis_pos
)
13862 glyph
--, x
-= glyph
->pixel_width
;
13863 /* That loop always goes one position too far, including
13864 the glyph before the ellipsis. So scan forward over
13866 x
+= glyph
->pixel_width
;
13869 else /* row is reversed */
13871 ellipsis_pos
= (glyph
+ 1)->charpos
;
13872 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13873 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13874 glyph
++, x
+= glyph
->pixel_width
;
13875 x
-= glyph
->pixel_width
;
13879 else if (match_with_avoid_cursor
)
13881 cursor
= glyph_after
;
13884 else if (string_seen
)
13886 int incr
= row
->reversed_p
? -1 : +1;
13888 /* Need to find the glyph that came out of a string which is
13889 present at point. That glyph is somewhere between
13890 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13891 positioned between POS_BEFORE and POS_AFTER in the
13893 struct glyph
*start
, *stop
;
13894 EMACS_INT pos
= pos_before
;
13898 /* If the row ends in a newline from a display string,
13899 reordering could have moved the glyphs belonging to the
13900 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13901 in this case we extend the search to the last glyph in
13902 the row that was not inserted by redisplay. */
13903 if (row
->ends_in_newline_from_string_p
)
13906 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13909 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13910 correspond to POS_BEFORE and POS_AFTER, respectively. We
13911 need START and STOP in the order that corresponds to the
13912 row's direction as given by its reversed_p flag. If the
13913 directionality of characters between POS_BEFORE and
13914 POS_AFTER is the opposite of the row's base direction,
13915 these characters will have been reordered for display,
13916 and we need to reverse START and STOP. */
13917 if (!row
->reversed_p
)
13919 start
= min (glyph_before
, glyph_after
);
13920 stop
= max (glyph_before
, glyph_after
);
13924 start
= max (glyph_before
, glyph_after
);
13925 stop
= min (glyph_before
, glyph_after
);
13927 for (glyph
= start
+ incr
;
13928 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13931 /* Any glyphs that come from the buffer are here because
13932 of bidi reordering. Skip them, and only pay
13933 attention to glyphs that came from some string. */
13934 if (STRINGP (glyph
->object
))
13938 /* If the display property covers the newline, we
13939 need to search for it one position farther. */
13940 EMACS_INT lim
= pos_after
13941 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13943 string_from_text_prop
= 0;
13944 str
= glyph
->object
;
13945 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13946 if (tem
== 0 /* from overlay */
13949 /* If the string from which this glyph came is
13950 found in the buffer at point, then we've
13951 found the glyph we've been looking for. If
13952 it comes from an overlay (tem == 0), and it
13953 has the `cursor' property on one of its
13954 glyphs, record that glyph as a candidate for
13955 displaying the cursor. (As in the
13956 unidirectional version, we will display the
13957 cursor on the last candidate we find.) */
13958 if (tem
== 0 || tem
== pt_old
)
13960 /* The glyphs from this string could have
13961 been reordered. Find the one with the
13962 smallest string position. Or there could
13963 be a character in the string with the
13964 `cursor' property, which means display
13965 cursor on that character's glyph. */
13966 EMACS_INT strpos
= glyph
->charpos
;
13971 string_from_text_prop
= 1;
13974 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13975 && EQ (glyph
->object
, str
);
13979 EMACS_INT gpos
= glyph
->charpos
;
13981 cprop
= Fget_char_property (make_number (gpos
),
13989 if (tem
&& glyph
->charpos
< strpos
)
13991 strpos
= glyph
->charpos
;
14000 pos
= tem
+ 1; /* don't find previous instances */
14002 /* This string is not what we want; skip all of the
14003 glyphs that came from it. */
14004 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14005 && EQ (glyph
->object
, str
))
14012 /* If we reached the end of the line, and END was from a string,
14013 the cursor is not on this line. */
14015 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14016 && STRINGP (end
->object
)
14017 && row
->continued_p
)
14020 /* A truncated row may not include PT among its character positions.
14021 Setting the cursor inside the scroll margin will trigger
14022 recalculation of hscroll in hscroll_window_tree. But if a
14023 display string covers point, defer to the string-handling
14024 code below to figure this out. */
14025 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14027 cursor
= glyph_before
;
14030 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14031 /* Zero-width characters produce no glyphs. */
14033 && (row
->reversed_p
14034 ? glyph_after
> glyphs_end
14035 : glyph_after
< glyphs_end
)))
14037 cursor
= glyph_after
;
14043 if (cursor
!= NULL
)
14049 /* Need to compute x that corresponds to GLYPH. */
14050 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14052 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14054 x
+= g
->pixel_width
;
14058 /* ROW could be part of a continued line, which, under bidi
14059 reordering, might have other rows whose start and end charpos
14060 occlude point. Only set w->cursor if we found a better
14061 approximation to the cursor position than we have from previously
14062 examined candidate rows belonging to the same continued line. */
14063 if (/* we already have a candidate row */
14064 w
->cursor
.vpos
>= 0
14065 /* that candidate is not the row we are processing */
14066 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14067 /* Make sure cursor.vpos specifies a row whose start and end
14068 charpos occlude point, and it is valid candidate for being a
14069 cursor-row. This is because some callers of this function
14070 leave cursor.vpos at the row where the cursor was displayed
14071 during the last redisplay cycle. */
14072 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14073 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14074 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14077 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14079 /* Don't consider glyphs that are outside TEXT_AREA. */
14080 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14082 /* Keep the candidate whose buffer position is the closest to
14083 point or has the `cursor' property. */
14084 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14085 w
->cursor
.hpos
>= 0
14086 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14087 && ((BUFFERP (g1
->object
)
14088 && (g1
->charpos
== pt_old
/* an exact match always wins */
14089 || (BUFFERP (glyph
->object
)
14090 && eabs (g1
->charpos
- pt_old
)
14091 < eabs (glyph
->charpos
- pt_old
))))
14092 /* previous candidate is a glyph from a string that has
14093 a non-nil `cursor' property */
14094 || (STRINGP (g1
->object
)
14095 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14096 Qcursor
, g1
->object
))
14097 /* pevious candidate is from the same display
14098 string as this one, and the display string
14099 came from a text property */
14100 || (EQ (g1
->object
, glyph
->object
)
14101 && string_from_text_prop
)
14102 /* this candidate is from newline and its
14103 position is not an exact match */
14104 || (INTEGERP (glyph
->object
)
14105 && glyph
->charpos
!= pt_old
)))))
14107 /* If this candidate gives an exact match, use that. */
14108 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14109 /* If this candidate is a glyph created for the
14110 terminating newline of a line, and point is on that
14111 newline, it wins because it's an exact match. */
14112 || (!row
->continued_p
14113 && INTEGERP (glyph
->object
)
14114 && glyph
->charpos
== 0
14115 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14116 /* Otherwise, keep the candidate that comes from a row
14117 spanning less buffer positions. This may win when one or
14118 both candidate positions are on glyphs that came from
14119 display strings, for which we cannot compare buffer
14121 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14122 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14123 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14126 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14128 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14129 w
->cursor
.y
= row
->y
+ dy
;
14131 if (w
== XWINDOW (selected_window
))
14133 if (!row
->continued_p
14134 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14137 this_line_buffer
= XBUFFER (w
->buffer
);
14139 CHARPOS (this_line_start_pos
)
14140 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14141 BYTEPOS (this_line_start_pos
)
14142 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14144 CHARPOS (this_line_end_pos
)
14145 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14146 BYTEPOS (this_line_end_pos
)
14147 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14149 this_line_y
= w
->cursor
.y
;
14150 this_line_pixel_height
= row
->height
;
14151 this_line_vpos
= w
->cursor
.vpos
;
14152 this_line_start_x
= row
->x
;
14155 CHARPOS (this_line_start_pos
) = 0;
14162 /* Run window scroll functions, if any, for WINDOW with new window
14163 start STARTP. Sets the window start of WINDOW to that position.
14165 We assume that the window's buffer is really current. */
14167 static inline struct text_pos
14168 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14170 struct window
*w
= XWINDOW (window
);
14171 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14173 if (current_buffer
!= XBUFFER (w
->buffer
))
14176 if (!NILP (Vwindow_scroll_functions
))
14178 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14179 make_number (CHARPOS (startp
)));
14180 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14181 /* In case the hook functions switch buffers. */
14182 if (current_buffer
!= XBUFFER (w
->buffer
))
14183 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14190 /* Make sure the line containing the cursor is fully visible.
14191 A value of 1 means there is nothing to be done.
14192 (Either the line is fully visible, or it cannot be made so,
14193 or we cannot tell.)
14195 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14196 is higher than window.
14198 A value of 0 means the caller should do scrolling
14199 as if point had gone off the screen. */
14202 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14204 struct glyph_matrix
*matrix
;
14205 struct glyph_row
*row
;
14208 if (!make_cursor_line_fully_visible_p
)
14211 /* It's not always possible to find the cursor, e.g, when a window
14212 is full of overlay strings. Don't do anything in that case. */
14213 if (w
->cursor
.vpos
< 0)
14216 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14217 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14219 /* If the cursor row is not partially visible, there's nothing to do. */
14220 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14223 /* If the row the cursor is in is taller than the window's height,
14224 it's not clear what to do, so do nothing. */
14225 window_height
= window_box_height (w
);
14226 if (row
->height
>= window_height
)
14228 if (!force_p
|| MINI_WINDOW_P (w
)
14229 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14236 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14237 non-zero means only WINDOW is redisplayed in redisplay_internal.
14238 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14239 in redisplay_window to bring a partially visible line into view in
14240 the case that only the cursor has moved.
14242 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14243 last screen line's vertical height extends past the end of the screen.
14247 1 if scrolling succeeded
14249 0 if scrolling didn't find point.
14251 -1 if new fonts have been loaded so that we must interrupt
14252 redisplay, adjust glyph matrices, and try again. */
14258 SCROLLING_NEED_LARGER_MATRICES
14261 /* If scroll-conservatively is more than this, never recenter.
14263 If you change this, don't forget to update the doc string of
14264 `scroll-conservatively' and the Emacs manual. */
14265 #define SCROLL_LIMIT 100
14268 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14269 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14270 int temp_scroll_step
, int last_line_misfit
)
14272 struct window
*w
= XWINDOW (window
);
14273 struct frame
*f
= XFRAME (w
->frame
);
14274 struct text_pos pos
, startp
;
14276 int this_scroll_margin
, scroll_max
, rc
, height
;
14277 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14278 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14279 Lisp_Object aggressive
;
14280 /* We will never try scrolling more than this number of lines. */
14281 int scroll_limit
= SCROLL_LIMIT
;
14284 debug_method_add (w
, "try_scrolling");
14287 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14289 /* Compute scroll margin height in pixels. We scroll when point is
14290 within this distance from the top or bottom of the window. */
14291 if (scroll_margin
> 0)
14292 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14293 * FRAME_LINE_HEIGHT (f
);
14295 this_scroll_margin
= 0;
14297 /* Force arg_scroll_conservatively to have a reasonable value, to
14298 avoid scrolling too far away with slow move_it_* functions. Note
14299 that the user can supply scroll-conservatively equal to
14300 `most-positive-fixnum', which can be larger than INT_MAX. */
14301 if (arg_scroll_conservatively
> scroll_limit
)
14303 arg_scroll_conservatively
= scroll_limit
+ 1;
14304 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14306 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14307 /* Compute how much we should try to scroll maximally to bring
14308 point into view. */
14309 scroll_max
= (max (scroll_step
,
14310 max (arg_scroll_conservatively
, temp_scroll_step
))
14311 * FRAME_LINE_HEIGHT (f
));
14312 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14313 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14314 /* We're trying to scroll because of aggressive scrolling but no
14315 scroll_step is set. Choose an arbitrary one. */
14316 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14322 /* Decide whether to scroll down. */
14323 if (PT
> CHARPOS (startp
))
14325 int scroll_margin_y
;
14327 /* Compute the pixel ypos of the scroll margin, then move it to
14328 either that ypos or PT, whichever comes first. */
14329 start_display (&it
, w
, startp
);
14330 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14331 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14332 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14333 (MOVE_TO_POS
| MOVE_TO_Y
));
14335 if (PT
> CHARPOS (it
.current
.pos
))
14337 int y0
= line_bottom_y (&it
);
14338 /* Compute how many pixels below window bottom to stop searching
14339 for PT. This avoids costly search for PT that is far away if
14340 the user limited scrolling by a small number of lines, but
14341 always finds PT if scroll_conservatively is set to a large
14342 number, such as most-positive-fixnum. */
14343 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14344 int y_to_move
= it
.last_visible_y
+ slack
;
14346 /* Compute the distance from the scroll margin to PT or to
14347 the scroll limit, whichever comes first. This should
14348 include the height of the cursor line, to make that line
14350 move_it_to (&it
, PT
, -1, y_to_move
,
14351 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14352 dy
= line_bottom_y (&it
) - y0
;
14354 if (dy
> scroll_max
)
14355 return SCROLLING_FAILED
;
14363 /* Point is in or below the bottom scroll margin, so move the
14364 window start down. If scrolling conservatively, move it just
14365 enough down to make point visible. If scroll_step is set,
14366 move it down by scroll_step. */
14367 if (arg_scroll_conservatively
)
14369 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14370 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14371 else if (scroll_step
|| temp_scroll_step
)
14372 amount_to_scroll
= scroll_max
;
14375 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14376 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14377 if (NUMBERP (aggressive
))
14379 double float_amount
= XFLOATINT (aggressive
) * height
;
14380 amount_to_scroll
= float_amount
;
14381 if (amount_to_scroll
== 0 && float_amount
> 0)
14382 amount_to_scroll
= 1;
14383 /* Don't let point enter the scroll margin near top of
14385 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14386 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14390 if (amount_to_scroll
<= 0)
14391 return SCROLLING_FAILED
;
14393 start_display (&it
, w
, startp
);
14394 if (arg_scroll_conservatively
<= scroll_limit
)
14395 move_it_vertically (&it
, amount_to_scroll
);
14398 /* Extra precision for users who set scroll-conservatively
14399 to a large number: make sure the amount we scroll
14400 the window start is never less than amount_to_scroll,
14401 which was computed as distance from window bottom to
14402 point. This matters when lines at window top and lines
14403 below window bottom have different height. */
14405 void *it1data
= NULL
;
14406 /* We use a temporary it1 because line_bottom_y can modify
14407 its argument, if it moves one line down; see there. */
14410 SAVE_IT (it1
, it
, it1data
);
14411 start_y
= line_bottom_y (&it1
);
14413 RESTORE_IT (&it
, &it
, it1data
);
14414 move_it_by_lines (&it
, 1);
14415 SAVE_IT (it1
, it
, it1data
);
14416 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14419 /* If STARTP is unchanged, move it down another screen line. */
14420 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14421 move_it_by_lines (&it
, 1);
14422 startp
= it
.current
.pos
;
14426 struct text_pos scroll_margin_pos
= startp
;
14428 /* See if point is inside the scroll margin at the top of the
14430 if (this_scroll_margin
)
14432 start_display (&it
, w
, startp
);
14433 move_it_vertically (&it
, this_scroll_margin
);
14434 scroll_margin_pos
= it
.current
.pos
;
14437 if (PT
< CHARPOS (scroll_margin_pos
))
14439 /* Point is in the scroll margin at the top of the window or
14440 above what is displayed in the window. */
14443 /* Compute the vertical distance from PT to the scroll
14444 margin position. Move as far as scroll_max allows, or
14445 one screenful, or 10 screen lines, whichever is largest.
14446 Give up if distance is greater than scroll_max. */
14447 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14448 start_display (&it
, w
, pos
);
14450 y_to_move
= max (it
.last_visible_y
,
14451 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14452 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14454 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14455 dy
= it
.current_y
- y0
;
14456 if (dy
> scroll_max
)
14457 return SCROLLING_FAILED
;
14459 /* Compute new window start. */
14460 start_display (&it
, w
, startp
);
14462 if (arg_scroll_conservatively
)
14463 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14464 max (scroll_step
, temp_scroll_step
));
14465 else if (scroll_step
|| temp_scroll_step
)
14466 amount_to_scroll
= scroll_max
;
14469 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14470 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14471 if (NUMBERP (aggressive
))
14473 double float_amount
= XFLOATINT (aggressive
) * height
;
14474 amount_to_scroll
= float_amount
;
14475 if (amount_to_scroll
== 0 && float_amount
> 0)
14476 amount_to_scroll
= 1;
14477 amount_to_scroll
-=
14478 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14479 /* Don't let point enter the scroll margin near
14480 bottom of the window. */
14481 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14482 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14486 if (amount_to_scroll
<= 0)
14487 return SCROLLING_FAILED
;
14489 move_it_vertically_backward (&it
, amount_to_scroll
);
14490 startp
= it
.current
.pos
;
14494 /* Run window scroll functions. */
14495 startp
= run_window_scroll_functions (window
, startp
);
14497 /* Display the window. Give up if new fonts are loaded, or if point
14499 if (!try_window (window
, startp
, 0))
14500 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14501 else if (w
->cursor
.vpos
< 0)
14503 clear_glyph_matrix (w
->desired_matrix
);
14504 rc
= SCROLLING_FAILED
;
14508 /* Maybe forget recorded base line for line number display. */
14509 if (!just_this_one_p
14510 || current_buffer
->clip_changed
14511 || BEG_UNCHANGED
< CHARPOS (startp
))
14512 w
->base_line_number
= Qnil
;
14514 /* If cursor ends up on a partially visible line,
14515 treat that as being off the bottom of the screen. */
14516 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14517 /* It's possible that the cursor is on the first line of the
14518 buffer, which is partially obscured due to a vscroll
14519 (Bug#7537). In that case, avoid looping forever . */
14520 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14522 clear_glyph_matrix (w
->desired_matrix
);
14523 ++extra_scroll_margin_lines
;
14526 rc
= SCROLLING_SUCCESS
;
14533 /* Compute a suitable window start for window W if display of W starts
14534 on a continuation line. Value is non-zero if a new window start
14537 The new window start will be computed, based on W's width, starting
14538 from the start of the continued line. It is the start of the
14539 screen line with the minimum distance from the old start W->start. */
14542 compute_window_start_on_continuation_line (struct window
*w
)
14544 struct text_pos pos
, start_pos
;
14545 int window_start_changed_p
= 0;
14547 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14549 /* If window start is on a continuation line... Window start may be
14550 < BEGV in case there's invisible text at the start of the
14551 buffer (M-x rmail, for example). */
14552 if (CHARPOS (start_pos
) > BEGV
14553 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14556 struct glyph_row
*row
;
14558 /* Handle the case that the window start is out of range. */
14559 if (CHARPOS (start_pos
) < BEGV
)
14560 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14561 else if (CHARPOS (start_pos
) > ZV
)
14562 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14564 /* Find the start of the continued line. This should be fast
14565 because scan_buffer is fast (newline cache). */
14566 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14567 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14568 row
, DEFAULT_FACE_ID
);
14569 reseat_at_previous_visible_line_start (&it
);
14571 /* If the line start is "too far" away from the window start,
14572 say it takes too much time to compute a new window start. */
14573 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14574 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14576 int min_distance
, distance
;
14578 /* Move forward by display lines to find the new window
14579 start. If window width was enlarged, the new start can
14580 be expected to be > the old start. If window width was
14581 decreased, the new window start will be < the old start.
14582 So, we're looking for the display line start with the
14583 minimum distance from the old window start. */
14584 pos
= it
.current
.pos
;
14585 min_distance
= INFINITY
;
14586 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14587 distance
< min_distance
)
14589 min_distance
= distance
;
14590 pos
= it
.current
.pos
;
14591 move_it_by_lines (&it
, 1);
14594 /* Set the window start there. */
14595 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14596 window_start_changed_p
= 1;
14600 return window_start_changed_p
;
14604 /* Try cursor movement in case text has not changed in window WINDOW,
14605 with window start STARTP. Value is
14607 CURSOR_MOVEMENT_SUCCESS if successful
14609 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14611 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14612 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14613 we want to scroll as if scroll-step were set to 1. See the code.
14615 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14616 which case we have to abort this redisplay, and adjust matrices
14621 CURSOR_MOVEMENT_SUCCESS
,
14622 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14623 CURSOR_MOVEMENT_MUST_SCROLL
,
14624 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14628 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14630 struct window
*w
= XWINDOW (window
);
14631 struct frame
*f
= XFRAME (w
->frame
);
14632 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14635 if (inhibit_try_cursor_movement
)
14639 /* Handle case where text has not changed, only point, and it has
14640 not moved off the frame. */
14641 if (/* Point may be in this window. */
14642 PT
>= CHARPOS (startp
)
14643 /* Selective display hasn't changed. */
14644 && !current_buffer
->clip_changed
14645 /* Function force-mode-line-update is used to force a thorough
14646 redisplay. It sets either windows_or_buffers_changed or
14647 update_mode_lines. So don't take a shortcut here for these
14649 && !update_mode_lines
14650 && !windows_or_buffers_changed
14651 && !cursor_type_changed
14652 /* Can't use this case if highlighting a region. When a
14653 region exists, cursor movement has to do more than just
14655 && !(!NILP (Vtransient_mark_mode
)
14656 && !NILP (BVAR (current_buffer
, mark_active
)))
14657 && NILP (w
->region_showing
)
14658 && NILP (Vshow_trailing_whitespace
)
14659 /* Right after splitting windows, last_point may be nil. */
14660 && INTEGERP (w
->last_point
)
14661 /* This code is not used for mini-buffer for the sake of the case
14662 of redisplaying to replace an echo area message; since in
14663 that case the mini-buffer contents per se are usually
14664 unchanged. This code is of no real use in the mini-buffer
14665 since the handling of this_line_start_pos, etc., in redisplay
14666 handles the same cases. */
14667 && !EQ (window
, minibuf_window
)
14668 /* When splitting windows or for new windows, it happens that
14669 redisplay is called with a nil window_end_vpos or one being
14670 larger than the window. This should really be fixed in
14671 window.c. I don't have this on my list, now, so we do
14672 approximately the same as the old redisplay code. --gerd. */
14673 && INTEGERP (w
->window_end_vpos
)
14674 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14675 && (FRAME_WINDOW_P (f
)
14676 || !overlay_arrow_in_current_buffer_p ()))
14678 int this_scroll_margin
, top_scroll_margin
;
14679 struct glyph_row
*row
= NULL
;
14682 debug_method_add (w
, "cursor movement");
14685 /* Scroll if point within this distance from the top or bottom
14686 of the window. This is a pixel value. */
14687 if (scroll_margin
> 0)
14689 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14690 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14693 this_scroll_margin
= 0;
14695 top_scroll_margin
= this_scroll_margin
;
14696 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14697 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14699 /* Start with the row the cursor was displayed during the last
14700 not paused redisplay. Give up if that row is not valid. */
14701 if (w
->last_cursor
.vpos
< 0
14702 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14703 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14706 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14707 if (row
->mode_line_p
)
14709 if (!row
->enabled_p
)
14710 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14713 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14715 int scroll_p
= 0, must_scroll
= 0;
14716 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14718 if (PT
> XFASTINT (w
->last_point
))
14720 /* Point has moved forward. */
14721 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14722 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14724 xassert (row
->enabled_p
);
14728 /* If the end position of a row equals the start
14729 position of the next row, and PT is at that position,
14730 we would rather display cursor in the next line. */
14731 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14732 && MATRIX_ROW_END_CHARPOS (row
) == PT
14733 && row
< w
->current_matrix
->rows
14734 + w
->current_matrix
->nrows
- 1
14735 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14736 && !cursor_row_p (row
))
14739 /* If within the scroll margin, scroll. Note that
14740 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14741 the next line would be drawn, and that
14742 this_scroll_margin can be zero. */
14743 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14744 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14745 /* Line is completely visible last line in window
14746 and PT is to be set in the next line. */
14747 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14748 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14749 && !row
->ends_at_zv_p
14750 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14753 else if (PT
< XFASTINT (w
->last_point
))
14755 /* Cursor has to be moved backward. Note that PT >=
14756 CHARPOS (startp) because of the outer if-statement. */
14757 while (!row
->mode_line_p
14758 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14759 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14760 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14761 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14762 row
> w
->current_matrix
->rows
14763 && (row
-1)->ends_in_newline_from_string_p
))))
14764 && (row
->y
> top_scroll_margin
14765 || CHARPOS (startp
) == BEGV
))
14767 xassert (row
->enabled_p
);
14771 /* Consider the following case: Window starts at BEGV,
14772 there is invisible, intangible text at BEGV, so that
14773 display starts at some point START > BEGV. It can
14774 happen that we are called with PT somewhere between
14775 BEGV and START. Try to handle that case. */
14776 if (row
< w
->current_matrix
->rows
14777 || row
->mode_line_p
)
14779 row
= w
->current_matrix
->rows
;
14780 if (row
->mode_line_p
)
14784 /* Due to newlines in overlay strings, we may have to
14785 skip forward over overlay strings. */
14786 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14787 && MATRIX_ROW_END_CHARPOS (row
) == PT
14788 && !cursor_row_p (row
))
14791 /* If within the scroll margin, scroll. */
14792 if (row
->y
< top_scroll_margin
14793 && CHARPOS (startp
) != BEGV
)
14798 /* Cursor did not move. So don't scroll even if cursor line
14799 is partially visible, as it was so before. */
14800 rc
= CURSOR_MOVEMENT_SUCCESS
;
14803 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14804 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14806 /* if PT is not in the glyph row, give up. */
14807 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14810 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14811 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14813 /* If rows are bidi-reordered and point moved, back up
14814 until we find a row that does not belong to a
14815 continuation line. This is because we must consider
14816 all rows of a continued line as candidates for the
14817 new cursor positioning, since row start and end
14818 positions change non-linearly with vertical position
14820 /* FIXME: Revisit this when glyph ``spilling'' in
14821 continuation lines' rows is implemented for
14822 bidi-reordered rows. */
14823 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14825 xassert (row
->enabled_p
);
14827 /* If we hit the beginning of the displayed portion
14828 without finding the first row of a continued
14830 if (row
<= w
->current_matrix
->rows
)
14832 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14840 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14841 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14842 && make_cursor_line_fully_visible_p
)
14844 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14845 && !row
->ends_at_zv_p
14846 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14847 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14848 else if (row
->height
> window_box_height (w
))
14850 /* If we end up in a partially visible line, let's
14851 make it fully visible, except when it's taller
14852 than the window, in which case we can't do much
14855 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14859 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14860 if (!cursor_row_fully_visible_p (w
, 0, 1))
14861 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14863 rc
= CURSOR_MOVEMENT_SUCCESS
;
14867 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14868 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14869 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14871 /* With bidi-reordered rows, there could be more than
14872 one candidate row whose start and end positions
14873 occlude point. We need to let set_cursor_from_row
14874 find the best candidate. */
14875 /* FIXME: Revisit this when glyph ``spilling'' in
14876 continuation lines' rows is implemented for
14877 bidi-reordered rows. */
14882 int at_zv_p
= 0, exact_match_p
= 0;
14884 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14885 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14886 && cursor_row_p (row
))
14887 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14889 /* As soon as we've found the exact match for point,
14890 or the first suitable row whose ends_at_zv_p flag
14891 is set, we are done. */
14893 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14895 && w
->cursor
.hpos
>= 0
14896 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14899 struct glyph_row
*candidate
=
14900 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14902 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14903 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14906 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14907 || (INTEGERP (g
->object
)
14908 && (g
->charpos
== PT
14909 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14911 if (rv
&& (at_zv_p
|| exact_match_p
))
14913 rc
= CURSOR_MOVEMENT_SUCCESS
;
14916 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14920 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14921 || row
->continued_p
)
14922 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14923 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14924 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14925 /* If we didn't find any candidate rows, or exited the
14926 loop before all the candidates were examined, signal
14927 to the caller that this method failed. */
14928 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14930 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14931 && !row
->continued_p
))
14932 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14934 rc
= CURSOR_MOVEMENT_SUCCESS
;
14940 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14942 rc
= CURSOR_MOVEMENT_SUCCESS
;
14947 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14948 && MATRIX_ROW_START_CHARPOS (row
) == PT
14949 && cursor_row_p (row
));
14957 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14961 set_vertical_scroll_bar (struct window
*w
)
14963 EMACS_INT start
, end
, whole
;
14965 /* Calculate the start and end positions for the current window.
14966 At some point, it would be nice to choose between scrollbars
14967 which reflect the whole buffer size, with special markers
14968 indicating narrowing, and scrollbars which reflect only the
14971 Note that mini-buffers sometimes aren't displaying any text. */
14972 if (!MINI_WINDOW_P (w
)
14973 || (w
== XWINDOW (minibuf_window
)
14974 && NILP (echo_area_buffer
[0])))
14976 struct buffer
*buf
= XBUFFER (w
->buffer
);
14977 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14978 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14979 /* I don't think this is guaranteed to be right. For the
14980 moment, we'll pretend it is. */
14981 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14985 if (whole
< (end
- start
))
14986 whole
= end
- start
;
14989 start
= end
= whole
= 0;
14991 /* Indicate what this scroll bar ought to be displaying now. */
14992 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14993 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14994 (w
, end
- start
, whole
, start
);
14998 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14999 selected_window is redisplayed.
15001 We can return without actually redisplaying the window if
15002 fonts_changed_p is nonzero. In that case, redisplay_internal will
15006 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15008 struct window
*w
= XWINDOW (window
);
15009 struct frame
*f
= XFRAME (w
->frame
);
15010 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15011 struct buffer
*old
= current_buffer
;
15012 struct text_pos lpoint
, opoint
, startp
;
15013 int update_mode_line
;
15016 /* Record it now because it's overwritten. */
15017 int current_matrix_up_to_date_p
= 0;
15018 int used_current_matrix_p
= 0;
15019 /* This is less strict than current_matrix_up_to_date_p.
15020 It indictes that the buffer contents and narrowing are unchanged. */
15021 int buffer_unchanged_p
= 0;
15022 int temp_scroll_step
= 0;
15023 int count
= SPECPDL_INDEX ();
15025 int centering_position
= -1;
15026 int last_line_misfit
= 0;
15027 EMACS_INT beg_unchanged
, end_unchanged
;
15029 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15032 /* W must be a leaf window here. */
15033 xassert (!NILP (w
->buffer
));
15035 *w
->desired_matrix
->method
= 0;
15039 reconsider_clip_changes (w
, buffer
);
15041 /* Has the mode line to be updated? */
15042 update_mode_line
= (!NILP (w
->update_mode_line
)
15043 || update_mode_lines
15044 || buffer
->clip_changed
15045 || buffer
->prevent_redisplay_optimizations_p
);
15047 if (MINI_WINDOW_P (w
))
15049 if (w
== XWINDOW (echo_area_window
)
15050 && !NILP (echo_area_buffer
[0]))
15052 if (update_mode_line
)
15053 /* We may have to update a tty frame's menu bar or a
15054 tool-bar. Example `M-x C-h C-h C-g'. */
15055 goto finish_menu_bars
;
15057 /* We've already displayed the echo area glyphs in this window. */
15058 goto finish_scroll_bars
;
15060 else if ((w
!= XWINDOW (minibuf_window
)
15061 || minibuf_level
== 0)
15062 /* When buffer is nonempty, redisplay window normally. */
15063 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15064 /* Quail displays non-mini buffers in minibuffer window.
15065 In that case, redisplay the window normally. */
15066 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15068 /* W is a mini-buffer window, but it's not active, so clear
15070 int yb
= window_text_bottom_y (w
);
15071 struct glyph_row
*row
;
15074 for (y
= 0, row
= w
->desired_matrix
->rows
;
15076 y
+= row
->height
, ++row
)
15077 blank_row (w
, row
, y
);
15078 goto finish_scroll_bars
;
15081 clear_glyph_matrix (w
->desired_matrix
);
15084 /* Otherwise set up data on this window; select its buffer and point
15086 /* Really select the buffer, for the sake of buffer-local
15088 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15090 current_matrix_up_to_date_p
15091 = (!NILP (w
->window_end_valid
)
15092 && !current_buffer
->clip_changed
15093 && !current_buffer
->prevent_redisplay_optimizations_p
15094 && XFASTINT (w
->last_modified
) >= MODIFF
15095 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15097 /* Run the window-bottom-change-functions
15098 if it is possible that the text on the screen has changed
15099 (either due to modification of the text, or any other reason). */
15100 if (!current_matrix_up_to_date_p
15101 && !NILP (Vwindow_text_change_functions
))
15103 safe_run_hooks (Qwindow_text_change_functions
);
15107 beg_unchanged
= BEG_UNCHANGED
;
15108 end_unchanged
= END_UNCHANGED
;
15110 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15112 specbind (Qinhibit_point_motion_hooks
, Qt
);
15115 = (!NILP (w
->window_end_valid
)
15116 && !current_buffer
->clip_changed
15117 && XFASTINT (w
->last_modified
) >= MODIFF
15118 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15120 /* When windows_or_buffers_changed is non-zero, we can't rely on
15121 the window end being valid, so set it to nil there. */
15122 if (windows_or_buffers_changed
)
15124 /* If window starts on a continuation line, maybe adjust the
15125 window start in case the window's width changed. */
15126 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15127 compute_window_start_on_continuation_line (w
);
15129 w
->window_end_valid
= Qnil
;
15132 /* Some sanity checks. */
15133 CHECK_WINDOW_END (w
);
15134 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15136 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15139 /* If %c is in mode line, update it if needed. */
15140 if (!NILP (w
->column_number_displayed
)
15141 /* This alternative quickly identifies a common case
15142 where no change is needed. */
15143 && !(PT
== XFASTINT (w
->last_point
)
15144 && XFASTINT (w
->last_modified
) >= MODIFF
15145 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15146 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15147 update_mode_line
= 1;
15149 /* Count number of windows showing the selected buffer. An indirect
15150 buffer counts as its base buffer. */
15151 if (!just_this_one_p
)
15153 struct buffer
*current_base
, *window_base
;
15154 current_base
= current_buffer
;
15155 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15156 if (current_base
->base_buffer
)
15157 current_base
= current_base
->base_buffer
;
15158 if (window_base
->base_buffer
)
15159 window_base
= window_base
->base_buffer
;
15160 if (current_base
== window_base
)
15164 /* Point refers normally to the selected window. For any other
15165 window, set up appropriate value. */
15166 if (!EQ (window
, selected_window
))
15168 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15169 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15173 new_pt_byte
= BEGV_BYTE
;
15174 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15176 else if (new_pt
> (ZV
- 1))
15179 new_pt_byte
= ZV_BYTE
;
15180 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15183 /* We don't use SET_PT so that the point-motion hooks don't run. */
15184 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15187 /* If any of the character widths specified in the display table
15188 have changed, invalidate the width run cache. It's true that
15189 this may be a bit late to catch such changes, but the rest of
15190 redisplay goes (non-fatally) haywire when the display table is
15191 changed, so why should we worry about doing any better? */
15192 if (current_buffer
->width_run_cache
)
15194 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15196 if (! disptab_matches_widthtab (disptab
,
15197 XVECTOR (BVAR (current_buffer
, width_table
))))
15199 invalidate_region_cache (current_buffer
,
15200 current_buffer
->width_run_cache
,
15202 recompute_width_table (current_buffer
, disptab
);
15206 /* If window-start is screwed up, choose a new one. */
15207 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15210 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15212 /* If someone specified a new starting point but did not insist,
15213 check whether it can be used. */
15214 if (!NILP (w
->optional_new_start
)
15215 && CHARPOS (startp
) >= BEGV
15216 && CHARPOS (startp
) <= ZV
)
15218 w
->optional_new_start
= Qnil
;
15219 start_display (&it
, w
, startp
);
15220 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15221 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15222 if (IT_CHARPOS (it
) == PT
)
15223 w
->force_start
= Qt
;
15224 /* IT may overshoot PT if text at PT is invisible. */
15225 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15226 w
->force_start
= Qt
;
15231 /* Handle case where place to start displaying has been specified,
15232 unless the specified location is outside the accessible range. */
15233 if (!NILP (w
->force_start
)
15234 || w
->frozen_window_start_p
)
15236 /* We set this later on if we have to adjust point. */
15239 w
->force_start
= Qnil
;
15241 w
->window_end_valid
= Qnil
;
15243 /* Forget any recorded base line for line number display. */
15244 if (!buffer_unchanged_p
)
15245 w
->base_line_number
= Qnil
;
15247 /* Redisplay the mode line. Select the buffer properly for that.
15248 Also, run the hook window-scroll-functions
15249 because we have scrolled. */
15250 /* Note, we do this after clearing force_start because
15251 if there's an error, it is better to forget about force_start
15252 than to get into an infinite loop calling the hook functions
15253 and having them get more errors. */
15254 if (!update_mode_line
15255 || ! NILP (Vwindow_scroll_functions
))
15257 update_mode_line
= 1;
15258 w
->update_mode_line
= Qt
;
15259 startp
= run_window_scroll_functions (window
, startp
);
15262 w
->last_modified
= make_number (0);
15263 w
->last_overlay_modified
= make_number (0);
15264 if (CHARPOS (startp
) < BEGV
)
15265 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15266 else if (CHARPOS (startp
) > ZV
)
15267 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15269 /* Redisplay, then check if cursor has been set during the
15270 redisplay. Give up if new fonts were loaded. */
15271 /* We used to issue a CHECK_MARGINS argument to try_window here,
15272 but this causes scrolling to fail when point begins inside
15273 the scroll margin (bug#148) -- cyd */
15274 if (!try_window (window
, startp
, 0))
15276 w
->force_start
= Qt
;
15277 clear_glyph_matrix (w
->desired_matrix
);
15278 goto need_larger_matrices
;
15281 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15283 /* If point does not appear, try to move point so it does
15284 appear. The desired matrix has been built above, so we
15285 can use it here. */
15286 new_vpos
= window_box_height (w
) / 2;
15289 if (!cursor_row_fully_visible_p (w
, 0, 0))
15291 /* Point does appear, but on a line partly visible at end of window.
15292 Move it back to a fully-visible line. */
15293 new_vpos
= window_box_height (w
);
15296 /* If we need to move point for either of the above reasons,
15297 now actually do it. */
15300 struct glyph_row
*row
;
15302 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15303 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15306 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15307 MATRIX_ROW_START_BYTEPOS (row
));
15309 if (w
!= XWINDOW (selected_window
))
15310 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15311 else if (current_buffer
== old
)
15312 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15314 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15316 /* If we are highlighting the region, then we just changed
15317 the region, so redisplay to show it. */
15318 if (!NILP (Vtransient_mark_mode
)
15319 && !NILP (BVAR (current_buffer
, mark_active
)))
15321 clear_glyph_matrix (w
->desired_matrix
);
15322 if (!try_window (window
, startp
, 0))
15323 goto need_larger_matrices
;
15328 debug_method_add (w
, "forced window start");
15333 /* Handle case where text has not changed, only point, and it has
15334 not moved off the frame, and we are not retrying after hscroll.
15335 (current_matrix_up_to_date_p is nonzero when retrying.) */
15336 if (current_matrix_up_to_date_p
15337 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15338 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15342 case CURSOR_MOVEMENT_SUCCESS
:
15343 used_current_matrix_p
= 1;
15346 case CURSOR_MOVEMENT_MUST_SCROLL
:
15347 goto try_to_scroll
;
15353 /* If current starting point was originally the beginning of a line
15354 but no longer is, find a new starting point. */
15355 else if (!NILP (w
->start_at_line_beg
)
15356 && !(CHARPOS (startp
) <= BEGV
15357 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15360 debug_method_add (w
, "recenter 1");
15365 /* Try scrolling with try_window_id. Value is > 0 if update has
15366 been done, it is -1 if we know that the same window start will
15367 not work. It is 0 if unsuccessful for some other reason. */
15368 else if ((tem
= try_window_id (w
)) != 0)
15371 debug_method_add (w
, "try_window_id %d", tem
);
15374 if (fonts_changed_p
)
15375 goto need_larger_matrices
;
15379 /* Otherwise try_window_id has returned -1 which means that we
15380 don't want the alternative below this comment to execute. */
15382 else if (CHARPOS (startp
) >= BEGV
15383 && CHARPOS (startp
) <= ZV
15384 && PT
>= CHARPOS (startp
)
15385 && (CHARPOS (startp
) < ZV
15386 /* Avoid starting at end of buffer. */
15387 || CHARPOS (startp
) == BEGV
15388 || (XFASTINT (w
->last_modified
) >= MODIFF
15389 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15391 int d1
, d2
, d3
, d4
, d5
, d6
;
15393 /* If first window line is a continuation line, and window start
15394 is inside the modified region, but the first change is before
15395 current window start, we must select a new window start.
15397 However, if this is the result of a down-mouse event (e.g. by
15398 extending the mouse-drag-overlay), we don't want to select a
15399 new window start, since that would change the position under
15400 the mouse, resulting in an unwanted mouse-movement rather
15401 than a simple mouse-click. */
15402 if (NILP (w
->start_at_line_beg
)
15403 && NILP (do_mouse_tracking
)
15404 && CHARPOS (startp
) > BEGV
15405 && CHARPOS (startp
) > BEG
+ beg_unchanged
15406 && CHARPOS (startp
) <= Z
- end_unchanged
15407 /* Even if w->start_at_line_beg is nil, a new window may
15408 start at a line_beg, since that's how set_buffer_window
15409 sets it. So, we need to check the return value of
15410 compute_window_start_on_continuation_line. (See also
15412 && XMARKER (w
->start
)->buffer
== current_buffer
15413 && compute_window_start_on_continuation_line (w
)
15414 /* It doesn't make sense to force the window start like we
15415 do at label force_start if it is already known that point
15416 will not be visible in the resulting window, because
15417 doing so will move point from its correct position
15418 instead of scrolling the window to bring point into view.
15420 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15422 w
->force_start
= Qt
;
15423 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15428 debug_method_add (w
, "same window start");
15431 /* Try to redisplay starting at same place as before.
15432 If point has not moved off frame, accept the results. */
15433 if (!current_matrix_up_to_date_p
15434 /* Don't use try_window_reusing_current_matrix in this case
15435 because a window scroll function can have changed the
15437 || !NILP (Vwindow_scroll_functions
)
15438 || MINI_WINDOW_P (w
)
15439 || !(used_current_matrix_p
15440 = try_window_reusing_current_matrix (w
)))
15442 IF_DEBUG (debug_method_add (w
, "1"));
15443 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15444 /* -1 means we need to scroll.
15445 0 means we need new matrices, but fonts_changed_p
15446 is set in that case, so we will detect it below. */
15447 goto try_to_scroll
;
15450 if (fonts_changed_p
)
15451 goto need_larger_matrices
;
15453 if (w
->cursor
.vpos
>= 0)
15455 if (!just_this_one_p
15456 || current_buffer
->clip_changed
15457 || BEG_UNCHANGED
< CHARPOS (startp
))
15458 /* Forget any recorded base line for line number display. */
15459 w
->base_line_number
= Qnil
;
15461 if (!cursor_row_fully_visible_p (w
, 1, 0))
15463 clear_glyph_matrix (w
->desired_matrix
);
15464 last_line_misfit
= 1;
15466 /* Drop through and scroll. */
15471 clear_glyph_matrix (w
->desired_matrix
);
15476 w
->last_modified
= make_number (0);
15477 w
->last_overlay_modified
= make_number (0);
15479 /* Redisplay the mode line. Select the buffer properly for that. */
15480 if (!update_mode_line
)
15482 update_mode_line
= 1;
15483 w
->update_mode_line
= Qt
;
15486 /* Try to scroll by specified few lines. */
15487 if ((scroll_conservatively
15488 || emacs_scroll_step
15489 || temp_scroll_step
15490 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15491 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15492 && CHARPOS (startp
) >= BEGV
15493 && CHARPOS (startp
) <= ZV
)
15495 /* The function returns -1 if new fonts were loaded, 1 if
15496 successful, 0 if not successful. */
15497 int ss
= try_scrolling (window
, just_this_one_p
,
15498 scroll_conservatively
,
15500 temp_scroll_step
, last_line_misfit
);
15503 case SCROLLING_SUCCESS
:
15506 case SCROLLING_NEED_LARGER_MATRICES
:
15507 goto need_larger_matrices
;
15509 case SCROLLING_FAILED
:
15517 /* Finally, just choose a place to start which positions point
15518 according to user preferences. */
15523 debug_method_add (w
, "recenter");
15526 /* w->vscroll = 0; */
15528 /* Forget any previously recorded base line for line number display. */
15529 if (!buffer_unchanged_p
)
15530 w
->base_line_number
= Qnil
;
15532 /* Determine the window start relative to point. */
15533 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15534 it
.current_y
= it
.last_visible_y
;
15535 if (centering_position
< 0)
15539 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15541 EMACS_INT margin_pos
= CHARPOS (startp
);
15543 Lisp_Object aggressive
;
15545 /* If there is a scroll margin at the top of the window, find
15546 its character position. */
15548 /* Cannot call start_display if startp is not in the
15549 accessible region of the buffer. This can happen when we
15550 have just switched to a different buffer and/or changed
15551 its restriction. In that case, startp is initialized to
15552 the character position 1 (BEG) because we did not yet
15553 have chance to display the buffer even once. */
15554 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15557 void *it1data
= NULL
;
15559 SAVE_IT (it1
, it
, it1data
);
15560 start_display (&it1
, w
, startp
);
15561 move_it_vertically (&it1
, margin
);
15562 margin_pos
= IT_CHARPOS (it1
);
15563 RESTORE_IT (&it
, &it
, it1data
);
15565 scrolling_up
= PT
> margin_pos
;
15568 ? BVAR (current_buffer
, scroll_up_aggressively
)
15569 : BVAR (current_buffer
, scroll_down_aggressively
);
15571 if (!MINI_WINDOW_P (w
)
15572 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15576 /* Setting scroll-conservatively overrides
15577 scroll-*-aggressively. */
15578 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15580 double float_amount
= XFLOATINT (aggressive
);
15582 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15583 if (pt_offset
== 0 && float_amount
> 0)
15588 /* Compute how much to move the window start backward from
15589 point so that point will be displayed where the user
15593 centering_position
= it
.last_visible_y
;
15595 centering_position
-= pt_offset
;
15596 centering_position
-=
15597 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15598 + WINDOW_HEADER_LINE_HEIGHT (w
);
15599 /* Don't let point enter the scroll margin near top of
15601 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15602 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15605 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15608 /* Set the window start half the height of the window backward
15610 centering_position
= window_box_height (w
) / 2;
15612 move_it_vertically_backward (&it
, centering_position
);
15614 xassert (IT_CHARPOS (it
) >= BEGV
);
15616 /* The function move_it_vertically_backward may move over more
15617 than the specified y-distance. If it->w is small, e.g. a
15618 mini-buffer window, we may end up in front of the window's
15619 display area. Start displaying at the start of the line
15620 containing PT in this case. */
15621 if (it
.current_y
<= 0)
15623 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15624 move_it_vertically_backward (&it
, 0);
15628 it
.current_x
= it
.hpos
= 0;
15630 /* Set the window start position here explicitly, to avoid an
15631 infinite loop in case the functions in window-scroll-functions
15633 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15635 /* Run scroll hooks. */
15636 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15638 /* Redisplay the window. */
15639 if (!current_matrix_up_to_date_p
15640 || windows_or_buffers_changed
15641 || cursor_type_changed
15642 /* Don't use try_window_reusing_current_matrix in this case
15643 because it can have changed the buffer. */
15644 || !NILP (Vwindow_scroll_functions
)
15645 || !just_this_one_p
15646 || MINI_WINDOW_P (w
)
15647 || !(used_current_matrix_p
15648 = try_window_reusing_current_matrix (w
)))
15649 try_window (window
, startp
, 0);
15651 /* If new fonts have been loaded (due to fontsets), give up. We
15652 have to start a new redisplay since we need to re-adjust glyph
15654 if (fonts_changed_p
)
15655 goto need_larger_matrices
;
15657 /* If cursor did not appear assume that the middle of the window is
15658 in the first line of the window. Do it again with the next line.
15659 (Imagine a window of height 100, displaying two lines of height
15660 60. Moving back 50 from it->last_visible_y will end in the first
15662 if (w
->cursor
.vpos
< 0)
15664 if (!NILP (w
->window_end_valid
)
15665 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15667 clear_glyph_matrix (w
->desired_matrix
);
15668 move_it_by_lines (&it
, 1);
15669 try_window (window
, it
.current
.pos
, 0);
15671 else if (PT
< IT_CHARPOS (it
))
15673 clear_glyph_matrix (w
->desired_matrix
);
15674 move_it_by_lines (&it
, -1);
15675 try_window (window
, it
.current
.pos
, 0);
15679 /* Not much we can do about it. */
15683 /* Consider the following case: Window starts at BEGV, there is
15684 invisible, intangible text at BEGV, so that display starts at
15685 some point START > BEGV. It can happen that we are called with
15686 PT somewhere between BEGV and START. Try to handle that case. */
15687 if (w
->cursor
.vpos
< 0)
15689 struct glyph_row
*row
= w
->current_matrix
->rows
;
15690 if (row
->mode_line_p
)
15692 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15695 if (!cursor_row_fully_visible_p (w
, 0, 0))
15697 /* If vscroll is enabled, disable it and try again. */
15701 clear_glyph_matrix (w
->desired_matrix
);
15705 /* If centering point failed to make the whole line visible,
15706 put point at the top instead. That has to make the whole line
15707 visible, if it can be done. */
15708 if (centering_position
== 0)
15711 clear_glyph_matrix (w
->desired_matrix
);
15712 centering_position
= 0;
15718 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15719 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15720 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15723 /* Display the mode line, if we must. */
15724 if ((update_mode_line
15725 /* If window not full width, must redo its mode line
15726 if (a) the window to its side is being redone and
15727 (b) we do a frame-based redisplay. This is a consequence
15728 of how inverted lines are drawn in frame-based redisplay. */
15729 || (!just_this_one_p
15730 && !FRAME_WINDOW_P (f
)
15731 && !WINDOW_FULL_WIDTH_P (w
))
15732 /* Line number to display. */
15733 || INTEGERP (w
->base_line_pos
)
15734 /* Column number is displayed and different from the one displayed. */
15735 || (!NILP (w
->column_number_displayed
)
15736 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15737 /* This means that the window has a mode line. */
15738 && (WINDOW_WANTS_MODELINE_P (w
)
15739 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15741 display_mode_lines (w
);
15743 /* If mode line height has changed, arrange for a thorough
15744 immediate redisplay using the correct mode line height. */
15745 if (WINDOW_WANTS_MODELINE_P (w
)
15746 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15748 fonts_changed_p
= 1;
15749 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15750 = DESIRED_MODE_LINE_HEIGHT (w
);
15753 /* If header line height has changed, arrange for a thorough
15754 immediate redisplay using the correct header line height. */
15755 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15756 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15758 fonts_changed_p
= 1;
15759 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15760 = DESIRED_HEADER_LINE_HEIGHT (w
);
15763 if (fonts_changed_p
)
15764 goto need_larger_matrices
;
15767 if (!line_number_displayed
15768 && !BUFFERP (w
->base_line_pos
))
15770 w
->base_line_pos
= Qnil
;
15771 w
->base_line_number
= Qnil
;
15776 /* When we reach a frame's selected window, redo the frame's menu bar. */
15777 if (update_mode_line
15778 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15780 int redisplay_menu_p
= 0;
15782 if (FRAME_WINDOW_P (f
))
15784 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15785 || defined (HAVE_NS) || defined (USE_GTK)
15786 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15788 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15792 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15794 if (redisplay_menu_p
)
15795 display_menu_bar (w
);
15797 #ifdef HAVE_WINDOW_SYSTEM
15798 if (FRAME_WINDOW_P (f
))
15800 #if defined (USE_GTK) || defined (HAVE_NS)
15801 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15802 redisplay_tool_bar (f
);
15804 if (WINDOWP (f
->tool_bar_window
)
15805 && (FRAME_TOOL_BAR_LINES (f
) > 0
15806 || !NILP (Vauto_resize_tool_bars
))
15807 && redisplay_tool_bar (f
))
15808 ignore_mouse_drag_p
= 1;
15814 #ifdef HAVE_WINDOW_SYSTEM
15815 if (FRAME_WINDOW_P (f
)
15816 && update_window_fringes (w
, (just_this_one_p
15817 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15818 || w
->pseudo_window_p
)))
15822 if (draw_window_fringes (w
, 1))
15823 x_draw_vertical_border (w
);
15827 #endif /* HAVE_WINDOW_SYSTEM */
15829 /* We go to this label, with fonts_changed_p nonzero,
15830 if it is necessary to try again using larger glyph matrices.
15831 We have to redeem the scroll bar even in this case,
15832 because the loop in redisplay_internal expects that. */
15833 need_larger_matrices
:
15835 finish_scroll_bars
:
15837 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15839 /* Set the thumb's position and size. */
15840 set_vertical_scroll_bar (w
);
15842 /* Note that we actually used the scroll bar attached to this
15843 window, so it shouldn't be deleted at the end of redisplay. */
15844 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15845 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15848 /* Restore current_buffer and value of point in it. The window
15849 update may have changed the buffer, so first make sure `opoint'
15850 is still valid (Bug#6177). */
15851 if (CHARPOS (opoint
) < BEGV
)
15852 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15853 else if (CHARPOS (opoint
) > ZV
)
15854 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15856 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15858 set_buffer_internal_1 (old
);
15859 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15860 shorter. This can be caused by log truncation in *Messages*. */
15861 if (CHARPOS (lpoint
) <= ZV
)
15862 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15864 unbind_to (count
, Qnil
);
15868 /* Build the complete desired matrix of WINDOW with a window start
15869 buffer position POS.
15871 Value is 1 if successful. It is zero if fonts were loaded during
15872 redisplay which makes re-adjusting glyph matrices necessary, and -1
15873 if point would appear in the scroll margins.
15874 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15875 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15879 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15881 struct window
*w
= XWINDOW (window
);
15883 struct glyph_row
*last_text_row
= NULL
;
15884 struct frame
*f
= XFRAME (w
->frame
);
15886 /* Make POS the new window start. */
15887 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15889 /* Mark cursor position as unknown. No overlay arrow seen. */
15890 w
->cursor
.vpos
= -1;
15891 overlay_arrow_seen
= 0;
15893 /* Initialize iterator and info to start at POS. */
15894 start_display (&it
, w
, pos
);
15896 /* Display all lines of W. */
15897 while (it
.current_y
< it
.last_visible_y
)
15899 if (display_line (&it
))
15900 last_text_row
= it
.glyph_row
- 1;
15901 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15905 /* Don't let the cursor end in the scroll margins. */
15906 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15907 && !MINI_WINDOW_P (w
))
15909 int this_scroll_margin
;
15911 if (scroll_margin
> 0)
15913 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15914 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15917 this_scroll_margin
= 0;
15919 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15920 && w
->cursor
.y
< this_scroll_margin
15921 && CHARPOS (pos
) > BEGV
15922 && IT_CHARPOS (it
) < ZV
)
15923 /* rms: considering make_cursor_line_fully_visible_p here
15924 seems to give wrong results. We don't want to recenter
15925 when the last line is partly visible, we want to allow
15926 that case to be handled in the usual way. */
15927 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15929 w
->cursor
.vpos
= -1;
15930 clear_glyph_matrix (w
->desired_matrix
);
15935 /* If bottom moved off end of frame, change mode line percentage. */
15936 if (XFASTINT (w
->window_end_pos
) <= 0
15937 && Z
!= IT_CHARPOS (it
))
15938 w
->update_mode_line
= Qt
;
15940 /* Set window_end_pos to the offset of the last character displayed
15941 on the window from the end of current_buffer. Set
15942 window_end_vpos to its row number. */
15945 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15946 w
->window_end_bytepos
15947 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15949 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15951 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15952 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15953 ->displays_text_p
);
15957 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15958 w
->window_end_pos
= make_number (Z
- ZV
);
15959 w
->window_end_vpos
= make_number (0);
15962 /* But that is not valid info until redisplay finishes. */
15963 w
->window_end_valid
= Qnil
;
15969 /************************************************************************
15970 Window redisplay reusing current matrix when buffer has not changed
15971 ************************************************************************/
15973 /* Try redisplay of window W showing an unchanged buffer with a
15974 different window start than the last time it was displayed by
15975 reusing its current matrix. Value is non-zero if successful.
15976 W->start is the new window start. */
15979 try_window_reusing_current_matrix (struct window
*w
)
15981 struct frame
*f
= XFRAME (w
->frame
);
15982 struct glyph_row
*bottom_row
;
15985 struct text_pos start
, new_start
;
15986 int nrows_scrolled
, i
;
15987 struct glyph_row
*last_text_row
;
15988 struct glyph_row
*last_reused_text_row
;
15989 struct glyph_row
*start_row
;
15990 int start_vpos
, min_y
, max_y
;
15993 if (inhibit_try_window_reusing
)
15997 if (/* This function doesn't handle terminal frames. */
15998 !FRAME_WINDOW_P (f
)
15999 /* Don't try to reuse the display if windows have been split
16001 || windows_or_buffers_changed
16002 || cursor_type_changed
)
16005 /* Can't do this if region may have changed. */
16006 if ((!NILP (Vtransient_mark_mode
)
16007 && !NILP (BVAR (current_buffer
, mark_active
)))
16008 || !NILP (w
->region_showing
)
16009 || !NILP (Vshow_trailing_whitespace
))
16012 /* If top-line visibility has changed, give up. */
16013 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16014 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16017 /* Give up if old or new display is scrolled vertically. We could
16018 make this function handle this, but right now it doesn't. */
16019 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16020 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16023 /* The variable new_start now holds the new window start. The old
16024 start `start' can be determined from the current matrix. */
16025 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16026 start
= start_row
->minpos
;
16027 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16029 /* Clear the desired matrix for the display below. */
16030 clear_glyph_matrix (w
->desired_matrix
);
16032 if (CHARPOS (new_start
) <= CHARPOS (start
))
16034 /* Don't use this method if the display starts with an ellipsis
16035 displayed for invisible text. It's not easy to handle that case
16036 below, and it's certainly not worth the effort since this is
16037 not a frequent case. */
16038 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16041 IF_DEBUG (debug_method_add (w
, "twu1"));
16043 /* Display up to a row that can be reused. The variable
16044 last_text_row is set to the last row displayed that displays
16045 text. Note that it.vpos == 0 if or if not there is a
16046 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16047 start_display (&it
, w
, new_start
);
16048 w
->cursor
.vpos
= -1;
16049 last_text_row
= last_reused_text_row
= NULL
;
16051 while (it
.current_y
< it
.last_visible_y
16052 && !fonts_changed_p
)
16054 /* If we have reached into the characters in the START row,
16055 that means the line boundaries have changed. So we
16056 can't start copying with the row START. Maybe it will
16057 work to start copying with the following row. */
16058 while (IT_CHARPOS (it
) > CHARPOS (start
))
16060 /* Advance to the next row as the "start". */
16062 start
= start_row
->minpos
;
16063 /* If there are no more rows to try, or just one, give up. */
16064 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16065 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16066 || CHARPOS (start
) == ZV
)
16068 clear_glyph_matrix (w
->desired_matrix
);
16072 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16074 /* If we have reached alignment,
16075 we can copy the rest of the rows. */
16076 if (IT_CHARPOS (it
) == CHARPOS (start
))
16079 if (display_line (&it
))
16080 last_text_row
= it
.glyph_row
- 1;
16083 /* A value of current_y < last_visible_y means that we stopped
16084 at the previous window start, which in turn means that we
16085 have at least one reusable row. */
16086 if (it
.current_y
< it
.last_visible_y
)
16088 struct glyph_row
*row
;
16090 /* IT.vpos always starts from 0; it counts text lines. */
16091 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16093 /* Find PT if not already found in the lines displayed. */
16094 if (w
->cursor
.vpos
< 0)
16096 int dy
= it
.current_y
- start_row
->y
;
16098 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16099 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16101 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16102 dy
, nrows_scrolled
);
16105 clear_glyph_matrix (w
->desired_matrix
);
16110 /* Scroll the display. Do it before the current matrix is
16111 changed. The problem here is that update has not yet
16112 run, i.e. part of the current matrix is not up to date.
16113 scroll_run_hook will clear the cursor, and use the
16114 current matrix to get the height of the row the cursor is
16116 run
.current_y
= start_row
->y
;
16117 run
.desired_y
= it
.current_y
;
16118 run
.height
= it
.last_visible_y
- it
.current_y
;
16120 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16123 FRAME_RIF (f
)->update_window_begin_hook (w
);
16124 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16125 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16126 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16130 /* Shift current matrix down by nrows_scrolled lines. */
16131 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16132 rotate_matrix (w
->current_matrix
,
16134 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16137 /* Disable lines that must be updated. */
16138 for (i
= 0; i
< nrows_scrolled
; ++i
)
16139 (start_row
+ i
)->enabled_p
= 0;
16141 /* Re-compute Y positions. */
16142 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16143 max_y
= it
.last_visible_y
;
16144 for (row
= start_row
+ nrows_scrolled
;
16148 row
->y
= it
.current_y
;
16149 row
->visible_height
= row
->height
;
16151 if (row
->y
< min_y
)
16152 row
->visible_height
-= min_y
- row
->y
;
16153 if (row
->y
+ row
->height
> max_y
)
16154 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16155 if (row
->fringe_bitmap_periodic_p
)
16156 row
->redraw_fringe_bitmaps_p
= 1;
16158 it
.current_y
+= row
->height
;
16160 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16161 last_reused_text_row
= row
;
16162 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16166 /* Disable lines in the current matrix which are now
16167 below the window. */
16168 for (++row
; row
< bottom_row
; ++row
)
16169 row
->enabled_p
= row
->mode_line_p
= 0;
16172 /* Update window_end_pos etc.; last_reused_text_row is the last
16173 reused row from the current matrix containing text, if any.
16174 The value of last_text_row is the last displayed line
16175 containing text. */
16176 if (last_reused_text_row
)
16178 w
->window_end_bytepos
16179 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16181 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16183 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16184 w
->current_matrix
));
16186 else if (last_text_row
)
16188 w
->window_end_bytepos
16189 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16191 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16193 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16197 /* This window must be completely empty. */
16198 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16199 w
->window_end_pos
= make_number (Z
- ZV
);
16200 w
->window_end_vpos
= make_number (0);
16202 w
->window_end_valid
= Qnil
;
16204 /* Update hint: don't try scrolling again in update_window. */
16205 w
->desired_matrix
->no_scrolling_p
= 1;
16208 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16212 else if (CHARPOS (new_start
) > CHARPOS (start
))
16214 struct glyph_row
*pt_row
, *row
;
16215 struct glyph_row
*first_reusable_row
;
16216 struct glyph_row
*first_row_to_display
;
16218 int yb
= window_text_bottom_y (w
);
16220 /* Find the row starting at new_start, if there is one. Don't
16221 reuse a partially visible line at the end. */
16222 first_reusable_row
= start_row
;
16223 while (first_reusable_row
->enabled_p
16224 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16225 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16226 < CHARPOS (new_start
)))
16227 ++first_reusable_row
;
16229 /* Give up if there is no row to reuse. */
16230 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16231 || !first_reusable_row
->enabled_p
16232 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16233 != CHARPOS (new_start
)))
16236 /* We can reuse fully visible rows beginning with
16237 first_reusable_row to the end of the window. Set
16238 first_row_to_display to the first row that cannot be reused.
16239 Set pt_row to the row containing point, if there is any. */
16241 for (first_row_to_display
= first_reusable_row
;
16242 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16243 ++first_row_to_display
)
16245 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16246 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16247 pt_row
= first_row_to_display
;
16250 /* Start displaying at the start of first_row_to_display. */
16251 xassert (first_row_to_display
->y
< yb
);
16252 init_to_row_start (&it
, w
, first_row_to_display
);
16254 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16256 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16258 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16259 + WINDOW_HEADER_LINE_HEIGHT (w
));
16261 /* Display lines beginning with first_row_to_display in the
16262 desired matrix. Set last_text_row to the last row displayed
16263 that displays text. */
16264 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16265 if (pt_row
== NULL
)
16266 w
->cursor
.vpos
= -1;
16267 last_text_row
= NULL
;
16268 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16269 if (display_line (&it
))
16270 last_text_row
= it
.glyph_row
- 1;
16272 /* If point is in a reused row, adjust y and vpos of the cursor
16276 w
->cursor
.vpos
-= nrows_scrolled
;
16277 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16280 /* Give up if point isn't in a row displayed or reused. (This
16281 also handles the case where w->cursor.vpos < nrows_scrolled
16282 after the calls to display_line, which can happen with scroll
16283 margins. See bug#1295.) */
16284 if (w
->cursor
.vpos
< 0)
16286 clear_glyph_matrix (w
->desired_matrix
);
16290 /* Scroll the display. */
16291 run
.current_y
= first_reusable_row
->y
;
16292 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16293 run
.height
= it
.last_visible_y
- run
.current_y
;
16294 dy
= run
.current_y
- run
.desired_y
;
16299 FRAME_RIF (f
)->update_window_begin_hook (w
);
16300 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16301 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16302 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16306 /* Adjust Y positions of reused rows. */
16307 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16308 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16309 max_y
= it
.last_visible_y
;
16310 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16313 row
->visible_height
= row
->height
;
16314 if (row
->y
< min_y
)
16315 row
->visible_height
-= min_y
- row
->y
;
16316 if (row
->y
+ row
->height
> max_y
)
16317 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16318 if (row
->fringe_bitmap_periodic_p
)
16319 row
->redraw_fringe_bitmaps_p
= 1;
16322 /* Scroll the current matrix. */
16323 xassert (nrows_scrolled
> 0);
16324 rotate_matrix (w
->current_matrix
,
16326 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16329 /* Disable rows not reused. */
16330 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16331 row
->enabled_p
= 0;
16333 /* Point may have moved to a different line, so we cannot assume that
16334 the previous cursor position is valid; locate the correct row. */
16337 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16338 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16342 w
->cursor
.y
= row
->y
;
16344 if (row
< bottom_row
)
16346 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16347 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16349 /* Can't use this optimization with bidi-reordered glyph
16350 rows, unless cursor is already at point. */
16351 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16353 if (!(w
->cursor
.hpos
>= 0
16354 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16355 && BUFFERP (glyph
->object
)
16356 && glyph
->charpos
== PT
))
16361 && (!BUFFERP (glyph
->object
)
16362 || glyph
->charpos
< PT
);
16366 w
->cursor
.x
+= glyph
->pixel_width
;
16371 /* Adjust window end. A null value of last_text_row means that
16372 the window end is in reused rows which in turn means that
16373 only its vpos can have changed. */
16376 w
->window_end_bytepos
16377 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16379 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16381 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16386 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16389 w
->window_end_valid
= Qnil
;
16390 w
->desired_matrix
->no_scrolling_p
= 1;
16393 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16403 /************************************************************************
16404 Window redisplay reusing current matrix when buffer has changed
16405 ************************************************************************/
16407 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16408 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16409 EMACS_INT
*, EMACS_INT
*);
16410 static struct glyph_row
*
16411 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16412 struct glyph_row
*);
16415 /* Return the last row in MATRIX displaying text. If row START is
16416 non-null, start searching with that row. IT gives the dimensions
16417 of the display. Value is null if matrix is empty; otherwise it is
16418 a pointer to the row found. */
16420 static struct glyph_row
*
16421 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16422 struct glyph_row
*start
)
16424 struct glyph_row
*row
, *row_found
;
16426 /* Set row_found to the last row in IT->w's current matrix
16427 displaying text. The loop looks funny but think of partially
16430 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16431 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16433 xassert (row
->enabled_p
);
16435 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16444 /* Return the last row in the current matrix of W that is not affected
16445 by changes at the start of current_buffer that occurred since W's
16446 current matrix was built. Value is null if no such row exists.
16448 BEG_UNCHANGED us the number of characters unchanged at the start of
16449 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16450 first changed character in current_buffer. Characters at positions <
16451 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16452 when the current matrix was built. */
16454 static struct glyph_row
*
16455 find_last_unchanged_at_beg_row (struct window
*w
)
16457 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16458 struct glyph_row
*row
;
16459 struct glyph_row
*row_found
= NULL
;
16460 int yb
= window_text_bottom_y (w
);
16462 /* Find the last row displaying unchanged text. */
16463 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16464 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16465 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16468 if (/* If row ends before first_changed_pos, it is unchanged,
16469 except in some case. */
16470 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16471 /* When row ends in ZV and we write at ZV it is not
16473 && !row
->ends_at_zv_p
16474 /* When first_changed_pos is the end of a continued line,
16475 row is not unchanged because it may be no longer
16477 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16478 && (row
->continued_p
16479 || row
->exact_window_width_line_p
)))
16482 /* Stop if last visible row. */
16483 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16491 /* Find the first glyph row in the current matrix of W that is not
16492 affected by changes at the end of current_buffer since the
16493 time W's current matrix was built.
16495 Return in *DELTA the number of chars by which buffer positions in
16496 unchanged text at the end of current_buffer must be adjusted.
16498 Return in *DELTA_BYTES the corresponding number of bytes.
16500 Value is null if no such row exists, i.e. all rows are affected by
16503 static struct glyph_row
*
16504 find_first_unchanged_at_end_row (struct window
*w
,
16505 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16507 struct glyph_row
*row
;
16508 struct glyph_row
*row_found
= NULL
;
16510 *delta
= *delta_bytes
= 0;
16512 /* Display must not have been paused, otherwise the current matrix
16513 is not up to date. */
16514 eassert (!NILP (w
->window_end_valid
));
16516 /* A value of window_end_pos >= END_UNCHANGED means that the window
16517 end is in the range of changed text. If so, there is no
16518 unchanged row at the end of W's current matrix. */
16519 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16522 /* Set row to the last row in W's current matrix displaying text. */
16523 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16525 /* If matrix is entirely empty, no unchanged row exists. */
16526 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16528 /* The value of row is the last glyph row in the matrix having a
16529 meaningful buffer position in it. The end position of row
16530 corresponds to window_end_pos. This allows us to translate
16531 buffer positions in the current matrix to current buffer
16532 positions for characters not in changed text. */
16534 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16535 EMACS_INT Z_BYTE_old
=
16536 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16537 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16538 struct glyph_row
*first_text_row
16539 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16541 *delta
= Z
- Z_old
;
16542 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16544 /* Set last_unchanged_pos to the buffer position of the last
16545 character in the buffer that has not been changed. Z is the
16546 index + 1 of the last character in current_buffer, i.e. by
16547 subtracting END_UNCHANGED we get the index of the last
16548 unchanged character, and we have to add BEG to get its buffer
16550 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16551 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16553 /* Search backward from ROW for a row displaying a line that
16554 starts at a minimum position >= last_unchanged_pos_old. */
16555 for (; row
> first_text_row
; --row
)
16557 /* This used to abort, but it can happen.
16558 It is ok to just stop the search instead here. KFS. */
16559 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16562 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16567 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16573 /* Make sure that glyph rows in the current matrix of window W
16574 reference the same glyph memory as corresponding rows in the
16575 frame's frame matrix. This function is called after scrolling W's
16576 current matrix on a terminal frame in try_window_id and
16577 try_window_reusing_current_matrix. */
16580 sync_frame_with_window_matrix_rows (struct window
*w
)
16582 struct frame
*f
= XFRAME (w
->frame
);
16583 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16585 /* Preconditions: W must be a leaf window and full-width. Its frame
16586 must have a frame matrix. */
16587 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16588 xassert (WINDOW_FULL_WIDTH_P (w
));
16589 xassert (!FRAME_WINDOW_P (f
));
16591 /* If W is a full-width window, glyph pointers in W's current matrix
16592 have, by definition, to be the same as glyph pointers in the
16593 corresponding frame matrix. Note that frame matrices have no
16594 marginal areas (see build_frame_matrix). */
16595 window_row
= w
->current_matrix
->rows
;
16596 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16597 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16598 while (window_row
< window_row_end
)
16600 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16601 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16603 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16604 frame_row
->glyphs
[TEXT_AREA
] = start
;
16605 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16606 frame_row
->glyphs
[LAST_AREA
] = end
;
16608 /* Disable frame rows whose corresponding window rows have
16609 been disabled in try_window_id. */
16610 if (!window_row
->enabled_p
)
16611 frame_row
->enabled_p
= 0;
16613 ++window_row
, ++frame_row
;
16618 /* Find the glyph row in window W containing CHARPOS. Consider all
16619 rows between START and END (not inclusive). END null means search
16620 all rows to the end of the display area of W. Value is the row
16621 containing CHARPOS or null. */
16624 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16625 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16627 struct glyph_row
*row
= start
;
16628 struct glyph_row
*best_row
= NULL
;
16629 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16632 /* If we happen to start on a header-line, skip that. */
16633 if (row
->mode_line_p
)
16636 if ((end
&& row
>= end
) || !row
->enabled_p
)
16639 last_y
= window_text_bottom_y (w
) - dy
;
16643 /* Give up if we have gone too far. */
16644 if (end
&& row
>= end
)
16646 /* This formerly returned if they were equal.
16647 I think that both quantities are of a "last plus one" type;
16648 if so, when they are equal, the row is within the screen. -- rms. */
16649 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16652 /* If it is in this row, return this row. */
16653 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16654 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16655 /* The end position of a row equals the start
16656 position of the next row. If CHARPOS is there, we
16657 would rather display it in the next line, except
16658 when this line ends in ZV. */
16659 && !row
->ends_at_zv_p
16660 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16661 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16665 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16666 || (!best_row
&& !row
->continued_p
))
16668 /* In bidi-reordered rows, there could be several rows
16669 occluding point, all of them belonging to the same
16670 continued line. We need to find the row which fits
16671 CHARPOS the best. */
16672 for (g
= row
->glyphs
[TEXT_AREA
];
16673 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16676 if (!STRINGP (g
->object
))
16678 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16680 mindif
= eabs (g
->charpos
- charpos
);
16682 /* Exact match always wins. */
16689 else if (best_row
&& !row
->continued_p
)
16696 /* Try to redisplay window W by reusing its existing display. W's
16697 current matrix must be up to date when this function is called,
16698 i.e. window_end_valid must not be nil.
16702 1 if display has been updated
16703 0 if otherwise unsuccessful
16704 -1 if redisplay with same window start is known not to succeed
16706 The following steps are performed:
16708 1. Find the last row in the current matrix of W that is not
16709 affected by changes at the start of current_buffer. If no such row
16712 2. Find the first row in W's current matrix that is not affected by
16713 changes at the end of current_buffer. Maybe there is no such row.
16715 3. Display lines beginning with the row + 1 found in step 1 to the
16716 row found in step 2 or, if step 2 didn't find a row, to the end of
16719 4. If cursor is not known to appear on the window, give up.
16721 5. If display stopped at the row found in step 2, scroll the
16722 display and current matrix as needed.
16724 6. Maybe display some lines at the end of W, if we must. This can
16725 happen under various circumstances, like a partially visible line
16726 becoming fully visible, or because newly displayed lines are displayed
16727 in smaller font sizes.
16729 7. Update W's window end information. */
16732 try_window_id (struct window
*w
)
16734 struct frame
*f
= XFRAME (w
->frame
);
16735 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16736 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16737 struct glyph_row
*last_unchanged_at_beg_row
;
16738 struct glyph_row
*first_unchanged_at_end_row
;
16739 struct glyph_row
*row
;
16740 struct glyph_row
*bottom_row
;
16743 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16745 struct text_pos start_pos
;
16747 int first_unchanged_at_end_vpos
= 0;
16748 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16749 struct text_pos start
;
16750 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16753 if (inhibit_try_window_id
)
16757 /* This is handy for debugging. */
16759 #define GIVE_UP(X) \
16761 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16765 #define GIVE_UP(X) return 0
16768 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16770 /* Don't use this for mini-windows because these can show
16771 messages and mini-buffers, and we don't handle that here. */
16772 if (MINI_WINDOW_P (w
))
16775 /* This flag is used to prevent redisplay optimizations. */
16776 if (windows_or_buffers_changed
|| cursor_type_changed
)
16779 /* Verify that narrowing has not changed.
16780 Also verify that we were not told to prevent redisplay optimizations.
16781 It would be nice to further
16782 reduce the number of cases where this prevents try_window_id. */
16783 if (current_buffer
->clip_changed
16784 || current_buffer
->prevent_redisplay_optimizations_p
)
16787 /* Window must either use window-based redisplay or be full width. */
16788 if (!FRAME_WINDOW_P (f
)
16789 && (!FRAME_LINE_INS_DEL_OK (f
)
16790 || !WINDOW_FULL_WIDTH_P (w
)))
16793 /* Give up if point is known NOT to appear in W. */
16794 if (PT
< CHARPOS (start
))
16797 /* Another way to prevent redisplay optimizations. */
16798 if (XFASTINT (w
->last_modified
) == 0)
16801 /* Verify that window is not hscrolled. */
16802 if (XFASTINT (w
->hscroll
) != 0)
16805 /* Verify that display wasn't paused. */
16806 if (NILP (w
->window_end_valid
))
16809 /* Can't use this if highlighting a region because a cursor movement
16810 will do more than just set the cursor. */
16811 if (!NILP (Vtransient_mark_mode
)
16812 && !NILP (BVAR (current_buffer
, mark_active
)))
16815 /* Likewise if highlighting trailing whitespace. */
16816 if (!NILP (Vshow_trailing_whitespace
))
16819 /* Likewise if showing a region. */
16820 if (!NILP (w
->region_showing
))
16823 /* Can't use this if overlay arrow position and/or string have
16825 if (overlay_arrows_changed_p ())
16828 /* When word-wrap is on, adding a space to the first word of a
16829 wrapped line can change the wrap position, altering the line
16830 above it. It might be worthwhile to handle this more
16831 intelligently, but for now just redisplay from scratch. */
16832 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16835 /* Under bidi reordering, adding or deleting a character in the
16836 beginning of a paragraph, before the first strong directional
16837 character, can change the base direction of the paragraph (unless
16838 the buffer specifies a fixed paragraph direction), which will
16839 require to redisplay the whole paragraph. It might be worthwhile
16840 to find the paragraph limits and widen the range of redisplayed
16841 lines to that, but for now just give up this optimization and
16842 redisplay from scratch. */
16843 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16844 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16847 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16848 only if buffer has really changed. The reason is that the gap is
16849 initially at Z for freshly visited files. The code below would
16850 set end_unchanged to 0 in that case. */
16851 if (MODIFF
> SAVE_MODIFF
16852 /* This seems to happen sometimes after saving a buffer. */
16853 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16855 if (GPT
- BEG
< BEG_UNCHANGED
)
16856 BEG_UNCHANGED
= GPT
- BEG
;
16857 if (Z
- GPT
< END_UNCHANGED
)
16858 END_UNCHANGED
= Z
- GPT
;
16861 /* The position of the first and last character that has been changed. */
16862 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16863 last_changed_charpos
= Z
- END_UNCHANGED
;
16865 /* If window starts after a line end, and the last change is in
16866 front of that newline, then changes don't affect the display.
16867 This case happens with stealth-fontification. Note that although
16868 the display is unchanged, glyph positions in the matrix have to
16869 be adjusted, of course. */
16870 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16871 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16872 && ((last_changed_charpos
< CHARPOS (start
)
16873 && CHARPOS (start
) == BEGV
)
16874 || (last_changed_charpos
< CHARPOS (start
) - 1
16875 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16877 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16878 struct glyph_row
*r0
;
16880 /* Compute how many chars/bytes have been added to or removed
16881 from the buffer. */
16882 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16883 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16884 Z_delta
= Z
- Z_old
;
16885 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16887 /* Give up if PT is not in the window. Note that it already has
16888 been checked at the start of try_window_id that PT is not in
16889 front of the window start. */
16890 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16893 /* If window start is unchanged, we can reuse the whole matrix
16894 as is, after adjusting glyph positions. No need to compute
16895 the window end again, since its offset from Z hasn't changed. */
16896 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16897 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16898 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16899 /* PT must not be in a partially visible line. */
16900 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16901 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16903 /* Adjust positions in the glyph matrix. */
16904 if (Z_delta
|| Z_delta_bytes
)
16906 struct glyph_row
*r1
16907 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16908 increment_matrix_positions (w
->current_matrix
,
16909 MATRIX_ROW_VPOS (r0
, current_matrix
),
16910 MATRIX_ROW_VPOS (r1
, current_matrix
),
16911 Z_delta
, Z_delta_bytes
);
16914 /* Set the cursor. */
16915 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16917 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16924 /* Handle the case that changes are all below what is displayed in
16925 the window, and that PT is in the window. This shortcut cannot
16926 be taken if ZV is visible in the window, and text has been added
16927 there that is visible in the window. */
16928 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16929 /* ZV is not visible in the window, or there are no
16930 changes at ZV, actually. */
16931 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16932 || first_changed_charpos
== last_changed_charpos
))
16934 struct glyph_row
*r0
;
16936 /* Give up if PT is not in the window. Note that it already has
16937 been checked at the start of try_window_id that PT is not in
16938 front of the window start. */
16939 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16942 /* If window start is unchanged, we can reuse the whole matrix
16943 as is, without changing glyph positions since no text has
16944 been added/removed in front of the window end. */
16945 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16946 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16947 /* PT must not be in a partially visible line. */
16948 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16949 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16951 /* We have to compute the window end anew since text
16952 could have been added/removed after it. */
16954 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16955 w
->window_end_bytepos
16956 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16958 /* Set the cursor. */
16959 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16961 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16968 /* Give up if window start is in the changed area.
16970 The condition used to read
16972 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16974 but why that was tested escapes me at the moment. */
16975 if (CHARPOS (start
) >= first_changed_charpos
16976 && CHARPOS (start
) <= last_changed_charpos
)
16979 /* Check that window start agrees with the start of the first glyph
16980 row in its current matrix. Check this after we know the window
16981 start is not in changed text, otherwise positions would not be
16983 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16984 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16987 /* Give up if the window ends in strings. Overlay strings
16988 at the end are difficult to handle, so don't try. */
16989 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16990 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16993 /* Compute the position at which we have to start displaying new
16994 lines. Some of the lines at the top of the window might be
16995 reusable because they are not displaying changed text. Find the
16996 last row in W's current matrix not affected by changes at the
16997 start of current_buffer. Value is null if changes start in the
16998 first line of window. */
16999 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17000 if (last_unchanged_at_beg_row
)
17002 /* Avoid starting to display in the moddle of a character, a TAB
17003 for instance. This is easier than to set up the iterator
17004 exactly, and it's not a frequent case, so the additional
17005 effort wouldn't really pay off. */
17006 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17007 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17008 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17009 --last_unchanged_at_beg_row
;
17011 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17014 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17016 start_pos
= it
.current
.pos
;
17018 /* Start displaying new lines in the desired matrix at the same
17019 vpos we would use in the current matrix, i.e. below
17020 last_unchanged_at_beg_row. */
17021 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17023 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17024 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17026 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17030 /* There are no reusable lines at the start of the window.
17031 Start displaying in the first text line. */
17032 start_display (&it
, w
, start
);
17033 it
.vpos
= it
.first_vpos
;
17034 start_pos
= it
.current
.pos
;
17037 /* Find the first row that is not affected by changes at the end of
17038 the buffer. Value will be null if there is no unchanged row, in
17039 which case we must redisplay to the end of the window. delta
17040 will be set to the value by which buffer positions beginning with
17041 first_unchanged_at_end_row have to be adjusted due to text
17043 first_unchanged_at_end_row
17044 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17045 IF_DEBUG (debug_delta
= delta
);
17046 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17048 /* Set stop_pos to the buffer position up to which we will have to
17049 display new lines. If first_unchanged_at_end_row != NULL, this
17050 is the buffer position of the start of the line displayed in that
17051 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17052 that we don't stop at a buffer position. */
17054 if (first_unchanged_at_end_row
)
17056 xassert (last_unchanged_at_beg_row
== NULL
17057 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17059 /* If this is a continuation line, move forward to the next one
17060 that isn't. Changes in lines above affect this line.
17061 Caution: this may move first_unchanged_at_end_row to a row
17062 not displaying text. */
17063 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17064 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17065 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17066 < it
.last_visible_y
))
17067 ++first_unchanged_at_end_row
;
17069 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17070 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17071 >= it
.last_visible_y
))
17072 first_unchanged_at_end_row
= NULL
;
17075 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17077 first_unchanged_at_end_vpos
17078 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17079 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17082 else if (last_unchanged_at_beg_row
== NULL
)
17088 /* Either there is no unchanged row at the end, or the one we have
17089 now displays text. This is a necessary condition for the window
17090 end pos calculation at the end of this function. */
17091 xassert (first_unchanged_at_end_row
== NULL
17092 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17094 debug_last_unchanged_at_beg_vpos
17095 = (last_unchanged_at_beg_row
17096 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17098 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17100 #endif /* GLYPH_DEBUG != 0 */
17103 /* Display new lines. Set last_text_row to the last new line
17104 displayed which has text on it, i.e. might end up as being the
17105 line where the window_end_vpos is. */
17106 w
->cursor
.vpos
= -1;
17107 last_text_row
= NULL
;
17108 overlay_arrow_seen
= 0;
17109 while (it
.current_y
< it
.last_visible_y
17110 && !fonts_changed_p
17111 && (first_unchanged_at_end_row
== NULL
17112 || IT_CHARPOS (it
) < stop_pos
))
17114 if (display_line (&it
))
17115 last_text_row
= it
.glyph_row
- 1;
17118 if (fonts_changed_p
)
17122 /* Compute differences in buffer positions, y-positions etc. for
17123 lines reused at the bottom of the window. Compute what we can
17125 if (first_unchanged_at_end_row
17126 /* No lines reused because we displayed everything up to the
17127 bottom of the window. */
17128 && it
.current_y
< it
.last_visible_y
)
17131 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17133 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17134 run
.current_y
= first_unchanged_at_end_row
->y
;
17135 run
.desired_y
= run
.current_y
+ dy
;
17136 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17140 delta
= delta_bytes
= dvpos
= dy
17141 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17142 first_unchanged_at_end_row
= NULL
;
17144 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17147 /* Find the cursor if not already found. We have to decide whether
17148 PT will appear on this window (it sometimes doesn't, but this is
17149 not a very frequent case.) This decision has to be made before
17150 the current matrix is altered. A value of cursor.vpos < 0 means
17151 that PT is either in one of the lines beginning at
17152 first_unchanged_at_end_row or below the window. Don't care for
17153 lines that might be displayed later at the window end; as
17154 mentioned, this is not a frequent case. */
17155 if (w
->cursor
.vpos
< 0)
17157 /* Cursor in unchanged rows at the top? */
17158 if (PT
< CHARPOS (start_pos
)
17159 && last_unchanged_at_beg_row
)
17161 row
= row_containing_pos (w
, PT
,
17162 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17163 last_unchanged_at_beg_row
+ 1, 0);
17165 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17168 /* Start from first_unchanged_at_end_row looking for PT. */
17169 else if (first_unchanged_at_end_row
)
17171 row
= row_containing_pos (w
, PT
- delta
,
17172 first_unchanged_at_end_row
, NULL
, 0);
17174 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17175 delta_bytes
, dy
, dvpos
);
17178 /* Give up if cursor was not found. */
17179 if (w
->cursor
.vpos
< 0)
17181 clear_glyph_matrix (w
->desired_matrix
);
17186 /* Don't let the cursor end in the scroll margins. */
17188 int this_scroll_margin
, cursor_height
;
17190 this_scroll_margin
=
17191 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17192 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17193 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17195 if ((w
->cursor
.y
< this_scroll_margin
17196 && CHARPOS (start
) > BEGV
)
17197 /* Old redisplay didn't take scroll margin into account at the bottom,
17198 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17199 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17200 ? cursor_height
+ this_scroll_margin
17201 : 1)) > it
.last_visible_y
)
17203 w
->cursor
.vpos
= -1;
17204 clear_glyph_matrix (w
->desired_matrix
);
17209 /* Scroll the display. Do it before changing the current matrix so
17210 that xterm.c doesn't get confused about where the cursor glyph is
17212 if (dy
&& run
.height
)
17216 if (FRAME_WINDOW_P (f
))
17218 FRAME_RIF (f
)->update_window_begin_hook (w
);
17219 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17220 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17221 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17225 /* Terminal frame. In this case, dvpos gives the number of
17226 lines to scroll by; dvpos < 0 means scroll up. */
17228 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17229 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17230 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17231 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17232 + window_internal_height (w
));
17234 #if defined (HAVE_GPM) || defined (MSDOS)
17235 x_clear_window_mouse_face (w
);
17237 /* Perform the operation on the screen. */
17240 /* Scroll last_unchanged_at_beg_row to the end of the
17241 window down dvpos lines. */
17242 set_terminal_window (f
, end
);
17244 /* On dumb terminals delete dvpos lines at the end
17245 before inserting dvpos empty lines. */
17246 if (!FRAME_SCROLL_REGION_OK (f
))
17247 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17249 /* Insert dvpos empty lines in front of
17250 last_unchanged_at_beg_row. */
17251 ins_del_lines (f
, from
, dvpos
);
17253 else if (dvpos
< 0)
17255 /* Scroll up last_unchanged_at_beg_vpos to the end of
17256 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17257 set_terminal_window (f
, end
);
17259 /* Delete dvpos lines in front of
17260 last_unchanged_at_beg_vpos. ins_del_lines will set
17261 the cursor to the given vpos and emit |dvpos| delete
17263 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17265 /* On a dumb terminal insert dvpos empty lines at the
17267 if (!FRAME_SCROLL_REGION_OK (f
))
17268 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17271 set_terminal_window (f
, 0);
17277 /* Shift reused rows of the current matrix to the right position.
17278 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17280 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17281 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17284 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17285 bottom_vpos
, dvpos
);
17286 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17289 else if (dvpos
> 0)
17291 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17292 bottom_vpos
, dvpos
);
17293 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17294 first_unchanged_at_end_vpos
+ dvpos
, 0);
17297 /* For frame-based redisplay, make sure that current frame and window
17298 matrix are in sync with respect to glyph memory. */
17299 if (!FRAME_WINDOW_P (f
))
17300 sync_frame_with_window_matrix_rows (w
);
17302 /* Adjust buffer positions in reused rows. */
17303 if (delta
|| delta_bytes
)
17304 increment_matrix_positions (current_matrix
,
17305 first_unchanged_at_end_vpos
+ dvpos
,
17306 bottom_vpos
, delta
, delta_bytes
);
17308 /* Adjust Y positions. */
17310 shift_glyph_matrix (w
, current_matrix
,
17311 first_unchanged_at_end_vpos
+ dvpos
,
17314 if (first_unchanged_at_end_row
)
17316 first_unchanged_at_end_row
+= dvpos
;
17317 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17318 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17319 first_unchanged_at_end_row
= NULL
;
17322 /* If scrolling up, there may be some lines to display at the end of
17324 last_text_row_at_end
= NULL
;
17327 /* Scrolling up can leave for example a partially visible line
17328 at the end of the window to be redisplayed. */
17329 /* Set last_row to the glyph row in the current matrix where the
17330 window end line is found. It has been moved up or down in
17331 the matrix by dvpos. */
17332 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17333 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17335 /* If last_row is the window end line, it should display text. */
17336 xassert (last_row
->displays_text_p
);
17338 /* If window end line was partially visible before, begin
17339 displaying at that line. Otherwise begin displaying with the
17340 line following it. */
17341 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17343 init_to_row_start (&it
, w
, last_row
);
17344 it
.vpos
= last_vpos
;
17345 it
.current_y
= last_row
->y
;
17349 init_to_row_end (&it
, w
, last_row
);
17350 it
.vpos
= 1 + last_vpos
;
17351 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17355 /* We may start in a continuation line. If so, we have to
17356 get the right continuation_lines_width and current_x. */
17357 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17358 it
.hpos
= it
.current_x
= 0;
17360 /* Display the rest of the lines at the window end. */
17361 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17362 while (it
.current_y
< it
.last_visible_y
17363 && !fonts_changed_p
)
17365 /* Is it always sure that the display agrees with lines in
17366 the current matrix? I don't think so, so we mark rows
17367 displayed invalid in the current matrix by setting their
17368 enabled_p flag to zero. */
17369 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17370 if (display_line (&it
))
17371 last_text_row_at_end
= it
.glyph_row
- 1;
17375 /* Update window_end_pos and window_end_vpos. */
17376 if (first_unchanged_at_end_row
17377 && !last_text_row_at_end
)
17379 /* Window end line if one of the preserved rows from the current
17380 matrix. Set row to the last row displaying text in current
17381 matrix starting at first_unchanged_at_end_row, after
17383 xassert (first_unchanged_at_end_row
->displays_text_p
);
17384 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17385 first_unchanged_at_end_row
);
17386 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17388 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17389 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17391 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17392 xassert (w
->window_end_bytepos
>= 0);
17393 IF_DEBUG (debug_method_add (w
, "A"));
17395 else if (last_text_row_at_end
)
17398 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17399 w
->window_end_bytepos
17400 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17402 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17403 xassert (w
->window_end_bytepos
>= 0);
17404 IF_DEBUG (debug_method_add (w
, "B"));
17406 else if (last_text_row
)
17408 /* We have displayed either to the end of the window or at the
17409 end of the window, i.e. the last row with text is to be found
17410 in the desired matrix. */
17412 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17413 w
->window_end_bytepos
17414 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17416 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17417 xassert (w
->window_end_bytepos
>= 0);
17419 else if (first_unchanged_at_end_row
== NULL
17420 && last_text_row
== NULL
17421 && last_text_row_at_end
== NULL
)
17423 /* Displayed to end of window, but no line containing text was
17424 displayed. Lines were deleted at the end of the window. */
17425 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17426 int vpos
= XFASTINT (w
->window_end_vpos
);
17427 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17428 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17431 row
== NULL
&& vpos
>= first_vpos
;
17432 --vpos
, --current_row
, --desired_row
)
17434 if (desired_row
->enabled_p
)
17436 if (desired_row
->displays_text_p
)
17439 else if (current_row
->displays_text_p
)
17443 xassert (row
!= NULL
);
17444 w
->window_end_vpos
= make_number (vpos
+ 1);
17445 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17446 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17447 xassert (w
->window_end_bytepos
>= 0);
17448 IF_DEBUG (debug_method_add (w
, "C"));
17453 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17454 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17456 /* Record that display has not been completed. */
17457 w
->window_end_valid
= Qnil
;
17458 w
->desired_matrix
->no_scrolling_p
= 1;
17466 /***********************************************************************
17467 More debugging support
17468 ***********************************************************************/
17472 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17473 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17474 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17477 /* Dump the contents of glyph matrix MATRIX on stderr.
17479 GLYPHS 0 means don't show glyph contents.
17480 GLYPHS 1 means show glyphs in short form
17481 GLYPHS > 1 means show glyphs in long form. */
17484 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17487 for (i
= 0; i
< matrix
->nrows
; ++i
)
17488 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17492 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17493 the glyph row and area where the glyph comes from. */
17496 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17498 if (glyph
->type
== CHAR_GLYPH
)
17501 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17502 glyph
- row
->glyphs
[TEXT_AREA
],
17505 (BUFFERP (glyph
->object
)
17507 : (STRINGP (glyph
->object
)
17510 glyph
->pixel_width
,
17512 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17516 glyph
->left_box_line_p
,
17517 glyph
->right_box_line_p
);
17519 else if (glyph
->type
== STRETCH_GLYPH
)
17522 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17523 glyph
- row
->glyphs
[TEXT_AREA
],
17526 (BUFFERP (glyph
->object
)
17528 : (STRINGP (glyph
->object
)
17531 glyph
->pixel_width
,
17535 glyph
->left_box_line_p
,
17536 glyph
->right_box_line_p
);
17538 else if (glyph
->type
== IMAGE_GLYPH
)
17541 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17542 glyph
- row
->glyphs
[TEXT_AREA
],
17545 (BUFFERP (glyph
->object
)
17547 : (STRINGP (glyph
->object
)
17550 glyph
->pixel_width
,
17554 glyph
->left_box_line_p
,
17555 glyph
->right_box_line_p
);
17557 else if (glyph
->type
== COMPOSITE_GLYPH
)
17560 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17561 glyph
- row
->glyphs
[TEXT_AREA
],
17564 (BUFFERP (glyph
->object
)
17566 : (STRINGP (glyph
->object
)
17569 glyph
->pixel_width
,
17571 if (glyph
->u
.cmp
.automatic
)
17574 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17575 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17577 glyph
->left_box_line_p
,
17578 glyph
->right_box_line_p
);
17583 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17584 GLYPHS 0 means don't show glyph contents.
17585 GLYPHS 1 means show glyphs in short form
17586 GLYPHS > 1 means show glyphs in long form. */
17589 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17593 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17594 fprintf (stderr
, "======================================================================\n");
17596 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17597 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17599 MATRIX_ROW_START_CHARPOS (row
),
17600 MATRIX_ROW_END_CHARPOS (row
),
17601 row
->used
[TEXT_AREA
],
17602 row
->contains_overlapping_glyphs_p
,
17604 row
->truncated_on_left_p
,
17605 row
->truncated_on_right_p
,
17607 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17608 row
->displays_text_p
,
17611 row
->ends_in_middle_of_char_p
,
17612 row
->starts_in_middle_of_char_p
,
17618 row
->visible_height
,
17621 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17622 row
->end
.overlay_string_index
,
17623 row
->continuation_lines_width
);
17624 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17625 CHARPOS (row
->start
.string_pos
),
17626 CHARPOS (row
->end
.string_pos
));
17627 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17628 row
->end
.dpvec_index
);
17635 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17637 struct glyph
*glyph
= row
->glyphs
[area
];
17638 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17640 /* Glyph for a line end in text. */
17641 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17644 if (glyph
< glyph_end
)
17645 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17647 for (; glyph
< glyph_end
; ++glyph
)
17648 dump_glyph (row
, glyph
, area
);
17651 else if (glyphs
== 1)
17655 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17657 char *s
= (char *) alloca (row
->used
[area
] + 1);
17660 for (i
= 0; i
< row
->used
[area
]; ++i
)
17662 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17663 if (glyph
->type
== CHAR_GLYPH
17664 && glyph
->u
.ch
< 0x80
17665 && glyph
->u
.ch
>= ' ')
17666 s
[i
] = glyph
->u
.ch
;
17672 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17678 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17679 Sdump_glyph_matrix
, 0, 1, "p",
17680 doc
: /* Dump the current matrix of the selected window to stderr.
17681 Shows contents of glyph row structures. With non-nil
17682 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17683 glyphs in short form, otherwise show glyphs in long form. */)
17684 (Lisp_Object glyphs
)
17686 struct window
*w
= XWINDOW (selected_window
);
17687 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17689 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17690 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17691 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17692 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17693 fprintf (stderr
, "=============================================\n");
17694 dump_glyph_matrix (w
->current_matrix
,
17695 NILP (glyphs
) ? 0 : XINT (glyphs
));
17700 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17701 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17704 struct frame
*f
= XFRAME (selected_frame
);
17705 dump_glyph_matrix (f
->current_matrix
, 1);
17710 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17711 doc
: /* Dump glyph row ROW to stderr.
17712 GLYPH 0 means don't dump glyphs.
17713 GLYPH 1 means dump glyphs in short form.
17714 GLYPH > 1 or omitted means dump glyphs in long form. */)
17715 (Lisp_Object row
, Lisp_Object glyphs
)
17717 struct glyph_matrix
*matrix
;
17720 CHECK_NUMBER (row
);
17721 matrix
= XWINDOW (selected_window
)->current_matrix
;
17723 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17724 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17726 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17731 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17732 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17733 GLYPH 0 means don't dump glyphs.
17734 GLYPH 1 means dump glyphs in short form.
17735 GLYPH > 1 or omitted means dump glyphs in long form. */)
17736 (Lisp_Object row
, Lisp_Object glyphs
)
17738 struct frame
*sf
= SELECTED_FRAME ();
17739 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17742 CHECK_NUMBER (row
);
17744 if (vpos
>= 0 && vpos
< m
->nrows
)
17745 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17746 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17751 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17752 doc
: /* Toggle tracing of redisplay.
17753 With ARG, turn tracing on if and only if ARG is positive. */)
17757 trace_redisplay_p
= !trace_redisplay_p
;
17760 arg
= Fprefix_numeric_value (arg
);
17761 trace_redisplay_p
= XINT (arg
) > 0;
17768 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17769 doc
: /* Like `format', but print result to stderr.
17770 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17771 (ptrdiff_t nargs
, Lisp_Object
*args
)
17773 Lisp_Object s
= Fformat (nargs
, args
);
17774 fprintf (stderr
, "%s", SDATA (s
));
17778 #endif /* GLYPH_DEBUG */
17782 /***********************************************************************
17783 Building Desired Matrix Rows
17784 ***********************************************************************/
17786 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17787 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17789 static struct glyph_row
*
17790 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17792 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17793 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17794 struct buffer
*old
= current_buffer
;
17795 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17796 int arrow_len
= SCHARS (overlay_arrow_string
);
17797 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17798 const unsigned char *p
;
17801 int n_glyphs_before
;
17803 set_buffer_temp (buffer
);
17804 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17805 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17806 SET_TEXT_POS (it
.position
, 0, 0);
17808 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17810 while (p
< arrow_end
)
17812 Lisp_Object face
, ilisp
;
17814 /* Get the next character. */
17816 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17819 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17820 if (! ASCII_CHAR_P (it
.c
))
17821 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17825 /* Get its face. */
17826 ilisp
= make_number (p
- arrow_string
);
17827 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17828 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17830 /* Compute its width, get its glyphs. */
17831 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17832 SET_TEXT_POS (it
.position
, -1, -1);
17833 PRODUCE_GLYPHS (&it
);
17835 /* If this character doesn't fit any more in the line, we have
17836 to remove some glyphs. */
17837 if (it
.current_x
> it
.last_visible_x
)
17839 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17844 set_buffer_temp (old
);
17845 return it
.glyph_row
;
17849 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17850 glyphs are only inserted for terminal frames since we can't really
17851 win with truncation glyphs when partially visible glyphs are
17852 involved. Which glyphs to insert is determined by
17853 produce_special_glyphs. */
17856 insert_left_trunc_glyphs (struct it
*it
)
17858 struct it truncate_it
;
17859 struct glyph
*from
, *end
, *to
, *toend
;
17861 xassert (!FRAME_WINDOW_P (it
->f
));
17863 /* Get the truncation glyphs. */
17865 truncate_it
.current_x
= 0;
17866 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17867 truncate_it
.glyph_row
= &scratch_glyph_row
;
17868 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17869 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17870 truncate_it
.object
= make_number (0);
17871 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17873 /* Overwrite glyphs from IT with truncation glyphs. */
17874 if (!it
->glyph_row
->reversed_p
)
17876 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17877 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17878 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17879 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17884 /* There may be padding glyphs left over. Overwrite them too. */
17885 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17887 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17893 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17897 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17898 that back to front. */
17899 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17900 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17901 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17902 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17904 while (from
>= end
&& to
>= toend
)
17906 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17909 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17910 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17911 while (from
>= end
&& to
>= toend
)
17916 /* Need to free some room before prepending additional
17918 int move_by
= from
- end
+ 1;
17919 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17920 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17922 for ( ; g
>= g0
; g
--)
17924 while (from
>= end
)
17926 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17932 /* Compute the pixel height and width of IT->glyph_row.
17934 Most of the time, ascent and height of a display line will be equal
17935 to the max_ascent and max_height values of the display iterator
17936 structure. This is not the case if
17938 1. We hit ZV without displaying anything. In this case, max_ascent
17939 and max_height will be zero.
17941 2. We have some glyphs that don't contribute to the line height.
17942 (The glyph row flag contributes_to_line_height_p is for future
17943 pixmap extensions).
17945 The first case is easily covered by using default values because in
17946 these cases, the line height does not really matter, except that it
17947 must not be zero. */
17950 compute_line_metrics (struct it
*it
)
17952 struct glyph_row
*row
= it
->glyph_row
;
17954 if (FRAME_WINDOW_P (it
->f
))
17956 int i
, min_y
, max_y
;
17958 /* The line may consist of one space only, that was added to
17959 place the cursor on it. If so, the row's height hasn't been
17961 if (row
->height
== 0)
17963 if (it
->max_ascent
+ it
->max_descent
== 0)
17964 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17965 row
->ascent
= it
->max_ascent
;
17966 row
->height
= it
->max_ascent
+ it
->max_descent
;
17967 row
->phys_ascent
= it
->max_phys_ascent
;
17968 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17969 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17972 /* Compute the width of this line. */
17973 row
->pixel_width
= row
->x
;
17974 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17975 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17977 xassert (row
->pixel_width
>= 0);
17978 xassert (row
->ascent
>= 0 && row
->height
> 0);
17980 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17981 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17983 /* If first line's physical ascent is larger than its logical
17984 ascent, use the physical ascent, and make the row taller.
17985 This makes accented characters fully visible. */
17986 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17987 && row
->phys_ascent
> row
->ascent
)
17989 row
->height
+= row
->phys_ascent
- row
->ascent
;
17990 row
->ascent
= row
->phys_ascent
;
17993 /* Compute how much of the line is visible. */
17994 row
->visible_height
= row
->height
;
17996 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17997 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17999 if (row
->y
< min_y
)
18000 row
->visible_height
-= min_y
- row
->y
;
18001 if (row
->y
+ row
->height
> max_y
)
18002 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18006 row
->pixel_width
= row
->used
[TEXT_AREA
];
18007 if (row
->continued_p
)
18008 row
->pixel_width
-= it
->continuation_pixel_width
;
18009 else if (row
->truncated_on_right_p
)
18010 row
->pixel_width
-= it
->truncation_pixel_width
;
18011 row
->ascent
= row
->phys_ascent
= 0;
18012 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18013 row
->extra_line_spacing
= 0;
18016 /* Compute a hash code for this row. */
18020 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18021 for (i
= 0; i
< row
->used
[area
]; ++i
)
18022 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
18023 + row
->glyphs
[area
][i
].u
.val
18024 + row
->glyphs
[area
][i
].face_id
18025 + row
->glyphs
[area
][i
].padding_p
18026 + (row
->glyphs
[area
][i
].type
<< 2));
18029 it
->max_ascent
= it
->max_descent
= 0;
18030 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18034 /* Append one space to the glyph row of iterator IT if doing a
18035 window-based redisplay. The space has the same face as
18036 IT->face_id. Value is non-zero if a space was added.
18038 This function is called to make sure that there is always one glyph
18039 at the end of a glyph row that the cursor can be set on under
18040 window-systems. (If there weren't such a glyph we would not know
18041 how wide and tall a box cursor should be displayed).
18043 At the same time this space let's a nicely handle clearing to the
18044 end of the line if the row ends in italic text. */
18047 append_space_for_newline (struct it
*it
, int default_face_p
)
18049 if (FRAME_WINDOW_P (it
->f
))
18051 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18053 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18054 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18056 /* Save some values that must not be changed.
18057 Must save IT->c and IT->len because otherwise
18058 ITERATOR_AT_END_P wouldn't work anymore after
18059 append_space_for_newline has been called. */
18060 enum display_element_type saved_what
= it
->what
;
18061 int saved_c
= it
->c
, saved_len
= it
->len
;
18062 int saved_char_to_display
= it
->char_to_display
;
18063 int saved_x
= it
->current_x
;
18064 int saved_face_id
= it
->face_id
;
18065 struct text_pos saved_pos
;
18066 Lisp_Object saved_object
;
18069 saved_object
= it
->object
;
18070 saved_pos
= it
->position
;
18072 it
->what
= IT_CHARACTER
;
18073 memset (&it
->position
, 0, sizeof it
->position
);
18074 it
->object
= make_number (0);
18075 it
->c
= it
->char_to_display
= ' ';
18078 if (default_face_p
)
18079 it
->face_id
= DEFAULT_FACE_ID
;
18080 else if (it
->face_before_selective_p
)
18081 it
->face_id
= it
->saved_face_id
;
18082 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18083 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18085 PRODUCE_GLYPHS (it
);
18087 it
->override_ascent
= -1;
18088 it
->constrain_row_ascent_descent_p
= 0;
18089 it
->current_x
= saved_x
;
18090 it
->object
= saved_object
;
18091 it
->position
= saved_pos
;
18092 it
->what
= saved_what
;
18093 it
->face_id
= saved_face_id
;
18094 it
->len
= saved_len
;
18096 it
->char_to_display
= saved_char_to_display
;
18105 /* Extend the face of the last glyph in the text area of IT->glyph_row
18106 to the end of the display line. Called from display_line. If the
18107 glyph row is empty, add a space glyph to it so that we know the
18108 face to draw. Set the glyph row flag fill_line_p. If the glyph
18109 row is R2L, prepend a stretch glyph to cover the empty space to the
18110 left of the leftmost glyph. */
18113 extend_face_to_end_of_line (struct it
*it
)
18116 struct frame
*f
= it
->f
;
18118 /* If line is already filled, do nothing. Non window-system frames
18119 get a grace of one more ``pixel'' because their characters are
18120 1-``pixel'' wide, so they hit the equality too early. This grace
18121 is needed only for R2L rows that are not continued, to produce
18122 one extra blank where we could display the cursor. */
18123 if (it
->current_x
>= it
->last_visible_x
18124 + (!FRAME_WINDOW_P (f
)
18125 && it
->glyph_row
->reversed_p
18126 && !it
->glyph_row
->continued_p
))
18129 /* Face extension extends the background and box of IT->face_id
18130 to the end of the line. If the background equals the background
18131 of the frame, we don't have to do anything. */
18132 if (it
->face_before_selective_p
)
18133 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18135 face
= FACE_FROM_ID (f
, it
->face_id
);
18137 if (FRAME_WINDOW_P (f
)
18138 && it
->glyph_row
->displays_text_p
18139 && face
->box
== FACE_NO_BOX
18140 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18142 && !it
->glyph_row
->reversed_p
)
18145 /* Set the glyph row flag indicating that the face of the last glyph
18146 in the text area has to be drawn to the end of the text area. */
18147 it
->glyph_row
->fill_line_p
= 1;
18149 /* If current character of IT is not ASCII, make sure we have the
18150 ASCII face. This will be automatically undone the next time
18151 get_next_display_element returns a multibyte character. Note
18152 that the character will always be single byte in unibyte
18154 if (!ASCII_CHAR_P (it
->c
))
18156 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18159 if (FRAME_WINDOW_P (f
))
18161 /* If the row is empty, add a space with the current face of IT,
18162 so that we know which face to draw. */
18163 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18165 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18166 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18167 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18169 #ifdef HAVE_WINDOW_SYSTEM
18170 if (it
->glyph_row
->reversed_p
)
18172 /* Prepend a stretch glyph to the row, such that the
18173 rightmost glyph will be drawn flushed all the way to the
18174 right margin of the window. The stretch glyph that will
18175 occupy the empty space, if any, to the left of the
18177 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18178 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18179 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18181 int row_width
, stretch_ascent
, stretch_width
;
18182 struct text_pos saved_pos
;
18183 int saved_face_id
, saved_avoid_cursor
;
18185 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18186 row_width
+= g
->pixel_width
;
18187 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18188 if (stretch_width
> 0)
18191 (((it
->ascent
+ it
->descent
)
18192 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18193 saved_pos
= it
->position
;
18194 memset (&it
->position
, 0, sizeof it
->position
);
18195 saved_avoid_cursor
= it
->avoid_cursor_p
;
18196 it
->avoid_cursor_p
= 1;
18197 saved_face_id
= it
->face_id
;
18198 /* The last row's stretch glyph should get the default
18199 face, to avoid painting the rest of the window with
18200 the region face, if the region ends at ZV. */
18201 if (it
->glyph_row
->ends_at_zv_p
)
18202 it
->face_id
= DEFAULT_FACE_ID
;
18204 it
->face_id
= face
->id
;
18205 append_stretch_glyph (it
, make_number (0), stretch_width
,
18206 it
->ascent
+ it
->descent
, stretch_ascent
);
18207 it
->position
= saved_pos
;
18208 it
->avoid_cursor_p
= saved_avoid_cursor
;
18209 it
->face_id
= saved_face_id
;
18212 #endif /* HAVE_WINDOW_SYSTEM */
18216 /* Save some values that must not be changed. */
18217 int saved_x
= it
->current_x
;
18218 struct text_pos saved_pos
;
18219 Lisp_Object saved_object
;
18220 enum display_element_type saved_what
= it
->what
;
18221 int saved_face_id
= it
->face_id
;
18223 saved_object
= it
->object
;
18224 saved_pos
= it
->position
;
18226 it
->what
= IT_CHARACTER
;
18227 memset (&it
->position
, 0, sizeof it
->position
);
18228 it
->object
= make_number (0);
18229 it
->c
= it
->char_to_display
= ' ';
18231 /* The last row's blank glyphs should get the default face, to
18232 avoid painting the rest of the window with the region face,
18233 if the region ends at ZV. */
18234 if (it
->glyph_row
->ends_at_zv_p
)
18235 it
->face_id
= DEFAULT_FACE_ID
;
18237 it
->face_id
= face
->id
;
18239 PRODUCE_GLYPHS (it
);
18241 while (it
->current_x
<= it
->last_visible_x
)
18242 PRODUCE_GLYPHS (it
);
18244 /* Don't count these blanks really. It would let us insert a left
18245 truncation glyph below and make us set the cursor on them, maybe. */
18246 it
->current_x
= saved_x
;
18247 it
->object
= saved_object
;
18248 it
->position
= saved_pos
;
18249 it
->what
= saved_what
;
18250 it
->face_id
= saved_face_id
;
18255 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18256 trailing whitespace. */
18259 trailing_whitespace_p (EMACS_INT charpos
)
18261 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18264 while (bytepos
< ZV_BYTE
18265 && (c
= FETCH_CHAR (bytepos
),
18266 c
== ' ' || c
== '\t'))
18269 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18271 if (bytepos
!= PT_BYTE
)
18278 /* Highlight trailing whitespace, if any, in ROW. */
18281 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18283 int used
= row
->used
[TEXT_AREA
];
18287 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18288 struct glyph
*glyph
= start
+ used
- 1;
18290 if (row
->reversed_p
)
18292 /* Right-to-left rows need to be processed in the opposite
18293 direction, so swap the edge pointers. */
18295 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18298 /* Skip over glyphs inserted to display the cursor at the
18299 end of a line, for extending the face of the last glyph
18300 to the end of the line on terminals, and for truncation
18301 and continuation glyphs. */
18302 if (!row
->reversed_p
)
18304 while (glyph
>= start
18305 && glyph
->type
== CHAR_GLYPH
18306 && INTEGERP (glyph
->object
))
18311 while (glyph
<= start
18312 && glyph
->type
== CHAR_GLYPH
18313 && INTEGERP (glyph
->object
))
18317 /* If last glyph is a space or stretch, and it's trailing
18318 whitespace, set the face of all trailing whitespace glyphs in
18319 IT->glyph_row to `trailing-whitespace'. */
18320 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18321 && BUFFERP (glyph
->object
)
18322 && (glyph
->type
== STRETCH_GLYPH
18323 || (glyph
->type
== CHAR_GLYPH
18324 && glyph
->u
.ch
== ' '))
18325 && trailing_whitespace_p (glyph
->charpos
))
18327 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18331 if (!row
->reversed_p
)
18333 while (glyph
>= start
18334 && BUFFERP (glyph
->object
)
18335 && (glyph
->type
== STRETCH_GLYPH
18336 || (glyph
->type
== CHAR_GLYPH
18337 && glyph
->u
.ch
== ' ')))
18338 (glyph
--)->face_id
= face_id
;
18342 while (glyph
<= start
18343 && BUFFERP (glyph
->object
)
18344 && (glyph
->type
== STRETCH_GLYPH
18345 || (glyph
->type
== CHAR_GLYPH
18346 && glyph
->u
.ch
== ' ')))
18347 (glyph
++)->face_id
= face_id
;
18354 /* Value is non-zero if glyph row ROW should be
18355 used to hold the cursor. */
18358 cursor_row_p (struct glyph_row
*row
)
18362 if (PT
== CHARPOS (row
->end
.pos
)
18363 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18365 /* Suppose the row ends on a string.
18366 Unless the row is continued, that means it ends on a newline
18367 in the string. If it's anything other than a display string
18368 (e.g. a before-string from an overlay), we don't want the
18369 cursor there. (This heuristic seems to give the optimal
18370 behavior for the various types of multi-line strings.) */
18371 if (CHARPOS (row
->end
.string_pos
) >= 0)
18373 if (row
->continued_p
)
18377 /* Check for `display' property. */
18378 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18379 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18380 struct glyph
*glyph
;
18383 for (glyph
= end
; glyph
>= beg
; --glyph
)
18384 if (STRINGP (glyph
->object
))
18387 = Fget_char_property (make_number (PT
),
18391 && display_prop_string_p (prop
, glyph
->object
));
18396 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18398 /* If the row ends in middle of a real character,
18399 and the line is continued, we want the cursor here.
18400 That's because CHARPOS (ROW->end.pos) would equal
18401 PT if PT is before the character. */
18402 if (!row
->ends_in_ellipsis_p
)
18403 result
= row
->continued_p
;
18405 /* If the row ends in an ellipsis, then
18406 CHARPOS (ROW->end.pos) will equal point after the
18407 invisible text. We want that position to be displayed
18408 after the ellipsis. */
18411 /* If the row ends at ZV, display the cursor at the end of that
18412 row instead of at the start of the row below. */
18413 else if (row
->ends_at_zv_p
)
18424 /* Push the property PROP so that it will be rendered at the current
18425 position in IT. Return 1 if PROP was successfully pushed, 0
18426 otherwise. Called from handle_line_prefix to handle the
18427 `line-prefix' and `wrap-prefix' properties. */
18430 push_display_prop (struct it
*it
, Lisp_Object prop
)
18432 struct text_pos pos
=
18433 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18435 xassert (it
->method
== GET_FROM_BUFFER
18436 || it
->method
== GET_FROM_DISPLAY_VECTOR
18437 || it
->method
== GET_FROM_STRING
);
18439 /* We need to save the current buffer/string position, so it will be
18440 restored by pop_it, because iterate_out_of_display_property
18441 depends on that being set correctly, but some situations leave
18442 it->position not yet set when this function is called. */
18443 push_it (it
, &pos
);
18445 if (STRINGP (prop
))
18447 if (SCHARS (prop
) == 0)
18454 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18455 it
->current
.overlay_string_index
= -1;
18456 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18457 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18458 it
->method
= GET_FROM_STRING
;
18459 it
->stop_charpos
= 0;
18461 it
->base_level_stop
= 0;
18463 /* Force paragraph direction to be that of the parent
18465 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18466 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18468 it
->paragraph_embedding
= L2R
;
18470 /* Set up the bidi iterator for this display string. */
18473 it
->bidi_it
.string
.lstring
= it
->string
;
18474 it
->bidi_it
.string
.s
= NULL
;
18475 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18476 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18477 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18478 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18479 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18482 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18484 it
->method
= GET_FROM_STRETCH
;
18487 #ifdef HAVE_WINDOW_SYSTEM
18488 else if (IMAGEP (prop
))
18490 it
->what
= IT_IMAGE
;
18491 it
->image_id
= lookup_image (it
->f
, prop
);
18492 it
->method
= GET_FROM_IMAGE
;
18494 #endif /* HAVE_WINDOW_SYSTEM */
18497 pop_it (it
); /* bogus display property, give up */
18504 /* Return the character-property PROP at the current position in IT. */
18507 get_it_property (struct it
*it
, Lisp_Object prop
)
18509 Lisp_Object position
;
18511 if (STRINGP (it
->object
))
18512 position
= make_number (IT_STRING_CHARPOS (*it
));
18513 else if (BUFFERP (it
->object
))
18514 position
= make_number (IT_CHARPOS (*it
));
18518 return Fget_char_property (position
, prop
, it
->object
);
18521 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18524 handle_line_prefix (struct it
*it
)
18526 Lisp_Object prefix
;
18528 if (it
->continuation_lines_width
> 0)
18530 prefix
= get_it_property (it
, Qwrap_prefix
);
18532 prefix
= Vwrap_prefix
;
18536 prefix
= get_it_property (it
, Qline_prefix
);
18538 prefix
= Vline_prefix
;
18540 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18542 /* If the prefix is wider than the window, and we try to wrap
18543 it, it would acquire its own wrap prefix, and so on till the
18544 iterator stack overflows. So, don't wrap the prefix. */
18545 it
->line_wrap
= TRUNCATE
;
18546 it
->avoid_cursor_p
= 1;
18552 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18553 only for R2L lines from display_line and display_string, when they
18554 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18555 the line/string needs to be continued on the next glyph row. */
18557 unproduce_glyphs (struct it
*it
, int n
)
18559 struct glyph
*glyph
, *end
;
18561 xassert (it
->glyph_row
);
18562 xassert (it
->glyph_row
->reversed_p
);
18563 xassert (it
->area
== TEXT_AREA
);
18564 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18566 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18567 n
= it
->glyph_row
->used
[TEXT_AREA
];
18568 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18569 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18570 for ( ; glyph
< end
; glyph
++)
18571 glyph
[-n
] = *glyph
;
18574 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18575 and ROW->maxpos. */
18577 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18578 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18579 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18581 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18582 lines' rows is implemented for bidi-reordered rows. */
18584 /* ROW->minpos is the value of min_pos, the minimal buffer position
18585 we have in ROW, or ROW->start.pos if that is smaller. */
18586 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18587 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18589 /* We didn't find buffer positions smaller than ROW->start, or
18590 didn't find _any_ valid buffer positions in any of the glyphs,
18591 so we must trust the iterator's computed positions. */
18592 row
->minpos
= row
->start
.pos
;
18595 max_pos
= CHARPOS (it
->current
.pos
);
18596 max_bpos
= BYTEPOS (it
->current
.pos
);
18599 /* Here are the various use-cases for ending the row, and the
18600 corresponding values for ROW->maxpos:
18602 Line ends in a newline from buffer eol_pos + 1
18603 Line is continued from buffer max_pos + 1
18604 Line is truncated on right it->current.pos
18605 Line ends in a newline from string max_pos + 1(*)
18606 (*) + 1 only when line ends in a forward scan
18607 Line is continued from string max_pos
18608 Line is continued from display vector max_pos
18609 Line is entirely from a string min_pos == max_pos
18610 Line is entirely from a display vector min_pos == max_pos
18611 Line that ends at ZV ZV
18613 If you discover other use-cases, please add them here as
18615 if (row
->ends_at_zv_p
)
18616 row
->maxpos
= it
->current
.pos
;
18617 else if (row
->used
[TEXT_AREA
])
18619 int seen_this_string
= 0;
18620 struct glyph_row
*r1
= row
- 1;
18622 /* Did we see the same display string on the previous row? */
18623 if (STRINGP (it
->object
)
18624 /* this is not the first row */
18625 && row
> it
->w
->desired_matrix
->rows
18626 /* previous row is not the header line */
18627 && !r1
->mode_line_p
18628 /* previous row also ends in a newline from a string */
18629 && r1
->ends_in_newline_from_string_p
)
18631 struct glyph
*start
, *end
;
18633 /* Search for the last glyph of the previous row that came
18634 from buffer or string. Depending on whether the row is
18635 L2R or R2L, we need to process it front to back or the
18636 other way round. */
18637 if (!r1
->reversed_p
)
18639 start
= r1
->glyphs
[TEXT_AREA
];
18640 end
= start
+ r1
->used
[TEXT_AREA
];
18641 /* Glyphs inserted by redisplay have an integer (zero)
18642 as their object. */
18644 && INTEGERP ((end
- 1)->object
)
18645 && (end
- 1)->charpos
<= 0)
18649 if (EQ ((end
- 1)->object
, it
->object
))
18650 seen_this_string
= 1;
18653 /* If all the glyphs of the previous row were inserted
18654 by redisplay, it means the previous row was
18655 produced from a single newline, which is only
18656 possible if that newline came from the same string
18657 as the one which produced this ROW. */
18658 seen_this_string
= 1;
18662 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18663 start
= end
+ r1
->used
[TEXT_AREA
];
18665 && INTEGERP ((end
+ 1)->object
)
18666 && (end
+ 1)->charpos
<= 0)
18670 if (EQ ((end
+ 1)->object
, it
->object
))
18671 seen_this_string
= 1;
18674 seen_this_string
= 1;
18677 /* Take note of each display string that covers a newline only
18678 once, the first time we see it. This is for when a display
18679 string includes more than one newline in it. */
18680 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18682 /* If we were scanning the buffer forward when we displayed
18683 the string, we want to account for at least one buffer
18684 position that belongs to this row (position covered by
18685 the display string), so that cursor positioning will
18686 consider this row as a candidate when point is at the end
18687 of the visual line represented by this row. This is not
18688 required when scanning back, because max_pos will already
18689 have a much larger value. */
18690 if (CHARPOS (row
->end
.pos
) > max_pos
)
18691 INC_BOTH (max_pos
, max_bpos
);
18692 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18694 else if (CHARPOS (it
->eol_pos
) > 0)
18695 SET_TEXT_POS (row
->maxpos
,
18696 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18697 else if (row
->continued_p
)
18699 /* If max_pos is different from IT's current position, it
18700 means IT->method does not belong to the display element
18701 at max_pos. However, it also means that the display
18702 element at max_pos was displayed in its entirety on this
18703 line, which is equivalent to saying that the next line
18704 starts at the next buffer position. */
18705 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18706 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18709 INC_BOTH (max_pos
, max_bpos
);
18710 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18713 else if (row
->truncated_on_right_p
)
18714 /* display_line already called reseat_at_next_visible_line_start,
18715 which puts the iterator at the beginning of the next line, in
18716 the logical order. */
18717 row
->maxpos
= it
->current
.pos
;
18718 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18719 /* A line that is entirely from a string/image/stretch... */
18720 row
->maxpos
= row
->minpos
;
18725 row
->maxpos
= it
->current
.pos
;
18728 /* Construct the glyph row IT->glyph_row in the desired matrix of
18729 IT->w from text at the current position of IT. See dispextern.h
18730 for an overview of struct it. Value is non-zero if
18731 IT->glyph_row displays text, as opposed to a line displaying ZV
18735 display_line (struct it
*it
)
18737 struct glyph_row
*row
= it
->glyph_row
;
18738 Lisp_Object overlay_arrow_string
;
18740 void *wrap_data
= NULL
;
18741 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18742 int wrap_row_used
= -1;
18743 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18744 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18745 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18746 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18747 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18749 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18750 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18752 /* We always start displaying at hpos zero even if hscrolled. */
18753 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18755 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18756 >= it
->w
->desired_matrix
->nrows
)
18758 it
->w
->nrows_scale_factor
++;
18759 fonts_changed_p
= 1;
18763 /* Is IT->w showing the region? */
18764 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18766 /* Clear the result glyph row and enable it. */
18767 prepare_desired_row (row
);
18769 row
->y
= it
->current_y
;
18770 row
->start
= it
->start
;
18771 row
->continuation_lines_width
= it
->continuation_lines_width
;
18772 row
->displays_text_p
= 1;
18773 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18774 it
->starts_in_middle_of_char_p
= 0;
18776 /* Arrange the overlays nicely for our purposes. Usually, we call
18777 display_line on only one line at a time, in which case this
18778 can't really hurt too much, or we call it on lines which appear
18779 one after another in the buffer, in which case all calls to
18780 recenter_overlay_lists but the first will be pretty cheap. */
18781 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18783 /* Move over display elements that are not visible because we are
18784 hscrolled. This may stop at an x-position < IT->first_visible_x
18785 if the first glyph is partially visible or if we hit a line end. */
18786 if (it
->current_x
< it
->first_visible_x
)
18788 this_line_min_pos
= row
->start
.pos
;
18789 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18790 MOVE_TO_POS
| MOVE_TO_X
);
18791 /* Record the smallest positions seen while we moved over
18792 display elements that are not visible. This is needed by
18793 redisplay_internal for optimizing the case where the cursor
18794 stays inside the same line. The rest of this function only
18795 considers positions that are actually displayed, so
18796 RECORD_MAX_MIN_POS will not otherwise record positions that
18797 are hscrolled to the left of the left edge of the window. */
18798 min_pos
= CHARPOS (this_line_min_pos
);
18799 min_bpos
= BYTEPOS (this_line_min_pos
);
18803 /* We only do this when not calling `move_it_in_display_line_to'
18804 above, because move_it_in_display_line_to calls
18805 handle_line_prefix itself. */
18806 handle_line_prefix (it
);
18809 /* Get the initial row height. This is either the height of the
18810 text hscrolled, if there is any, or zero. */
18811 row
->ascent
= it
->max_ascent
;
18812 row
->height
= it
->max_ascent
+ it
->max_descent
;
18813 row
->phys_ascent
= it
->max_phys_ascent
;
18814 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18815 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18817 /* Utility macro to record max and min buffer positions seen until now. */
18818 #define RECORD_MAX_MIN_POS(IT) \
18821 int composition_p = (IT)->what == IT_COMPOSITION; \
18822 EMACS_INT current_pos = \
18823 composition_p ? (IT)->cmp_it.charpos \
18824 : IT_CHARPOS (*(IT)); \
18825 EMACS_INT current_bpos = \
18826 composition_p ? CHAR_TO_BYTE (current_pos) \
18827 : IT_BYTEPOS (*(IT)); \
18828 if (current_pos < min_pos) \
18830 min_pos = current_pos; \
18831 min_bpos = current_bpos; \
18833 if (IT_CHARPOS (*it) > max_pos) \
18835 max_pos = IT_CHARPOS (*it); \
18836 max_bpos = IT_BYTEPOS (*it); \
18841 /* Loop generating characters. The loop is left with IT on the next
18842 character to display. */
18845 int n_glyphs_before
, hpos_before
, x_before
;
18847 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18849 /* Retrieve the next thing to display. Value is zero if end of
18851 if (!get_next_display_element (it
))
18853 /* Maybe add a space at the end of this line that is used to
18854 display the cursor there under X. Set the charpos of the
18855 first glyph of blank lines not corresponding to any text
18857 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18858 row
->exact_window_width_line_p
= 1;
18859 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18860 || row
->used
[TEXT_AREA
] == 0)
18862 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18863 row
->displays_text_p
= 0;
18865 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18866 && (!MINI_WINDOW_P (it
->w
)
18867 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18868 row
->indicate_empty_line_p
= 1;
18871 it
->continuation_lines_width
= 0;
18872 row
->ends_at_zv_p
= 1;
18873 /* A row that displays right-to-left text must always have
18874 its last face extended all the way to the end of line,
18875 even if this row ends in ZV, because we still write to
18876 the screen left to right. */
18877 if (row
->reversed_p
)
18878 extend_face_to_end_of_line (it
);
18882 /* Now, get the metrics of what we want to display. This also
18883 generates glyphs in `row' (which is IT->glyph_row). */
18884 n_glyphs_before
= row
->used
[TEXT_AREA
];
18887 /* Remember the line height so far in case the next element doesn't
18888 fit on the line. */
18889 if (it
->line_wrap
!= TRUNCATE
)
18891 ascent
= it
->max_ascent
;
18892 descent
= it
->max_descent
;
18893 phys_ascent
= it
->max_phys_ascent
;
18894 phys_descent
= it
->max_phys_descent
;
18896 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18898 if (IT_DISPLAYING_WHITESPACE (it
))
18902 SAVE_IT (wrap_it
, *it
, wrap_data
);
18904 wrap_row_used
= row
->used
[TEXT_AREA
];
18905 wrap_row_ascent
= row
->ascent
;
18906 wrap_row_height
= row
->height
;
18907 wrap_row_phys_ascent
= row
->phys_ascent
;
18908 wrap_row_phys_height
= row
->phys_height
;
18909 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18910 wrap_row_min_pos
= min_pos
;
18911 wrap_row_min_bpos
= min_bpos
;
18912 wrap_row_max_pos
= max_pos
;
18913 wrap_row_max_bpos
= max_bpos
;
18919 PRODUCE_GLYPHS (it
);
18921 /* If this display element was in marginal areas, continue with
18923 if (it
->area
!= TEXT_AREA
)
18925 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18926 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18927 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18928 row
->phys_height
= max (row
->phys_height
,
18929 it
->max_phys_ascent
+ it
->max_phys_descent
);
18930 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18931 it
->max_extra_line_spacing
);
18932 set_iterator_to_next (it
, 1);
18936 /* Does the display element fit on the line? If we truncate
18937 lines, we should draw past the right edge of the window. If
18938 we don't truncate, we want to stop so that we can display the
18939 continuation glyph before the right margin. If lines are
18940 continued, there are two possible strategies for characters
18941 resulting in more than 1 glyph (e.g. tabs): Display as many
18942 glyphs as possible in this line and leave the rest for the
18943 continuation line, or display the whole element in the next
18944 line. Original redisplay did the former, so we do it also. */
18945 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18946 hpos_before
= it
->hpos
;
18949 if (/* Not a newline. */
18951 /* Glyphs produced fit entirely in the line. */
18952 && it
->current_x
< it
->last_visible_x
)
18954 it
->hpos
+= nglyphs
;
18955 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18956 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18957 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18958 row
->phys_height
= max (row
->phys_height
,
18959 it
->max_phys_ascent
+ it
->max_phys_descent
);
18960 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18961 it
->max_extra_line_spacing
);
18962 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18963 row
->x
= x
- it
->first_visible_x
;
18964 /* Record the maximum and minimum buffer positions seen so
18965 far in glyphs that will be displayed by this row. */
18967 RECORD_MAX_MIN_POS (it
);
18972 struct glyph
*glyph
;
18974 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18976 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18977 new_x
= x
+ glyph
->pixel_width
;
18979 if (/* Lines are continued. */
18980 it
->line_wrap
!= TRUNCATE
18981 && (/* Glyph doesn't fit on the line. */
18982 new_x
> it
->last_visible_x
18983 /* Or it fits exactly on a window system frame. */
18984 || (new_x
== it
->last_visible_x
18985 && FRAME_WINDOW_P (it
->f
))))
18987 /* End of a continued line. */
18990 || (new_x
== it
->last_visible_x
18991 && FRAME_WINDOW_P (it
->f
)))
18993 /* Current glyph is the only one on the line or
18994 fits exactly on the line. We must continue
18995 the line because we can't draw the cursor
18996 after the glyph. */
18997 row
->continued_p
= 1;
18998 it
->current_x
= new_x
;
18999 it
->continuation_lines_width
+= new_x
;
19001 if (i
== nglyphs
- 1)
19003 /* If line-wrap is on, check if a previous
19004 wrap point was found. */
19005 if (wrap_row_used
> 0
19006 /* Even if there is a previous wrap
19007 point, continue the line here as
19008 usual, if (i) the previous character
19009 was a space or tab AND (ii) the
19010 current character is not. */
19012 || IT_DISPLAYING_WHITESPACE (it
)))
19015 /* Record the maximum and minimum buffer
19016 positions seen so far in glyphs that will be
19017 displayed by this row. */
19019 RECORD_MAX_MIN_POS (it
);
19020 set_iterator_to_next (it
, 1);
19021 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19023 if (!get_next_display_element (it
))
19025 row
->exact_window_width_line_p
= 1;
19026 it
->continuation_lines_width
= 0;
19027 row
->continued_p
= 0;
19028 row
->ends_at_zv_p
= 1;
19030 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19032 row
->continued_p
= 0;
19033 row
->exact_window_width_line_p
= 1;
19037 else if (it
->bidi_p
)
19038 RECORD_MAX_MIN_POS (it
);
19040 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19041 && !FRAME_WINDOW_P (it
->f
))
19043 /* A padding glyph that doesn't fit on this line.
19044 This means the whole character doesn't fit
19046 if (row
->reversed_p
)
19047 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19048 - n_glyphs_before
);
19049 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19051 /* Fill the rest of the row with continuation
19052 glyphs like in 20.x. */
19053 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19054 < row
->glyphs
[1 + TEXT_AREA
])
19055 produce_special_glyphs (it
, IT_CONTINUATION
);
19057 row
->continued_p
= 1;
19058 it
->current_x
= x_before
;
19059 it
->continuation_lines_width
+= x_before
;
19061 /* Restore the height to what it was before the
19062 element not fitting on the line. */
19063 it
->max_ascent
= ascent
;
19064 it
->max_descent
= descent
;
19065 it
->max_phys_ascent
= phys_ascent
;
19066 it
->max_phys_descent
= phys_descent
;
19068 else if (wrap_row_used
> 0)
19071 if (row
->reversed_p
)
19072 unproduce_glyphs (it
,
19073 row
->used
[TEXT_AREA
] - wrap_row_used
);
19074 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19075 it
->continuation_lines_width
+= wrap_x
;
19076 row
->used
[TEXT_AREA
] = wrap_row_used
;
19077 row
->ascent
= wrap_row_ascent
;
19078 row
->height
= wrap_row_height
;
19079 row
->phys_ascent
= wrap_row_phys_ascent
;
19080 row
->phys_height
= wrap_row_phys_height
;
19081 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19082 min_pos
= wrap_row_min_pos
;
19083 min_bpos
= wrap_row_min_bpos
;
19084 max_pos
= wrap_row_max_pos
;
19085 max_bpos
= wrap_row_max_bpos
;
19086 row
->continued_p
= 1;
19087 row
->ends_at_zv_p
= 0;
19088 row
->exact_window_width_line_p
= 0;
19089 it
->continuation_lines_width
+= x
;
19091 /* Make sure that a non-default face is extended
19092 up to the right margin of the window. */
19093 extend_face_to_end_of_line (it
);
19095 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19097 /* A TAB that extends past the right edge of the
19098 window. This produces a single glyph on
19099 window system frames. We leave the glyph in
19100 this row and let it fill the row, but don't
19101 consume the TAB. */
19102 it
->continuation_lines_width
+= it
->last_visible_x
;
19103 row
->ends_in_middle_of_char_p
= 1;
19104 row
->continued_p
= 1;
19105 glyph
->pixel_width
= it
->last_visible_x
- x
;
19106 it
->starts_in_middle_of_char_p
= 1;
19110 /* Something other than a TAB that draws past
19111 the right edge of the window. Restore
19112 positions to values before the element. */
19113 if (row
->reversed_p
)
19114 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19115 - (n_glyphs_before
+ i
));
19116 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19118 /* Display continuation glyphs. */
19119 if (!FRAME_WINDOW_P (it
->f
))
19120 produce_special_glyphs (it
, IT_CONTINUATION
);
19121 row
->continued_p
= 1;
19123 it
->current_x
= x_before
;
19124 it
->continuation_lines_width
+= x
;
19125 extend_face_to_end_of_line (it
);
19127 if (nglyphs
> 1 && i
> 0)
19129 row
->ends_in_middle_of_char_p
= 1;
19130 it
->starts_in_middle_of_char_p
= 1;
19133 /* Restore the height to what it was before the
19134 element not fitting on the line. */
19135 it
->max_ascent
= ascent
;
19136 it
->max_descent
= descent
;
19137 it
->max_phys_ascent
= phys_ascent
;
19138 it
->max_phys_descent
= phys_descent
;
19143 else if (new_x
> it
->first_visible_x
)
19145 /* Increment number of glyphs actually displayed. */
19148 /* Record the maximum and minimum buffer positions
19149 seen so far in glyphs that will be displayed by
19152 RECORD_MAX_MIN_POS (it
);
19154 if (x
< it
->first_visible_x
)
19155 /* Glyph is partially visible, i.e. row starts at
19156 negative X position. */
19157 row
->x
= x
- it
->first_visible_x
;
19161 /* Glyph is completely off the left margin of the
19162 window. This should not happen because of the
19163 move_it_in_display_line at the start of this
19164 function, unless the text display area of the
19165 window is empty. */
19166 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19169 /* Even if this display element produced no glyphs at all,
19170 we want to record its position. */
19171 if (it
->bidi_p
&& nglyphs
== 0)
19172 RECORD_MAX_MIN_POS (it
);
19174 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19175 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19176 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19177 row
->phys_height
= max (row
->phys_height
,
19178 it
->max_phys_ascent
+ it
->max_phys_descent
);
19179 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19180 it
->max_extra_line_spacing
);
19182 /* End of this display line if row is continued. */
19183 if (row
->continued_p
|| row
->ends_at_zv_p
)
19188 /* Is this a line end? If yes, we're also done, after making
19189 sure that a non-default face is extended up to the right
19190 margin of the window. */
19191 if (ITERATOR_AT_END_OF_LINE_P (it
))
19193 int used_before
= row
->used
[TEXT_AREA
];
19195 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19197 /* Add a space at the end of the line that is used to
19198 display the cursor there. */
19199 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19200 append_space_for_newline (it
, 0);
19202 /* Extend the face to the end of the line. */
19203 extend_face_to_end_of_line (it
);
19205 /* Make sure we have the position. */
19206 if (used_before
== 0)
19207 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19209 /* Record the position of the newline, for use in
19211 it
->eol_pos
= it
->current
.pos
;
19213 /* Consume the line end. This skips over invisible lines. */
19214 set_iterator_to_next (it
, 1);
19215 it
->continuation_lines_width
= 0;
19219 /* Proceed with next display element. Note that this skips
19220 over lines invisible because of selective display. */
19221 set_iterator_to_next (it
, 1);
19223 /* If we truncate lines, we are done when the last displayed
19224 glyphs reach past the right margin of the window. */
19225 if (it
->line_wrap
== TRUNCATE
19226 && (FRAME_WINDOW_P (it
->f
)
19227 ? (it
->current_x
>= it
->last_visible_x
)
19228 : (it
->current_x
> it
->last_visible_x
)))
19230 /* Maybe add truncation glyphs. */
19231 if (!FRAME_WINDOW_P (it
->f
))
19235 if (!row
->reversed_p
)
19237 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19238 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19243 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19244 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19246 /* Remove any padding glyphs at the front of ROW, to
19247 make room for the truncation glyphs we will be
19248 adding below. The loop below always inserts at
19249 least one truncation glyph, so also remove the
19250 last glyph added to ROW. */
19251 unproduce_glyphs (it
, i
+ 1);
19252 /* Adjust i for the loop below. */
19253 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19256 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19258 row
->used
[TEXT_AREA
] = i
;
19259 produce_special_glyphs (it
, IT_TRUNCATION
);
19262 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19264 /* Don't truncate if we can overflow newline into fringe. */
19265 if (!get_next_display_element (it
))
19267 it
->continuation_lines_width
= 0;
19268 row
->ends_at_zv_p
= 1;
19269 row
->exact_window_width_line_p
= 1;
19272 if (ITERATOR_AT_END_OF_LINE_P (it
))
19274 row
->exact_window_width_line_p
= 1;
19275 goto at_end_of_line
;
19279 row
->truncated_on_right_p
= 1;
19280 it
->continuation_lines_width
= 0;
19281 reseat_at_next_visible_line_start (it
, 0);
19282 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19283 it
->hpos
= hpos_before
;
19284 it
->current_x
= x_before
;
19290 bidi_unshelve_cache (wrap_data
, 1);
19292 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19293 at the left window margin. */
19294 if (it
->first_visible_x
19295 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19297 if (!FRAME_WINDOW_P (it
->f
))
19298 insert_left_trunc_glyphs (it
);
19299 row
->truncated_on_left_p
= 1;
19302 /* Remember the position at which this line ends.
19304 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19305 cannot be before the call to find_row_edges below, since that is
19306 where these positions are determined. */
19307 row
->end
= it
->current
;
19310 row
->minpos
= row
->start
.pos
;
19311 row
->maxpos
= row
->end
.pos
;
19315 /* ROW->minpos and ROW->maxpos must be the smallest and
19316 `1 + the largest' buffer positions in ROW. But if ROW was
19317 bidi-reordered, these two positions can be anywhere in the
19318 row, so we must determine them now. */
19319 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19322 /* If the start of this line is the overlay arrow-position, then
19323 mark this glyph row as the one containing the overlay arrow.
19324 This is clearly a mess with variable size fonts. It would be
19325 better to let it be displayed like cursors under X. */
19326 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19327 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19328 !NILP (overlay_arrow_string
)))
19330 /* Overlay arrow in window redisplay is a fringe bitmap. */
19331 if (STRINGP (overlay_arrow_string
))
19333 struct glyph_row
*arrow_row
19334 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19335 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19336 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19337 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19338 struct glyph
*p2
, *end
;
19340 /* Copy the arrow glyphs. */
19341 while (glyph
< arrow_end
)
19344 /* Throw away padding glyphs. */
19346 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19347 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19353 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19358 xassert (INTEGERP (overlay_arrow_string
));
19359 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19361 overlay_arrow_seen
= 1;
19364 /* Compute pixel dimensions of this line. */
19365 compute_line_metrics (it
);
19367 /* Record whether this row ends inside an ellipsis. */
19368 row
->ends_in_ellipsis_p
19369 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19370 && it
->ellipsis_p
);
19372 /* Save fringe bitmaps in this row. */
19373 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19374 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19375 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19376 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19378 it
->left_user_fringe_bitmap
= 0;
19379 it
->left_user_fringe_face_id
= 0;
19380 it
->right_user_fringe_bitmap
= 0;
19381 it
->right_user_fringe_face_id
= 0;
19383 /* Maybe set the cursor. */
19384 cvpos
= it
->w
->cursor
.vpos
;
19386 /* In bidi-reordered rows, keep checking for proper cursor
19387 position even if one has been found already, because buffer
19388 positions in such rows change non-linearly with ROW->VPOS,
19389 when a line is continued. One exception: when we are at ZV,
19390 display cursor on the first suitable glyph row, since all
19391 the empty rows after that also have their position set to ZV. */
19392 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19393 lines' rows is implemented for bidi-reordered rows. */
19395 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19396 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19397 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19398 && cursor_row_p (row
))
19399 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19401 /* Highlight trailing whitespace. */
19402 if (!NILP (Vshow_trailing_whitespace
))
19403 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19405 /* Prepare for the next line. This line starts horizontally at (X
19406 HPOS) = (0 0). Vertical positions are incremented. As a
19407 convenience for the caller, IT->glyph_row is set to the next
19409 it
->current_x
= it
->hpos
= 0;
19410 it
->current_y
+= row
->height
;
19411 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19414 /* The next row should by default use the same value of the
19415 reversed_p flag as this one. set_iterator_to_next decides when
19416 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19417 the flag accordingly. */
19418 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19419 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19420 it
->start
= row
->end
;
19421 return row
->displays_text_p
;
19423 #undef RECORD_MAX_MIN_POS
19426 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19427 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19428 doc
: /* Return paragraph direction at point in BUFFER.
19429 Value is either `left-to-right' or `right-to-left'.
19430 If BUFFER is omitted or nil, it defaults to the current buffer.
19432 Paragraph direction determines how the text in the paragraph is displayed.
19433 In left-to-right paragraphs, text begins at the left margin of the window
19434 and the reading direction is generally left to right. In right-to-left
19435 paragraphs, text begins at the right margin and is read from right to left.
19437 See also `bidi-paragraph-direction'. */)
19438 (Lisp_Object buffer
)
19440 struct buffer
*buf
= current_buffer
;
19441 struct buffer
*old
= buf
;
19443 if (! NILP (buffer
))
19445 CHECK_BUFFER (buffer
);
19446 buf
= XBUFFER (buffer
);
19449 if (NILP (BVAR (buf
, bidi_display_reordering
))
19450 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19451 return Qleft_to_right
;
19452 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19453 return BVAR (buf
, bidi_paragraph_direction
);
19456 /* Determine the direction from buffer text. We could try to
19457 use current_matrix if it is up to date, but this seems fast
19458 enough as it is. */
19459 struct bidi_it itb
;
19460 EMACS_INT pos
= BUF_PT (buf
);
19461 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19463 void *itb_data
= bidi_shelve_cache ();
19465 set_buffer_temp (buf
);
19466 /* bidi_paragraph_init finds the base direction of the paragraph
19467 by searching forward from paragraph start. We need the base
19468 direction of the current or _previous_ paragraph, so we need
19469 to make sure we are within that paragraph. To that end, find
19470 the previous non-empty line. */
19471 if (pos
>= ZV
&& pos
> BEGV
)
19474 bytepos
= CHAR_TO_BYTE (pos
);
19476 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19477 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19479 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19480 || c
== ' ' || c
== '\t' || c
== '\f')
19482 if (bytepos
<= BEGV_BYTE
)
19487 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19490 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19491 itb
.paragraph_dir
= NEUTRAL_DIR
;
19492 itb
.string
.s
= NULL
;
19493 itb
.string
.lstring
= Qnil
;
19494 itb
.string
.bufpos
= 0;
19495 itb
.string
.unibyte
= 0;
19496 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19497 bidi_unshelve_cache (itb_data
, 0);
19498 set_buffer_temp (old
);
19499 switch (itb
.paragraph_dir
)
19502 return Qleft_to_right
;
19505 return Qright_to_left
;
19515 /***********************************************************************
19517 ***********************************************************************/
19519 /* Redisplay the menu bar in the frame for window W.
19521 The menu bar of X frames that don't have X toolkit support is
19522 displayed in a special window W->frame->menu_bar_window.
19524 The menu bar of terminal frames is treated specially as far as
19525 glyph matrices are concerned. Menu bar lines are not part of
19526 windows, so the update is done directly on the frame matrix rows
19527 for the menu bar. */
19530 display_menu_bar (struct window
*w
)
19532 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19537 /* Don't do all this for graphical frames. */
19539 if (FRAME_W32_P (f
))
19542 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19548 if (FRAME_NS_P (f
))
19550 #endif /* HAVE_NS */
19552 #ifdef USE_X_TOOLKIT
19553 xassert (!FRAME_WINDOW_P (f
));
19554 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19555 it
.first_visible_x
= 0;
19556 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19557 #else /* not USE_X_TOOLKIT */
19558 if (FRAME_WINDOW_P (f
))
19560 /* Menu bar lines are displayed in the desired matrix of the
19561 dummy window menu_bar_window. */
19562 struct window
*menu_w
;
19563 xassert (WINDOWP (f
->menu_bar_window
));
19564 menu_w
= XWINDOW (f
->menu_bar_window
);
19565 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19567 it
.first_visible_x
= 0;
19568 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19572 /* This is a TTY frame, i.e. character hpos/vpos are used as
19574 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19576 it
.first_visible_x
= 0;
19577 it
.last_visible_x
= FRAME_COLS (f
);
19579 #endif /* not USE_X_TOOLKIT */
19581 /* FIXME: This should be controlled by a user option. See the
19582 comments in redisplay_tool_bar and display_mode_line about
19584 it
.paragraph_embedding
= L2R
;
19586 if (! mode_line_inverse_video
)
19587 /* Force the menu-bar to be displayed in the default face. */
19588 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19590 /* Clear all rows of the menu bar. */
19591 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19593 struct glyph_row
*row
= it
.glyph_row
+ i
;
19594 clear_glyph_row (row
);
19595 row
->enabled_p
= 1;
19596 row
->full_width_p
= 1;
19599 /* Display all items of the menu bar. */
19600 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19601 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19603 Lisp_Object string
;
19605 /* Stop at nil string. */
19606 string
= AREF (items
, i
+ 1);
19610 /* Remember where item was displayed. */
19611 ASET (items
, i
+ 3, make_number (it
.hpos
));
19613 /* Display the item, pad with one space. */
19614 if (it
.current_x
< it
.last_visible_x
)
19615 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19616 SCHARS (string
) + 1, 0, 0, -1);
19619 /* Fill out the line with spaces. */
19620 if (it
.current_x
< it
.last_visible_x
)
19621 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19623 /* Compute the total height of the lines. */
19624 compute_line_metrics (&it
);
19629 /***********************************************************************
19631 ***********************************************************************/
19633 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19634 FORCE is non-zero, redisplay mode lines unconditionally.
19635 Otherwise, redisplay only mode lines that are garbaged. Value is
19636 the number of windows whose mode lines were redisplayed. */
19639 redisplay_mode_lines (Lisp_Object window
, int force
)
19643 while (!NILP (window
))
19645 struct window
*w
= XWINDOW (window
);
19647 if (WINDOWP (w
->hchild
))
19648 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19649 else if (WINDOWP (w
->vchild
))
19650 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19652 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19653 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19655 struct text_pos lpoint
;
19656 struct buffer
*old
= current_buffer
;
19658 /* Set the window's buffer for the mode line display. */
19659 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19660 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19662 /* Point refers normally to the selected window. For any
19663 other window, set up appropriate value. */
19664 if (!EQ (window
, selected_window
))
19666 struct text_pos pt
;
19668 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19669 if (CHARPOS (pt
) < BEGV
)
19670 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19671 else if (CHARPOS (pt
) > (ZV
- 1))
19672 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19674 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19677 /* Display mode lines. */
19678 clear_glyph_matrix (w
->desired_matrix
);
19679 if (display_mode_lines (w
))
19682 w
->must_be_updated_p
= 1;
19685 /* Restore old settings. */
19686 set_buffer_internal_1 (old
);
19687 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19697 /* Display the mode and/or header line of window W. Value is the
19698 sum number of mode lines and header lines displayed. */
19701 display_mode_lines (struct window
*w
)
19703 Lisp_Object old_selected_window
, old_selected_frame
;
19706 old_selected_frame
= selected_frame
;
19707 selected_frame
= w
->frame
;
19708 old_selected_window
= selected_window
;
19709 XSETWINDOW (selected_window
, w
);
19711 /* These will be set while the mode line specs are processed. */
19712 line_number_displayed
= 0;
19713 w
->column_number_displayed
= Qnil
;
19715 if (WINDOW_WANTS_MODELINE_P (w
))
19717 struct window
*sel_w
= XWINDOW (old_selected_window
);
19719 /* Select mode line face based on the real selected window. */
19720 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19721 BVAR (current_buffer
, mode_line_format
));
19725 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19727 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19728 BVAR (current_buffer
, header_line_format
));
19732 selected_frame
= old_selected_frame
;
19733 selected_window
= old_selected_window
;
19738 /* Display mode or header line of window W. FACE_ID specifies which
19739 line to display; it is either MODE_LINE_FACE_ID or
19740 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19741 display. Value is the pixel height of the mode/header line
19745 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19749 int count
= SPECPDL_INDEX ();
19751 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19752 /* Don't extend on a previously drawn mode-line.
19753 This may happen if called from pos_visible_p. */
19754 it
.glyph_row
->enabled_p
= 0;
19755 prepare_desired_row (it
.glyph_row
);
19757 it
.glyph_row
->mode_line_p
= 1;
19759 if (! mode_line_inverse_video
)
19760 /* Force the mode-line to be displayed in the default face. */
19761 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19763 /* FIXME: This should be controlled by a user option. But
19764 supporting such an option is not trivial, since the mode line is
19765 made up of many separate strings. */
19766 it
.paragraph_embedding
= L2R
;
19768 record_unwind_protect (unwind_format_mode_line
,
19769 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19771 mode_line_target
= MODE_LINE_DISPLAY
;
19773 /* Temporarily make frame's keyboard the current kboard so that
19774 kboard-local variables in the mode_line_format will get the right
19776 push_kboard (FRAME_KBOARD (it
.f
));
19777 record_unwind_save_match_data ();
19778 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19781 unbind_to (count
, Qnil
);
19783 /* Fill up with spaces. */
19784 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19786 compute_line_metrics (&it
);
19787 it
.glyph_row
->full_width_p
= 1;
19788 it
.glyph_row
->continued_p
= 0;
19789 it
.glyph_row
->truncated_on_left_p
= 0;
19790 it
.glyph_row
->truncated_on_right_p
= 0;
19792 /* Make a 3D mode-line have a shadow at its right end. */
19793 face
= FACE_FROM_ID (it
.f
, face_id
);
19794 extend_face_to_end_of_line (&it
);
19795 if (face
->box
!= FACE_NO_BOX
)
19797 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19798 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19799 last
->right_box_line_p
= 1;
19802 return it
.glyph_row
->height
;
19805 /* Move element ELT in LIST to the front of LIST.
19806 Return the updated list. */
19809 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19811 register Lisp_Object tail
, prev
;
19812 register Lisp_Object tem
;
19816 while (CONSP (tail
))
19822 /* Splice out the link TAIL. */
19824 list
= XCDR (tail
);
19826 Fsetcdr (prev
, XCDR (tail
));
19828 /* Now make it the first. */
19829 Fsetcdr (tail
, list
);
19834 tail
= XCDR (tail
);
19838 /* Not found--return unchanged LIST. */
19842 /* Contribute ELT to the mode line for window IT->w. How it
19843 translates into text depends on its data type.
19845 IT describes the display environment in which we display, as usual.
19847 DEPTH is the depth in recursion. It is used to prevent
19848 infinite recursion here.
19850 FIELD_WIDTH is the number of characters the display of ELT should
19851 occupy in the mode line, and PRECISION is the maximum number of
19852 characters to display from ELT's representation. See
19853 display_string for details.
19855 Returns the hpos of the end of the text generated by ELT.
19857 PROPS is a property list to add to any string we encounter.
19859 If RISKY is nonzero, remove (disregard) any properties in any string
19860 we encounter, and ignore :eval and :propertize.
19862 The global variable `mode_line_target' determines whether the
19863 output is passed to `store_mode_line_noprop',
19864 `store_mode_line_string', or `display_string'. */
19867 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19868 Lisp_Object elt
, Lisp_Object props
, int risky
)
19870 int n
= 0, field
, prec
;
19875 elt
= build_string ("*too-deep*");
19879 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19883 /* A string: output it and check for %-constructs within it. */
19885 EMACS_INT offset
= 0;
19887 if (SCHARS (elt
) > 0
19888 && (!NILP (props
) || risky
))
19890 Lisp_Object oprops
, aelt
;
19891 oprops
= Ftext_properties_at (make_number (0), elt
);
19893 /* If the starting string's properties are not what
19894 we want, translate the string. Also, if the string
19895 is risky, do that anyway. */
19897 if (NILP (Fequal (props
, oprops
)) || risky
)
19899 /* If the starting string has properties,
19900 merge the specified ones onto the existing ones. */
19901 if (! NILP (oprops
) && !risky
)
19905 oprops
= Fcopy_sequence (oprops
);
19907 while (CONSP (tem
))
19909 oprops
= Fplist_put (oprops
, XCAR (tem
),
19910 XCAR (XCDR (tem
)));
19911 tem
= XCDR (XCDR (tem
));
19916 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19917 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19919 /* AELT is what we want. Move it to the front
19920 without consing. */
19922 mode_line_proptrans_alist
19923 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19929 /* If AELT has the wrong props, it is useless.
19930 so get rid of it. */
19932 mode_line_proptrans_alist
19933 = Fdelq (aelt
, mode_line_proptrans_alist
);
19935 elt
= Fcopy_sequence (elt
);
19936 Fset_text_properties (make_number (0), Flength (elt
),
19938 /* Add this item to mode_line_proptrans_alist. */
19939 mode_line_proptrans_alist
19940 = Fcons (Fcons (elt
, props
),
19941 mode_line_proptrans_alist
);
19942 /* Truncate mode_line_proptrans_alist
19943 to at most 50 elements. */
19944 tem
= Fnthcdr (make_number (50),
19945 mode_line_proptrans_alist
);
19947 XSETCDR (tem
, Qnil
);
19956 prec
= precision
- n
;
19957 switch (mode_line_target
)
19959 case MODE_LINE_NOPROP
:
19960 case MODE_LINE_TITLE
:
19961 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19963 case MODE_LINE_STRING
:
19964 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19966 case MODE_LINE_DISPLAY
:
19967 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19968 0, prec
, 0, STRING_MULTIBYTE (elt
));
19975 /* Handle the non-literal case. */
19977 while ((precision
<= 0 || n
< precision
)
19978 && SREF (elt
, offset
) != 0
19979 && (mode_line_target
!= MODE_LINE_DISPLAY
19980 || it
->current_x
< it
->last_visible_x
))
19982 EMACS_INT last_offset
= offset
;
19984 /* Advance to end of string or next format specifier. */
19985 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19988 if (offset
- 1 != last_offset
)
19990 EMACS_INT nchars
, nbytes
;
19992 /* Output to end of string or up to '%'. Field width
19993 is length of string. Don't output more than
19994 PRECISION allows us. */
19997 prec
= c_string_width (SDATA (elt
) + last_offset
,
19998 offset
- last_offset
, precision
- n
,
20001 switch (mode_line_target
)
20003 case MODE_LINE_NOPROP
:
20004 case MODE_LINE_TITLE
:
20005 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20007 case MODE_LINE_STRING
:
20009 EMACS_INT bytepos
= last_offset
;
20010 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20011 EMACS_INT endpos
= (precision
<= 0
20012 ? string_byte_to_char (elt
, offset
)
20013 : charpos
+ nchars
);
20015 n
+= store_mode_line_string (NULL
,
20016 Fsubstring (elt
, make_number (charpos
),
20017 make_number (endpos
)),
20021 case MODE_LINE_DISPLAY
:
20023 EMACS_INT bytepos
= last_offset
;
20024 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20026 if (precision
<= 0)
20027 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20028 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20030 STRING_MULTIBYTE (elt
));
20035 else /* c == '%' */
20037 EMACS_INT percent_position
= offset
;
20039 /* Get the specified minimum width. Zero means
20042 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20043 field
= field
* 10 + c
- '0';
20045 /* Don't pad beyond the total padding allowed. */
20046 if (field_width
- n
> 0 && field
> field_width
- n
)
20047 field
= field_width
- n
;
20049 /* Note that either PRECISION <= 0 or N < PRECISION. */
20050 prec
= precision
- n
;
20053 n
+= display_mode_element (it
, depth
, field
, prec
,
20054 Vglobal_mode_string
, props
,
20059 EMACS_INT bytepos
, charpos
;
20061 Lisp_Object string
;
20063 bytepos
= percent_position
;
20064 charpos
= (STRING_MULTIBYTE (elt
)
20065 ? string_byte_to_char (elt
, bytepos
)
20067 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20068 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20070 switch (mode_line_target
)
20072 case MODE_LINE_NOPROP
:
20073 case MODE_LINE_TITLE
:
20074 n
+= store_mode_line_noprop (spec
, field
, prec
);
20076 case MODE_LINE_STRING
:
20078 Lisp_Object tem
= build_string (spec
);
20079 props
= Ftext_properties_at (make_number (charpos
), elt
);
20080 /* Should only keep face property in props */
20081 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20084 case MODE_LINE_DISPLAY
:
20086 int nglyphs_before
, nwritten
;
20088 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20089 nwritten
= display_string (spec
, string
, elt
,
20094 /* Assign to the glyphs written above the
20095 string where the `%x' came from, position
20099 struct glyph
*glyph
20100 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20104 for (i
= 0; i
< nwritten
; ++i
)
20106 glyph
[i
].object
= elt
;
20107 glyph
[i
].charpos
= charpos
;
20124 /* A symbol: process the value of the symbol recursively
20125 as if it appeared here directly. Avoid error if symbol void.
20126 Special case: if value of symbol is a string, output the string
20129 register Lisp_Object tem
;
20131 /* If the variable is not marked as risky to set
20132 then its contents are risky to use. */
20133 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20136 tem
= Fboundp (elt
);
20139 tem
= Fsymbol_value (elt
);
20140 /* If value is a string, output that string literally:
20141 don't check for % within it. */
20145 if (!EQ (tem
, elt
))
20147 /* Give up right away for nil or t. */
20157 register Lisp_Object car
, tem
;
20159 /* A cons cell: five distinct cases.
20160 If first element is :eval or :propertize, do something special.
20161 If first element is a string or a cons, process all the elements
20162 and effectively concatenate them.
20163 If first element is a negative number, truncate displaying cdr to
20164 at most that many characters. If positive, pad (with spaces)
20165 to at least that many characters.
20166 If first element is a symbol, process the cadr or caddr recursively
20167 according to whether the symbol's value is non-nil or nil. */
20169 if (EQ (car
, QCeval
))
20171 /* An element of the form (:eval FORM) means evaluate FORM
20172 and use the result as mode line elements. */
20177 if (CONSP (XCDR (elt
)))
20180 spec
= safe_eval (XCAR (XCDR (elt
)));
20181 n
+= display_mode_element (it
, depth
, field_width
- n
,
20182 precision
- n
, spec
, props
,
20186 else if (EQ (car
, QCpropertize
))
20188 /* An element of the form (:propertize ELT PROPS...)
20189 means display ELT but applying properties PROPS. */
20194 if (CONSP (XCDR (elt
)))
20195 n
+= display_mode_element (it
, depth
, field_width
- n
,
20196 precision
- n
, XCAR (XCDR (elt
)),
20197 XCDR (XCDR (elt
)), risky
);
20199 else if (SYMBOLP (car
))
20201 tem
= Fboundp (car
);
20205 /* elt is now the cdr, and we know it is a cons cell.
20206 Use its car if CAR has a non-nil value. */
20209 tem
= Fsymbol_value (car
);
20216 /* Symbol's value is nil (or symbol is unbound)
20217 Get the cddr of the original list
20218 and if possible find the caddr and use that. */
20222 else if (!CONSP (elt
))
20227 else if (INTEGERP (car
))
20229 register int lim
= XINT (car
);
20233 /* Negative int means reduce maximum width. */
20234 if (precision
<= 0)
20237 precision
= min (precision
, -lim
);
20241 /* Padding specified. Don't let it be more than
20242 current maximum. */
20244 lim
= min (precision
, lim
);
20246 /* If that's more padding than already wanted, queue it.
20247 But don't reduce padding already specified even if
20248 that is beyond the current truncation point. */
20249 field_width
= max (lim
, field_width
);
20253 else if (STRINGP (car
) || CONSP (car
))
20255 Lisp_Object halftail
= elt
;
20259 && (precision
<= 0 || n
< precision
))
20261 n
+= display_mode_element (it
, depth
,
20262 /* Do padding only after the last
20263 element in the list. */
20264 (! CONSP (XCDR (elt
))
20267 precision
- n
, XCAR (elt
),
20271 if ((len
& 1) == 0)
20272 halftail
= XCDR (halftail
);
20273 /* Check for cycle. */
20274 if (EQ (halftail
, elt
))
20283 elt
= build_string ("*invalid*");
20287 /* Pad to FIELD_WIDTH. */
20288 if (field_width
> 0 && n
< field_width
)
20290 switch (mode_line_target
)
20292 case MODE_LINE_NOPROP
:
20293 case MODE_LINE_TITLE
:
20294 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20296 case MODE_LINE_STRING
:
20297 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20299 case MODE_LINE_DISPLAY
:
20300 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20309 /* Store a mode-line string element in mode_line_string_list.
20311 If STRING is non-null, display that C string. Otherwise, the Lisp
20312 string LISP_STRING is displayed.
20314 FIELD_WIDTH is the minimum number of output glyphs to produce.
20315 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20316 with spaces. FIELD_WIDTH <= 0 means don't pad.
20318 PRECISION is the maximum number of characters to output from
20319 STRING. PRECISION <= 0 means don't truncate the string.
20321 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20322 properties to the string.
20324 PROPS are the properties to add to the string.
20325 The mode_line_string_face face property is always added to the string.
20329 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20330 int field_width
, int precision
, Lisp_Object props
)
20335 if (string
!= NULL
)
20337 len
= strlen (string
);
20338 if (precision
> 0 && len
> precision
)
20340 lisp_string
= make_string (string
, len
);
20342 props
= mode_line_string_face_prop
;
20343 else if (!NILP (mode_line_string_face
))
20345 Lisp_Object face
= Fplist_get (props
, Qface
);
20346 props
= Fcopy_sequence (props
);
20348 face
= mode_line_string_face
;
20350 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20351 props
= Fplist_put (props
, Qface
, face
);
20353 Fadd_text_properties (make_number (0), make_number (len
),
20354 props
, lisp_string
);
20358 len
= XFASTINT (Flength (lisp_string
));
20359 if (precision
> 0 && len
> precision
)
20362 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20365 if (!NILP (mode_line_string_face
))
20369 props
= Ftext_properties_at (make_number (0), lisp_string
);
20370 face
= Fplist_get (props
, Qface
);
20372 face
= mode_line_string_face
;
20374 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20375 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20377 lisp_string
= Fcopy_sequence (lisp_string
);
20380 Fadd_text_properties (make_number (0), make_number (len
),
20381 props
, lisp_string
);
20386 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20390 if (field_width
> len
)
20392 field_width
-= len
;
20393 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20395 Fadd_text_properties (make_number (0), make_number (field_width
),
20396 props
, lisp_string
);
20397 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20405 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20407 doc
: /* Format a string out of a mode line format specification.
20408 First arg FORMAT specifies the mode line format (see `mode-line-format'
20409 for details) to use.
20411 By default, the format is evaluated for the currently selected window.
20413 Optional second arg FACE specifies the face property to put on all
20414 characters for which no face is specified. The value nil means the
20415 default face. The value t means whatever face the window's mode line
20416 currently uses (either `mode-line' or `mode-line-inactive',
20417 depending on whether the window is the selected window or not).
20418 An integer value means the value string has no text
20421 Optional third and fourth args WINDOW and BUFFER specify the window
20422 and buffer to use as the context for the formatting (defaults
20423 are the selected window and the WINDOW's buffer). */)
20424 (Lisp_Object format
, Lisp_Object face
,
20425 Lisp_Object window
, Lisp_Object buffer
)
20430 struct buffer
*old_buffer
= NULL
;
20432 int no_props
= INTEGERP (face
);
20433 int count
= SPECPDL_INDEX ();
20435 int string_start
= 0;
20438 window
= selected_window
;
20439 CHECK_WINDOW (window
);
20440 w
= XWINDOW (window
);
20443 buffer
= w
->buffer
;
20444 CHECK_BUFFER (buffer
);
20446 /* Make formatting the modeline a non-op when noninteractive, otherwise
20447 there will be problems later caused by a partially initialized frame. */
20448 if (NILP (format
) || noninteractive
)
20449 return empty_unibyte_string
;
20454 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20455 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20456 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20457 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20458 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20459 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20460 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20463 if (XBUFFER (buffer
) != current_buffer
)
20464 old_buffer
= current_buffer
;
20466 /* Save things including mode_line_proptrans_alist,
20467 and set that to nil so that we don't alter the outer value. */
20468 record_unwind_protect (unwind_format_mode_line
,
20469 format_mode_line_unwind_data
20470 (old_buffer
, selected_window
, 1));
20471 mode_line_proptrans_alist
= Qnil
;
20473 Fselect_window (window
, Qt
);
20475 set_buffer_internal_1 (XBUFFER (buffer
));
20477 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20481 mode_line_target
= MODE_LINE_NOPROP
;
20482 mode_line_string_face_prop
= Qnil
;
20483 mode_line_string_list
= Qnil
;
20484 string_start
= MODE_LINE_NOPROP_LEN (0);
20488 mode_line_target
= MODE_LINE_STRING
;
20489 mode_line_string_list
= Qnil
;
20490 mode_line_string_face
= face
;
20491 mode_line_string_face_prop
20492 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20495 push_kboard (FRAME_KBOARD (it
.f
));
20496 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20501 len
= MODE_LINE_NOPROP_LEN (string_start
);
20502 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20506 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20507 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20508 empty_unibyte_string
);
20511 unbind_to (count
, Qnil
);
20515 /* Write a null-terminated, right justified decimal representation of
20516 the positive integer D to BUF using a minimal field width WIDTH. */
20519 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20521 register char *p
= buf
;
20529 *p
++ = d
% 10 + '0';
20534 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20545 /* Write a null-terminated, right justified decimal and "human
20546 readable" representation of the nonnegative integer D to BUF using
20547 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20549 static const char power_letter
[] =
20563 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20565 /* We aim to represent the nonnegative integer D as
20566 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20567 EMACS_INT quotient
= d
;
20569 /* -1 means: do not use TENTHS. */
20573 /* Length of QUOTIENT.TENTHS as a string. */
20579 if (1000 <= quotient
)
20581 /* Scale to the appropriate EXPONENT. */
20584 remainder
= quotient
% 1000;
20588 while (1000 <= quotient
);
20590 /* Round to nearest and decide whether to use TENTHS or not. */
20593 tenths
= remainder
/ 100;
20594 if (50 <= remainder
% 100)
20601 if (quotient
== 10)
20609 if (500 <= remainder
)
20611 if (quotient
< 999)
20622 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20623 if (tenths
== -1 && quotient
<= 99)
20630 p
= psuffix
= buf
+ max (width
, length
);
20632 /* Print EXPONENT. */
20633 *psuffix
++ = power_letter
[exponent
];
20636 /* Print TENTHS. */
20639 *--p
= '0' + tenths
;
20643 /* Print QUOTIENT. */
20646 int digit
= quotient
% 10;
20647 *--p
= '0' + digit
;
20649 while ((quotient
/= 10) != 0);
20651 /* Print leading spaces. */
20656 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20657 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20658 type of CODING_SYSTEM. Return updated pointer into BUF. */
20660 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20663 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20666 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20667 const unsigned char *eol_str
;
20669 /* The EOL conversion we are using. */
20670 Lisp_Object eoltype
;
20672 val
= CODING_SYSTEM_SPEC (coding_system
);
20675 if (!VECTORP (val
)) /* Not yet decided. */
20680 eoltype
= eol_mnemonic_undecided
;
20681 /* Don't mention EOL conversion if it isn't decided. */
20686 Lisp_Object eolvalue
;
20688 attrs
= AREF (val
, 0);
20689 eolvalue
= AREF (val
, 2);
20692 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20696 /* The EOL conversion that is normal on this system. */
20698 if (NILP (eolvalue
)) /* Not yet decided. */
20699 eoltype
= eol_mnemonic_undecided
;
20700 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20701 eoltype
= eol_mnemonic_undecided
;
20702 else /* eolvalue is Qunix, Qdos, or Qmac. */
20703 eoltype
= (EQ (eolvalue
, Qunix
)
20704 ? eol_mnemonic_unix
20705 : (EQ (eolvalue
, Qdos
) == 1
20706 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20712 /* Mention the EOL conversion if it is not the usual one. */
20713 if (STRINGP (eoltype
))
20715 eol_str
= SDATA (eoltype
);
20716 eol_str_len
= SBYTES (eoltype
);
20718 else if (CHARACTERP (eoltype
))
20720 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20721 int c
= XFASTINT (eoltype
);
20722 eol_str_len
= CHAR_STRING (c
, tmp
);
20727 eol_str
= invalid_eol_type
;
20728 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20730 memcpy (buf
, eol_str
, eol_str_len
);
20731 buf
+= eol_str_len
;
20737 /* Return a string for the output of a mode line %-spec for window W,
20738 generated by character C. FIELD_WIDTH > 0 means pad the string
20739 returned with spaces to that value. Return a Lisp string in
20740 *STRING if the resulting string is taken from that Lisp string.
20742 Note we operate on the current buffer for most purposes,
20743 the exception being w->base_line_pos. */
20745 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20747 static const char *
20748 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20749 Lisp_Object
*string
)
20752 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20753 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20754 struct buffer
*b
= current_buffer
;
20762 if (!NILP (BVAR (b
, read_only
)))
20764 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20769 /* This differs from %* only for a modified read-only buffer. */
20770 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20772 if (!NILP (BVAR (b
, read_only
)))
20777 /* This differs from %* in ignoring read-only-ness. */
20778 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20790 if (command_loop_level
> 5)
20792 p
= decode_mode_spec_buf
;
20793 for (i
= 0; i
< command_loop_level
; i
++)
20796 return decode_mode_spec_buf
;
20804 if (command_loop_level
> 5)
20806 p
= decode_mode_spec_buf
;
20807 for (i
= 0; i
< command_loop_level
; i
++)
20810 return decode_mode_spec_buf
;
20817 /* Let lots_of_dashes be a string of infinite length. */
20818 if (mode_line_target
== MODE_LINE_NOPROP
||
20819 mode_line_target
== MODE_LINE_STRING
)
20821 if (field_width
<= 0
20822 || field_width
> sizeof (lots_of_dashes
))
20824 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20825 decode_mode_spec_buf
[i
] = '-';
20826 decode_mode_spec_buf
[i
] = '\0';
20827 return decode_mode_spec_buf
;
20830 return lots_of_dashes
;
20834 obj
= BVAR (b
, name
);
20838 /* %c and %l are ignored in `frame-title-format'.
20839 (In redisplay_internal, the frame title is drawn _before_ the
20840 windows are updated, so the stuff which depends on actual
20841 window contents (such as %l) may fail to render properly, or
20842 even crash emacs.) */
20843 if (mode_line_target
== MODE_LINE_TITLE
)
20847 EMACS_INT col
= current_column ();
20848 w
->column_number_displayed
= make_number (col
);
20849 pint2str (decode_mode_spec_buf
, field_width
, col
);
20850 return decode_mode_spec_buf
;
20854 #ifndef SYSTEM_MALLOC
20856 if (NILP (Vmemory_full
))
20859 return "!MEM FULL! ";
20866 /* %F displays the frame name. */
20867 if (!NILP (f
->title
))
20868 return SSDATA (f
->title
);
20869 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20870 return SSDATA (f
->name
);
20874 obj
= BVAR (b
, filename
);
20879 EMACS_INT size
= ZV
- BEGV
;
20880 pint2str (decode_mode_spec_buf
, field_width
, size
);
20881 return decode_mode_spec_buf
;
20886 EMACS_INT size
= ZV
- BEGV
;
20887 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20888 return decode_mode_spec_buf
;
20893 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20894 EMACS_INT topline
, nlines
, height
;
20897 /* %c and %l are ignored in `frame-title-format'. */
20898 if (mode_line_target
== MODE_LINE_TITLE
)
20901 startpos
= XMARKER (w
->start
)->charpos
;
20902 startpos_byte
= marker_byte_position (w
->start
);
20903 height
= WINDOW_TOTAL_LINES (w
);
20905 /* If we decided that this buffer isn't suitable for line numbers,
20906 don't forget that too fast. */
20907 if (EQ (w
->base_line_pos
, w
->buffer
))
20909 /* But do forget it, if the window shows a different buffer now. */
20910 else if (BUFFERP (w
->base_line_pos
))
20911 w
->base_line_pos
= Qnil
;
20913 /* If the buffer is very big, don't waste time. */
20914 if (INTEGERP (Vline_number_display_limit
)
20915 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20917 w
->base_line_pos
= Qnil
;
20918 w
->base_line_number
= Qnil
;
20922 if (INTEGERP (w
->base_line_number
)
20923 && INTEGERP (w
->base_line_pos
)
20924 && XFASTINT (w
->base_line_pos
) <= startpos
)
20926 line
= XFASTINT (w
->base_line_number
);
20927 linepos
= XFASTINT (w
->base_line_pos
);
20928 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20933 linepos
= BUF_BEGV (b
);
20934 linepos_byte
= BUF_BEGV_BYTE (b
);
20937 /* Count lines from base line to window start position. */
20938 nlines
= display_count_lines (linepos_byte
,
20942 topline
= nlines
+ line
;
20944 /* Determine a new base line, if the old one is too close
20945 or too far away, or if we did not have one.
20946 "Too close" means it's plausible a scroll-down would
20947 go back past it. */
20948 if (startpos
== BUF_BEGV (b
))
20950 w
->base_line_number
= make_number (topline
);
20951 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20953 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20954 || linepos
== BUF_BEGV (b
))
20956 EMACS_INT limit
= BUF_BEGV (b
);
20957 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20958 EMACS_INT position
;
20959 EMACS_INT distance
=
20960 (height
* 2 + 30) * line_number_display_limit_width
;
20962 if (startpos
- distance
> limit
)
20964 limit
= startpos
- distance
;
20965 limit_byte
= CHAR_TO_BYTE (limit
);
20968 nlines
= display_count_lines (startpos_byte
,
20970 - (height
* 2 + 30),
20972 /* If we couldn't find the lines we wanted within
20973 line_number_display_limit_width chars per line,
20974 give up on line numbers for this window. */
20975 if (position
== limit_byte
&& limit
== startpos
- distance
)
20977 w
->base_line_pos
= w
->buffer
;
20978 w
->base_line_number
= Qnil
;
20982 w
->base_line_number
= make_number (topline
- nlines
);
20983 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20986 /* Now count lines from the start pos to point. */
20987 nlines
= display_count_lines (startpos_byte
,
20988 PT_BYTE
, PT
, &junk
);
20990 /* Record that we did display the line number. */
20991 line_number_displayed
= 1;
20993 /* Make the string to show. */
20994 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20995 return decode_mode_spec_buf
;
20998 char* p
= decode_mode_spec_buf
;
20999 int pad
= field_width
- 2;
21005 return decode_mode_spec_buf
;
21011 obj
= BVAR (b
, mode_name
);
21015 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21021 EMACS_INT pos
= marker_position (w
->start
);
21022 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21024 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21026 if (pos
<= BUF_BEGV (b
))
21031 else if (pos
<= BUF_BEGV (b
))
21035 if (total
> 1000000)
21036 /* Do it differently for a large value, to avoid overflow. */
21037 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21039 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21040 /* We can't normally display a 3-digit number,
21041 so get us a 2-digit number that is close. */
21044 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21045 return decode_mode_spec_buf
;
21049 /* Display percentage of size above the bottom of the screen. */
21052 EMACS_INT toppos
= marker_position (w
->start
);
21053 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21054 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21056 if (botpos
>= BUF_ZV (b
))
21058 if (toppos
<= BUF_BEGV (b
))
21065 if (total
> 1000000)
21066 /* Do it differently for a large value, to avoid overflow. */
21067 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21069 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21070 /* We can't normally display a 3-digit number,
21071 so get us a 2-digit number that is close. */
21074 if (toppos
<= BUF_BEGV (b
))
21075 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21077 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21078 return decode_mode_spec_buf
;
21083 /* status of process */
21084 obj
= Fget_buffer_process (Fcurrent_buffer ());
21086 return "no process";
21088 obj
= Fsymbol_name (Fprocess_status (obj
));
21094 int count
= inhibit_garbage_collection ();
21095 Lisp_Object val
= call1 (intern ("file-remote-p"),
21096 BVAR (current_buffer
, directory
));
21097 unbind_to (count
, Qnil
);
21105 case 't': /* indicate TEXT or BINARY */
21109 /* coding-system (not including end-of-line format) */
21111 /* coding-system (including end-of-line type) */
21113 int eol_flag
= (c
== 'Z');
21114 char *p
= decode_mode_spec_buf
;
21116 if (! FRAME_WINDOW_P (f
))
21118 /* No need to mention EOL here--the terminal never needs
21119 to do EOL conversion. */
21120 p
= decode_mode_spec_coding (CODING_ID_NAME
21121 (FRAME_KEYBOARD_CODING (f
)->id
),
21123 p
= decode_mode_spec_coding (CODING_ID_NAME
21124 (FRAME_TERMINAL_CODING (f
)->id
),
21127 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21130 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21131 #ifdef subprocesses
21132 obj
= Fget_buffer_process (Fcurrent_buffer ());
21133 if (PROCESSP (obj
))
21135 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21137 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21140 #endif /* subprocesses */
21143 return decode_mode_spec_buf
;
21150 return SSDATA (obj
);
21157 /* Count up to COUNT lines starting from START_BYTE.
21158 But don't go beyond LIMIT_BYTE.
21159 Return the number of lines thus found (always nonnegative).
21161 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21164 display_count_lines (EMACS_INT start_byte
,
21165 EMACS_INT limit_byte
, EMACS_INT count
,
21166 EMACS_INT
*byte_pos_ptr
)
21168 register unsigned char *cursor
;
21169 unsigned char *base
;
21171 register EMACS_INT ceiling
;
21172 register unsigned char *ceiling_addr
;
21173 EMACS_INT orig_count
= count
;
21175 /* If we are not in selective display mode,
21176 check only for newlines. */
21177 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21178 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21182 while (start_byte
< limit_byte
)
21184 ceiling
= BUFFER_CEILING_OF (start_byte
);
21185 ceiling
= min (limit_byte
- 1, ceiling
);
21186 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21187 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21190 if (selective_display
)
21191 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21194 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21197 if (cursor
!= ceiling_addr
)
21201 start_byte
+= cursor
- base
+ 1;
21202 *byte_pos_ptr
= start_byte
;
21206 if (++cursor
== ceiling_addr
)
21212 start_byte
+= cursor
- base
;
21217 while (start_byte
> limit_byte
)
21219 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21220 ceiling
= max (limit_byte
, ceiling
);
21221 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21222 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21225 if (selective_display
)
21226 while (--cursor
!= ceiling_addr
21227 && *cursor
!= '\n' && *cursor
!= 015)
21230 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21233 if (cursor
!= ceiling_addr
)
21237 start_byte
+= cursor
- base
+ 1;
21238 *byte_pos_ptr
= start_byte
;
21239 /* When scanning backwards, we should
21240 not count the newline posterior to which we stop. */
21241 return - orig_count
- 1;
21247 /* Here we add 1 to compensate for the last decrement
21248 of CURSOR, which took it past the valid range. */
21249 start_byte
+= cursor
- base
+ 1;
21253 *byte_pos_ptr
= limit_byte
;
21256 return - orig_count
+ count
;
21257 return orig_count
- count
;
21263 /***********************************************************************
21265 ***********************************************************************/
21267 /* Display a NUL-terminated string, starting with index START.
21269 If STRING is non-null, display that C string. Otherwise, the Lisp
21270 string LISP_STRING is displayed. There's a case that STRING is
21271 non-null and LISP_STRING is not nil. It means STRING is a string
21272 data of LISP_STRING. In that case, we display LISP_STRING while
21273 ignoring its text properties.
21275 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21276 FACE_STRING. Display STRING or LISP_STRING with the face at
21277 FACE_STRING_POS in FACE_STRING:
21279 Display the string in the environment given by IT, but use the
21280 standard display table, temporarily.
21282 FIELD_WIDTH is the minimum number of output glyphs to produce.
21283 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21284 with spaces. If STRING has more characters, more than FIELD_WIDTH
21285 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21287 PRECISION is the maximum number of characters to output from
21288 STRING. PRECISION < 0 means don't truncate the string.
21290 This is roughly equivalent to printf format specifiers:
21292 FIELD_WIDTH PRECISION PRINTF
21293 ----------------------------------------
21299 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21300 display them, and < 0 means obey the current buffer's value of
21301 enable_multibyte_characters.
21303 Value is the number of columns displayed. */
21306 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21307 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21308 int field_width
, int precision
, int max_x
, int multibyte
)
21310 int hpos_at_start
= it
->hpos
;
21311 int saved_face_id
= it
->face_id
;
21312 struct glyph_row
*row
= it
->glyph_row
;
21313 EMACS_INT it_charpos
;
21315 /* Initialize the iterator IT for iteration over STRING beginning
21316 with index START. */
21317 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21318 precision
, field_width
, multibyte
);
21319 if (string
&& STRINGP (lisp_string
))
21320 /* LISP_STRING is the one returned by decode_mode_spec. We should
21321 ignore its text properties. */
21322 it
->stop_charpos
= it
->end_charpos
;
21324 /* If displaying STRING, set up the face of the iterator from
21325 FACE_STRING, if that's given. */
21326 if (STRINGP (face_string
))
21332 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21333 0, it
->region_beg_charpos
,
21334 it
->region_end_charpos
,
21335 &endptr
, it
->base_face_id
, 0);
21336 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21337 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21340 /* Set max_x to the maximum allowed X position. Don't let it go
21341 beyond the right edge of the window. */
21343 max_x
= it
->last_visible_x
;
21345 max_x
= min (max_x
, it
->last_visible_x
);
21347 /* Skip over display elements that are not visible. because IT->w is
21349 if (it
->current_x
< it
->first_visible_x
)
21350 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21351 MOVE_TO_POS
| MOVE_TO_X
);
21353 row
->ascent
= it
->max_ascent
;
21354 row
->height
= it
->max_ascent
+ it
->max_descent
;
21355 row
->phys_ascent
= it
->max_phys_ascent
;
21356 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21357 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21359 if (STRINGP (it
->string
))
21360 it_charpos
= IT_STRING_CHARPOS (*it
);
21362 it_charpos
= IT_CHARPOS (*it
);
21364 /* This condition is for the case that we are called with current_x
21365 past last_visible_x. */
21366 while (it
->current_x
< max_x
)
21368 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21370 /* Get the next display element. */
21371 if (!get_next_display_element (it
))
21374 /* Produce glyphs. */
21375 x_before
= it
->current_x
;
21376 n_glyphs_before
= row
->used
[TEXT_AREA
];
21377 PRODUCE_GLYPHS (it
);
21379 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21382 while (i
< nglyphs
)
21384 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21386 if (it
->line_wrap
!= TRUNCATE
21387 && x
+ glyph
->pixel_width
> max_x
)
21389 /* End of continued line or max_x reached. */
21390 if (CHAR_GLYPH_PADDING_P (*glyph
))
21392 /* A wide character is unbreakable. */
21393 if (row
->reversed_p
)
21394 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21395 - n_glyphs_before
);
21396 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21397 it
->current_x
= x_before
;
21401 if (row
->reversed_p
)
21402 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21403 - (n_glyphs_before
+ i
));
21404 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21409 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21411 /* Glyph is at least partially visible. */
21413 if (x
< it
->first_visible_x
)
21414 row
->x
= x
- it
->first_visible_x
;
21418 /* Glyph is off the left margin of the display area.
21419 Should not happen. */
21423 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21424 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21425 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21426 row
->phys_height
= max (row
->phys_height
,
21427 it
->max_phys_ascent
+ it
->max_phys_descent
);
21428 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21429 it
->max_extra_line_spacing
);
21430 x
+= glyph
->pixel_width
;
21434 /* Stop if max_x reached. */
21438 /* Stop at line ends. */
21439 if (ITERATOR_AT_END_OF_LINE_P (it
))
21441 it
->continuation_lines_width
= 0;
21445 set_iterator_to_next (it
, 1);
21446 if (STRINGP (it
->string
))
21447 it_charpos
= IT_STRING_CHARPOS (*it
);
21449 it_charpos
= IT_CHARPOS (*it
);
21451 /* Stop if truncating at the right edge. */
21452 if (it
->line_wrap
== TRUNCATE
21453 && it
->current_x
>= it
->last_visible_x
)
21455 /* Add truncation mark, but don't do it if the line is
21456 truncated at a padding space. */
21457 if (it_charpos
< it
->string_nchars
)
21459 if (!FRAME_WINDOW_P (it
->f
))
21463 if (it
->current_x
> it
->last_visible_x
)
21465 if (!row
->reversed_p
)
21467 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21468 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21473 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21474 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21476 unproduce_glyphs (it
, ii
+ 1);
21477 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21479 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21481 row
->used
[TEXT_AREA
] = ii
;
21482 produce_special_glyphs (it
, IT_TRUNCATION
);
21485 produce_special_glyphs (it
, IT_TRUNCATION
);
21487 row
->truncated_on_right_p
= 1;
21493 /* Maybe insert a truncation at the left. */
21494 if (it
->first_visible_x
21497 if (!FRAME_WINDOW_P (it
->f
))
21498 insert_left_trunc_glyphs (it
);
21499 row
->truncated_on_left_p
= 1;
21502 it
->face_id
= saved_face_id
;
21504 /* Value is number of columns displayed. */
21505 return it
->hpos
- hpos_at_start
;
21510 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21511 appears as an element of LIST or as the car of an element of LIST.
21512 If PROPVAL is a list, compare each element against LIST in that
21513 way, and return 1/2 if any element of PROPVAL is found in LIST.
21514 Otherwise return 0. This function cannot quit.
21515 The return value is 2 if the text is invisible but with an ellipsis
21516 and 1 if it's invisible and without an ellipsis. */
21519 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21521 register Lisp_Object tail
, proptail
;
21523 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21525 register Lisp_Object tem
;
21527 if (EQ (propval
, tem
))
21529 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21530 return NILP (XCDR (tem
)) ? 1 : 2;
21533 if (CONSP (propval
))
21535 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21537 Lisp_Object propelt
;
21538 propelt
= XCAR (proptail
);
21539 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21541 register Lisp_Object tem
;
21543 if (EQ (propelt
, tem
))
21545 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21546 return NILP (XCDR (tem
)) ? 1 : 2;
21554 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21555 doc
: /* Non-nil if the property makes the text invisible.
21556 POS-OR-PROP can be a marker or number, in which case it is taken to be
21557 a position in the current buffer and the value of the `invisible' property
21558 is checked; or it can be some other value, which is then presumed to be the
21559 value of the `invisible' property of the text of interest.
21560 The non-nil value returned can be t for truly invisible text or something
21561 else if the text is replaced by an ellipsis. */)
21562 (Lisp_Object pos_or_prop
)
21565 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21566 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21568 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21569 return (invis
== 0 ? Qnil
21571 : make_number (invis
));
21574 /* Calculate a width or height in pixels from a specification using
21575 the following elements:
21578 NUM - a (fractional) multiple of the default font width/height
21579 (NUM) - specifies exactly NUM pixels
21580 UNIT - a fixed number of pixels, see below.
21581 ELEMENT - size of a display element in pixels, see below.
21582 (NUM . SPEC) - equals NUM * SPEC
21583 (+ SPEC SPEC ...) - add pixel values
21584 (- SPEC SPEC ...) - subtract pixel values
21585 (- SPEC) - negate pixel value
21588 INT or FLOAT - a number constant
21589 SYMBOL - use symbol's (buffer local) variable binding.
21592 in - pixels per inch *)
21593 mm - pixels per 1/1000 meter *)
21594 cm - pixels per 1/100 meter *)
21595 width - width of current font in pixels.
21596 height - height of current font in pixels.
21598 *) using the ratio(s) defined in display-pixels-per-inch.
21602 left-fringe - left fringe width in pixels
21603 right-fringe - right fringe width in pixels
21605 left-margin - left margin width in pixels
21606 right-margin - right margin width in pixels
21608 scroll-bar - scroll-bar area width in pixels
21612 Pixels corresponding to 5 inches:
21615 Total width of non-text areas on left side of window (if scroll-bar is on left):
21616 '(space :width (+ left-fringe left-margin scroll-bar))
21618 Align to first text column (in header line):
21619 '(space :align-to 0)
21621 Align to middle of text area minus half the width of variable `my-image'
21622 containing a loaded image:
21623 '(space :align-to (0.5 . (- text my-image)))
21625 Width of left margin minus width of 1 character in the default font:
21626 '(space :width (- left-margin 1))
21628 Width of left margin minus width of 2 characters in the current font:
21629 '(space :width (- left-margin (2 . width)))
21631 Center 1 character over left-margin (in header line):
21632 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21634 Different ways to express width of left fringe plus left margin minus one pixel:
21635 '(space :width (- (+ left-fringe left-margin) (1)))
21636 '(space :width (+ left-fringe left-margin (- (1))))
21637 '(space :width (+ left-fringe left-margin (-1)))
21641 #define NUMVAL(X) \
21642 ((INTEGERP (X) || FLOATP (X)) \
21647 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21648 struct font
*font
, int width_p
, int *align_to
)
21652 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21653 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21656 return OK_PIXELS (0);
21658 xassert (FRAME_LIVE_P (it
->f
));
21660 if (SYMBOLP (prop
))
21662 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21664 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21666 if (unit
[0] == 'i' && unit
[1] == 'n')
21668 else if (unit
[0] == 'm' && unit
[1] == 'm')
21670 else if (unit
[0] == 'c' && unit
[1] == 'm')
21677 #ifdef HAVE_WINDOW_SYSTEM
21678 if (FRAME_WINDOW_P (it
->f
)
21680 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21681 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21683 return OK_PIXELS (ppi
/ pixels
);
21686 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21687 || (CONSP (Vdisplay_pixels_per_inch
)
21689 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21690 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21692 return OK_PIXELS (ppi
/ pixels
);
21698 #ifdef HAVE_WINDOW_SYSTEM
21699 if (EQ (prop
, Qheight
))
21700 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21701 if (EQ (prop
, Qwidth
))
21702 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21704 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21705 return OK_PIXELS (1);
21708 if (EQ (prop
, Qtext
))
21709 return OK_PIXELS (width_p
21710 ? window_box_width (it
->w
, TEXT_AREA
)
21711 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21713 if (align_to
&& *align_to
< 0)
21716 if (EQ (prop
, Qleft
))
21717 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21718 if (EQ (prop
, Qright
))
21719 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21720 if (EQ (prop
, Qcenter
))
21721 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21722 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21723 if (EQ (prop
, Qleft_fringe
))
21724 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21725 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21726 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21727 if (EQ (prop
, Qright_fringe
))
21728 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21729 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21730 : window_box_right_offset (it
->w
, TEXT_AREA
));
21731 if (EQ (prop
, Qleft_margin
))
21732 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21733 if (EQ (prop
, Qright_margin
))
21734 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21735 if (EQ (prop
, Qscroll_bar
))
21736 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21738 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21739 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21740 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21745 if (EQ (prop
, Qleft_fringe
))
21746 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21747 if (EQ (prop
, Qright_fringe
))
21748 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21749 if (EQ (prop
, Qleft_margin
))
21750 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21751 if (EQ (prop
, Qright_margin
))
21752 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21753 if (EQ (prop
, Qscroll_bar
))
21754 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21757 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21760 if (INTEGERP (prop
) || FLOATP (prop
))
21762 int base_unit
= (width_p
21763 ? FRAME_COLUMN_WIDTH (it
->f
)
21764 : FRAME_LINE_HEIGHT (it
->f
));
21765 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21770 Lisp_Object car
= XCAR (prop
);
21771 Lisp_Object cdr
= XCDR (prop
);
21775 #ifdef HAVE_WINDOW_SYSTEM
21776 if (FRAME_WINDOW_P (it
->f
)
21777 && valid_image_p (prop
))
21779 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21780 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21782 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21785 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21791 while (CONSP (cdr
))
21793 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21794 font
, width_p
, align_to
))
21797 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21802 if (EQ (car
, Qminus
))
21804 return OK_PIXELS (pixels
);
21807 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21810 if (INTEGERP (car
) || FLOATP (car
))
21813 pixels
= XFLOATINT (car
);
21815 return OK_PIXELS (pixels
);
21816 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21817 font
, width_p
, align_to
))
21818 return OK_PIXELS (pixels
* fact
);
21829 /***********************************************************************
21831 ***********************************************************************/
21833 #ifdef HAVE_WINDOW_SYSTEM
21838 dump_glyph_string (struct glyph_string
*s
)
21840 fprintf (stderr
, "glyph string\n");
21841 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21842 s
->x
, s
->y
, s
->width
, s
->height
);
21843 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21844 fprintf (stderr
, " hl = %d\n", s
->hl
);
21845 fprintf (stderr
, " left overhang = %d, right = %d\n",
21846 s
->left_overhang
, s
->right_overhang
);
21847 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21848 fprintf (stderr
, " extends to end of line = %d\n",
21849 s
->extends_to_end_of_line_p
);
21850 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21851 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21854 #endif /* GLYPH_DEBUG */
21856 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21857 of XChar2b structures for S; it can't be allocated in
21858 init_glyph_string because it must be allocated via `alloca'. W
21859 is the window on which S is drawn. ROW and AREA are the glyph row
21860 and area within the row from which S is constructed. START is the
21861 index of the first glyph structure covered by S. HL is a
21862 face-override for drawing S. */
21865 #define OPTIONAL_HDC(hdc) HDC hdc,
21866 #define DECLARE_HDC(hdc) HDC hdc;
21867 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21868 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21871 #ifndef OPTIONAL_HDC
21872 #define OPTIONAL_HDC(hdc)
21873 #define DECLARE_HDC(hdc)
21874 #define ALLOCATE_HDC(hdc, f)
21875 #define RELEASE_HDC(hdc, f)
21879 init_glyph_string (struct glyph_string
*s
,
21881 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21882 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21884 memset (s
, 0, sizeof *s
);
21886 s
->f
= XFRAME (w
->frame
);
21890 s
->display
= FRAME_X_DISPLAY (s
->f
);
21891 s
->window
= FRAME_X_WINDOW (s
->f
);
21892 s
->char2b
= char2b
;
21896 s
->first_glyph
= row
->glyphs
[area
] + start
;
21897 s
->height
= row
->height
;
21898 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21899 s
->ybase
= s
->y
+ row
->ascent
;
21903 /* Append the list of glyph strings with head H and tail T to the list
21904 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21907 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21908 struct glyph_string
*h
, struct glyph_string
*t
)
21922 /* Prepend the list of glyph strings with head H and tail T to the
21923 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21927 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21928 struct glyph_string
*h
, struct glyph_string
*t
)
21942 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21943 Set *HEAD and *TAIL to the resulting list. */
21946 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21947 struct glyph_string
*s
)
21949 s
->next
= s
->prev
= NULL
;
21950 append_glyph_string_lists (head
, tail
, s
, s
);
21954 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21955 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21956 make sure that X resources for the face returned are allocated.
21957 Value is a pointer to a realized face that is ready for display if
21958 DISPLAY_P is non-zero. */
21960 static inline struct face
*
21961 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21962 XChar2b
*char2b
, int display_p
)
21964 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21968 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21970 if (code
!= FONT_INVALID_CODE
)
21971 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21973 STORE_XCHAR2B (char2b
, 0, 0);
21976 /* Make sure X resources of the face are allocated. */
21977 #ifdef HAVE_X_WINDOWS
21981 xassert (face
!= NULL
);
21982 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21989 /* Get face and two-byte form of character glyph GLYPH on frame F.
21990 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21991 a pointer to a realized face that is ready for display. */
21993 static inline struct face
*
21994 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21995 XChar2b
*char2b
, int *two_byte_p
)
21999 xassert (glyph
->type
== CHAR_GLYPH
);
22000 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22009 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22010 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22012 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22014 if (code
!= FONT_INVALID_CODE
)
22015 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22017 STORE_XCHAR2B (char2b
, 0, 0);
22020 /* Make sure X resources of the face are allocated. */
22021 xassert (face
!= NULL
);
22022 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22027 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22028 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
22031 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22035 if (CHAR_BYTE8_P (c
))
22036 code
= CHAR_TO_BYTE8 (c
);
22038 code
= font
->driver
->encode_char (font
, c
);
22040 if (code
== FONT_INVALID_CODE
)
22042 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22047 /* Fill glyph string S with composition components specified by S->cmp.
22049 BASE_FACE is the base face of the composition.
22050 S->cmp_from is the index of the first component for S.
22052 OVERLAPS non-zero means S should draw the foreground only, and use
22053 its physical height for clipping. See also draw_glyphs.
22055 Value is the index of a component not in S. */
22058 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22062 /* For all glyphs of this composition, starting at the offset
22063 S->cmp_from, until we reach the end of the definition or encounter a
22064 glyph that requires the different face, add it to S. */
22069 s
->for_overlaps
= overlaps
;
22072 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22074 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22076 /* TAB in a composition means display glyphs with padding space
22077 on the left or right. */
22080 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22083 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22090 s
->font
= s
->face
->font
;
22092 else if (s
->face
!= face
)
22100 /* All glyph strings for the same composition has the same width,
22101 i.e. the width set for the first component of the composition. */
22102 s
->width
= s
->first_glyph
->pixel_width
;
22104 /* If the specified font could not be loaded, use the frame's
22105 default font, but record the fact that we couldn't load it in
22106 the glyph string so that we can draw rectangles for the
22107 characters of the glyph string. */
22108 if (s
->font
== NULL
)
22110 s
->font_not_found_p
= 1;
22111 s
->font
= FRAME_FONT (s
->f
);
22114 /* Adjust base line for subscript/superscript text. */
22115 s
->ybase
+= s
->first_glyph
->voffset
;
22117 /* This glyph string must always be drawn with 16-bit functions. */
22124 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22125 int start
, int end
, int overlaps
)
22127 struct glyph
*glyph
, *last
;
22128 Lisp_Object lgstring
;
22131 s
->for_overlaps
= overlaps
;
22132 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22133 last
= s
->row
->glyphs
[s
->area
] + end
;
22134 s
->cmp_id
= glyph
->u
.cmp
.id
;
22135 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22136 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22137 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22138 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22139 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22141 while (glyph
< last
22142 && glyph
->u
.cmp
.automatic
22143 && glyph
->u
.cmp
.id
== s
->cmp_id
22144 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22145 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22147 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22149 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22150 unsigned code
= LGLYPH_CODE (lglyph
);
22152 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22154 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22155 return glyph
- s
->row
->glyphs
[s
->area
];
22159 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22160 See the comment of fill_glyph_string for arguments.
22161 Value is the index of the first glyph not in S. */
22165 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22166 int start
, int end
, int overlaps
)
22168 struct glyph
*glyph
, *last
;
22171 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22172 s
->for_overlaps
= overlaps
;
22173 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22174 last
= s
->row
->glyphs
[s
->area
] + end
;
22175 voffset
= glyph
->voffset
;
22176 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22177 s
->font
= s
->face
->font
;
22179 s
->width
= glyph
->pixel_width
;
22181 while (glyph
< last
22182 && glyph
->type
== GLYPHLESS_GLYPH
22183 && glyph
->voffset
== voffset
22184 && glyph
->face_id
== face_id
)
22187 s
->width
+= glyph
->pixel_width
;
22190 s
->ybase
+= voffset
;
22191 return glyph
- s
->row
->glyphs
[s
->area
];
22195 /* Fill glyph string S from a sequence of character glyphs.
22197 FACE_ID is the face id of the string. START is the index of the
22198 first glyph to consider, END is the index of the last + 1.
22199 OVERLAPS non-zero means S should draw the foreground only, and use
22200 its physical height for clipping. See also draw_glyphs.
22202 Value is the index of the first glyph not in S. */
22205 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22206 int start
, int end
, int overlaps
)
22208 struct glyph
*glyph
, *last
;
22210 int glyph_not_available_p
;
22212 xassert (s
->f
== XFRAME (s
->w
->frame
));
22213 xassert (s
->nchars
== 0);
22214 xassert (start
>= 0 && end
> start
);
22216 s
->for_overlaps
= overlaps
;
22217 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22218 last
= s
->row
->glyphs
[s
->area
] + end
;
22219 voffset
= glyph
->voffset
;
22220 s
->padding_p
= glyph
->padding_p
;
22221 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22223 while (glyph
< last
22224 && glyph
->type
== CHAR_GLYPH
22225 && glyph
->voffset
== voffset
22226 /* Same face id implies same font, nowadays. */
22227 && glyph
->face_id
== face_id
22228 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22232 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22233 s
->char2b
+ s
->nchars
,
22235 s
->two_byte_p
= two_byte_p
;
22237 xassert (s
->nchars
<= end
- start
);
22238 s
->width
+= glyph
->pixel_width
;
22239 if (glyph
++->padding_p
!= s
->padding_p
)
22243 s
->font
= s
->face
->font
;
22245 /* If the specified font could not be loaded, use the frame's font,
22246 but record the fact that we couldn't load it in
22247 S->font_not_found_p so that we can draw rectangles for the
22248 characters of the glyph string. */
22249 if (s
->font
== NULL
|| glyph_not_available_p
)
22251 s
->font_not_found_p
= 1;
22252 s
->font
= FRAME_FONT (s
->f
);
22255 /* Adjust base line for subscript/superscript text. */
22256 s
->ybase
+= voffset
;
22258 xassert (s
->face
&& s
->face
->gc
);
22259 return glyph
- s
->row
->glyphs
[s
->area
];
22263 /* Fill glyph string S from image glyph S->first_glyph. */
22266 fill_image_glyph_string (struct glyph_string
*s
)
22268 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22269 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22271 s
->slice
= s
->first_glyph
->slice
.img
;
22272 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22273 s
->font
= s
->face
->font
;
22274 s
->width
= s
->first_glyph
->pixel_width
;
22276 /* Adjust base line for subscript/superscript text. */
22277 s
->ybase
+= s
->first_glyph
->voffset
;
22281 /* Fill glyph string S from a sequence of stretch glyphs.
22283 START is the index of the first glyph to consider,
22284 END is the index of the last + 1.
22286 Value is the index of the first glyph not in S. */
22289 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22291 struct glyph
*glyph
, *last
;
22292 int voffset
, face_id
;
22294 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22296 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22297 last
= s
->row
->glyphs
[s
->area
] + end
;
22298 face_id
= glyph
->face_id
;
22299 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22300 s
->font
= s
->face
->font
;
22301 s
->width
= glyph
->pixel_width
;
22303 voffset
= glyph
->voffset
;
22307 && glyph
->type
== STRETCH_GLYPH
22308 && glyph
->voffset
== voffset
22309 && glyph
->face_id
== face_id
);
22311 s
->width
+= glyph
->pixel_width
;
22313 /* Adjust base line for subscript/superscript text. */
22314 s
->ybase
+= voffset
;
22316 /* The case that face->gc == 0 is handled when drawing the glyph
22317 string by calling PREPARE_FACE_FOR_DISPLAY. */
22319 return glyph
- s
->row
->glyphs
[s
->area
];
22322 static struct font_metrics
*
22323 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22325 static struct font_metrics metrics
;
22326 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22328 if (! font
|| code
== FONT_INVALID_CODE
)
22330 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22335 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22336 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22337 assumed to be zero. */
22340 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22342 *left
= *right
= 0;
22344 if (glyph
->type
== CHAR_GLYPH
)
22348 struct font_metrics
*pcm
;
22350 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22351 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22353 if (pcm
->rbearing
> pcm
->width
)
22354 *right
= pcm
->rbearing
- pcm
->width
;
22355 if (pcm
->lbearing
< 0)
22356 *left
= -pcm
->lbearing
;
22359 else if (glyph
->type
== COMPOSITE_GLYPH
)
22361 if (! glyph
->u
.cmp
.automatic
)
22363 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22365 if (cmp
->rbearing
> cmp
->pixel_width
)
22366 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22367 if (cmp
->lbearing
< 0)
22368 *left
= - cmp
->lbearing
;
22372 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22373 struct font_metrics metrics
;
22375 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22376 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22377 if (metrics
.rbearing
> metrics
.width
)
22378 *right
= metrics
.rbearing
- metrics
.width
;
22379 if (metrics
.lbearing
< 0)
22380 *left
= - metrics
.lbearing
;
22386 /* Return the index of the first glyph preceding glyph string S that
22387 is overwritten by S because of S's left overhang. Value is -1
22388 if no glyphs are overwritten. */
22391 left_overwritten (struct glyph_string
*s
)
22395 if (s
->left_overhang
)
22398 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22399 int first
= s
->first_glyph
- glyphs
;
22401 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22402 x
-= glyphs
[i
].pixel_width
;
22413 /* Return the index of the first glyph preceding glyph string S that
22414 is overwriting S because of its right overhang. Value is -1 if no
22415 glyph in front of S overwrites S. */
22418 left_overwriting (struct glyph_string
*s
)
22421 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22422 int first
= s
->first_glyph
- glyphs
;
22426 for (i
= first
- 1; i
>= 0; --i
)
22429 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22432 x
-= glyphs
[i
].pixel_width
;
22439 /* Return the index of the last glyph following glyph string S that is
22440 overwritten by S because of S's right overhang. Value is -1 if
22441 no such glyph is found. */
22444 right_overwritten (struct glyph_string
*s
)
22448 if (s
->right_overhang
)
22451 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22452 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22453 int end
= s
->row
->used
[s
->area
];
22455 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22456 x
+= glyphs
[i
].pixel_width
;
22465 /* Return the index of the last glyph following glyph string S that
22466 overwrites S because of its left overhang. Value is negative
22467 if no such glyph is found. */
22470 right_overwriting (struct glyph_string
*s
)
22473 int end
= s
->row
->used
[s
->area
];
22474 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22475 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22479 for (i
= first
; i
< end
; ++i
)
22482 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22485 x
+= glyphs
[i
].pixel_width
;
22492 /* Set background width of glyph string S. START is the index of the
22493 first glyph following S. LAST_X is the right-most x-position + 1
22494 in the drawing area. */
22497 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22499 /* If the face of this glyph string has to be drawn to the end of
22500 the drawing area, set S->extends_to_end_of_line_p. */
22502 if (start
== s
->row
->used
[s
->area
]
22503 && s
->area
== TEXT_AREA
22504 && ((s
->row
->fill_line_p
22505 && (s
->hl
== DRAW_NORMAL_TEXT
22506 || s
->hl
== DRAW_IMAGE_RAISED
22507 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22508 || s
->hl
== DRAW_MOUSE_FACE
))
22509 s
->extends_to_end_of_line_p
= 1;
22511 /* If S extends its face to the end of the line, set its
22512 background_width to the distance to the right edge of the drawing
22514 if (s
->extends_to_end_of_line_p
)
22515 s
->background_width
= last_x
- s
->x
+ 1;
22517 s
->background_width
= s
->width
;
22521 /* Compute overhangs and x-positions for glyph string S and its
22522 predecessors, or successors. X is the starting x-position for S.
22523 BACKWARD_P non-zero means process predecessors. */
22526 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22532 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22533 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22543 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22544 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22554 /* The following macros are only called from draw_glyphs below.
22555 They reference the following parameters of that function directly:
22556 `w', `row', `area', and `overlap_p'
22557 as well as the following local variables:
22558 `s', `f', and `hdc' (in W32) */
22561 /* On W32, silently add local `hdc' variable to argument list of
22562 init_glyph_string. */
22563 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22564 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22566 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22567 init_glyph_string (s, char2b, w, row, area, start, hl)
22570 /* Add a glyph string for a stretch glyph to the list of strings
22571 between HEAD and TAIL. START is the index of the stretch glyph in
22572 row area AREA of glyph row ROW. END is the index of the last glyph
22573 in that glyph row area. X is the current output position assigned
22574 to the new glyph string constructed. HL overrides that face of the
22575 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22576 is the right-most x-position of the drawing area. */
22578 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22579 and below -- keep them on one line. */
22580 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22583 s = (struct glyph_string *) alloca (sizeof *s); \
22584 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22585 START = fill_stretch_glyph_string (s, START, END); \
22586 append_glyph_string (&HEAD, &TAIL, s); \
22592 /* Add a glyph string for an image glyph to the list of strings
22593 between HEAD and TAIL. START is the index of the image glyph in
22594 row area AREA of glyph row ROW. END is the index of the last glyph
22595 in that glyph row area. X is the current output position assigned
22596 to the new glyph string constructed. HL overrides that face of the
22597 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22598 is the right-most x-position of the drawing area. */
22600 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22603 s = (struct glyph_string *) alloca (sizeof *s); \
22604 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22605 fill_image_glyph_string (s); \
22606 append_glyph_string (&HEAD, &TAIL, s); \
22613 /* Add a glyph string for a sequence of character glyphs to the list
22614 of strings between HEAD and TAIL. START is the index of the first
22615 glyph in row area AREA of glyph row ROW that is part of the new
22616 glyph string. END is the index of the last glyph in that glyph row
22617 area. X is the current output position assigned to the new glyph
22618 string constructed. HL overrides that face of the glyph; e.g. it
22619 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22620 right-most x-position of the drawing area. */
22622 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22628 face_id = (row)->glyphs[area][START].face_id; \
22630 s = (struct glyph_string *) alloca (sizeof *s); \
22631 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22632 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22633 append_glyph_string (&HEAD, &TAIL, s); \
22635 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22640 /* Add a glyph string for a composite sequence to the list of strings
22641 between HEAD and TAIL. START is the index of the first glyph in
22642 row area AREA of glyph row ROW that is part of the new glyph
22643 string. END is the index of the last glyph in that glyph row area.
22644 X is the current output position assigned to the new glyph string
22645 constructed. HL overrides that face of the glyph; e.g. it is
22646 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22647 x-position of the drawing area. */
22649 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22651 int face_id = (row)->glyphs[area][START].face_id; \
22652 struct face *base_face = FACE_FROM_ID (f, face_id); \
22653 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22654 struct composition *cmp = composition_table[cmp_id]; \
22656 struct glyph_string *first_s IF_LINT (= NULL); \
22659 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22661 /* Make glyph_strings for each glyph sequence that is drawable by \
22662 the same face, and append them to HEAD/TAIL. */ \
22663 for (n = 0; n < cmp->glyph_len;) \
22665 s = (struct glyph_string *) alloca (sizeof *s); \
22666 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22667 append_glyph_string (&(HEAD), &(TAIL), s); \
22673 n = fill_composite_glyph_string (s, base_face, overlaps); \
22681 /* Add a glyph string for a glyph-string sequence to the list of strings
22682 between HEAD and TAIL. */
22684 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22688 Lisp_Object gstring; \
22690 face_id = (row)->glyphs[area][START].face_id; \
22691 gstring = (composition_gstring_from_id \
22692 ((row)->glyphs[area][START].u.cmp.id)); \
22693 s = (struct glyph_string *) alloca (sizeof *s); \
22694 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22695 * LGSTRING_GLYPH_LEN (gstring)); \
22696 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22697 append_glyph_string (&(HEAD), &(TAIL), s); \
22699 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22703 /* Add a glyph string for a sequence of glyphless character's glyphs
22704 to the list of strings between HEAD and TAIL. The meanings of
22705 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22707 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22712 face_id = (row)->glyphs[area][START].face_id; \
22714 s = (struct glyph_string *) alloca (sizeof *s); \
22715 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22716 append_glyph_string (&HEAD, &TAIL, s); \
22718 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22724 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22725 of AREA of glyph row ROW on window W between indices START and END.
22726 HL overrides the face for drawing glyph strings, e.g. it is
22727 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22728 x-positions of the drawing area.
22730 This is an ugly monster macro construct because we must use alloca
22731 to allocate glyph strings (because draw_glyphs can be called
22732 asynchronously). */
22734 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22737 HEAD = TAIL = NULL; \
22738 while (START < END) \
22740 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22741 switch (first_glyph->type) \
22744 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22748 case COMPOSITE_GLYPH: \
22749 if (first_glyph->u.cmp.automatic) \
22750 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22753 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22757 case STRETCH_GLYPH: \
22758 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22762 case IMAGE_GLYPH: \
22763 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22767 case GLYPHLESS_GLYPH: \
22768 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22778 set_glyph_string_background_width (s, START, LAST_X); \
22785 /* Draw glyphs between START and END in AREA of ROW on window W,
22786 starting at x-position X. X is relative to AREA in W. HL is a
22787 face-override with the following meaning:
22789 DRAW_NORMAL_TEXT draw normally
22790 DRAW_CURSOR draw in cursor face
22791 DRAW_MOUSE_FACE draw in mouse face.
22792 DRAW_INVERSE_VIDEO draw in mode line face
22793 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22794 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22796 If OVERLAPS is non-zero, draw only the foreground of characters and
22797 clip to the physical height of ROW. Non-zero value also defines
22798 the overlapping part to be drawn:
22800 OVERLAPS_PRED overlap with preceding rows
22801 OVERLAPS_SUCC overlap with succeeding rows
22802 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22803 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22805 Value is the x-position reached, relative to AREA of W. */
22808 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22809 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22810 enum draw_glyphs_face hl
, int overlaps
)
22812 struct glyph_string
*head
, *tail
;
22813 struct glyph_string
*s
;
22814 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22815 int i
, j
, x_reached
, last_x
, area_left
= 0;
22816 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22819 ALLOCATE_HDC (hdc
, f
);
22821 /* Let's rather be paranoid than getting a SEGV. */
22822 end
= min (end
, row
->used
[area
]);
22823 start
= max (0, start
);
22824 start
= min (end
, start
);
22826 /* Translate X to frame coordinates. Set last_x to the right
22827 end of the drawing area. */
22828 if (row
->full_width_p
)
22830 /* X is relative to the left edge of W, without scroll bars
22832 area_left
= WINDOW_LEFT_EDGE_X (w
);
22833 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22837 area_left
= window_box_left (w
, area
);
22838 last_x
= area_left
+ window_box_width (w
, area
);
22842 /* Build a doubly-linked list of glyph_string structures between
22843 head and tail from what we have to draw. Note that the macro
22844 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22845 the reason we use a separate variable `i'. */
22847 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22849 x_reached
= tail
->x
+ tail
->background_width
;
22853 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22854 the row, redraw some glyphs in front or following the glyph
22855 strings built above. */
22856 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22858 struct glyph_string
*h
, *t
;
22859 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22860 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22861 int check_mouse_face
= 0;
22864 /* If mouse highlighting is on, we may need to draw adjacent
22865 glyphs using mouse-face highlighting. */
22866 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22868 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22870 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22871 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22873 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22875 check_mouse_face
= 1;
22876 mouse_beg_col
= (row
== mouse_beg_row
)
22877 ? hlinfo
->mouse_face_beg_col
: 0;
22878 mouse_end_col
= (row
== mouse_end_row
)
22879 ? hlinfo
->mouse_face_end_col
22880 : row
->used
[TEXT_AREA
];
22884 /* Compute overhangs for all glyph strings. */
22885 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22886 for (s
= head
; s
; s
= s
->next
)
22887 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22889 /* Prepend glyph strings for glyphs in front of the first glyph
22890 string that are overwritten because of the first glyph
22891 string's left overhang. The background of all strings
22892 prepended must be drawn because the first glyph string
22894 i
= left_overwritten (head
);
22897 enum draw_glyphs_face overlap_hl
;
22899 /* If this row contains mouse highlighting, attempt to draw
22900 the overlapped glyphs with the correct highlight. This
22901 code fails if the overlap encompasses more than one glyph
22902 and mouse-highlight spans only some of these glyphs.
22903 However, making it work perfectly involves a lot more
22904 code, and I don't know if the pathological case occurs in
22905 practice, so we'll stick to this for now. --- cyd */
22906 if (check_mouse_face
22907 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22908 overlap_hl
= DRAW_MOUSE_FACE
;
22910 overlap_hl
= DRAW_NORMAL_TEXT
;
22913 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22914 overlap_hl
, dummy_x
, last_x
);
22916 compute_overhangs_and_x (t
, head
->x
, 1);
22917 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22921 /* Prepend glyph strings for glyphs in front of the first glyph
22922 string that overwrite that glyph string because of their
22923 right overhang. For these strings, only the foreground must
22924 be drawn, because it draws over the glyph string at `head'.
22925 The background must not be drawn because this would overwrite
22926 right overhangs of preceding glyphs for which no glyph
22928 i
= left_overwriting (head
);
22931 enum draw_glyphs_face overlap_hl
;
22933 if (check_mouse_face
22934 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22935 overlap_hl
= DRAW_MOUSE_FACE
;
22937 overlap_hl
= DRAW_NORMAL_TEXT
;
22940 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22941 overlap_hl
, dummy_x
, last_x
);
22942 for (s
= h
; s
; s
= s
->next
)
22943 s
->background_filled_p
= 1;
22944 compute_overhangs_and_x (t
, head
->x
, 1);
22945 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22948 /* Append glyphs strings for glyphs following the last glyph
22949 string tail that are overwritten by tail. The background of
22950 these strings has to be drawn because tail's foreground draws
22952 i
= right_overwritten (tail
);
22955 enum draw_glyphs_face overlap_hl
;
22957 if (check_mouse_face
22958 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22959 overlap_hl
= DRAW_MOUSE_FACE
;
22961 overlap_hl
= DRAW_NORMAL_TEXT
;
22963 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22964 overlap_hl
, x
, last_x
);
22965 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22966 we don't have `end = i;' here. */
22967 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22968 append_glyph_string_lists (&head
, &tail
, h
, t
);
22972 /* Append glyph strings for glyphs following the last glyph
22973 string tail that overwrite tail. The foreground of such
22974 glyphs has to be drawn because it writes into the background
22975 of tail. The background must not be drawn because it could
22976 paint over the foreground of following glyphs. */
22977 i
= right_overwriting (tail
);
22980 enum draw_glyphs_face overlap_hl
;
22981 if (check_mouse_face
22982 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22983 overlap_hl
= DRAW_MOUSE_FACE
;
22985 overlap_hl
= DRAW_NORMAL_TEXT
;
22988 i
++; /* We must include the Ith glyph. */
22989 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22990 overlap_hl
, x
, last_x
);
22991 for (s
= h
; s
; s
= s
->next
)
22992 s
->background_filled_p
= 1;
22993 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22994 append_glyph_string_lists (&head
, &tail
, h
, t
);
22996 if (clip_head
|| clip_tail
)
22997 for (s
= head
; s
; s
= s
->next
)
22999 s
->clip_head
= clip_head
;
23000 s
->clip_tail
= clip_tail
;
23004 /* Draw all strings. */
23005 for (s
= head
; s
; s
= s
->next
)
23006 FRAME_RIF (f
)->draw_glyph_string (s
);
23009 /* When focus a sole frame and move horizontally, this sets on_p to 0
23010 causing a failure to erase prev cursor position. */
23011 if (area
== TEXT_AREA
23012 && !row
->full_width_p
23013 /* When drawing overlapping rows, only the glyph strings'
23014 foreground is drawn, which doesn't erase a cursor
23018 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23019 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23020 : (tail
? tail
->x
+ tail
->background_width
: x
));
23024 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23025 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23029 /* Value is the x-position up to which drawn, relative to AREA of W.
23030 This doesn't include parts drawn because of overhangs. */
23031 if (row
->full_width_p
)
23032 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23034 x_reached
-= area_left
;
23036 RELEASE_HDC (hdc
, f
);
23041 /* Expand row matrix if too narrow. Don't expand if area
23044 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23046 if (!fonts_changed_p \
23047 && (it->glyph_row->glyphs[area] \
23048 < it->glyph_row->glyphs[area + 1])) \
23050 it->w->ncols_scale_factor++; \
23051 fonts_changed_p = 1; \
23055 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23056 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23059 append_glyph (struct it
*it
)
23061 struct glyph
*glyph
;
23062 enum glyph_row_area area
= it
->area
;
23064 xassert (it
->glyph_row
);
23065 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23067 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23068 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23070 /* If the glyph row is reversed, we need to prepend the glyph
23071 rather than append it. */
23072 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23076 /* Make room for the additional glyph. */
23077 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23079 glyph
= it
->glyph_row
->glyphs
[area
];
23081 glyph
->charpos
= CHARPOS (it
->position
);
23082 glyph
->object
= it
->object
;
23083 if (it
->pixel_width
> 0)
23085 glyph
->pixel_width
= it
->pixel_width
;
23086 glyph
->padding_p
= 0;
23090 /* Assure at least 1-pixel width. Otherwise, cursor can't
23091 be displayed correctly. */
23092 glyph
->pixel_width
= 1;
23093 glyph
->padding_p
= 1;
23095 glyph
->ascent
= it
->ascent
;
23096 glyph
->descent
= it
->descent
;
23097 glyph
->voffset
= it
->voffset
;
23098 glyph
->type
= CHAR_GLYPH
;
23099 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23100 glyph
->multibyte_p
= it
->multibyte_p
;
23101 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23102 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23103 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23104 || it
->phys_descent
> it
->descent
);
23105 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23106 glyph
->face_id
= it
->face_id
;
23107 glyph
->u
.ch
= it
->char_to_display
;
23108 glyph
->slice
.img
= null_glyph_slice
;
23109 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23112 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23113 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23115 glyph
->bidi_type
= it
->bidi_it
.type
;
23119 glyph
->resolved_level
= 0;
23120 glyph
->bidi_type
= UNKNOWN_BT
;
23122 ++it
->glyph_row
->used
[area
];
23125 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23128 /* Store one glyph for the composition IT->cmp_it.id in
23129 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23133 append_composite_glyph (struct it
*it
)
23135 struct glyph
*glyph
;
23136 enum glyph_row_area area
= it
->area
;
23138 xassert (it
->glyph_row
);
23140 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23141 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23143 /* If the glyph row is reversed, we need to prepend the glyph
23144 rather than append it. */
23145 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23149 /* Make room for the new glyph. */
23150 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23152 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23154 glyph
->charpos
= it
->cmp_it
.charpos
;
23155 glyph
->object
= it
->object
;
23156 glyph
->pixel_width
= it
->pixel_width
;
23157 glyph
->ascent
= it
->ascent
;
23158 glyph
->descent
= it
->descent
;
23159 glyph
->voffset
= it
->voffset
;
23160 glyph
->type
= COMPOSITE_GLYPH
;
23161 if (it
->cmp_it
.ch
< 0)
23163 glyph
->u
.cmp
.automatic
= 0;
23164 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23165 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23169 glyph
->u
.cmp
.automatic
= 1;
23170 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23171 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23172 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23174 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23175 glyph
->multibyte_p
= it
->multibyte_p
;
23176 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23177 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23178 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23179 || it
->phys_descent
> it
->descent
);
23180 glyph
->padding_p
= 0;
23181 glyph
->glyph_not_available_p
= 0;
23182 glyph
->face_id
= it
->face_id
;
23183 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23186 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23187 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23189 glyph
->bidi_type
= it
->bidi_it
.type
;
23191 ++it
->glyph_row
->used
[area
];
23194 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23198 /* Change IT->ascent and IT->height according to the setting of
23202 take_vertical_position_into_account (struct it
*it
)
23206 if (it
->voffset
< 0)
23207 /* Increase the ascent so that we can display the text higher
23209 it
->ascent
-= it
->voffset
;
23211 /* Increase the descent so that we can display the text lower
23213 it
->descent
+= it
->voffset
;
23218 /* Produce glyphs/get display metrics for the image IT is loaded with.
23219 See the description of struct display_iterator in dispextern.h for
23220 an overview of struct display_iterator. */
23223 produce_image_glyph (struct it
*it
)
23227 int glyph_ascent
, crop
;
23228 struct glyph_slice slice
;
23230 xassert (it
->what
== IT_IMAGE
);
23232 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23234 /* Make sure X resources of the face is loaded. */
23235 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23237 if (it
->image_id
< 0)
23239 /* Fringe bitmap. */
23240 it
->ascent
= it
->phys_ascent
= 0;
23241 it
->descent
= it
->phys_descent
= 0;
23242 it
->pixel_width
= 0;
23247 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23249 /* Make sure X resources of the image is loaded. */
23250 prepare_image_for_display (it
->f
, img
);
23252 slice
.x
= slice
.y
= 0;
23253 slice
.width
= img
->width
;
23254 slice
.height
= img
->height
;
23256 if (INTEGERP (it
->slice
.x
))
23257 slice
.x
= XINT (it
->slice
.x
);
23258 else if (FLOATP (it
->slice
.x
))
23259 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23261 if (INTEGERP (it
->slice
.y
))
23262 slice
.y
= XINT (it
->slice
.y
);
23263 else if (FLOATP (it
->slice
.y
))
23264 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23266 if (INTEGERP (it
->slice
.width
))
23267 slice
.width
= XINT (it
->slice
.width
);
23268 else if (FLOATP (it
->slice
.width
))
23269 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23271 if (INTEGERP (it
->slice
.height
))
23272 slice
.height
= XINT (it
->slice
.height
);
23273 else if (FLOATP (it
->slice
.height
))
23274 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23276 if (slice
.x
>= img
->width
)
23277 slice
.x
= img
->width
;
23278 if (slice
.y
>= img
->height
)
23279 slice
.y
= img
->height
;
23280 if (slice
.x
+ slice
.width
>= img
->width
)
23281 slice
.width
= img
->width
- slice
.x
;
23282 if (slice
.y
+ slice
.height
> img
->height
)
23283 slice
.height
= img
->height
- slice
.y
;
23285 if (slice
.width
== 0 || slice
.height
== 0)
23288 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23290 it
->descent
= slice
.height
- glyph_ascent
;
23292 it
->descent
+= img
->vmargin
;
23293 if (slice
.y
+ slice
.height
== img
->height
)
23294 it
->descent
+= img
->vmargin
;
23295 it
->phys_descent
= it
->descent
;
23297 it
->pixel_width
= slice
.width
;
23299 it
->pixel_width
+= img
->hmargin
;
23300 if (slice
.x
+ slice
.width
== img
->width
)
23301 it
->pixel_width
+= img
->hmargin
;
23303 /* It's quite possible for images to have an ascent greater than
23304 their height, so don't get confused in that case. */
23305 if (it
->descent
< 0)
23310 if (face
->box
!= FACE_NO_BOX
)
23312 if (face
->box_line_width
> 0)
23315 it
->ascent
+= face
->box_line_width
;
23316 if (slice
.y
+ slice
.height
== img
->height
)
23317 it
->descent
+= face
->box_line_width
;
23320 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23321 it
->pixel_width
+= eabs (face
->box_line_width
);
23322 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23323 it
->pixel_width
+= eabs (face
->box_line_width
);
23326 take_vertical_position_into_account (it
);
23328 /* Automatically crop wide image glyphs at right edge so we can
23329 draw the cursor on same display row. */
23330 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23331 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23333 it
->pixel_width
-= crop
;
23334 slice
.width
-= crop
;
23339 struct glyph
*glyph
;
23340 enum glyph_row_area area
= it
->area
;
23342 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23343 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23345 glyph
->charpos
= CHARPOS (it
->position
);
23346 glyph
->object
= it
->object
;
23347 glyph
->pixel_width
= it
->pixel_width
;
23348 glyph
->ascent
= glyph_ascent
;
23349 glyph
->descent
= it
->descent
;
23350 glyph
->voffset
= it
->voffset
;
23351 glyph
->type
= IMAGE_GLYPH
;
23352 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23353 glyph
->multibyte_p
= it
->multibyte_p
;
23354 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23355 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23356 glyph
->overlaps_vertically_p
= 0;
23357 glyph
->padding_p
= 0;
23358 glyph
->glyph_not_available_p
= 0;
23359 glyph
->face_id
= it
->face_id
;
23360 glyph
->u
.img_id
= img
->id
;
23361 glyph
->slice
.img
= slice
;
23362 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23365 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23366 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23368 glyph
->bidi_type
= it
->bidi_it
.type
;
23370 ++it
->glyph_row
->used
[area
];
23373 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23378 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23379 of the glyph, WIDTH and HEIGHT are the width and height of the
23380 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23383 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23384 int width
, int height
, int ascent
)
23386 struct glyph
*glyph
;
23387 enum glyph_row_area area
= it
->area
;
23389 xassert (ascent
>= 0 && ascent
<= height
);
23391 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23392 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23394 /* If the glyph row is reversed, we need to prepend the glyph
23395 rather than append it. */
23396 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23400 /* Make room for the additional glyph. */
23401 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23403 glyph
= it
->glyph_row
->glyphs
[area
];
23405 glyph
->charpos
= CHARPOS (it
->position
);
23406 glyph
->object
= object
;
23407 glyph
->pixel_width
= width
;
23408 glyph
->ascent
= ascent
;
23409 glyph
->descent
= height
- ascent
;
23410 glyph
->voffset
= it
->voffset
;
23411 glyph
->type
= STRETCH_GLYPH
;
23412 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23413 glyph
->multibyte_p
= it
->multibyte_p
;
23414 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23415 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23416 glyph
->overlaps_vertically_p
= 0;
23417 glyph
->padding_p
= 0;
23418 glyph
->glyph_not_available_p
= 0;
23419 glyph
->face_id
= it
->face_id
;
23420 glyph
->u
.stretch
.ascent
= ascent
;
23421 glyph
->u
.stretch
.height
= height
;
23422 glyph
->slice
.img
= null_glyph_slice
;
23423 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23426 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23427 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23429 glyph
->bidi_type
= it
->bidi_it
.type
;
23433 glyph
->resolved_level
= 0;
23434 glyph
->bidi_type
= UNKNOWN_BT
;
23436 ++it
->glyph_row
->used
[area
];
23439 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23442 #endif /* HAVE_WINDOW_SYSTEM */
23444 /* Produce a stretch glyph for iterator IT. IT->object is the value
23445 of the glyph property displayed. The value must be a list
23446 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23449 1. `:width WIDTH' specifies that the space should be WIDTH *
23450 canonical char width wide. WIDTH may be an integer or floating
23453 2. `:relative-width FACTOR' specifies that the width of the stretch
23454 should be computed from the width of the first character having the
23455 `glyph' property, and should be FACTOR times that width.
23457 3. `:align-to HPOS' specifies that the space should be wide enough
23458 to reach HPOS, a value in canonical character units.
23460 Exactly one of the above pairs must be present.
23462 4. `:height HEIGHT' specifies that the height of the stretch produced
23463 should be HEIGHT, measured in canonical character units.
23465 5. `:relative-height FACTOR' specifies that the height of the
23466 stretch should be FACTOR times the height of the characters having
23467 the glyph property.
23469 Either none or exactly one of 4 or 5 must be present.
23471 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23472 of the stretch should be used for the ascent of the stretch.
23473 ASCENT must be in the range 0 <= ASCENT <= 100. */
23476 produce_stretch_glyph (struct it
*it
)
23478 /* (space :width WIDTH :height HEIGHT ...) */
23479 Lisp_Object prop
, plist
;
23480 int width
= 0, height
= 0, align_to
= -1;
23481 int zero_width_ok_p
= 0;
23484 struct face
*face
= NULL
;
23485 struct font
*font
= NULL
;
23487 #ifdef HAVE_WINDOW_SYSTEM
23488 int zero_height_ok_p
= 0;
23490 if (FRAME_WINDOW_P (it
->f
))
23492 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23493 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23494 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23498 /* List should start with `space'. */
23499 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23500 plist
= XCDR (it
->object
);
23502 /* Compute the width of the stretch. */
23503 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23504 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23506 /* Absolute width `:width WIDTH' specified and valid. */
23507 zero_width_ok_p
= 1;
23510 #ifdef HAVE_WINDOW_SYSTEM
23511 else if (FRAME_WINDOW_P (it
->f
)
23512 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23514 /* Relative width `:relative-width FACTOR' specified and valid.
23515 Compute the width of the characters having the `glyph'
23518 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23521 if (it
->multibyte_p
)
23522 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23525 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23526 if (! ASCII_CHAR_P (it2
.c
))
23527 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23530 it2
.glyph_row
= NULL
;
23531 it2
.what
= IT_CHARACTER
;
23532 x_produce_glyphs (&it2
);
23533 width
= NUMVAL (prop
) * it2
.pixel_width
;
23535 #endif /* HAVE_WINDOW_SYSTEM */
23536 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23537 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23539 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23540 align_to
= (align_to
< 0
23542 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23543 else if (align_to
< 0)
23544 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23545 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23546 zero_width_ok_p
= 1;
23549 /* Nothing specified -> width defaults to canonical char width. */
23550 width
= FRAME_COLUMN_WIDTH (it
->f
);
23552 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23555 #ifdef HAVE_WINDOW_SYSTEM
23556 /* Compute height. */
23557 if (FRAME_WINDOW_P (it
->f
))
23559 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23560 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23563 zero_height_ok_p
= 1;
23565 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23567 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23569 height
= FONT_HEIGHT (font
);
23571 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23574 /* Compute percentage of height used for ascent. If
23575 `:ascent ASCENT' is present and valid, use that. Otherwise,
23576 derive the ascent from the font in use. */
23577 if (prop
= Fplist_get (plist
, QCascent
),
23578 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23579 ascent
= height
* NUMVAL (prop
) / 100.0;
23580 else if (!NILP (prop
)
23581 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23582 ascent
= min (max (0, (int)tem
), height
);
23584 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23587 #endif /* HAVE_WINDOW_SYSTEM */
23590 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23591 && it
->current_x
+ width
> it
->last_visible_x
)
23593 width
= it
->last_visible_x
- it
->current_x
;
23594 #ifdef HAVE_WINDOW_SYSTEM
23595 /* Subtact one more pixel from the stretch width, but only on
23596 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23597 width
-= FRAME_WINDOW_P (it
->f
);
23601 if (width
> 0 && height
> 0 && it
->glyph_row
)
23603 Lisp_Object o_object
= it
->object
;
23604 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23607 if (!STRINGP (object
))
23608 object
= it
->w
->buffer
;
23609 #ifdef HAVE_WINDOW_SYSTEM
23610 if (FRAME_WINDOW_P (it
->f
))
23611 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23615 it
->object
= object
;
23616 it
->char_to_display
= ' ';
23617 it
->pixel_width
= it
->len
= 1;
23619 tty_append_glyph (it
);
23620 it
->object
= o_object
;
23624 it
->pixel_width
= width
;
23625 #ifdef HAVE_WINDOW_SYSTEM
23626 if (FRAME_WINDOW_P (it
->f
))
23628 it
->ascent
= it
->phys_ascent
= ascent
;
23629 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23630 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23631 take_vertical_position_into_account (it
);
23635 it
->nglyphs
= width
;
23638 #ifdef HAVE_WINDOW_SYSTEM
23640 /* Calculate line-height and line-spacing properties.
23641 An integer value specifies explicit pixel value.
23642 A float value specifies relative value to current face height.
23643 A cons (float . face-name) specifies relative value to
23644 height of specified face font.
23646 Returns height in pixels, or nil. */
23650 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23651 int boff
, int override
)
23653 Lisp_Object face_name
= Qnil
;
23654 int ascent
, descent
, height
;
23656 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23661 face_name
= XCAR (val
);
23663 if (!NUMBERP (val
))
23664 val
= make_number (1);
23665 if (NILP (face_name
))
23667 height
= it
->ascent
+ it
->descent
;
23672 if (NILP (face_name
))
23674 font
= FRAME_FONT (it
->f
);
23675 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23677 else if (EQ (face_name
, Qt
))
23686 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23688 return make_number (-1);
23690 face
= FACE_FROM_ID (it
->f
, face_id
);
23693 return make_number (-1);
23694 boff
= font
->baseline_offset
;
23695 if (font
->vertical_centering
)
23696 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23699 ascent
= FONT_BASE (font
) + boff
;
23700 descent
= FONT_DESCENT (font
) - boff
;
23704 it
->override_ascent
= ascent
;
23705 it
->override_descent
= descent
;
23706 it
->override_boff
= boff
;
23709 height
= ascent
+ descent
;
23713 height
= (int)(XFLOAT_DATA (val
) * height
);
23714 else if (INTEGERP (val
))
23715 height
*= XINT (val
);
23717 return make_number (height
);
23721 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23722 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23723 and only if this is for a character for which no font was found.
23725 If the display method (it->glyphless_method) is
23726 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23727 length of the acronym or the hexadecimal string, UPPER_XOFF and
23728 UPPER_YOFF are pixel offsets for the upper part of the string,
23729 LOWER_XOFF and LOWER_YOFF are for the lower part.
23731 For the other display methods, LEN through LOWER_YOFF are zero. */
23734 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23735 short upper_xoff
, short upper_yoff
,
23736 short lower_xoff
, short lower_yoff
)
23738 struct glyph
*glyph
;
23739 enum glyph_row_area area
= it
->area
;
23741 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23742 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23744 /* If the glyph row is reversed, we need to prepend the glyph
23745 rather than append it. */
23746 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23750 /* Make room for the additional glyph. */
23751 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23753 glyph
= it
->glyph_row
->glyphs
[area
];
23755 glyph
->charpos
= CHARPOS (it
->position
);
23756 glyph
->object
= it
->object
;
23757 glyph
->pixel_width
= it
->pixel_width
;
23758 glyph
->ascent
= it
->ascent
;
23759 glyph
->descent
= it
->descent
;
23760 glyph
->voffset
= it
->voffset
;
23761 glyph
->type
= GLYPHLESS_GLYPH
;
23762 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23763 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23764 glyph
->u
.glyphless
.len
= len
;
23765 glyph
->u
.glyphless
.ch
= it
->c
;
23766 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23767 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23768 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23769 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23770 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23771 glyph
->multibyte_p
= it
->multibyte_p
;
23772 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23773 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23774 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23775 || it
->phys_descent
> it
->descent
);
23776 glyph
->padding_p
= 0;
23777 glyph
->glyph_not_available_p
= 0;
23778 glyph
->face_id
= face_id
;
23779 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23782 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23783 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23785 glyph
->bidi_type
= it
->bidi_it
.type
;
23787 ++it
->glyph_row
->used
[area
];
23790 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23794 /* Produce a glyph for a glyphless character for iterator IT.
23795 IT->glyphless_method specifies which method to use for displaying
23796 the character. See the description of enum
23797 glyphless_display_method in dispextern.h for the detail.
23799 FOR_NO_FONT is nonzero if and only if this is for a character for
23800 which no font was found. ACRONYM, if non-nil, is an acronym string
23801 for the character. */
23804 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23809 int base_width
, base_height
, width
, height
;
23810 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23813 /* Get the metrics of the base font. We always refer to the current
23815 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23816 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23817 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23818 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23819 base_height
= it
->ascent
+ it
->descent
;
23820 base_width
= font
->average_width
;
23822 /* Get a face ID for the glyph by utilizing a cache (the same way as
23823 done for `escape-glyph' in get_next_display_element). */
23824 if (it
->f
== last_glyphless_glyph_frame
23825 && it
->face_id
== last_glyphless_glyph_face_id
)
23827 face_id
= last_glyphless_glyph_merged_face_id
;
23831 /* Merge the `glyphless-char' face into the current face. */
23832 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23833 last_glyphless_glyph_frame
= it
->f
;
23834 last_glyphless_glyph_face_id
= it
->face_id
;
23835 last_glyphless_glyph_merged_face_id
= face_id
;
23838 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23840 it
->pixel_width
= THIN_SPACE_WIDTH
;
23842 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23844 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23846 width
= CHAR_WIDTH (it
->c
);
23849 else if (width
> 4)
23851 it
->pixel_width
= base_width
* width
;
23853 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23859 unsigned int code
[6];
23861 int ascent
, descent
;
23862 struct font_metrics metrics_upper
, metrics_lower
;
23864 face
= FACE_FROM_ID (it
->f
, face_id
);
23865 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23866 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23868 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23870 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23871 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23872 if (CONSP (acronym
))
23873 acronym
= XCAR (acronym
);
23874 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23878 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23879 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23882 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23883 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23884 upper_len
= (len
+ 1) / 2;
23885 font
->driver
->text_extents (font
, code
, upper_len
,
23887 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23892 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23893 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23894 upper_xoff
= upper_yoff
= 2; /* the typical case */
23895 if (base_width
>= width
)
23897 /* Align the upper to the left, the lower to the right. */
23898 it
->pixel_width
= base_width
;
23899 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23903 /* Center the shorter one. */
23904 it
->pixel_width
= width
;
23905 if (metrics_upper
.width
>= metrics_lower
.width
)
23906 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23909 /* FIXME: This code doesn't look right. It formerly was
23910 missing the "lower_xoff = 0;", which couldn't have
23911 been right since it left lower_xoff uninitialized. */
23913 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23917 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23918 top, bottom, and between upper and lower strings. */
23919 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23920 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23921 /* Center vertically.
23922 H:base_height, D:base_descent
23923 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23925 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23926 descent = D - H/2 + h/2;
23927 lower_yoff = descent - 2 - ld;
23928 upper_yoff = lower_yoff - la - 1 - ud; */
23929 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23930 descent
= it
->descent
- (base_height
- height
) / 2;
23931 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23932 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23933 - metrics_upper
.descent
);
23934 /* Don't make the height shorter than the base height. */
23935 if (height
> base_height
)
23937 it
->ascent
= ascent
;
23938 it
->descent
= descent
;
23942 it
->phys_ascent
= it
->ascent
;
23943 it
->phys_descent
= it
->descent
;
23945 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23946 upper_xoff
, upper_yoff
,
23947 lower_xoff
, lower_yoff
);
23949 take_vertical_position_into_account (it
);
23954 Produce glyphs/get display metrics for the display element IT is
23955 loaded with. See the description of struct it in dispextern.h
23956 for an overview of struct it. */
23959 x_produce_glyphs (struct it
*it
)
23961 int extra_line_spacing
= it
->extra_line_spacing
;
23963 it
->glyph_not_available_p
= 0;
23965 if (it
->what
== IT_CHARACTER
)
23968 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23969 struct font
*font
= face
->font
;
23970 struct font_metrics
*pcm
= NULL
;
23971 int boff
; /* baseline offset */
23975 /* When no suitable font is found, display this character by
23976 the method specified in the first extra slot of
23977 Vglyphless_char_display. */
23978 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23980 xassert (it
->what
== IT_GLYPHLESS
);
23981 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23985 boff
= font
->baseline_offset
;
23986 if (font
->vertical_centering
)
23987 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23989 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23995 if (it
->override_ascent
>= 0)
23997 it
->ascent
= it
->override_ascent
;
23998 it
->descent
= it
->override_descent
;
23999 boff
= it
->override_boff
;
24003 it
->ascent
= FONT_BASE (font
) + boff
;
24004 it
->descent
= FONT_DESCENT (font
) - boff
;
24007 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24009 pcm
= get_per_char_metric (font
, &char2b
);
24010 if (pcm
->width
== 0
24011 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24017 it
->phys_ascent
= pcm
->ascent
+ boff
;
24018 it
->phys_descent
= pcm
->descent
- boff
;
24019 it
->pixel_width
= pcm
->width
;
24023 it
->glyph_not_available_p
= 1;
24024 it
->phys_ascent
= it
->ascent
;
24025 it
->phys_descent
= it
->descent
;
24026 it
->pixel_width
= font
->space_width
;
24029 if (it
->constrain_row_ascent_descent_p
)
24031 if (it
->descent
> it
->max_descent
)
24033 it
->ascent
+= it
->descent
- it
->max_descent
;
24034 it
->descent
= it
->max_descent
;
24036 if (it
->ascent
> it
->max_ascent
)
24038 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24039 it
->ascent
= it
->max_ascent
;
24041 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24042 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24043 extra_line_spacing
= 0;
24046 /* If this is a space inside a region of text with
24047 `space-width' property, change its width. */
24048 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24050 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24052 /* If face has a box, add the box thickness to the character
24053 height. If character has a box line to the left and/or
24054 right, add the box line width to the character's width. */
24055 if (face
->box
!= FACE_NO_BOX
)
24057 int thick
= face
->box_line_width
;
24061 it
->ascent
+= thick
;
24062 it
->descent
+= thick
;
24067 if (it
->start_of_box_run_p
)
24068 it
->pixel_width
+= thick
;
24069 if (it
->end_of_box_run_p
)
24070 it
->pixel_width
+= thick
;
24073 /* If face has an overline, add the height of the overline
24074 (1 pixel) and a 1 pixel margin to the character height. */
24075 if (face
->overline_p
)
24076 it
->ascent
+= overline_margin
;
24078 if (it
->constrain_row_ascent_descent_p
)
24080 if (it
->ascent
> it
->max_ascent
)
24081 it
->ascent
= it
->max_ascent
;
24082 if (it
->descent
> it
->max_descent
)
24083 it
->descent
= it
->max_descent
;
24086 take_vertical_position_into_account (it
);
24088 /* If we have to actually produce glyphs, do it. */
24093 /* Translate a space with a `space-width' property
24094 into a stretch glyph. */
24095 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24096 / FONT_HEIGHT (font
));
24097 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24098 it
->ascent
+ it
->descent
, ascent
);
24103 /* If characters with lbearing or rbearing are displayed
24104 in this line, record that fact in a flag of the
24105 glyph row. This is used to optimize X output code. */
24106 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24107 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24109 if (! stretched_p
&& it
->pixel_width
== 0)
24110 /* We assure that all visible glyphs have at least 1-pixel
24112 it
->pixel_width
= 1;
24114 else if (it
->char_to_display
== '\n')
24116 /* A newline has no width, but we need the height of the
24117 line. But if previous part of the line sets a height,
24118 don't increase that height */
24120 Lisp_Object height
;
24121 Lisp_Object total_height
= Qnil
;
24123 it
->override_ascent
= -1;
24124 it
->pixel_width
= 0;
24127 height
= get_it_property (it
, Qline_height
);
24128 /* Split (line-height total-height) list */
24130 && CONSP (XCDR (height
))
24131 && NILP (XCDR (XCDR (height
))))
24133 total_height
= XCAR (XCDR (height
));
24134 height
= XCAR (height
);
24136 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24138 if (it
->override_ascent
>= 0)
24140 it
->ascent
= it
->override_ascent
;
24141 it
->descent
= it
->override_descent
;
24142 boff
= it
->override_boff
;
24146 it
->ascent
= FONT_BASE (font
) + boff
;
24147 it
->descent
= FONT_DESCENT (font
) - boff
;
24150 if (EQ (height
, Qt
))
24152 if (it
->descent
> it
->max_descent
)
24154 it
->ascent
+= it
->descent
- it
->max_descent
;
24155 it
->descent
= it
->max_descent
;
24157 if (it
->ascent
> it
->max_ascent
)
24159 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24160 it
->ascent
= it
->max_ascent
;
24162 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24163 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24164 it
->constrain_row_ascent_descent_p
= 1;
24165 extra_line_spacing
= 0;
24169 Lisp_Object spacing
;
24171 it
->phys_ascent
= it
->ascent
;
24172 it
->phys_descent
= it
->descent
;
24174 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24175 && face
->box
!= FACE_NO_BOX
24176 && face
->box_line_width
> 0)
24178 it
->ascent
+= face
->box_line_width
;
24179 it
->descent
+= face
->box_line_width
;
24182 && XINT (height
) > it
->ascent
+ it
->descent
)
24183 it
->ascent
= XINT (height
) - it
->descent
;
24185 if (!NILP (total_height
))
24186 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24189 spacing
= get_it_property (it
, Qline_spacing
);
24190 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24192 if (INTEGERP (spacing
))
24194 extra_line_spacing
= XINT (spacing
);
24195 if (!NILP (total_height
))
24196 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24200 else /* i.e. (it->char_to_display == '\t') */
24202 if (font
->space_width
> 0)
24204 int tab_width
= it
->tab_width
* font
->space_width
;
24205 int x
= it
->current_x
+ it
->continuation_lines_width
;
24206 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24208 /* If the distance from the current position to the next tab
24209 stop is less than a space character width, use the
24210 tab stop after that. */
24211 if (next_tab_x
- x
< font
->space_width
)
24212 next_tab_x
+= tab_width
;
24214 it
->pixel_width
= next_tab_x
- x
;
24216 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24217 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24221 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24222 it
->ascent
+ it
->descent
, it
->ascent
);
24227 it
->pixel_width
= 0;
24232 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24234 /* A static composition.
24236 Note: A composition is represented as one glyph in the
24237 glyph matrix. There are no padding glyphs.
24239 Important note: pixel_width, ascent, and descent are the
24240 values of what is drawn by draw_glyphs (i.e. the values of
24241 the overall glyphs composed). */
24242 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24243 int boff
; /* baseline offset */
24244 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24245 int glyph_len
= cmp
->glyph_len
;
24246 struct font
*font
= face
->font
;
24250 /* If we have not yet calculated pixel size data of glyphs of
24251 the composition for the current face font, calculate them
24252 now. Theoretically, we have to check all fonts for the
24253 glyphs, but that requires much time and memory space. So,
24254 here we check only the font of the first glyph. This may
24255 lead to incorrect display, but it's very rare, and C-l
24256 (recenter-top-bottom) can correct the display anyway. */
24257 if (! cmp
->font
|| cmp
->font
!= font
)
24259 /* Ascent and descent of the font of the first character
24260 of this composition (adjusted by baseline offset).
24261 Ascent and descent of overall glyphs should not be less
24262 than these, respectively. */
24263 int font_ascent
, font_descent
, font_height
;
24264 /* Bounding box of the overall glyphs. */
24265 int leftmost
, rightmost
, lowest
, highest
;
24266 int lbearing
, rbearing
;
24267 int i
, width
, ascent
, descent
;
24268 int left_padded
= 0, right_padded
= 0;
24269 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24271 struct font_metrics
*pcm
;
24272 int font_not_found_p
;
24275 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24276 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24278 if (glyph_len
< cmp
->glyph_len
)
24280 for (i
= 0; i
< glyph_len
; i
++)
24282 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24284 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24289 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24290 : IT_CHARPOS (*it
));
24291 /* If no suitable font is found, use the default font. */
24292 font_not_found_p
= font
== NULL
;
24293 if (font_not_found_p
)
24295 face
= face
->ascii_face
;
24298 boff
= font
->baseline_offset
;
24299 if (font
->vertical_centering
)
24300 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24301 font_ascent
= FONT_BASE (font
) + boff
;
24302 font_descent
= FONT_DESCENT (font
) - boff
;
24303 font_height
= FONT_HEIGHT (font
);
24305 cmp
->font
= (void *) font
;
24308 if (! font_not_found_p
)
24310 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24312 pcm
= get_per_char_metric (font
, &char2b
);
24315 /* Initialize the bounding box. */
24318 width
= pcm
->width
;
24319 ascent
= pcm
->ascent
;
24320 descent
= pcm
->descent
;
24321 lbearing
= pcm
->lbearing
;
24322 rbearing
= pcm
->rbearing
;
24326 width
= font
->space_width
;
24327 ascent
= FONT_BASE (font
);
24328 descent
= FONT_DESCENT (font
);
24335 lowest
= - descent
+ boff
;
24336 highest
= ascent
+ boff
;
24338 if (! font_not_found_p
24339 && font
->default_ascent
24340 && CHAR_TABLE_P (Vuse_default_ascent
)
24341 && !NILP (Faref (Vuse_default_ascent
,
24342 make_number (it
->char_to_display
))))
24343 highest
= font
->default_ascent
+ boff
;
24345 /* Draw the first glyph at the normal position. It may be
24346 shifted to right later if some other glyphs are drawn
24348 cmp
->offsets
[i
* 2] = 0;
24349 cmp
->offsets
[i
* 2 + 1] = boff
;
24350 cmp
->lbearing
= lbearing
;
24351 cmp
->rbearing
= rbearing
;
24353 /* Set cmp->offsets for the remaining glyphs. */
24354 for (i
++; i
< glyph_len
; i
++)
24356 int left
, right
, btm
, top
;
24357 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24359 struct face
*this_face
;
24363 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24364 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24365 font
= this_face
->font
;
24371 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24373 pcm
= get_per_char_metric (font
, &char2b
);
24376 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24379 width
= pcm
->width
;
24380 ascent
= pcm
->ascent
;
24381 descent
= pcm
->descent
;
24382 lbearing
= pcm
->lbearing
;
24383 rbearing
= pcm
->rbearing
;
24384 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24386 /* Relative composition with or without
24387 alternate chars. */
24388 left
= (leftmost
+ rightmost
- width
) / 2;
24389 btm
= - descent
+ boff
;
24390 if (font
->relative_compose
24391 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24392 || NILP (Faref (Vignore_relative_composition
,
24393 make_number (ch
)))))
24396 if (- descent
>= font
->relative_compose
)
24397 /* One extra pixel between two glyphs. */
24399 else if (ascent
<= 0)
24400 /* One extra pixel between two glyphs. */
24401 btm
= lowest
- 1 - ascent
- descent
;
24406 /* A composition rule is specified by an integer
24407 value that encodes global and new reference
24408 points (GREF and NREF). GREF and NREF are
24409 specified by numbers as below:
24411 0---1---2 -- ascent
24415 9--10--11 -- center
24417 ---3---4---5--- baseline
24419 6---7---8 -- descent
24421 int rule
= COMPOSITION_RULE (cmp
, i
);
24422 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24424 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24425 grefx
= gref
% 3, nrefx
= nref
% 3;
24426 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24428 xoff
= font_height
* (xoff
- 128) / 256;
24430 yoff
= font_height
* (yoff
- 128) / 256;
24433 + grefx
* (rightmost
- leftmost
) / 2
24434 - nrefx
* width
/ 2
24437 btm
= ((grefy
== 0 ? highest
24439 : grefy
== 2 ? lowest
24440 : (highest
+ lowest
) / 2)
24441 - (nrefy
== 0 ? ascent
+ descent
24442 : nrefy
== 1 ? descent
- boff
24444 : (ascent
+ descent
) / 2)
24448 cmp
->offsets
[i
* 2] = left
;
24449 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24451 /* Update the bounding box of the overall glyphs. */
24454 right
= left
+ width
;
24455 if (left
< leftmost
)
24457 if (right
> rightmost
)
24460 top
= btm
+ descent
+ ascent
;
24466 if (cmp
->lbearing
> left
+ lbearing
)
24467 cmp
->lbearing
= left
+ lbearing
;
24468 if (cmp
->rbearing
< left
+ rbearing
)
24469 cmp
->rbearing
= left
+ rbearing
;
24473 /* If there are glyphs whose x-offsets are negative,
24474 shift all glyphs to the right and make all x-offsets
24478 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24479 cmp
->offsets
[i
* 2] -= leftmost
;
24480 rightmost
-= leftmost
;
24481 cmp
->lbearing
-= leftmost
;
24482 cmp
->rbearing
-= leftmost
;
24485 if (left_padded
&& cmp
->lbearing
< 0)
24487 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24488 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24489 rightmost
-= cmp
->lbearing
;
24490 cmp
->rbearing
-= cmp
->lbearing
;
24493 if (right_padded
&& rightmost
< cmp
->rbearing
)
24495 rightmost
= cmp
->rbearing
;
24498 cmp
->pixel_width
= rightmost
;
24499 cmp
->ascent
= highest
;
24500 cmp
->descent
= - lowest
;
24501 if (cmp
->ascent
< font_ascent
)
24502 cmp
->ascent
= font_ascent
;
24503 if (cmp
->descent
< font_descent
)
24504 cmp
->descent
= font_descent
;
24508 && (cmp
->lbearing
< 0
24509 || cmp
->rbearing
> cmp
->pixel_width
))
24510 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24512 it
->pixel_width
= cmp
->pixel_width
;
24513 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24514 it
->descent
= it
->phys_descent
= cmp
->descent
;
24515 if (face
->box
!= FACE_NO_BOX
)
24517 int thick
= face
->box_line_width
;
24521 it
->ascent
+= thick
;
24522 it
->descent
+= thick
;
24527 if (it
->start_of_box_run_p
)
24528 it
->pixel_width
+= thick
;
24529 if (it
->end_of_box_run_p
)
24530 it
->pixel_width
+= thick
;
24533 /* If face has an overline, add the height of the overline
24534 (1 pixel) and a 1 pixel margin to the character height. */
24535 if (face
->overline_p
)
24536 it
->ascent
+= overline_margin
;
24538 take_vertical_position_into_account (it
);
24539 if (it
->ascent
< 0)
24541 if (it
->descent
< 0)
24545 append_composite_glyph (it
);
24547 else if (it
->what
== IT_COMPOSITION
)
24549 /* A dynamic (automatic) composition. */
24550 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24551 Lisp_Object gstring
;
24552 struct font_metrics metrics
;
24556 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24558 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24561 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24562 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24563 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24564 it
->descent
= it
->phys_descent
= metrics
.descent
;
24565 if (face
->box
!= FACE_NO_BOX
)
24567 int thick
= face
->box_line_width
;
24571 it
->ascent
+= thick
;
24572 it
->descent
+= thick
;
24577 if (it
->start_of_box_run_p
)
24578 it
->pixel_width
+= thick
;
24579 if (it
->end_of_box_run_p
)
24580 it
->pixel_width
+= thick
;
24582 /* If face has an overline, add the height of the overline
24583 (1 pixel) and a 1 pixel margin to the character height. */
24584 if (face
->overline_p
)
24585 it
->ascent
+= overline_margin
;
24586 take_vertical_position_into_account (it
);
24587 if (it
->ascent
< 0)
24589 if (it
->descent
< 0)
24593 append_composite_glyph (it
);
24595 else if (it
->what
== IT_GLYPHLESS
)
24596 produce_glyphless_glyph (it
, 0, Qnil
);
24597 else if (it
->what
== IT_IMAGE
)
24598 produce_image_glyph (it
);
24599 else if (it
->what
== IT_STRETCH
)
24600 produce_stretch_glyph (it
);
24603 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24604 because this isn't true for images with `:ascent 100'. */
24605 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24606 if (it
->area
== TEXT_AREA
)
24607 it
->current_x
+= it
->pixel_width
;
24609 if (extra_line_spacing
> 0)
24611 it
->descent
+= extra_line_spacing
;
24612 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24613 it
->max_extra_line_spacing
= extra_line_spacing
;
24616 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24617 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24618 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24619 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24623 Output LEN glyphs starting at START at the nominal cursor position.
24624 Advance the nominal cursor over the text. The global variable
24625 updated_window contains the window being updated, updated_row is
24626 the glyph row being updated, and updated_area is the area of that
24627 row being updated. */
24630 x_write_glyphs (struct glyph
*start
, int len
)
24634 xassert (updated_window
&& updated_row
);
24637 /* Write glyphs. */
24639 hpos
= start
- updated_row
->glyphs
[updated_area
];
24640 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24641 updated_row
, updated_area
,
24643 DRAW_NORMAL_TEXT
, 0);
24645 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24646 if (updated_area
== TEXT_AREA
24647 && updated_window
->phys_cursor_on_p
24648 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24649 && updated_window
->phys_cursor
.hpos
>= hpos
24650 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24651 updated_window
->phys_cursor_on_p
= 0;
24655 /* Advance the output cursor. */
24656 output_cursor
.hpos
+= len
;
24657 output_cursor
.x
= x
;
24662 Insert LEN glyphs from START at the nominal cursor position. */
24665 x_insert_glyphs (struct glyph
*start
, int len
)
24669 int line_height
, shift_by_width
, shifted_region_width
;
24670 struct glyph_row
*row
;
24671 struct glyph
*glyph
;
24672 int frame_x
, frame_y
;
24675 xassert (updated_window
&& updated_row
);
24677 w
= updated_window
;
24678 f
= XFRAME (WINDOW_FRAME (w
));
24680 /* Get the height of the line we are in. */
24682 line_height
= row
->height
;
24684 /* Get the width of the glyphs to insert. */
24685 shift_by_width
= 0;
24686 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24687 shift_by_width
+= glyph
->pixel_width
;
24689 /* Get the width of the region to shift right. */
24690 shifted_region_width
= (window_box_width (w
, updated_area
)
24695 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24696 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24698 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24699 line_height
, shift_by_width
);
24701 /* Write the glyphs. */
24702 hpos
= start
- row
->glyphs
[updated_area
];
24703 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24705 DRAW_NORMAL_TEXT
, 0);
24707 /* Advance the output cursor. */
24708 output_cursor
.hpos
+= len
;
24709 output_cursor
.x
+= shift_by_width
;
24715 Erase the current text line from the nominal cursor position
24716 (inclusive) to pixel column TO_X (exclusive). The idea is that
24717 everything from TO_X onward is already erased.
24719 TO_X is a pixel position relative to updated_area of
24720 updated_window. TO_X == -1 means clear to the end of this area. */
24723 x_clear_end_of_line (int to_x
)
24726 struct window
*w
= updated_window
;
24727 int max_x
, min_y
, max_y
;
24728 int from_x
, from_y
, to_y
;
24730 xassert (updated_window
&& updated_row
);
24731 f
= XFRAME (w
->frame
);
24733 if (updated_row
->full_width_p
)
24734 max_x
= WINDOW_TOTAL_WIDTH (w
);
24736 max_x
= window_box_width (w
, updated_area
);
24737 max_y
= window_text_bottom_y (w
);
24739 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24740 of window. For TO_X > 0, truncate to end of drawing area. */
24746 to_x
= min (to_x
, max_x
);
24748 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24750 /* Notice if the cursor will be cleared by this operation. */
24751 if (!updated_row
->full_width_p
)
24752 notice_overwritten_cursor (w
, updated_area
,
24753 output_cursor
.x
, -1,
24755 MATRIX_ROW_BOTTOM_Y (updated_row
));
24757 from_x
= output_cursor
.x
;
24759 /* Translate to frame coordinates. */
24760 if (updated_row
->full_width_p
)
24762 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24763 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24767 int area_left
= window_box_left (w
, updated_area
);
24768 from_x
+= area_left
;
24772 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24773 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24774 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24776 /* Prevent inadvertently clearing to end of the X window. */
24777 if (to_x
> from_x
&& to_y
> from_y
)
24780 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24781 to_x
- from_x
, to_y
- from_y
);
24786 #endif /* HAVE_WINDOW_SYSTEM */
24790 /***********************************************************************
24792 ***********************************************************************/
24794 /* Value is the internal representation of the specified cursor type
24795 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24796 of the bar cursor. */
24798 static enum text_cursor_kinds
24799 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24801 enum text_cursor_kinds type
;
24806 if (EQ (arg
, Qbox
))
24807 return FILLED_BOX_CURSOR
;
24809 if (EQ (arg
, Qhollow
))
24810 return HOLLOW_BOX_CURSOR
;
24812 if (EQ (arg
, Qbar
))
24819 && EQ (XCAR (arg
), Qbar
)
24820 && INTEGERP (XCDR (arg
))
24821 && XINT (XCDR (arg
)) >= 0)
24823 *width
= XINT (XCDR (arg
));
24827 if (EQ (arg
, Qhbar
))
24830 return HBAR_CURSOR
;
24834 && EQ (XCAR (arg
), Qhbar
)
24835 && INTEGERP (XCDR (arg
))
24836 && XINT (XCDR (arg
)) >= 0)
24838 *width
= XINT (XCDR (arg
));
24839 return HBAR_CURSOR
;
24842 /* Treat anything unknown as "hollow box cursor".
24843 It was bad to signal an error; people have trouble fixing
24844 .Xdefaults with Emacs, when it has something bad in it. */
24845 type
= HOLLOW_BOX_CURSOR
;
24850 /* Set the default cursor types for specified frame. */
24852 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24857 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24858 FRAME_CURSOR_WIDTH (f
) = width
;
24860 /* By default, set up the blink-off state depending on the on-state. */
24862 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24865 FRAME_BLINK_OFF_CURSOR (f
)
24866 = get_specified_cursor_type (XCDR (tem
), &width
);
24867 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24870 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24874 #ifdef HAVE_WINDOW_SYSTEM
24876 /* Return the cursor we want to be displayed in window W. Return
24877 width of bar/hbar cursor through WIDTH arg. Return with
24878 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24879 (i.e. if the `system caret' should track this cursor).
24881 In a mini-buffer window, we want the cursor only to appear if we
24882 are reading input from this window. For the selected window, we
24883 want the cursor type given by the frame parameter or buffer local
24884 setting of cursor-type. If explicitly marked off, draw no cursor.
24885 In all other cases, we want a hollow box cursor. */
24887 static enum text_cursor_kinds
24888 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24889 int *active_cursor
)
24891 struct frame
*f
= XFRAME (w
->frame
);
24892 struct buffer
*b
= XBUFFER (w
->buffer
);
24893 int cursor_type
= DEFAULT_CURSOR
;
24894 Lisp_Object alt_cursor
;
24895 int non_selected
= 0;
24897 *active_cursor
= 1;
24900 if (cursor_in_echo_area
24901 && FRAME_HAS_MINIBUF_P (f
)
24902 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24904 if (w
== XWINDOW (echo_area_window
))
24906 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24908 *width
= FRAME_CURSOR_WIDTH (f
);
24909 return FRAME_DESIRED_CURSOR (f
);
24912 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24915 *active_cursor
= 0;
24919 /* Detect a nonselected window or nonselected frame. */
24920 else if (w
!= XWINDOW (f
->selected_window
)
24921 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24923 *active_cursor
= 0;
24925 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24931 /* Never display a cursor in a window in which cursor-type is nil. */
24932 if (NILP (BVAR (b
, cursor_type
)))
24935 /* Get the normal cursor type for this window. */
24936 if (EQ (BVAR (b
, cursor_type
), Qt
))
24938 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24939 *width
= FRAME_CURSOR_WIDTH (f
);
24942 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24944 /* Use cursor-in-non-selected-windows instead
24945 for non-selected window or frame. */
24948 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24949 if (!EQ (Qt
, alt_cursor
))
24950 return get_specified_cursor_type (alt_cursor
, width
);
24951 /* t means modify the normal cursor type. */
24952 if (cursor_type
== FILLED_BOX_CURSOR
)
24953 cursor_type
= HOLLOW_BOX_CURSOR
;
24954 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24956 return cursor_type
;
24959 /* Use normal cursor if not blinked off. */
24960 if (!w
->cursor_off_p
)
24962 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24964 if (cursor_type
== FILLED_BOX_CURSOR
)
24966 /* Using a block cursor on large images can be very annoying.
24967 So use a hollow cursor for "large" images.
24968 If image is not transparent (no mask), also use hollow cursor. */
24969 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24970 if (img
!= NULL
&& IMAGEP (img
->spec
))
24972 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24973 where N = size of default frame font size.
24974 This should cover most of the "tiny" icons people may use. */
24976 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24977 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24978 cursor_type
= HOLLOW_BOX_CURSOR
;
24981 else if (cursor_type
!= NO_CURSOR
)
24983 /* Display current only supports BOX and HOLLOW cursors for images.
24984 So for now, unconditionally use a HOLLOW cursor when cursor is
24985 not a solid box cursor. */
24986 cursor_type
= HOLLOW_BOX_CURSOR
;
24989 return cursor_type
;
24992 /* Cursor is blinked off, so determine how to "toggle" it. */
24994 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24995 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24996 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24998 /* Then see if frame has specified a specific blink off cursor type. */
24999 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25001 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25002 return FRAME_BLINK_OFF_CURSOR (f
);
25006 /* Some people liked having a permanently visible blinking cursor,
25007 while others had very strong opinions against it. So it was
25008 decided to remove it. KFS 2003-09-03 */
25010 /* Finally perform built-in cursor blinking:
25011 filled box <-> hollow box
25012 wide [h]bar <-> narrow [h]bar
25013 narrow [h]bar <-> no cursor
25014 other type <-> no cursor */
25016 if (cursor_type
== FILLED_BOX_CURSOR
)
25017 return HOLLOW_BOX_CURSOR
;
25019 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25022 return cursor_type
;
25030 /* Notice when the text cursor of window W has been completely
25031 overwritten by a drawing operation that outputs glyphs in AREA
25032 starting at X0 and ending at X1 in the line starting at Y0 and
25033 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25034 the rest of the line after X0 has been written. Y coordinates
25035 are window-relative. */
25038 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25039 int x0
, int x1
, int y0
, int y1
)
25041 int cx0
, cx1
, cy0
, cy1
;
25042 struct glyph_row
*row
;
25044 if (!w
->phys_cursor_on_p
)
25046 if (area
!= TEXT_AREA
)
25049 if (w
->phys_cursor
.vpos
< 0
25050 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25051 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25052 !(row
->enabled_p
&& row
->displays_text_p
)))
25055 if (row
->cursor_in_fringe_p
)
25057 row
->cursor_in_fringe_p
= 0;
25058 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25059 w
->phys_cursor_on_p
= 0;
25063 cx0
= w
->phys_cursor
.x
;
25064 cx1
= cx0
+ w
->phys_cursor_width
;
25065 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25068 /* The cursor image will be completely removed from the
25069 screen if the output area intersects the cursor area in
25070 y-direction. When we draw in [y0 y1[, and some part of
25071 the cursor is at y < y0, that part must have been drawn
25072 before. When scrolling, the cursor is erased before
25073 actually scrolling, so we don't come here. When not
25074 scrolling, the rows above the old cursor row must have
25075 changed, and in this case these rows must have written
25076 over the cursor image.
25078 Likewise if part of the cursor is below y1, with the
25079 exception of the cursor being in the first blank row at
25080 the buffer and window end because update_text_area
25081 doesn't draw that row. (Except when it does, but
25082 that's handled in update_text_area.) */
25084 cy0
= w
->phys_cursor
.y
;
25085 cy1
= cy0
+ w
->phys_cursor_height
;
25086 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25089 w
->phys_cursor_on_p
= 0;
25092 #endif /* HAVE_WINDOW_SYSTEM */
25095 /************************************************************************
25097 ************************************************************************/
25099 #ifdef HAVE_WINDOW_SYSTEM
25102 Fix the display of area AREA of overlapping row ROW in window W
25103 with respect to the overlapping part OVERLAPS. */
25106 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25107 enum glyph_row_area area
, int overlaps
)
25114 for (i
= 0; i
< row
->used
[area
];)
25116 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25118 int start
= i
, start_x
= x
;
25122 x
+= row
->glyphs
[area
][i
].pixel_width
;
25125 while (i
< row
->used
[area
]
25126 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25128 draw_glyphs (w
, start_x
, row
, area
,
25130 DRAW_NORMAL_TEXT
, overlaps
);
25134 x
+= row
->glyphs
[area
][i
].pixel_width
;
25144 Draw the cursor glyph of window W in glyph row ROW. See the
25145 comment of draw_glyphs for the meaning of HL. */
25148 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25149 enum draw_glyphs_face hl
)
25151 /* If cursor hpos is out of bounds, don't draw garbage. This can
25152 happen in mini-buffer windows when switching between echo area
25153 glyphs and mini-buffer. */
25154 if ((row
->reversed_p
25155 ? (w
->phys_cursor
.hpos
>= 0)
25156 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25158 int on_p
= w
->phys_cursor_on_p
;
25160 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25161 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25163 w
->phys_cursor_on_p
= on_p
;
25165 if (hl
== DRAW_CURSOR
)
25166 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25167 /* When we erase the cursor, and ROW is overlapped by other
25168 rows, make sure that these overlapping parts of other rows
25170 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25172 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25174 if (row
> w
->current_matrix
->rows
25175 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25176 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25177 OVERLAPS_ERASED_CURSOR
);
25179 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25180 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25181 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25182 OVERLAPS_ERASED_CURSOR
);
25189 Erase the image of a cursor of window W from the screen. */
25192 erase_phys_cursor (struct window
*w
)
25194 struct frame
*f
= XFRAME (w
->frame
);
25195 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25196 int hpos
= w
->phys_cursor
.hpos
;
25197 int vpos
= w
->phys_cursor
.vpos
;
25198 int mouse_face_here_p
= 0;
25199 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25200 struct glyph_row
*cursor_row
;
25201 struct glyph
*cursor_glyph
;
25202 enum draw_glyphs_face hl
;
25204 /* No cursor displayed or row invalidated => nothing to do on the
25206 if (w
->phys_cursor_type
== NO_CURSOR
)
25207 goto mark_cursor_off
;
25209 /* VPOS >= active_glyphs->nrows means that window has been resized.
25210 Don't bother to erase the cursor. */
25211 if (vpos
>= active_glyphs
->nrows
)
25212 goto mark_cursor_off
;
25214 /* If row containing cursor is marked invalid, there is nothing we
25216 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25217 if (!cursor_row
->enabled_p
)
25218 goto mark_cursor_off
;
25220 /* If line spacing is > 0, old cursor may only be partially visible in
25221 window after split-window. So adjust visible height. */
25222 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25223 window_text_bottom_y (w
) - cursor_row
->y
);
25225 /* If row is completely invisible, don't attempt to delete a cursor which
25226 isn't there. This can happen if cursor is at top of a window, and
25227 we switch to a buffer with a header line in that window. */
25228 if (cursor_row
->visible_height
<= 0)
25229 goto mark_cursor_off
;
25231 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25232 if (cursor_row
->cursor_in_fringe_p
)
25234 cursor_row
->cursor_in_fringe_p
= 0;
25235 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25236 goto mark_cursor_off
;
25239 /* This can happen when the new row is shorter than the old one.
25240 In this case, either draw_glyphs or clear_end_of_line
25241 should have cleared the cursor. Note that we wouldn't be
25242 able to erase the cursor in this case because we don't have a
25243 cursor glyph at hand. */
25244 if ((cursor_row
->reversed_p
25245 ? (w
->phys_cursor
.hpos
< 0)
25246 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25247 goto mark_cursor_off
;
25249 /* If the cursor is in the mouse face area, redisplay that when
25250 we clear the cursor. */
25251 if (! NILP (hlinfo
->mouse_face_window
)
25252 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25253 /* Don't redraw the cursor's spot in mouse face if it is at the
25254 end of a line (on a newline). The cursor appears there, but
25255 mouse highlighting does not. */
25256 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25257 mouse_face_here_p
= 1;
25259 /* Maybe clear the display under the cursor. */
25260 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25263 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25266 cursor_glyph
= get_phys_cursor_glyph (w
);
25267 if (cursor_glyph
== NULL
)
25268 goto mark_cursor_off
;
25270 width
= cursor_glyph
->pixel_width
;
25271 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25272 x
= w
->phys_cursor
.x
;
25274 width
-= left_x
- x
;
25275 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25276 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25277 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25280 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25283 /* Erase the cursor by redrawing the character underneath it. */
25284 if (mouse_face_here_p
)
25285 hl
= DRAW_MOUSE_FACE
;
25287 hl
= DRAW_NORMAL_TEXT
;
25288 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25291 w
->phys_cursor_on_p
= 0;
25292 w
->phys_cursor_type
= NO_CURSOR
;
25297 Display or clear cursor of window W. If ON is zero, clear the
25298 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25299 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25302 display_and_set_cursor (struct window
*w
, int on
,
25303 int hpos
, int vpos
, int x
, int y
)
25305 struct frame
*f
= XFRAME (w
->frame
);
25306 int new_cursor_type
;
25307 int new_cursor_width
;
25309 struct glyph_row
*glyph_row
;
25310 struct glyph
*glyph
;
25312 /* This is pointless on invisible frames, and dangerous on garbaged
25313 windows and frames; in the latter case, the frame or window may
25314 be in the midst of changing its size, and x and y may be off the
25316 if (! FRAME_VISIBLE_P (f
)
25317 || FRAME_GARBAGED_P (f
)
25318 || vpos
>= w
->current_matrix
->nrows
25319 || hpos
>= w
->current_matrix
->matrix_w
)
25322 /* If cursor is off and we want it off, return quickly. */
25323 if (!on
&& !w
->phys_cursor_on_p
)
25326 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25327 /* If cursor row is not enabled, we don't really know where to
25328 display the cursor. */
25329 if (!glyph_row
->enabled_p
)
25331 w
->phys_cursor_on_p
= 0;
25336 if (!glyph_row
->exact_window_width_line_p
25337 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25338 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25340 xassert (interrupt_input_blocked
);
25342 /* Set new_cursor_type to the cursor we want to be displayed. */
25343 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25344 &new_cursor_width
, &active_cursor
);
25346 /* If cursor is currently being shown and we don't want it to be or
25347 it is in the wrong place, or the cursor type is not what we want,
25349 if (w
->phys_cursor_on_p
25351 || w
->phys_cursor
.x
!= x
25352 || w
->phys_cursor
.y
!= y
25353 || new_cursor_type
!= w
->phys_cursor_type
25354 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25355 && new_cursor_width
!= w
->phys_cursor_width
)))
25356 erase_phys_cursor (w
);
25358 /* Don't check phys_cursor_on_p here because that flag is only set
25359 to zero in some cases where we know that the cursor has been
25360 completely erased, to avoid the extra work of erasing the cursor
25361 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25362 still not be visible, or it has only been partly erased. */
25365 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25366 w
->phys_cursor_height
= glyph_row
->height
;
25368 /* Set phys_cursor_.* before x_draw_.* is called because some
25369 of them may need the information. */
25370 w
->phys_cursor
.x
= x
;
25371 w
->phys_cursor
.y
= glyph_row
->y
;
25372 w
->phys_cursor
.hpos
= hpos
;
25373 w
->phys_cursor
.vpos
= vpos
;
25376 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25377 new_cursor_type
, new_cursor_width
,
25378 on
, active_cursor
);
25382 /* Switch the display of W's cursor on or off, according to the value
25386 update_window_cursor (struct window
*w
, int on
)
25388 /* Don't update cursor in windows whose frame is in the process
25389 of being deleted. */
25390 if (w
->current_matrix
)
25393 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25394 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25400 /* Call update_window_cursor with parameter ON_P on all leaf windows
25401 in the window tree rooted at W. */
25404 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25408 if (!NILP (w
->hchild
))
25409 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25410 else if (!NILP (w
->vchild
))
25411 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25413 update_window_cursor (w
, on_p
);
25415 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25421 Display the cursor on window W, or clear it, according to ON_P.
25422 Don't change the cursor's position. */
25425 x_update_cursor (struct frame
*f
, int on_p
)
25427 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25432 Clear the cursor of window W to background color, and mark the
25433 cursor as not shown. This is used when the text where the cursor
25434 is about to be rewritten. */
25437 x_clear_cursor (struct window
*w
)
25439 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25440 update_window_cursor (w
, 0);
25443 #endif /* HAVE_WINDOW_SYSTEM */
25445 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25448 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25449 int start_hpos
, int end_hpos
,
25450 enum draw_glyphs_face draw
)
25452 #ifdef HAVE_WINDOW_SYSTEM
25453 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25455 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25459 #if defined (HAVE_GPM) || defined (MSDOS)
25460 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25464 /* Display the active region described by mouse_face_* according to DRAW. */
25467 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25469 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25470 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25472 if (/* If window is in the process of being destroyed, don't bother
25474 w
->current_matrix
!= NULL
25475 /* Don't update mouse highlight if hidden */
25476 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25477 /* Recognize when we are called to operate on rows that don't exist
25478 anymore. This can happen when a window is split. */
25479 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25481 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25482 struct glyph_row
*row
, *first
, *last
;
25484 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25485 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25487 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25489 int start_hpos
, end_hpos
, start_x
;
25491 /* For all but the first row, the highlight starts at column 0. */
25494 /* R2L rows have BEG and END in reversed order, but the
25495 screen drawing geometry is always left to right. So
25496 we need to mirror the beginning and end of the
25497 highlighted area in R2L rows. */
25498 if (!row
->reversed_p
)
25500 start_hpos
= hlinfo
->mouse_face_beg_col
;
25501 start_x
= hlinfo
->mouse_face_beg_x
;
25503 else if (row
== last
)
25505 start_hpos
= hlinfo
->mouse_face_end_col
;
25506 start_x
= hlinfo
->mouse_face_end_x
;
25514 else if (row
->reversed_p
&& row
== last
)
25516 start_hpos
= hlinfo
->mouse_face_end_col
;
25517 start_x
= hlinfo
->mouse_face_end_x
;
25527 if (!row
->reversed_p
)
25528 end_hpos
= hlinfo
->mouse_face_end_col
;
25529 else if (row
== first
)
25530 end_hpos
= hlinfo
->mouse_face_beg_col
;
25533 end_hpos
= row
->used
[TEXT_AREA
];
25534 if (draw
== DRAW_NORMAL_TEXT
)
25535 row
->fill_line_p
= 1; /* Clear to end of line */
25538 else if (row
->reversed_p
&& row
== first
)
25539 end_hpos
= hlinfo
->mouse_face_beg_col
;
25542 end_hpos
= row
->used
[TEXT_AREA
];
25543 if (draw
== DRAW_NORMAL_TEXT
)
25544 row
->fill_line_p
= 1; /* Clear to end of line */
25547 if (end_hpos
> start_hpos
)
25549 draw_row_with_mouse_face (w
, start_x
, row
,
25550 start_hpos
, end_hpos
, draw
);
25553 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25557 #ifdef HAVE_WINDOW_SYSTEM
25558 /* When we've written over the cursor, arrange for it to
25559 be displayed again. */
25560 if (FRAME_WINDOW_P (f
)
25561 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25564 display_and_set_cursor (w
, 1,
25565 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25566 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25569 #endif /* HAVE_WINDOW_SYSTEM */
25572 #ifdef HAVE_WINDOW_SYSTEM
25573 /* Change the mouse cursor. */
25574 if (FRAME_WINDOW_P (f
))
25576 if (draw
== DRAW_NORMAL_TEXT
25577 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25578 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25579 else if (draw
== DRAW_MOUSE_FACE
)
25580 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25582 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25584 #endif /* HAVE_WINDOW_SYSTEM */
25588 Clear out the mouse-highlighted active region.
25589 Redraw it un-highlighted first. Value is non-zero if mouse
25590 face was actually drawn unhighlighted. */
25593 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25597 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25599 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25603 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25604 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25605 hlinfo
->mouse_face_window
= Qnil
;
25606 hlinfo
->mouse_face_overlay
= Qnil
;
25610 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25611 within the mouse face on that window. */
25613 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25615 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25617 /* Quickly resolve the easy cases. */
25618 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25619 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25621 if (vpos
< hlinfo
->mouse_face_beg_row
25622 || vpos
> hlinfo
->mouse_face_end_row
)
25624 if (vpos
> hlinfo
->mouse_face_beg_row
25625 && vpos
< hlinfo
->mouse_face_end_row
)
25628 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25630 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25632 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25635 else if ((vpos
== hlinfo
->mouse_face_beg_row
25636 && hpos
>= hlinfo
->mouse_face_beg_col
)
25637 || (vpos
== hlinfo
->mouse_face_end_row
25638 && hpos
< hlinfo
->mouse_face_end_col
))
25643 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25645 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25648 else if ((vpos
== hlinfo
->mouse_face_beg_row
25649 && hpos
<= hlinfo
->mouse_face_beg_col
)
25650 || (vpos
== hlinfo
->mouse_face_end_row
25651 && hpos
> hlinfo
->mouse_face_end_col
))
25659 Non-zero if physical cursor of window W is within mouse face. */
25662 cursor_in_mouse_face_p (struct window
*w
)
25664 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25669 /* Find the glyph rows START_ROW and END_ROW of window W that display
25670 characters between buffer positions START_CHARPOS and END_CHARPOS
25671 (excluding END_CHARPOS). This is similar to row_containing_pos,
25672 but is more accurate when bidi reordering makes buffer positions
25673 change non-linearly with glyph rows. */
25675 rows_from_pos_range (struct window
*w
,
25676 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25677 struct glyph_row
**start
, struct glyph_row
**end
)
25679 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25680 int last_y
= window_text_bottom_y (w
);
25681 struct glyph_row
*row
;
25686 while (!first
->enabled_p
25687 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25690 /* Find the START row. */
25692 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25695 /* A row can potentially be the START row if the range of the
25696 characters it displays intersects the range
25697 [START_CHARPOS..END_CHARPOS). */
25698 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25699 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25700 /* See the commentary in row_containing_pos, for the
25701 explanation of the complicated way to check whether
25702 some position is beyond the end of the characters
25703 displayed by a row. */
25704 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25705 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25706 && !row
->ends_at_zv_p
25707 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25708 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25709 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25710 && !row
->ends_at_zv_p
25711 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25713 /* Found a candidate row. Now make sure at least one of the
25714 glyphs it displays has a charpos from the range
25715 [START_CHARPOS..END_CHARPOS).
25717 This is not obvious because bidi reordering could make
25718 buffer positions of a row be 1,2,3,102,101,100, and if we
25719 want to highlight characters in [50..60), we don't want
25720 this row, even though [50..60) does intersect [1..103),
25721 the range of character positions given by the row's start
25722 and end positions. */
25723 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25724 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25728 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25729 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25738 /* Find the END row. */
25740 /* If the last row is partially visible, start looking for END
25741 from that row, instead of starting from FIRST. */
25742 && !(row
->enabled_p
25743 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25745 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25747 struct glyph_row
*next
= row
+ 1;
25749 if (!next
->enabled_p
25750 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25751 /* The first row >= START whose range of displayed characters
25752 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25753 is the row END + 1. */
25754 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25755 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25756 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25757 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25758 && !next
->ends_at_zv_p
25759 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25760 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25761 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25762 && !next
->ends_at_zv_p
25763 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25770 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25771 but none of the characters it displays are in the range, it is
25773 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25774 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25778 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25779 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25792 /* This function sets the mouse_face_* elements of HLINFO, assuming
25793 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25794 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25795 for the overlay or run of text properties specifying the mouse
25796 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25797 before-string and after-string that must also be highlighted.
25798 COVER_STRING, if non-nil, is a display string that may cover some
25799 or all of the highlighted text. */
25802 mouse_face_from_buffer_pos (Lisp_Object window
,
25803 Mouse_HLInfo
*hlinfo
,
25804 EMACS_INT mouse_charpos
,
25805 EMACS_INT start_charpos
,
25806 EMACS_INT end_charpos
,
25807 Lisp_Object before_string
,
25808 Lisp_Object after_string
,
25809 Lisp_Object cover_string
)
25811 struct window
*w
= XWINDOW (window
);
25812 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25813 struct glyph_row
*r1
, *r2
;
25814 struct glyph
*glyph
, *end
;
25815 EMACS_INT ignore
, pos
;
25818 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25819 xassert (NILP (before_string
) || STRINGP (before_string
));
25820 xassert (NILP (after_string
) || STRINGP (after_string
));
25822 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25823 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25825 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25826 /* If the before-string or display-string contains newlines,
25827 rows_from_pos_range skips to its last row. Move back. */
25828 if (!NILP (before_string
) || !NILP (cover_string
))
25830 struct glyph_row
*prev
;
25831 while ((prev
= r1
- 1, prev
>= first
)
25832 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25833 && prev
->used
[TEXT_AREA
] > 0)
25835 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25836 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25837 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25839 || !(EQ (glyph
->object
, before_string
)
25840 || EQ (glyph
->object
, cover_string
)))
25847 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25848 hlinfo
->mouse_face_past_end
= 1;
25850 else if (!NILP (after_string
))
25852 /* If the after-string has newlines, advance to its last row. */
25853 struct glyph_row
*next
;
25854 struct glyph_row
*last
25855 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25857 for (next
= r2
+ 1;
25859 && next
->used
[TEXT_AREA
] > 0
25860 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25864 /* The rest of the display engine assumes that mouse_face_beg_row is
25865 either above below mouse_face_end_row or identical to it. But
25866 with bidi-reordered continued lines, the row for START_CHARPOS
25867 could be below the row for END_CHARPOS. If so, swap the rows and
25868 store them in correct order. */
25871 struct glyph_row
*tem
= r2
;
25877 hlinfo
->mouse_face_beg_y
= r1
->y
;
25878 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25879 hlinfo
->mouse_face_end_y
= r2
->y
;
25880 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25882 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25883 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25884 could be anywhere in the row and in any order. The strategy
25885 below is to find the leftmost and the rightmost glyph that
25886 belongs to either of these 3 strings, or whose position is
25887 between START_CHARPOS and END_CHARPOS, and highlight all the
25888 glyphs between those two. This may cover more than just the text
25889 between START_CHARPOS and END_CHARPOS if the range of characters
25890 strides the bidi level boundary, e.g. if the beginning is in R2L
25891 text while the end is in L2R text or vice versa. */
25892 if (!r1
->reversed_p
)
25894 /* This row is in a left to right paragraph. Scan it left to
25896 glyph
= r1
->glyphs
[TEXT_AREA
];
25897 end
= glyph
+ r1
->used
[TEXT_AREA
];
25900 /* Skip truncation glyphs at the start of the glyph row. */
25901 if (r1
->displays_text_p
)
25903 && INTEGERP (glyph
->object
)
25904 && glyph
->charpos
< 0;
25906 x
+= glyph
->pixel_width
;
25908 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25909 or COVER_STRING, and the first glyph from buffer whose
25910 position is between START_CHARPOS and END_CHARPOS. */
25912 && !INTEGERP (glyph
->object
)
25913 && !EQ (glyph
->object
, cover_string
)
25914 && !(BUFFERP (glyph
->object
)
25915 && (glyph
->charpos
>= start_charpos
25916 && glyph
->charpos
< end_charpos
));
25919 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25920 are present at buffer positions between START_CHARPOS and
25921 END_CHARPOS, or if they come from an overlay. */
25922 if (EQ (glyph
->object
, before_string
))
25924 pos
= string_buffer_position (before_string
,
25926 /* If pos == 0, it means before_string came from an
25927 overlay, not from a buffer position. */
25928 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25931 else if (EQ (glyph
->object
, after_string
))
25933 pos
= string_buffer_position (after_string
, end_charpos
);
25934 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25937 x
+= glyph
->pixel_width
;
25939 hlinfo
->mouse_face_beg_x
= x
;
25940 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25944 /* This row is in a right to left paragraph. Scan it right to
25948 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25949 glyph
= end
+ r1
->used
[TEXT_AREA
];
25951 /* Skip truncation glyphs at the start of the glyph row. */
25952 if (r1
->displays_text_p
)
25954 && INTEGERP (glyph
->object
)
25955 && glyph
->charpos
< 0;
25959 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25960 or COVER_STRING, and the first glyph from buffer whose
25961 position is between START_CHARPOS and END_CHARPOS. */
25963 && !INTEGERP (glyph
->object
)
25964 && !EQ (glyph
->object
, cover_string
)
25965 && !(BUFFERP (glyph
->object
)
25966 && (glyph
->charpos
>= start_charpos
25967 && glyph
->charpos
< end_charpos
));
25970 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25971 are present at buffer positions between START_CHARPOS and
25972 END_CHARPOS, or if they come from an overlay. */
25973 if (EQ (glyph
->object
, before_string
))
25975 pos
= string_buffer_position (before_string
, start_charpos
);
25976 /* If pos == 0, it means before_string came from an
25977 overlay, not from a buffer position. */
25978 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25981 else if (EQ (glyph
->object
, after_string
))
25983 pos
= string_buffer_position (after_string
, end_charpos
);
25984 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25989 glyph
++; /* first glyph to the right of the highlighted area */
25990 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25991 x
+= g
->pixel_width
;
25992 hlinfo
->mouse_face_beg_x
= x
;
25993 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25996 /* If the highlight ends in a different row, compute GLYPH and END
25997 for the end row. Otherwise, reuse the values computed above for
25998 the row where the highlight begins. */
26001 if (!r2
->reversed_p
)
26003 glyph
= r2
->glyphs
[TEXT_AREA
];
26004 end
= glyph
+ r2
->used
[TEXT_AREA
];
26009 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26010 glyph
= end
+ r2
->used
[TEXT_AREA
];
26014 if (!r2
->reversed_p
)
26016 /* Skip truncation and continuation glyphs near the end of the
26017 row, and also blanks and stretch glyphs inserted by
26018 extend_face_to_end_of_line. */
26020 && INTEGERP ((end
- 1)->object
)
26021 && (end
- 1)->charpos
<= 0)
26023 /* Scan the rest of the glyph row from the end, looking for the
26024 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26025 COVER_STRING, or whose position is between START_CHARPOS
26029 && !INTEGERP (end
->object
)
26030 && !EQ (end
->object
, cover_string
)
26031 && !(BUFFERP (end
->object
)
26032 && (end
->charpos
>= start_charpos
26033 && end
->charpos
< end_charpos
));
26036 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26037 are present at buffer positions between START_CHARPOS and
26038 END_CHARPOS, or if they come from an overlay. */
26039 if (EQ (end
->object
, before_string
))
26041 pos
= string_buffer_position (before_string
, start_charpos
);
26042 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26045 else if (EQ (end
->object
, after_string
))
26047 pos
= string_buffer_position (after_string
, end_charpos
);
26048 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26052 /* Find the X coordinate of the last glyph to be highlighted. */
26053 for (; glyph
<= end
; ++glyph
)
26054 x
+= glyph
->pixel_width
;
26056 hlinfo
->mouse_face_end_x
= x
;
26057 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26061 /* Skip truncation and continuation glyphs near the end of the
26062 row, and also blanks and stretch glyphs inserted by
26063 extend_face_to_end_of_line. */
26067 && INTEGERP (end
->object
)
26068 && end
->charpos
<= 0)
26070 x
+= end
->pixel_width
;
26073 /* Scan the rest of the glyph row from the end, looking for the
26074 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26075 COVER_STRING, or whose position is between START_CHARPOS
26079 && !INTEGERP (end
->object
)
26080 && !EQ (end
->object
, cover_string
)
26081 && !(BUFFERP (end
->object
)
26082 && (end
->charpos
>= start_charpos
26083 && end
->charpos
< end_charpos
));
26086 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26087 are present at buffer positions between START_CHARPOS and
26088 END_CHARPOS, or if they come from an overlay. */
26089 if (EQ (end
->object
, before_string
))
26091 pos
= string_buffer_position (before_string
, start_charpos
);
26092 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26095 else if (EQ (end
->object
, after_string
))
26097 pos
= string_buffer_position (after_string
, end_charpos
);
26098 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26101 x
+= end
->pixel_width
;
26103 hlinfo
->mouse_face_end_x
= x
;
26104 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26107 hlinfo
->mouse_face_window
= window
;
26108 hlinfo
->mouse_face_face_id
26109 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26111 !hlinfo
->mouse_face_hidden
, -1);
26112 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26115 /* The following function is not used anymore (replaced with
26116 mouse_face_from_string_pos), but I leave it here for the time
26117 being, in case someone would. */
26119 #if 0 /* not used */
26121 /* Find the position of the glyph for position POS in OBJECT in
26122 window W's current matrix, and return in *X, *Y the pixel
26123 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26125 RIGHT_P non-zero means return the position of the right edge of the
26126 glyph, RIGHT_P zero means return the left edge position.
26128 If no glyph for POS exists in the matrix, return the position of
26129 the glyph with the next smaller position that is in the matrix, if
26130 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26131 exists in the matrix, return the position of the glyph with the
26132 next larger position in OBJECT.
26134 Value is non-zero if a glyph was found. */
26137 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26138 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26140 int yb
= window_text_bottom_y (w
);
26141 struct glyph_row
*r
;
26142 struct glyph
*best_glyph
= NULL
;
26143 struct glyph_row
*best_row
= NULL
;
26146 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26147 r
->enabled_p
&& r
->y
< yb
;
26150 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26151 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26154 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26155 if (EQ (g
->object
, object
))
26157 if (g
->charpos
== pos
)
26164 else if (best_glyph
== NULL
26165 || ((eabs (g
->charpos
- pos
)
26166 < eabs (best_glyph
->charpos
- pos
))
26169 : g
->charpos
> pos
)))
26183 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26187 *x
+= best_glyph
->pixel_width
;
26192 *vpos
= best_row
- w
->current_matrix
->rows
;
26195 return best_glyph
!= NULL
;
26197 #endif /* not used */
26199 /* Find the positions of the first and the last glyphs in window W's
26200 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26201 (assumed to be a string), and return in HLINFO's mouse_face_*
26202 members the pixel and column/row coordinates of those glyphs. */
26205 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26206 Lisp_Object object
,
26207 EMACS_INT startpos
, EMACS_INT endpos
)
26209 int yb
= window_text_bottom_y (w
);
26210 struct glyph_row
*r
;
26211 struct glyph
*g
, *e
;
26215 /* Find the glyph row with at least one position in the range
26216 [STARTPOS..ENDPOS], and the first glyph in that row whose
26217 position belongs to that range. */
26218 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26219 r
->enabled_p
&& r
->y
< yb
;
26222 if (!r
->reversed_p
)
26224 g
= r
->glyphs
[TEXT_AREA
];
26225 e
= g
+ r
->used
[TEXT_AREA
];
26226 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26227 if (EQ (g
->object
, object
)
26228 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26230 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26231 hlinfo
->mouse_face_beg_y
= r
->y
;
26232 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26233 hlinfo
->mouse_face_beg_x
= gx
;
26242 e
= r
->glyphs
[TEXT_AREA
];
26243 g
= e
+ r
->used
[TEXT_AREA
];
26244 for ( ; g
> e
; --g
)
26245 if (EQ ((g
-1)->object
, object
)
26246 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26248 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26249 hlinfo
->mouse_face_beg_y
= r
->y
;
26250 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26251 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26252 gx
+= g1
->pixel_width
;
26253 hlinfo
->mouse_face_beg_x
= gx
;
26265 /* Starting with the next row, look for the first row which does NOT
26266 include any glyphs whose positions are in the range. */
26267 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26269 g
= r
->glyphs
[TEXT_AREA
];
26270 e
= g
+ r
->used
[TEXT_AREA
];
26272 for ( ; g
< e
; ++g
)
26273 if (EQ (g
->object
, object
)
26274 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26283 /* The highlighted region ends on the previous row. */
26286 /* Set the end row and its vertical pixel coordinate. */
26287 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26288 hlinfo
->mouse_face_end_y
= r
->y
;
26290 /* Compute and set the end column and the end column's horizontal
26291 pixel coordinate. */
26292 if (!r
->reversed_p
)
26294 g
= r
->glyphs
[TEXT_AREA
];
26295 e
= g
+ r
->used
[TEXT_AREA
];
26296 for ( ; e
> g
; --e
)
26297 if (EQ ((e
-1)->object
, object
)
26298 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26300 hlinfo
->mouse_face_end_col
= e
- g
;
26302 for (gx
= r
->x
; g
< e
; ++g
)
26303 gx
+= g
->pixel_width
;
26304 hlinfo
->mouse_face_end_x
= gx
;
26308 e
= r
->glyphs
[TEXT_AREA
];
26309 g
= e
+ r
->used
[TEXT_AREA
];
26310 for (gx
= r
->x
; e
< g
; ++e
)
26312 if (EQ (e
->object
, object
)
26313 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26315 gx
+= e
->pixel_width
;
26317 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26318 hlinfo
->mouse_face_end_x
= gx
;
26322 #ifdef HAVE_WINDOW_SYSTEM
26324 /* See if position X, Y is within a hot-spot of an image. */
26327 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26329 if (!CONSP (hot_spot
))
26332 if (EQ (XCAR (hot_spot
), Qrect
))
26334 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26335 Lisp_Object rect
= XCDR (hot_spot
);
26339 if (!CONSP (XCAR (rect
)))
26341 if (!CONSP (XCDR (rect
)))
26343 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26345 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26347 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26349 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26353 else if (EQ (XCAR (hot_spot
), Qcircle
))
26355 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26356 Lisp_Object circ
= XCDR (hot_spot
);
26357 Lisp_Object lr
, lx0
, ly0
;
26359 && CONSP (XCAR (circ
))
26360 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26361 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26362 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26364 double r
= XFLOATINT (lr
);
26365 double dx
= XINT (lx0
) - x
;
26366 double dy
= XINT (ly0
) - y
;
26367 return (dx
* dx
+ dy
* dy
<= r
* r
);
26370 else if (EQ (XCAR (hot_spot
), Qpoly
))
26372 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26373 if (VECTORP (XCDR (hot_spot
)))
26375 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26376 Lisp_Object
*poly
= v
->contents
;
26377 int n
= v
->header
.size
;
26380 Lisp_Object lx
, ly
;
26383 /* Need an even number of coordinates, and at least 3 edges. */
26384 if (n
< 6 || n
& 1)
26387 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26388 If count is odd, we are inside polygon. Pixels on edges
26389 may or may not be included depending on actual geometry of the
26391 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26392 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26394 x0
= XINT (lx
), y0
= XINT (ly
);
26395 for (i
= 0; i
< n
; i
+= 2)
26397 int x1
= x0
, y1
= y0
;
26398 if ((lx
= poly
[i
], !INTEGERP (lx
))
26399 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26401 x0
= XINT (lx
), y0
= XINT (ly
);
26403 /* Does this segment cross the X line? */
26411 if (y
> y0
&& y
> y1
)
26413 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26423 find_hot_spot (Lisp_Object map
, int x
, int y
)
26425 while (CONSP (map
))
26427 if (CONSP (XCAR (map
))
26428 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26436 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26438 doc
: /* Lookup in image map MAP coordinates X and Y.
26439 An image map is an alist where each element has the format (AREA ID PLIST).
26440 An AREA is specified as either a rectangle, a circle, or a polygon:
26441 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26442 pixel coordinates of the upper left and bottom right corners.
26443 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26444 and the radius of the circle; r may be a float or integer.
26445 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26446 vector describes one corner in the polygon.
26447 Returns the alist element for the first matching AREA in MAP. */)
26448 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26456 return find_hot_spot (map
, XINT (x
), XINT (y
));
26460 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26462 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26464 /* Do not change cursor shape while dragging mouse. */
26465 if (!NILP (do_mouse_tracking
))
26468 if (!NILP (pointer
))
26470 if (EQ (pointer
, Qarrow
))
26471 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26472 else if (EQ (pointer
, Qhand
))
26473 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26474 else if (EQ (pointer
, Qtext
))
26475 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26476 else if (EQ (pointer
, intern ("hdrag")))
26477 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26478 #ifdef HAVE_X_WINDOWS
26479 else if (EQ (pointer
, intern ("vdrag")))
26480 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26482 else if (EQ (pointer
, intern ("hourglass")))
26483 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26484 else if (EQ (pointer
, Qmodeline
))
26485 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26487 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26490 if (cursor
!= No_Cursor
)
26491 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26494 #endif /* HAVE_WINDOW_SYSTEM */
26496 /* Take proper action when mouse has moved to the mode or header line
26497 or marginal area AREA of window W, x-position X and y-position Y.
26498 X is relative to the start of the text display area of W, so the
26499 width of bitmap areas and scroll bars must be subtracted to get a
26500 position relative to the start of the mode line. */
26503 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26504 enum window_part area
)
26506 struct window
*w
= XWINDOW (window
);
26507 struct frame
*f
= XFRAME (w
->frame
);
26508 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26509 #ifdef HAVE_WINDOW_SYSTEM
26510 Display_Info
*dpyinfo
;
26512 Cursor cursor
= No_Cursor
;
26513 Lisp_Object pointer
= Qnil
;
26514 int dx
, dy
, width
, height
;
26516 Lisp_Object string
, object
= Qnil
;
26517 Lisp_Object pos
, help
;
26519 Lisp_Object mouse_face
;
26520 int original_x_pixel
= x
;
26521 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26522 struct glyph_row
*row
;
26524 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26529 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26530 returns them in row/column units! */
26531 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26532 &object
, &dx
, &dy
, &width
, &height
);
26534 row
= (area
== ON_MODE_LINE
26535 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26536 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26538 /* Find the glyph under the mouse pointer. */
26539 if (row
->mode_line_p
&& row
->enabled_p
)
26541 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26542 end
= glyph
+ row
->used
[TEXT_AREA
];
26544 for (x0
= original_x_pixel
;
26545 glyph
< end
&& x0
>= glyph
->pixel_width
;
26547 x0
-= glyph
->pixel_width
;
26555 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26556 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26557 returns them in row/column units! */
26558 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26559 &object
, &dx
, &dy
, &width
, &height
);
26564 #ifdef HAVE_WINDOW_SYSTEM
26565 if (IMAGEP (object
))
26567 Lisp_Object image_map
, hotspot
;
26568 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26570 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26572 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26576 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26577 If so, we could look for mouse-enter, mouse-leave
26578 properties in PLIST (and do something...). */
26579 hotspot
= XCDR (hotspot
);
26580 if (CONSP (hotspot
)
26581 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26583 pointer
= Fplist_get (plist
, Qpointer
);
26584 if (NILP (pointer
))
26586 help
= Fplist_get (plist
, Qhelp_echo
);
26589 help_echo_string
= help
;
26590 /* Is this correct? ++kfs */
26591 XSETWINDOW (help_echo_window
, w
);
26592 help_echo_object
= w
->buffer
;
26593 help_echo_pos
= charpos
;
26597 if (NILP (pointer
))
26598 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26600 #endif /* HAVE_WINDOW_SYSTEM */
26602 if (STRINGP (string
))
26604 pos
= make_number (charpos
);
26605 /* If we're on a string with `help-echo' text property, arrange
26606 for the help to be displayed. This is done by setting the
26607 global variable help_echo_string to the help string. */
26610 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26613 help_echo_string
= help
;
26614 XSETWINDOW (help_echo_window
, w
);
26615 help_echo_object
= string
;
26616 help_echo_pos
= charpos
;
26620 #ifdef HAVE_WINDOW_SYSTEM
26621 if (FRAME_WINDOW_P (f
))
26623 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26624 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26625 if (NILP (pointer
))
26626 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26628 /* Change the mouse pointer according to what is under X/Y. */
26630 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26633 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26634 if (!KEYMAPP (map
))
26635 map
= Fget_text_property (pos
, Qkeymap
, string
);
26636 if (!KEYMAPP (map
))
26637 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26642 /* Change the mouse face according to what is under X/Y. */
26643 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26644 if (!NILP (mouse_face
)
26645 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26650 struct glyph
* tmp_glyph
;
26654 int total_pixel_width
;
26655 EMACS_INT begpos
, endpos
, ignore
;
26659 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26660 Qmouse_face
, string
, Qnil
);
26666 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26668 endpos
= SCHARS (string
);
26672 /* Calculate the glyph position GPOS of GLYPH in the
26673 displayed string, relative to the beginning of the
26674 highlighted part of the string.
26676 Note: GPOS is different from CHARPOS. CHARPOS is the
26677 position of GLYPH in the internal string object. A mode
26678 line string format has structures which are converted to
26679 a flattened string by the Emacs Lisp interpreter. The
26680 internal string is an element of those structures. The
26681 displayed string is the flattened string. */
26682 tmp_glyph
= row_start_glyph
;
26683 while (tmp_glyph
< glyph
26684 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26685 && begpos
<= tmp_glyph
->charpos
26686 && tmp_glyph
->charpos
< endpos
)))
26688 gpos
= glyph
- tmp_glyph
;
26690 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26691 the highlighted part of the displayed string to which
26692 GLYPH belongs. Note: GSEQ_LENGTH is different from
26693 SCHARS (STRING), because the latter returns the length of
26694 the internal string. */
26695 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26697 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26698 && begpos
<= tmp_glyph
->charpos
26699 && tmp_glyph
->charpos
< endpos
));
26702 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26704 /* Calculate the total pixel width of all the glyphs between
26705 the beginning of the highlighted area and GLYPH. */
26706 total_pixel_width
= 0;
26707 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26708 total_pixel_width
+= tmp_glyph
->pixel_width
;
26710 /* Pre calculation of re-rendering position. Note: X is in
26711 column units here, after the call to mode_line_string or
26712 marginal_area_string. */
26714 vpos
= (area
== ON_MODE_LINE
26715 ? (w
->current_matrix
)->nrows
- 1
26718 /* If GLYPH's position is included in the region that is
26719 already drawn in mouse face, we have nothing to do. */
26720 if ( EQ (window
, hlinfo
->mouse_face_window
)
26721 && (!row
->reversed_p
26722 ? (hlinfo
->mouse_face_beg_col
<= hpos
26723 && hpos
< hlinfo
->mouse_face_end_col
)
26724 /* In R2L rows we swap BEG and END, see below. */
26725 : (hlinfo
->mouse_face_end_col
<= hpos
26726 && hpos
< hlinfo
->mouse_face_beg_col
))
26727 && hlinfo
->mouse_face_beg_row
== vpos
)
26730 if (clear_mouse_face (hlinfo
))
26731 cursor
= No_Cursor
;
26733 if (!row
->reversed_p
)
26735 hlinfo
->mouse_face_beg_col
= hpos
;
26736 hlinfo
->mouse_face_beg_x
= original_x_pixel
26737 - (total_pixel_width
+ dx
);
26738 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26739 hlinfo
->mouse_face_end_x
= 0;
26743 /* In R2L rows, show_mouse_face expects BEG and END
26744 coordinates to be swapped. */
26745 hlinfo
->mouse_face_end_col
= hpos
;
26746 hlinfo
->mouse_face_end_x
= original_x_pixel
26747 - (total_pixel_width
+ dx
);
26748 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26749 hlinfo
->mouse_face_beg_x
= 0;
26752 hlinfo
->mouse_face_beg_row
= vpos
;
26753 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26754 hlinfo
->mouse_face_beg_y
= 0;
26755 hlinfo
->mouse_face_end_y
= 0;
26756 hlinfo
->mouse_face_past_end
= 0;
26757 hlinfo
->mouse_face_window
= window
;
26759 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26765 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26767 if (NILP (pointer
))
26770 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26771 clear_mouse_face (hlinfo
);
26773 #ifdef HAVE_WINDOW_SYSTEM
26774 if (FRAME_WINDOW_P (f
))
26775 define_frame_cursor1 (f
, cursor
, pointer
);
26781 Take proper action when the mouse has moved to position X, Y on
26782 frame F as regards highlighting characters that have mouse-face
26783 properties. Also de-highlighting chars where the mouse was before.
26784 X and Y can be negative or out of range. */
26787 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26789 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26790 enum window_part part
;
26791 Lisp_Object window
;
26793 Cursor cursor
= No_Cursor
;
26794 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26797 /* When a menu is active, don't highlight because this looks odd. */
26798 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26799 if (popup_activated ())
26803 if (NILP (Vmouse_highlight
)
26804 || !f
->glyphs_initialized_p
26805 || f
->pointer_invisible
)
26808 hlinfo
->mouse_face_mouse_x
= x
;
26809 hlinfo
->mouse_face_mouse_y
= y
;
26810 hlinfo
->mouse_face_mouse_frame
= f
;
26812 if (hlinfo
->mouse_face_defer
)
26815 if (gc_in_progress
)
26817 hlinfo
->mouse_face_deferred_gc
= 1;
26821 /* Which window is that in? */
26822 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26824 /* If we were displaying active text in another window, clear that.
26825 Also clear if we move out of text area in same window. */
26826 if (! EQ (window
, hlinfo
->mouse_face_window
)
26827 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26828 && !NILP (hlinfo
->mouse_face_window
)))
26829 clear_mouse_face (hlinfo
);
26831 /* Not on a window -> return. */
26832 if (!WINDOWP (window
))
26835 /* Reset help_echo_string. It will get recomputed below. */
26836 help_echo_string
= Qnil
;
26838 /* Convert to window-relative pixel coordinates. */
26839 w
= XWINDOW (window
);
26840 frame_to_window_pixel_xy (w
, &x
, &y
);
26842 #ifdef HAVE_WINDOW_SYSTEM
26843 /* Handle tool-bar window differently since it doesn't display a
26845 if (EQ (window
, f
->tool_bar_window
))
26847 note_tool_bar_highlight (f
, x
, y
);
26852 /* Mouse is on the mode, header line or margin? */
26853 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26854 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26856 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26860 #ifdef HAVE_WINDOW_SYSTEM
26861 if (part
== ON_VERTICAL_BORDER
)
26863 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26864 help_echo_string
= build_string ("drag-mouse-1: resize");
26866 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26867 || part
== ON_SCROLL_BAR
)
26868 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26870 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26873 /* Are we in a window whose display is up to date?
26874 And verify the buffer's text has not changed. */
26875 b
= XBUFFER (w
->buffer
);
26876 if (part
== ON_TEXT
26877 && EQ (w
->window_end_valid
, w
->buffer
)
26878 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26879 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26881 int hpos
, vpos
, dx
, dy
, area
;
26883 struct glyph
*glyph
;
26884 Lisp_Object object
;
26885 Lisp_Object mouse_face
= Qnil
, position
;
26886 Lisp_Object
*overlay_vec
= NULL
;
26887 ptrdiff_t i
, noverlays
;
26888 struct buffer
*obuf
;
26889 EMACS_INT obegv
, ozv
;
26892 /* Find the glyph under X/Y. */
26893 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26895 #ifdef HAVE_WINDOW_SYSTEM
26896 /* Look for :pointer property on image. */
26897 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26899 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26900 if (img
!= NULL
&& IMAGEP (img
->spec
))
26902 Lisp_Object image_map
, hotspot
;
26903 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26905 && (hotspot
= find_hot_spot (image_map
,
26906 glyph
->slice
.img
.x
+ dx
,
26907 glyph
->slice
.img
.y
+ dy
),
26909 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26913 /* Could check XCAR (hotspot) to see if we enter/leave
26915 If so, we could look for mouse-enter, mouse-leave
26916 properties in PLIST (and do something...). */
26917 hotspot
= XCDR (hotspot
);
26918 if (CONSP (hotspot
)
26919 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26921 pointer
= Fplist_get (plist
, Qpointer
);
26922 if (NILP (pointer
))
26924 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26925 if (!NILP (help_echo_string
))
26927 help_echo_window
= window
;
26928 help_echo_object
= glyph
->object
;
26929 help_echo_pos
= glyph
->charpos
;
26933 if (NILP (pointer
))
26934 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26937 #endif /* HAVE_WINDOW_SYSTEM */
26939 /* Clear mouse face if X/Y not over text. */
26941 || area
!= TEXT_AREA
26942 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26943 /* Glyph's OBJECT is an integer for glyphs inserted by the
26944 display engine for its internal purposes, like truncation
26945 and continuation glyphs and blanks beyond the end of
26946 line's text on text terminals. If we are over such a
26947 glyph, we are not over any text. */
26948 || INTEGERP (glyph
->object
)
26949 /* R2L rows have a stretch glyph at their front, which
26950 stands for no text, whereas L2R rows have no glyphs at
26951 all beyond the end of text. Treat such stretch glyphs
26952 like we do with NULL glyphs in L2R rows. */
26953 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26954 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26955 && glyph
->type
== STRETCH_GLYPH
26956 && glyph
->avoid_cursor_p
))
26958 if (clear_mouse_face (hlinfo
))
26959 cursor
= No_Cursor
;
26960 #ifdef HAVE_WINDOW_SYSTEM
26961 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26963 if (area
!= TEXT_AREA
)
26964 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26966 pointer
= Vvoid_text_area_pointer
;
26972 pos
= glyph
->charpos
;
26973 object
= glyph
->object
;
26974 if (!STRINGP (object
) && !BUFFERP (object
))
26977 /* If we get an out-of-range value, return now; avoid an error. */
26978 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26981 /* Make the window's buffer temporarily current for
26982 overlays_at and compute_char_face. */
26983 obuf
= current_buffer
;
26984 current_buffer
= b
;
26990 /* Is this char mouse-active or does it have help-echo? */
26991 position
= make_number (pos
);
26993 if (BUFFERP (object
))
26995 /* Put all the overlays we want in a vector in overlay_vec. */
26996 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26997 /* Sort overlays into increasing priority order. */
26998 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27003 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27006 cursor
= No_Cursor
;
27008 /* Check mouse-face highlighting. */
27010 /* If there exists an overlay with mouse-face overlapping
27011 the one we are currently highlighting, we have to
27012 check if we enter the overlapping overlay, and then
27013 highlight only that. */
27014 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27015 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27017 /* Find the highest priority overlay with a mouse-face. */
27018 Lisp_Object overlay
= Qnil
;
27019 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27021 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27022 if (!NILP (mouse_face
))
27023 overlay
= overlay_vec
[i
];
27026 /* If we're highlighting the same overlay as before, there's
27027 no need to do that again. */
27028 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27029 goto check_help_echo
;
27030 hlinfo
->mouse_face_overlay
= overlay
;
27032 /* Clear the display of the old active region, if any. */
27033 if (clear_mouse_face (hlinfo
))
27034 cursor
= No_Cursor
;
27036 /* If no overlay applies, get a text property. */
27037 if (NILP (overlay
))
27038 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27040 /* Next, compute the bounds of the mouse highlighting and
27042 if (!NILP (mouse_face
) && STRINGP (object
))
27044 /* The mouse-highlighting comes from a display string
27045 with a mouse-face. */
27049 s
= Fprevious_single_property_change
27050 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27051 e
= Fnext_single_property_change
27052 (position
, Qmouse_face
, object
, Qnil
);
27054 s
= make_number (0);
27056 e
= make_number (SCHARS (object
) - 1);
27057 mouse_face_from_string_pos (w
, hlinfo
, object
,
27058 XINT (s
), XINT (e
));
27059 hlinfo
->mouse_face_past_end
= 0;
27060 hlinfo
->mouse_face_window
= window
;
27061 hlinfo
->mouse_face_face_id
27062 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27063 glyph
->face_id
, 1);
27064 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27065 cursor
= No_Cursor
;
27069 /* The mouse-highlighting, if any, comes from an overlay
27070 or text property in the buffer. */
27071 Lisp_Object buffer
IF_LINT (= Qnil
);
27072 Lisp_Object cover_string
IF_LINT (= Qnil
);
27074 if (STRINGP (object
))
27076 /* If we are on a display string with no mouse-face,
27077 check if the text under it has one. */
27078 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27079 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27080 pos
= string_buffer_position (object
, start
);
27083 mouse_face
= get_char_property_and_overlay
27084 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27085 buffer
= w
->buffer
;
27086 cover_string
= object
;
27092 cover_string
= Qnil
;
27095 if (!NILP (mouse_face
))
27097 Lisp_Object before
, after
;
27098 Lisp_Object before_string
, after_string
;
27099 /* To correctly find the limits of mouse highlight
27100 in a bidi-reordered buffer, we must not use the
27101 optimization of limiting the search in
27102 previous-single-property-change and
27103 next-single-property-change, because
27104 rows_from_pos_range needs the real start and end
27105 positions to DTRT in this case. That's because
27106 the first row visible in a window does not
27107 necessarily display the character whose position
27108 is the smallest. */
27110 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27111 ? Fmarker_position (w
->start
)
27114 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27115 ? make_number (BUF_Z (XBUFFER (buffer
))
27116 - XFASTINT (w
->window_end_pos
))
27119 if (NILP (overlay
))
27121 /* Handle the text property case. */
27122 before
= Fprevious_single_property_change
27123 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27124 after
= Fnext_single_property_change
27125 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27126 before_string
= after_string
= Qnil
;
27130 /* Handle the overlay case. */
27131 before
= Foverlay_start (overlay
);
27132 after
= Foverlay_end (overlay
);
27133 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27134 after_string
= Foverlay_get (overlay
, Qafter_string
);
27136 if (!STRINGP (before_string
)) before_string
= Qnil
;
27137 if (!STRINGP (after_string
)) after_string
= Qnil
;
27140 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27143 before_string
, after_string
,
27145 cursor
= No_Cursor
;
27152 /* Look for a `help-echo' property. */
27153 if (NILP (help_echo_string
)) {
27154 Lisp_Object help
, overlay
;
27156 /* Check overlays first. */
27157 help
= overlay
= Qnil
;
27158 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27160 overlay
= overlay_vec
[i
];
27161 help
= Foverlay_get (overlay
, Qhelp_echo
);
27166 help_echo_string
= help
;
27167 help_echo_window
= window
;
27168 help_echo_object
= overlay
;
27169 help_echo_pos
= pos
;
27173 Lisp_Object obj
= glyph
->object
;
27174 EMACS_INT charpos
= glyph
->charpos
;
27176 /* Try text properties. */
27179 && charpos
< SCHARS (obj
))
27181 help
= Fget_text_property (make_number (charpos
),
27185 /* If the string itself doesn't specify a help-echo,
27186 see if the buffer text ``under'' it does. */
27187 struct glyph_row
*r
27188 = MATRIX_ROW (w
->current_matrix
, vpos
);
27189 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27190 EMACS_INT p
= string_buffer_position (obj
, start
);
27193 help
= Fget_char_property (make_number (p
),
27194 Qhelp_echo
, w
->buffer
);
27203 else if (BUFFERP (obj
)
27206 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27211 help_echo_string
= help
;
27212 help_echo_window
= window
;
27213 help_echo_object
= obj
;
27214 help_echo_pos
= charpos
;
27219 #ifdef HAVE_WINDOW_SYSTEM
27220 /* Look for a `pointer' property. */
27221 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27223 /* Check overlays first. */
27224 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27225 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27227 if (NILP (pointer
))
27229 Lisp_Object obj
= glyph
->object
;
27230 EMACS_INT charpos
= glyph
->charpos
;
27232 /* Try text properties. */
27235 && charpos
< SCHARS (obj
))
27237 pointer
= Fget_text_property (make_number (charpos
),
27239 if (NILP (pointer
))
27241 /* If the string itself doesn't specify a pointer,
27242 see if the buffer text ``under'' it does. */
27243 struct glyph_row
*r
27244 = MATRIX_ROW (w
->current_matrix
, vpos
);
27245 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27246 EMACS_INT p
= string_buffer_position (obj
, start
);
27248 pointer
= Fget_char_property (make_number (p
),
27249 Qpointer
, w
->buffer
);
27252 else if (BUFFERP (obj
)
27255 pointer
= Fget_text_property (make_number (charpos
),
27259 #endif /* HAVE_WINDOW_SYSTEM */
27263 current_buffer
= obuf
;
27268 #ifdef HAVE_WINDOW_SYSTEM
27269 if (FRAME_WINDOW_P (f
))
27270 define_frame_cursor1 (f
, cursor
, pointer
);
27272 /* This is here to prevent a compiler error, about "label at end of
27273 compound statement". */
27280 Clear any mouse-face on window W. This function is part of the
27281 redisplay interface, and is called from try_window_id and similar
27282 functions to ensure the mouse-highlight is off. */
27285 x_clear_window_mouse_face (struct window
*w
)
27287 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27288 Lisp_Object window
;
27291 XSETWINDOW (window
, w
);
27292 if (EQ (window
, hlinfo
->mouse_face_window
))
27293 clear_mouse_face (hlinfo
);
27299 Just discard the mouse face information for frame F, if any.
27300 This is used when the size of F is changed. */
27303 cancel_mouse_face (struct frame
*f
)
27305 Lisp_Object window
;
27306 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27308 window
= hlinfo
->mouse_face_window
;
27309 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27311 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27312 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27313 hlinfo
->mouse_face_window
= Qnil
;
27319 /***********************************************************************
27321 ***********************************************************************/
27323 #ifdef HAVE_WINDOW_SYSTEM
27325 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27326 which intersects rectangle R. R is in window-relative coordinates. */
27329 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27330 enum glyph_row_area area
)
27332 struct glyph
*first
= row
->glyphs
[area
];
27333 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27334 struct glyph
*last
;
27335 int first_x
, start_x
, x
;
27337 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27338 /* If row extends face to end of line write the whole line. */
27339 draw_glyphs (w
, 0, row
, area
,
27340 0, row
->used
[area
],
27341 DRAW_NORMAL_TEXT
, 0);
27344 /* Set START_X to the window-relative start position for drawing glyphs of
27345 AREA. The first glyph of the text area can be partially visible.
27346 The first glyphs of other areas cannot. */
27347 start_x
= window_box_left_offset (w
, area
);
27349 if (area
== TEXT_AREA
)
27352 /* Find the first glyph that must be redrawn. */
27354 && x
+ first
->pixel_width
< r
->x
)
27356 x
+= first
->pixel_width
;
27360 /* Find the last one. */
27364 && x
< r
->x
+ r
->width
)
27366 x
+= last
->pixel_width
;
27372 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27373 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27374 DRAW_NORMAL_TEXT
, 0);
27379 /* Redraw the parts of the glyph row ROW on window W intersecting
27380 rectangle R. R is in window-relative coordinates. Value is
27381 non-zero if mouse-face was overwritten. */
27384 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27386 xassert (row
->enabled_p
);
27388 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27389 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27390 0, row
->used
[TEXT_AREA
],
27391 DRAW_NORMAL_TEXT
, 0);
27394 if (row
->used
[LEFT_MARGIN_AREA
])
27395 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27396 if (row
->used
[TEXT_AREA
])
27397 expose_area (w
, row
, r
, TEXT_AREA
);
27398 if (row
->used
[RIGHT_MARGIN_AREA
])
27399 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27400 draw_row_fringe_bitmaps (w
, row
);
27403 return row
->mouse_face_p
;
27407 /* Redraw those parts of glyphs rows during expose event handling that
27408 overlap other rows. Redrawing of an exposed line writes over parts
27409 of lines overlapping that exposed line; this function fixes that.
27411 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27412 row in W's current matrix that is exposed and overlaps other rows.
27413 LAST_OVERLAPPING_ROW is the last such row. */
27416 expose_overlaps (struct window
*w
,
27417 struct glyph_row
*first_overlapping_row
,
27418 struct glyph_row
*last_overlapping_row
,
27421 struct glyph_row
*row
;
27423 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27424 if (row
->overlapping_p
)
27426 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27429 if (row
->used
[LEFT_MARGIN_AREA
])
27430 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27432 if (row
->used
[TEXT_AREA
])
27433 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27435 if (row
->used
[RIGHT_MARGIN_AREA
])
27436 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27442 /* Return non-zero if W's cursor intersects rectangle R. */
27445 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27447 XRectangle cr
, result
;
27448 struct glyph
*cursor_glyph
;
27449 struct glyph_row
*row
;
27451 if (w
->phys_cursor
.vpos
>= 0
27452 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27453 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27455 && row
->cursor_in_fringe_p
)
27457 /* Cursor is in the fringe. */
27458 cr
.x
= window_box_right_offset (w
,
27459 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27460 ? RIGHT_MARGIN_AREA
27463 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27464 cr
.height
= row
->height
;
27465 return x_intersect_rectangles (&cr
, r
, &result
);
27468 cursor_glyph
= get_phys_cursor_glyph (w
);
27471 /* r is relative to W's box, but w->phys_cursor.x is relative
27472 to left edge of W's TEXT area. Adjust it. */
27473 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27474 cr
.y
= w
->phys_cursor
.y
;
27475 cr
.width
= cursor_glyph
->pixel_width
;
27476 cr
.height
= w
->phys_cursor_height
;
27477 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27478 I assume the effect is the same -- and this is portable. */
27479 return x_intersect_rectangles (&cr
, r
, &result
);
27481 /* If we don't understand the format, pretend we're not in the hot-spot. */
27487 Draw a vertical window border to the right of window W if W doesn't
27488 have vertical scroll bars. */
27491 x_draw_vertical_border (struct window
*w
)
27493 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27495 /* We could do better, if we knew what type of scroll-bar the adjacent
27496 windows (on either side) have... But we don't :-(
27497 However, I think this works ok. ++KFS 2003-04-25 */
27499 /* Redraw borders between horizontally adjacent windows. Don't
27500 do it for frames with vertical scroll bars because either the
27501 right scroll bar of a window, or the left scroll bar of its
27502 neighbor will suffice as a border. */
27503 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27506 if (!WINDOW_RIGHTMOST_P (w
)
27507 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27509 int x0
, x1
, y0
, y1
;
27511 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27514 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27517 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27519 else if (!WINDOW_LEFTMOST_P (w
)
27520 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27522 int x0
, x1
, y0
, y1
;
27524 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27527 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27530 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27535 /* Redraw the part of window W intersection rectangle FR. Pixel
27536 coordinates in FR are frame-relative. Call this function with
27537 input blocked. Value is non-zero if the exposure overwrites
27541 expose_window (struct window
*w
, XRectangle
*fr
)
27543 struct frame
*f
= XFRAME (w
->frame
);
27545 int mouse_face_overwritten_p
= 0;
27547 /* If window is not yet fully initialized, do nothing. This can
27548 happen when toolkit scroll bars are used and a window is split.
27549 Reconfiguring the scroll bar will generate an expose for a newly
27551 if (w
->current_matrix
== NULL
)
27554 /* When we're currently updating the window, display and current
27555 matrix usually don't agree. Arrange for a thorough display
27557 if (w
== updated_window
)
27559 SET_FRAME_GARBAGED (f
);
27563 /* Frame-relative pixel rectangle of W. */
27564 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27565 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27566 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27567 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27569 if (x_intersect_rectangles (fr
, &wr
, &r
))
27571 int yb
= window_text_bottom_y (w
);
27572 struct glyph_row
*row
;
27573 int cursor_cleared_p
, phys_cursor_on_p
;
27574 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27576 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27577 r
.x
, r
.y
, r
.width
, r
.height
));
27579 /* Convert to window coordinates. */
27580 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27581 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27583 /* Turn off the cursor. */
27584 if (!w
->pseudo_window_p
27585 && phys_cursor_in_rect_p (w
, &r
))
27587 x_clear_cursor (w
);
27588 cursor_cleared_p
= 1;
27591 cursor_cleared_p
= 0;
27593 /* If the row containing the cursor extends face to end of line,
27594 then expose_area might overwrite the cursor outside the
27595 rectangle and thus notice_overwritten_cursor might clear
27596 w->phys_cursor_on_p. We remember the original value and
27597 check later if it is changed. */
27598 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27600 /* Update lines intersecting rectangle R. */
27601 first_overlapping_row
= last_overlapping_row
= NULL
;
27602 for (row
= w
->current_matrix
->rows
;
27607 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27609 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27610 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27611 || (r
.y
>= y0
&& r
.y
< y1
)
27612 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27614 /* A header line may be overlapping, but there is no need
27615 to fix overlapping areas for them. KFS 2005-02-12 */
27616 if (row
->overlapping_p
&& !row
->mode_line_p
)
27618 if (first_overlapping_row
== NULL
)
27619 first_overlapping_row
= row
;
27620 last_overlapping_row
= row
;
27624 if (expose_line (w
, row
, &r
))
27625 mouse_face_overwritten_p
= 1;
27628 else if (row
->overlapping_p
)
27630 /* We must redraw a row overlapping the exposed area. */
27632 ? y0
+ row
->phys_height
> r
.y
27633 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27635 if (first_overlapping_row
== NULL
)
27636 first_overlapping_row
= row
;
27637 last_overlapping_row
= row
;
27645 /* Display the mode line if there is one. */
27646 if (WINDOW_WANTS_MODELINE_P (w
)
27647 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27649 && row
->y
< r
.y
+ r
.height
)
27651 if (expose_line (w
, row
, &r
))
27652 mouse_face_overwritten_p
= 1;
27655 if (!w
->pseudo_window_p
)
27657 /* Fix the display of overlapping rows. */
27658 if (first_overlapping_row
)
27659 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27662 /* Draw border between windows. */
27663 x_draw_vertical_border (w
);
27665 /* Turn the cursor on again. */
27666 if (cursor_cleared_p
27667 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27668 update_window_cursor (w
, 1);
27672 return mouse_face_overwritten_p
;
27677 /* Redraw (parts) of all windows in the window tree rooted at W that
27678 intersect R. R contains frame pixel coordinates. Value is
27679 non-zero if the exposure overwrites mouse-face. */
27682 expose_window_tree (struct window
*w
, XRectangle
*r
)
27684 struct frame
*f
= XFRAME (w
->frame
);
27685 int mouse_face_overwritten_p
= 0;
27687 while (w
&& !FRAME_GARBAGED_P (f
))
27689 if (!NILP (w
->hchild
))
27690 mouse_face_overwritten_p
27691 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27692 else if (!NILP (w
->vchild
))
27693 mouse_face_overwritten_p
27694 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27696 mouse_face_overwritten_p
|= expose_window (w
, r
);
27698 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27701 return mouse_face_overwritten_p
;
27706 Redisplay an exposed area of frame F. X and Y are the upper-left
27707 corner of the exposed rectangle. W and H are width and height of
27708 the exposed area. All are pixel values. W or H zero means redraw
27709 the entire frame. */
27712 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27715 int mouse_face_overwritten_p
= 0;
27717 TRACE ((stderr
, "expose_frame "));
27719 /* No need to redraw if frame will be redrawn soon. */
27720 if (FRAME_GARBAGED_P (f
))
27722 TRACE ((stderr
, " garbaged\n"));
27726 /* If basic faces haven't been realized yet, there is no point in
27727 trying to redraw anything. This can happen when we get an expose
27728 event while Emacs is starting, e.g. by moving another window. */
27729 if (FRAME_FACE_CACHE (f
) == NULL
27730 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27732 TRACE ((stderr
, " no faces\n"));
27736 if (w
== 0 || h
== 0)
27739 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27740 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27750 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27751 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27753 if (WINDOWP (f
->tool_bar_window
))
27754 mouse_face_overwritten_p
27755 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27757 #ifdef HAVE_X_WINDOWS
27759 #ifndef USE_X_TOOLKIT
27760 if (WINDOWP (f
->menu_bar_window
))
27761 mouse_face_overwritten_p
27762 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27763 #endif /* not USE_X_TOOLKIT */
27767 /* Some window managers support a focus-follows-mouse style with
27768 delayed raising of frames. Imagine a partially obscured frame,
27769 and moving the mouse into partially obscured mouse-face on that
27770 frame. The visible part of the mouse-face will be highlighted,
27771 then the WM raises the obscured frame. With at least one WM, KDE
27772 2.1, Emacs is not getting any event for the raising of the frame
27773 (even tried with SubstructureRedirectMask), only Expose events.
27774 These expose events will draw text normally, i.e. not
27775 highlighted. Which means we must redo the highlight here.
27776 Subsume it under ``we love X''. --gerd 2001-08-15 */
27777 /* Included in Windows version because Windows most likely does not
27778 do the right thing if any third party tool offers
27779 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27780 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27782 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27783 if (f
== hlinfo
->mouse_face_mouse_frame
)
27785 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27786 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27787 clear_mouse_face (hlinfo
);
27788 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27795 Determine the intersection of two rectangles R1 and R2. Return
27796 the intersection in *RESULT. Value is non-zero if RESULT is not
27800 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27802 XRectangle
*left
, *right
;
27803 XRectangle
*upper
, *lower
;
27804 int intersection_p
= 0;
27806 /* Rearrange so that R1 is the left-most rectangle. */
27808 left
= r1
, right
= r2
;
27810 left
= r2
, right
= r1
;
27812 /* X0 of the intersection is right.x0, if this is inside R1,
27813 otherwise there is no intersection. */
27814 if (right
->x
<= left
->x
+ left
->width
)
27816 result
->x
= right
->x
;
27818 /* The right end of the intersection is the minimum of
27819 the right ends of left and right. */
27820 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27823 /* Same game for Y. */
27825 upper
= r1
, lower
= r2
;
27827 upper
= r2
, lower
= r1
;
27829 /* The upper end of the intersection is lower.y0, if this is inside
27830 of upper. Otherwise, there is no intersection. */
27831 if (lower
->y
<= upper
->y
+ upper
->height
)
27833 result
->y
= lower
->y
;
27835 /* The lower end of the intersection is the minimum of the lower
27836 ends of upper and lower. */
27837 result
->height
= (min (lower
->y
+ lower
->height
,
27838 upper
->y
+ upper
->height
)
27840 intersection_p
= 1;
27844 return intersection_p
;
27847 #endif /* HAVE_WINDOW_SYSTEM */
27850 /***********************************************************************
27852 ***********************************************************************/
27855 syms_of_xdisp (void)
27857 Vwith_echo_area_save_vector
= Qnil
;
27858 staticpro (&Vwith_echo_area_save_vector
);
27860 Vmessage_stack
= Qnil
;
27861 staticpro (&Vmessage_stack
);
27863 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27865 message_dolog_marker1
= Fmake_marker ();
27866 staticpro (&message_dolog_marker1
);
27867 message_dolog_marker2
= Fmake_marker ();
27868 staticpro (&message_dolog_marker2
);
27869 message_dolog_marker3
= Fmake_marker ();
27870 staticpro (&message_dolog_marker3
);
27873 defsubr (&Sdump_frame_glyph_matrix
);
27874 defsubr (&Sdump_glyph_matrix
);
27875 defsubr (&Sdump_glyph_row
);
27876 defsubr (&Sdump_tool_bar_row
);
27877 defsubr (&Strace_redisplay
);
27878 defsubr (&Strace_to_stderr
);
27880 #ifdef HAVE_WINDOW_SYSTEM
27881 defsubr (&Stool_bar_lines_needed
);
27882 defsubr (&Slookup_image_map
);
27884 defsubr (&Sformat_mode_line
);
27885 defsubr (&Sinvisible_p
);
27886 defsubr (&Scurrent_bidi_paragraph_direction
);
27888 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27889 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27890 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27891 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27892 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27893 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27894 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27895 DEFSYM (Qeval
, "eval");
27896 DEFSYM (QCdata
, ":data");
27897 DEFSYM (Qdisplay
, "display");
27898 DEFSYM (Qspace_width
, "space-width");
27899 DEFSYM (Qraise
, "raise");
27900 DEFSYM (Qslice
, "slice");
27901 DEFSYM (Qspace
, "space");
27902 DEFSYM (Qmargin
, "margin");
27903 DEFSYM (Qpointer
, "pointer");
27904 DEFSYM (Qleft_margin
, "left-margin");
27905 DEFSYM (Qright_margin
, "right-margin");
27906 DEFSYM (Qcenter
, "center");
27907 DEFSYM (Qline_height
, "line-height");
27908 DEFSYM (QCalign_to
, ":align-to");
27909 DEFSYM (QCrelative_width
, ":relative-width");
27910 DEFSYM (QCrelative_height
, ":relative-height");
27911 DEFSYM (QCeval
, ":eval");
27912 DEFSYM (QCpropertize
, ":propertize");
27913 DEFSYM (QCfile
, ":file");
27914 DEFSYM (Qfontified
, "fontified");
27915 DEFSYM (Qfontification_functions
, "fontification-functions");
27916 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27917 DEFSYM (Qescape_glyph
, "escape-glyph");
27918 DEFSYM (Qnobreak_space
, "nobreak-space");
27919 DEFSYM (Qimage
, "image");
27920 DEFSYM (Qtext
, "text");
27921 DEFSYM (Qboth
, "both");
27922 DEFSYM (Qboth_horiz
, "both-horiz");
27923 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27924 DEFSYM (QCmap
, ":map");
27925 DEFSYM (QCpointer
, ":pointer");
27926 DEFSYM (Qrect
, "rect");
27927 DEFSYM (Qcircle
, "circle");
27928 DEFSYM (Qpoly
, "poly");
27929 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27930 DEFSYM (Qgrow_only
, "grow-only");
27931 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27932 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27933 DEFSYM (Qposition
, "position");
27934 DEFSYM (Qbuffer_position
, "buffer-position");
27935 DEFSYM (Qobject
, "object");
27936 DEFSYM (Qbar
, "bar");
27937 DEFSYM (Qhbar
, "hbar");
27938 DEFSYM (Qbox
, "box");
27939 DEFSYM (Qhollow
, "hollow");
27940 DEFSYM (Qhand
, "hand");
27941 DEFSYM (Qarrow
, "arrow");
27942 DEFSYM (Qtext
, "text");
27943 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27945 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27946 Fcons (intern_c_string ("void-variable"), Qnil
)),
27948 staticpro (&list_of_error
);
27950 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27951 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27952 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27953 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27955 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27956 staticpro (&echo_buffer
[0]);
27957 staticpro (&echo_buffer
[1]);
27959 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27960 staticpro (&echo_area_buffer
[0]);
27961 staticpro (&echo_area_buffer
[1]);
27963 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27964 staticpro (&Vmessages_buffer_name
);
27966 mode_line_proptrans_alist
= Qnil
;
27967 staticpro (&mode_line_proptrans_alist
);
27968 mode_line_string_list
= Qnil
;
27969 staticpro (&mode_line_string_list
);
27970 mode_line_string_face
= Qnil
;
27971 staticpro (&mode_line_string_face
);
27972 mode_line_string_face_prop
= Qnil
;
27973 staticpro (&mode_line_string_face_prop
);
27974 Vmode_line_unwind_vector
= Qnil
;
27975 staticpro (&Vmode_line_unwind_vector
);
27977 help_echo_string
= Qnil
;
27978 staticpro (&help_echo_string
);
27979 help_echo_object
= Qnil
;
27980 staticpro (&help_echo_object
);
27981 help_echo_window
= Qnil
;
27982 staticpro (&help_echo_window
);
27983 previous_help_echo_string
= Qnil
;
27984 staticpro (&previous_help_echo_string
);
27985 help_echo_pos
= -1;
27987 DEFSYM (Qright_to_left
, "right-to-left");
27988 DEFSYM (Qleft_to_right
, "left-to-right");
27990 #ifdef HAVE_WINDOW_SYSTEM
27991 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27992 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27993 For example, if a block cursor is over a tab, it will be drawn as
27994 wide as that tab on the display. */);
27995 x_stretch_cursor_p
= 0;
27998 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27999 doc
: /* *Non-nil means highlight trailing whitespace.
28000 The face used for trailing whitespace is `trailing-whitespace'. */);
28001 Vshow_trailing_whitespace
= Qnil
;
28003 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28004 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28005 If the value is t, Emacs highlights non-ASCII chars which have the
28006 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28007 or `escape-glyph' face respectively.
28009 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28010 U+2011 (non-breaking hyphen) are affected.
28012 Any other non-nil value means to display these characters as a escape
28013 glyph followed by an ordinary space or hyphen.
28015 A value of nil means no special handling of these characters. */);
28016 Vnobreak_char_display
= Qt
;
28018 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28019 doc
: /* *The pointer shape to show in void text areas.
28020 A value of nil means to show the text pointer. Other options are `arrow',
28021 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28022 Vvoid_text_area_pointer
= Qarrow
;
28024 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28025 doc
: /* Non-nil means don't actually do any redisplay.
28026 This is used for internal purposes. */);
28027 Vinhibit_redisplay
= Qnil
;
28029 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28030 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28031 Vglobal_mode_string
= Qnil
;
28033 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28034 doc
: /* Marker for where to display an arrow on top of the buffer text.
28035 This must be the beginning of a line in order to work.
28036 See also `overlay-arrow-string'. */);
28037 Voverlay_arrow_position
= Qnil
;
28039 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28040 doc
: /* String to display as an arrow in non-window frames.
28041 See also `overlay-arrow-position'. */);
28042 Voverlay_arrow_string
= make_pure_c_string ("=>");
28044 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28045 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28046 The symbols on this list are examined during redisplay to determine
28047 where to display overlay arrows. */);
28048 Voverlay_arrow_variable_list
28049 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28051 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28052 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28053 If that fails to bring point back on frame, point is centered instead.
28054 If this is zero, point is always centered after it moves off frame.
28055 If you want scrolling to always be a line at a time, you should set
28056 `scroll-conservatively' to a large value rather than set this to 1. */);
28058 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28059 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28060 If point moves off-screen, redisplay will scroll by up to
28061 `scroll-conservatively' lines in order to bring point just barely
28062 onto the screen again. If that cannot be done, then redisplay
28063 recenters point as usual.
28065 If the value is greater than 100, redisplay will never recenter point,
28066 but will always scroll just enough text to bring point into view, even
28067 if you move far away.
28069 A value of zero means always recenter point if it moves off screen. */);
28070 scroll_conservatively
= 0;
28072 DEFVAR_INT ("scroll-margin", scroll_margin
,
28073 doc
: /* *Number of lines of margin at the top and bottom of a window.
28074 Recenter the window whenever point gets within this many lines
28075 of the top or bottom of the window. */);
28078 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28079 doc
: /* Pixels per inch value for non-window system displays.
28080 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28081 Vdisplay_pixels_per_inch
= make_float (72.0);
28084 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28087 DEFVAR_LISP ("truncate-partial-width-windows",
28088 Vtruncate_partial_width_windows
,
28089 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28090 For an integer value, truncate lines in each window narrower than the
28091 full frame width, provided the window width is less than that integer;
28092 otherwise, respect the value of `truncate-lines'.
28094 For any other non-nil value, truncate lines in all windows that do
28095 not span the full frame width.
28097 A value of nil means to respect the value of `truncate-lines'.
28099 If `word-wrap' is enabled, you might want to reduce this. */);
28100 Vtruncate_partial_width_windows
= make_number (50);
28102 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28103 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28104 Any other value means to use the appropriate face, `mode-line',
28105 `header-line', or `menu' respectively. */);
28106 mode_line_inverse_video
= 1;
28108 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28109 doc
: /* *Maximum buffer size for which line number should be displayed.
28110 If the buffer is bigger than this, the line number does not appear
28111 in the mode line. A value of nil means no limit. */);
28112 Vline_number_display_limit
= Qnil
;
28114 DEFVAR_INT ("line-number-display-limit-width",
28115 line_number_display_limit_width
,
28116 doc
: /* *Maximum line width (in characters) for line number display.
28117 If the average length of the lines near point is bigger than this, then the
28118 line number may be omitted from the mode line. */);
28119 line_number_display_limit_width
= 200;
28121 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28122 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28123 highlight_nonselected_windows
= 0;
28125 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28126 doc
: /* Non-nil if more than one frame is visible on this display.
28127 Minibuffer-only frames don't count, but iconified frames do.
28128 This variable is not guaranteed to be accurate except while processing
28129 `frame-title-format' and `icon-title-format'. */);
28131 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28132 doc
: /* Template for displaying the title bar of visible frames.
28133 \(Assuming the window manager supports this feature.)
28135 This variable has the same structure as `mode-line-format', except that
28136 the %c and %l constructs are ignored. It is used only on frames for
28137 which no explicit name has been set \(see `modify-frame-parameters'). */);
28139 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28140 doc
: /* Template for displaying the title bar of an iconified frame.
28141 \(Assuming the window manager supports this feature.)
28142 This variable has the same structure as `mode-line-format' (which see),
28143 and is used only on frames for which no explicit name has been set
28144 \(see `modify-frame-parameters'). */);
28146 = Vframe_title_format
28147 = pure_cons (intern_c_string ("multiple-frames"),
28148 pure_cons (make_pure_c_string ("%b"),
28149 pure_cons (pure_cons (empty_unibyte_string
,
28150 pure_cons (intern_c_string ("invocation-name"),
28151 pure_cons (make_pure_c_string ("@"),
28152 pure_cons (intern_c_string ("system-name"),
28156 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28157 doc
: /* Maximum number of lines to keep in the message log buffer.
28158 If nil, disable message logging. If t, log messages but don't truncate
28159 the buffer when it becomes large. */);
28160 Vmessage_log_max
= make_number (100);
28162 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28163 doc
: /* Functions called before redisplay, if window sizes have changed.
28164 The value should be a list of functions that take one argument.
28165 Just before redisplay, for each frame, if any of its windows have changed
28166 size since the last redisplay, or have been split or deleted,
28167 all the functions in the list are called, with the frame as argument. */);
28168 Vwindow_size_change_functions
= Qnil
;
28170 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28171 doc
: /* List of functions to call before redisplaying a window with scrolling.
28172 Each function is called with two arguments, the window and its new
28173 display-start position. Note that these functions are also called by
28174 `set-window-buffer'. Also note that the value of `window-end' is not
28175 valid when these functions are called. */);
28176 Vwindow_scroll_functions
= Qnil
;
28178 DEFVAR_LISP ("window-text-change-functions",
28179 Vwindow_text_change_functions
,
28180 doc
: /* Functions to call in redisplay when text in the window might change. */);
28181 Vwindow_text_change_functions
= Qnil
;
28183 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28184 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28185 Each function is called with two arguments, the window and the end trigger value.
28186 See `set-window-redisplay-end-trigger'. */);
28187 Vredisplay_end_trigger_functions
= Qnil
;
28189 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28190 doc
: /* *Non-nil means autoselect window with mouse pointer.
28191 If nil, do not autoselect windows.
28192 A positive number means delay autoselection by that many seconds: a
28193 window is autoselected only after the mouse has remained in that
28194 window for the duration of the delay.
28195 A negative number has a similar effect, but causes windows to be
28196 autoselected only after the mouse has stopped moving. \(Because of
28197 the way Emacs compares mouse events, you will occasionally wait twice
28198 that time before the window gets selected.\)
28199 Any other value means to autoselect window instantaneously when the
28200 mouse pointer enters it.
28202 Autoselection selects the minibuffer only if it is active, and never
28203 unselects the minibuffer if it is active.
28205 When customizing this variable make sure that the actual value of
28206 `focus-follows-mouse' matches the behavior of your window manager. */);
28207 Vmouse_autoselect_window
= Qnil
;
28209 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28210 doc
: /* *Non-nil means automatically resize tool-bars.
28211 This dynamically changes the tool-bar's height to the minimum height
28212 that is needed to make all tool-bar items visible.
28213 If value is `grow-only', the tool-bar's height is only increased
28214 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28215 Vauto_resize_tool_bars
= Qt
;
28217 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28218 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28219 auto_raise_tool_bar_buttons_p
= 1;
28221 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28222 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28223 make_cursor_line_fully_visible_p
= 1;
28225 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28226 doc
: /* *Border below tool-bar in pixels.
28227 If an integer, use it as the height of the border.
28228 If it is one of `internal-border-width' or `border-width', use the
28229 value of the corresponding frame parameter.
28230 Otherwise, no border is added below the tool-bar. */);
28231 Vtool_bar_border
= Qinternal_border_width
;
28233 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28234 doc
: /* *Margin around tool-bar buttons in pixels.
28235 If an integer, use that for both horizontal and vertical margins.
28236 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28237 HORZ specifying the horizontal margin, and VERT specifying the
28238 vertical margin. */);
28239 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28241 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28242 doc
: /* *Relief thickness of tool-bar buttons. */);
28243 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28245 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28246 doc
: /* Tool bar style to use.
28248 image - show images only
28249 text - show text only
28250 both - show both, text below image
28251 both-horiz - show text to the right of the image
28252 text-image-horiz - show text to the left of the image
28253 any other - use system default or image if no system default. */);
28254 Vtool_bar_style
= Qnil
;
28256 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28257 doc
: /* *Maximum number of characters a label can have to be shown.
28258 The tool bar style must also show labels for this to have any effect, see
28259 `tool-bar-style'. */);
28260 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28262 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28263 doc
: /* List of functions to call to fontify regions of text.
28264 Each function is called with one argument POS. Functions must
28265 fontify a region starting at POS in the current buffer, and give
28266 fontified regions the property `fontified'. */);
28267 Vfontification_functions
= Qnil
;
28268 Fmake_variable_buffer_local (Qfontification_functions
);
28270 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28271 unibyte_display_via_language_environment
,
28272 doc
: /* *Non-nil means display unibyte text according to language environment.
28273 Specifically, this means that raw bytes in the range 160-255 decimal
28274 are displayed by converting them to the equivalent multibyte characters
28275 according to the current language environment. As a result, they are
28276 displayed according to the current fontset.
28278 Note that this variable affects only how these bytes are displayed,
28279 but does not change the fact they are interpreted as raw bytes. */);
28280 unibyte_display_via_language_environment
= 0;
28282 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28283 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28284 If a float, it specifies a fraction of the mini-window frame's height.
28285 If an integer, it specifies a number of lines. */);
28286 Vmax_mini_window_height
= make_float (0.25);
28288 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28289 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28290 A value of nil means don't automatically resize mini-windows.
28291 A value of t means resize them to fit the text displayed in them.
28292 A value of `grow-only', the default, means let mini-windows grow only;
28293 they return to their normal size when the minibuffer is closed, or the
28294 echo area becomes empty. */);
28295 Vresize_mini_windows
= Qgrow_only
;
28297 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28298 doc
: /* Alist specifying how to blink the cursor off.
28299 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28300 `cursor-type' frame-parameter or variable equals ON-STATE,
28301 comparing using `equal', Emacs uses OFF-STATE to specify
28302 how to blink it off. ON-STATE and OFF-STATE are values for
28303 the `cursor-type' frame parameter.
28305 If a frame's ON-STATE has no entry in this list,
28306 the frame's other specifications determine how to blink the cursor off. */);
28307 Vblink_cursor_alist
= Qnil
;
28309 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28310 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28311 If non-nil, windows are automatically scrolled horizontally to make
28312 point visible. */);
28313 automatic_hscrolling_p
= 1;
28314 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28316 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28317 doc
: /* *How many columns away from the window edge point is allowed to get
28318 before automatic hscrolling will horizontally scroll the window. */);
28319 hscroll_margin
= 5;
28321 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28322 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28323 When point is less than `hscroll-margin' columns from the window
28324 edge, automatic hscrolling will scroll the window by the amount of columns
28325 determined by this variable. If its value is a positive integer, scroll that
28326 many columns. If it's a positive floating-point number, it specifies the
28327 fraction of the window's width to scroll. If it's nil or zero, point will be
28328 centered horizontally after the scroll. Any other value, including negative
28329 numbers, are treated as if the value were zero.
28331 Automatic hscrolling always moves point outside the scroll margin, so if
28332 point was more than scroll step columns inside the margin, the window will
28333 scroll more than the value given by the scroll step.
28335 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28336 and `scroll-right' overrides this variable's effect. */);
28337 Vhscroll_step
= make_number (0);
28339 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28340 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28341 Bind this around calls to `message' to let it take effect. */);
28342 message_truncate_lines
= 0;
28344 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28345 doc
: /* Normal hook run to update the menu bar definitions.
28346 Redisplay runs this hook before it redisplays the menu bar.
28347 This is used to update submenus such as Buffers,
28348 whose contents depend on various data. */);
28349 Vmenu_bar_update_hook
= Qnil
;
28351 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28352 doc
: /* Frame for which we are updating a menu.
28353 The enable predicate for a menu binding should check this variable. */);
28354 Vmenu_updating_frame
= Qnil
;
28356 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28357 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28358 inhibit_menubar_update
= 0;
28360 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28361 doc
: /* Prefix prepended to all continuation lines at display time.
28362 The value may be a string, an image, or a stretch-glyph; it is
28363 interpreted in the same way as the value of a `display' text property.
28365 This variable is overridden by any `wrap-prefix' text or overlay
28368 To add a prefix to non-continuation lines, use `line-prefix'. */);
28369 Vwrap_prefix
= Qnil
;
28370 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28371 Fmake_variable_buffer_local (Qwrap_prefix
);
28373 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28374 doc
: /* Prefix prepended to all non-continuation lines at display time.
28375 The value may be a string, an image, or a stretch-glyph; it is
28376 interpreted in the same way as the value of a `display' text property.
28378 This variable is overridden by any `line-prefix' text or overlay
28381 To add a prefix to continuation lines, use `wrap-prefix'. */);
28382 Vline_prefix
= Qnil
;
28383 DEFSYM (Qline_prefix
, "line-prefix");
28384 Fmake_variable_buffer_local (Qline_prefix
);
28386 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28387 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28388 inhibit_eval_during_redisplay
= 0;
28390 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28391 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28392 inhibit_free_realized_faces
= 0;
28395 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28396 doc
: /* Inhibit try_window_id display optimization. */);
28397 inhibit_try_window_id
= 0;
28399 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28400 doc
: /* Inhibit try_window_reusing display optimization. */);
28401 inhibit_try_window_reusing
= 0;
28403 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28404 doc
: /* Inhibit try_cursor_movement display optimization. */);
28405 inhibit_try_cursor_movement
= 0;
28406 #endif /* GLYPH_DEBUG */
28408 DEFVAR_INT ("overline-margin", overline_margin
,
28409 doc
: /* *Space between overline and text, in pixels.
28410 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28411 margin to the caracter height. */);
28412 overline_margin
= 2;
28414 DEFVAR_INT ("underline-minimum-offset",
28415 underline_minimum_offset
,
28416 doc
: /* Minimum distance between baseline and underline.
28417 This can improve legibility of underlined text at small font sizes,
28418 particularly when using variable `x-use-underline-position-properties'
28419 with fonts that specify an UNDERLINE_POSITION relatively close to the
28420 baseline. The default value is 1. */);
28421 underline_minimum_offset
= 1;
28423 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28424 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28425 This feature only works when on a window system that can change
28426 cursor shapes. */);
28427 display_hourglass_p
= 1;
28429 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28430 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28431 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28433 hourglass_atimer
= NULL
;
28434 hourglass_shown_p
= 0;
28436 DEFSYM (Qglyphless_char
, "glyphless-char");
28437 DEFSYM (Qhex_code
, "hex-code");
28438 DEFSYM (Qempty_box
, "empty-box");
28439 DEFSYM (Qthin_space
, "thin-space");
28440 DEFSYM (Qzero_width
, "zero-width");
28442 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28443 /* Intern this now in case it isn't already done.
28444 Setting this variable twice is harmless.
28445 But don't staticpro it here--that is done in alloc.c. */
28446 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28447 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28449 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28450 doc
: /* Char-table defining glyphless characters.
28451 Each element, if non-nil, should be one of the following:
28452 an ASCII acronym string: display this string in a box
28453 `hex-code': display the hexadecimal code of a character in a box
28454 `empty-box': display as an empty box
28455 `thin-space': display as 1-pixel width space
28456 `zero-width': don't display
28457 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28458 display method for graphical terminals and text terminals respectively.
28459 GRAPHICAL and TEXT should each have one of the values listed above.
28461 The char-table has one extra slot to control the display of a character for
28462 which no font is found. This slot only takes effect on graphical terminals.
28463 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28464 `thin-space'. The default is `empty-box'. */);
28465 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28466 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28471 /* Initialize this module when Emacs starts. */
28476 current_header_line_height
= current_mode_line_height
= -1;
28478 CHARPOS (this_line_start_pos
) = 0;
28480 if (!noninteractive
)
28482 struct window
*m
= XWINDOW (minibuf_window
);
28483 Lisp_Object frame
= m
->frame
;
28484 struct frame
*f
= XFRAME (frame
);
28485 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28486 struct window
*r
= XWINDOW (root
);
28489 echo_area_window
= minibuf_window
;
28491 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28492 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28493 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28494 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28495 XSETFASTINT (m
->total_lines
, 1);
28496 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28498 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28499 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28500 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28502 /* The default ellipsis glyphs `...'. */
28503 for (i
= 0; i
< 3; ++i
)
28504 default_invis_vector
[i
] = make_number ('.');
28508 /* Allocate the buffer for frame titles.
28509 Also used for `format-mode-line'. */
28511 mode_line_noprop_buf
= (char *) xmalloc (size
);
28512 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28513 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28514 mode_line_target
= MODE_LINE_DISPLAY
;
28517 help_echo_showing_p
= 0;
28520 /* Since w32 does not support atimers, it defines its own implementation of
28521 the following three functions in w32fns.c. */
28524 /* Platform-independent portion of hourglass implementation. */
28526 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28528 hourglass_started (void)
28530 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28533 /* Cancel a currently active hourglass timer, and start a new one. */
28535 start_hourglass (void)
28537 #if defined (HAVE_WINDOW_SYSTEM)
28539 int secs
, usecs
= 0;
28541 cancel_hourglass ();
28543 if (INTEGERP (Vhourglass_delay
)
28544 && XINT (Vhourglass_delay
) > 0)
28545 secs
= XFASTINT (Vhourglass_delay
);
28546 else if (FLOATP (Vhourglass_delay
)
28547 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28550 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28551 secs
= XFASTINT (tem
);
28552 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28555 secs
= DEFAULT_HOURGLASS_DELAY
;
28557 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28558 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28559 show_hourglass
, NULL
);
28564 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28567 cancel_hourglass (void)
28569 #if defined (HAVE_WINDOW_SYSTEM)
28570 if (hourglass_atimer
)
28572 cancel_atimer (hourglass_atimer
);
28573 hourglass_atimer
= NULL
;
28576 if (hourglass_shown_p
)
28580 #endif /* ! WINDOWSNT */