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. A display string is either an overlay with
3390 `display' property whose value is a string or a `display' text
3391 property whose value is a string. */
3393 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3395 /* OBJECT = nil means current buffer. */
3396 Lisp_Object object
=
3397 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3398 Lisp_Object pos
= make_number (charpos
);
3400 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3402 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3405 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3408 /* Look forward for the first character where the `display' property
3410 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3412 return XFASTINT (pos
);
3417 /***********************************************************************
3419 ***********************************************************************/
3421 /* Handle changes in the `fontified' property of the current buffer by
3422 calling hook functions from Qfontification_functions to fontify
3425 static enum prop_handled
3426 handle_fontified_prop (struct it
*it
)
3428 Lisp_Object prop
, pos
;
3429 enum prop_handled handled
= HANDLED_NORMALLY
;
3431 if (!NILP (Vmemory_full
))
3434 /* Get the value of the `fontified' property at IT's current buffer
3435 position. (The `fontified' property doesn't have a special
3436 meaning in strings.) If the value is nil, call functions from
3437 Qfontification_functions. */
3438 if (!STRINGP (it
->string
)
3440 && !NILP (Vfontification_functions
)
3441 && !NILP (Vrun_hooks
)
3442 && (pos
= make_number (IT_CHARPOS (*it
)),
3443 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3444 /* Ignore the special cased nil value always present at EOB since
3445 no amount of fontifying will be able to change it. */
3446 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3448 int count
= SPECPDL_INDEX ();
3450 struct buffer
*obuf
= current_buffer
;
3451 int begv
= BEGV
, zv
= ZV
;
3452 int old_clip_changed
= current_buffer
->clip_changed
;
3454 val
= Vfontification_functions
;
3455 specbind (Qfontification_functions
, Qnil
);
3457 xassert (it
->end_charpos
== ZV
);
3459 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3460 safe_call1 (val
, pos
);
3463 Lisp_Object fns
, fn
;
3464 struct gcpro gcpro1
, gcpro2
;
3469 for (; CONSP (val
); val
= XCDR (val
))
3475 /* A value of t indicates this hook has a local
3476 binding; it means to run the global binding too.
3477 In a global value, t should not occur. If it
3478 does, we must ignore it to avoid an endless
3480 for (fns
= Fdefault_value (Qfontification_functions
);
3486 safe_call1 (fn
, pos
);
3490 safe_call1 (fn
, pos
);
3496 unbind_to (count
, Qnil
);
3498 /* Fontification functions routinely call `save-restriction'.
3499 Normally, this tags clip_changed, which can confuse redisplay
3500 (see discussion in Bug#6671). Since we don't perform any
3501 special handling of fontification changes in the case where
3502 `save-restriction' isn't called, there's no point doing so in
3503 this case either. So, if the buffer's restrictions are
3504 actually left unchanged, reset clip_changed. */
3505 if (obuf
== current_buffer
)
3507 if (begv
== BEGV
&& zv
== ZV
)
3508 current_buffer
->clip_changed
= old_clip_changed
;
3510 /* There isn't much we can reasonably do to protect against
3511 misbehaving fontification, but here's a fig leaf. */
3512 else if (!NILP (BVAR (obuf
, name
)))
3513 set_buffer_internal_1 (obuf
);
3515 /* The fontification code may have added/removed text.
3516 It could do even a lot worse, but let's at least protect against
3517 the most obvious case where only the text past `pos' gets changed',
3518 as is/was done in grep.el where some escapes sequences are turned
3519 into face properties (bug#7876). */
3520 it
->end_charpos
= ZV
;
3522 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3523 something. This avoids an endless loop if they failed to
3524 fontify the text for which reason ever. */
3525 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3526 handled
= HANDLED_RECOMPUTE_PROPS
;
3534 /***********************************************************************
3536 ***********************************************************************/
3538 /* Set up iterator IT from face properties at its current position.
3539 Called from handle_stop. */
3541 static enum prop_handled
3542 handle_face_prop (struct it
*it
)
3545 EMACS_INT next_stop
;
3547 if (!STRINGP (it
->string
))
3550 = face_at_buffer_position (it
->w
,
3552 it
->region_beg_charpos
,
3553 it
->region_end_charpos
,
3556 + TEXT_PROP_DISTANCE_LIMIT
),
3557 0, it
->base_face_id
);
3559 /* Is this a start of a run of characters with box face?
3560 Caveat: this can be called for a freshly initialized
3561 iterator; face_id is -1 in this case. We know that the new
3562 face will not change until limit, i.e. if the new face has a
3563 box, all characters up to limit will have one. But, as
3564 usual, we don't know whether limit is really the end. */
3565 if (new_face_id
!= it
->face_id
)
3567 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3569 /* If new face has a box but old face has not, this is
3570 the start of a run of characters with box, i.e. it has
3571 a shadow on the left side. The value of face_id of the
3572 iterator will be -1 if this is the initial call that gets
3573 the face. In this case, we have to look in front of IT's
3574 position and see whether there is a face != new_face_id. */
3575 it
->start_of_box_run_p
3576 = (new_face
->box
!= FACE_NO_BOX
3577 && (it
->face_id
>= 0
3578 || IT_CHARPOS (*it
) == BEG
3579 || new_face_id
!= face_before_it_pos (it
)));
3580 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3588 Lisp_Object from_overlay
3589 = (it
->current
.overlay_string_index
>= 0
3590 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3593 /* See if we got to this string directly or indirectly from
3594 an overlay property. That includes the before-string or
3595 after-string of an overlay, strings in display properties
3596 provided by an overlay, their text properties, etc.
3598 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3599 if (! NILP (from_overlay
))
3600 for (i
= it
->sp
- 1; i
>= 0; i
--)
3602 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3604 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3605 else if (! NILP (it
->stack
[i
].from_overlay
))
3606 from_overlay
= it
->stack
[i
].from_overlay
;
3608 if (!NILP (from_overlay
))
3612 if (! NILP (from_overlay
))
3614 bufpos
= IT_CHARPOS (*it
);
3615 /* For a string from an overlay, the base face depends
3616 only on text properties and ignores overlays. */
3618 = face_for_overlay_string (it
->w
,
3620 it
->region_beg_charpos
,
3621 it
->region_end_charpos
,
3624 + TEXT_PROP_DISTANCE_LIMIT
),
3632 /* For strings from a `display' property, use the face at
3633 IT's current buffer position as the base face to merge
3634 with, so that overlay strings appear in the same face as
3635 surrounding text, unless they specify their own
3637 base_face_id
= underlying_face_id (it
);
3640 new_face_id
= face_at_string_position (it
->w
,
3642 IT_STRING_CHARPOS (*it
),
3644 it
->region_beg_charpos
,
3645 it
->region_end_charpos
,
3649 /* Is this a start of a run of characters with box? Caveat:
3650 this can be called for a freshly allocated iterator; face_id
3651 is -1 is this case. We know that the new face will not
3652 change until the next check pos, i.e. if the new face has a
3653 box, all characters up to that position will have a
3654 box. But, as usual, we don't know whether that position
3655 is really the end. */
3656 if (new_face_id
!= it
->face_id
)
3658 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3659 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3661 /* If new face has a box but old face hasn't, this is the
3662 start of a run of characters with box, i.e. it has a
3663 shadow on the left side. */
3664 it
->start_of_box_run_p
3665 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3666 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3670 it
->face_id
= new_face_id
;
3671 return HANDLED_NORMALLY
;
3675 /* Return the ID of the face ``underlying'' IT's current position,
3676 which is in a string. If the iterator is associated with a
3677 buffer, return the face at IT's current buffer position.
3678 Otherwise, use the iterator's base_face_id. */
3681 underlying_face_id (struct it
*it
)
3683 int face_id
= it
->base_face_id
, i
;
3685 xassert (STRINGP (it
->string
));
3687 for (i
= it
->sp
- 1; i
>= 0; --i
)
3688 if (NILP (it
->stack
[i
].string
))
3689 face_id
= it
->stack
[i
].face_id
;
3695 /* Compute the face one character before or after the current position
3696 of IT, in the visual order. BEFORE_P non-zero means get the face
3697 in front (to the left in L2R paragraphs, to the right in R2L
3698 paragraphs) of IT's screen position. Value is the ID of the face. */
3701 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3704 EMACS_INT next_check_charpos
;
3706 void *it_copy_data
= NULL
;
3708 xassert (it
->s
== NULL
);
3710 if (STRINGP (it
->string
))
3712 EMACS_INT bufpos
, charpos
;
3715 /* No face change past the end of the string (for the case
3716 we are padding with spaces). No face change before the
3718 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3719 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3724 /* Set charpos to the position before or after IT's current
3725 position, in the logical order, which in the non-bidi
3726 case is the same as the visual order. */
3728 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3729 else if (it
->what
== IT_COMPOSITION
)
3730 /* For composition, we must check the character after the
3732 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3734 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3740 /* With bidi iteration, the character before the current
3741 in the visual order cannot be found by simple
3742 iteration, because "reverse" reordering is not
3743 supported. Instead, we need to use the move_it_*
3744 family of functions. */
3745 /* Ignore face changes before the first visible
3746 character on this display line. */
3747 if (it
->current_x
<= it
->first_visible_x
)
3749 SAVE_IT (it_copy
, *it
, it_copy_data
);
3750 /* Implementation note: Since move_it_in_display_line
3751 works in the iterator geometry, and thinks the first
3752 character is always the leftmost, even in R2L lines,
3753 we don't need to distinguish between the R2L and L2R
3755 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3756 it_copy
.current_x
- 1, MOVE_TO_X
);
3757 charpos
= IT_STRING_CHARPOS (it_copy
);
3758 RESTORE_IT (it
, it
, it_copy_data
);
3762 /* Set charpos to the string position of the character
3763 that comes after IT's current position in the visual
3765 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3769 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3771 charpos
= it_copy
.bidi_it
.charpos
;
3774 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3776 if (it
->current
.overlay_string_index
>= 0)
3777 bufpos
= IT_CHARPOS (*it
);
3781 base_face_id
= underlying_face_id (it
);
3783 /* Get the face for ASCII, or unibyte. */
3784 face_id
= face_at_string_position (it
->w
,
3788 it
->region_beg_charpos
,
3789 it
->region_end_charpos
,
3790 &next_check_charpos
,
3793 /* Correct the face for charsets different from ASCII. Do it
3794 for the multibyte case only. The face returned above is
3795 suitable for unibyte text if IT->string is unibyte. */
3796 if (STRING_MULTIBYTE (it
->string
))
3798 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3799 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3801 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3803 c
= string_char_and_length (p
, &len
);
3804 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3809 struct text_pos pos
;
3811 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3812 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3815 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3816 pos
= it
->current
.pos
;
3821 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3824 if (it
->what
== IT_COMPOSITION
)
3826 /* For composition, we must check the position after
3828 pos
.charpos
+= it
->cmp_it
.nchars
;
3829 pos
.bytepos
+= it
->len
;
3832 INC_TEXT_POS (pos
, it
->multibyte_p
);
3839 /* With bidi iteration, the character before the current
3840 in the visual order cannot be found by simple
3841 iteration, because "reverse" reordering is not
3842 supported. Instead, we need to use the move_it_*
3843 family of functions. */
3844 /* Ignore face changes before the first visible
3845 character on this display line. */
3846 if (it
->current_x
<= it
->first_visible_x
)
3848 SAVE_IT (it_copy
, *it
, it_copy_data
);
3849 /* Implementation note: Since move_it_in_display_line
3850 works in the iterator geometry, and thinks the first
3851 character is always the leftmost, even in R2L lines,
3852 we don't need to distinguish between the R2L and L2R
3854 move_it_in_display_line (&it_copy
, ZV
,
3855 it_copy
.current_x
- 1, MOVE_TO_X
);
3856 pos
= it_copy
.current
.pos
;
3857 RESTORE_IT (it
, it
, it_copy_data
);
3861 /* Set charpos to the buffer position of the character
3862 that comes after IT's current position in the visual
3864 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3868 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3871 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3874 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3876 /* Determine face for CHARSET_ASCII, or unibyte. */
3877 face_id
= face_at_buffer_position (it
->w
,
3879 it
->region_beg_charpos
,
3880 it
->region_end_charpos
,
3881 &next_check_charpos
,
3884 /* Correct the face for charsets different from ASCII. Do it
3885 for the multibyte case only. The face returned above is
3886 suitable for unibyte text if current_buffer is unibyte. */
3887 if (it
->multibyte_p
)
3889 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3890 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3891 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3900 /***********************************************************************
3902 ***********************************************************************/
3904 /* Set up iterator IT from invisible properties at its current
3905 position. Called from handle_stop. */
3907 static enum prop_handled
3908 handle_invisible_prop (struct it
*it
)
3910 enum prop_handled handled
= HANDLED_NORMALLY
;
3912 if (STRINGP (it
->string
))
3914 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3916 /* Get the value of the invisible text property at the
3917 current position. Value will be nil if there is no such
3919 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3920 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3923 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3927 handled
= HANDLED_RECOMPUTE_PROPS
;
3929 /* Get the position at which the next change of the
3930 invisible text property can be found in IT->string.
3931 Value will be nil if the property value is the same for
3932 all the rest of IT->string. */
3933 XSETINT (limit
, SCHARS (it
->string
));
3934 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3937 /* Text at current position is invisible. The next
3938 change in the property is at position end_charpos.
3939 Move IT's current position to that position. */
3940 if (INTEGERP (end_charpos
)
3941 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3943 struct text_pos old
;
3946 old
= it
->current
.string_pos
;
3947 oldpos
= CHARPOS (old
);
3950 if (it
->bidi_it
.first_elt
3951 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3952 bidi_paragraph_init (it
->paragraph_embedding
,
3954 /* Bidi-iterate out of the invisible text. */
3957 bidi_move_to_visually_next (&it
->bidi_it
);
3959 while (oldpos
<= it
->bidi_it
.charpos
3960 && it
->bidi_it
.charpos
< endpos
);
3962 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3963 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3964 if (IT_CHARPOS (*it
) >= endpos
)
3965 it
->prev_stop
= endpos
;
3969 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3970 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3975 /* The rest of the string is invisible. If this is an
3976 overlay string, proceed with the next overlay string
3977 or whatever comes and return a character from there. */
3978 if (it
->current
.overlay_string_index
>= 0)
3980 next_overlay_string (it
);
3981 /* Don't check for overlay strings when we just
3982 finished processing them. */
3983 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3987 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3988 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3996 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3997 Lisp_Object pos
, prop
, overlay
;
3999 /* First of all, is there invisible text at this position? */
4000 tem
= start_charpos
= IT_CHARPOS (*it
);
4001 pos
= make_number (tem
);
4002 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4004 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4006 /* If we are on invisible text, skip over it. */
4007 if (invis_p
&& start_charpos
< it
->end_charpos
)
4009 /* Record whether we have to display an ellipsis for the
4011 int display_ellipsis_p
= invis_p
== 2;
4013 handled
= HANDLED_RECOMPUTE_PROPS
;
4015 /* Loop skipping over invisible text. The loop is left at
4016 ZV or with IT on the first char being visible again. */
4019 /* Try to skip some invisible text. Return value is the
4020 position reached which can be equal to where we start
4021 if there is nothing invisible there. This skips both
4022 over invisible text properties and overlays with
4023 invisible property. */
4024 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4026 /* If we skipped nothing at all we weren't at invisible
4027 text in the first place. If everything to the end of
4028 the buffer was skipped, end the loop. */
4029 if (newpos
== tem
|| newpos
>= ZV
)
4033 /* We skipped some characters but not necessarily
4034 all there are. Check if we ended up on visible
4035 text. Fget_char_property returns the property of
4036 the char before the given position, i.e. if we
4037 get invis_p = 0, this means that the char at
4038 newpos is visible. */
4039 pos
= make_number (newpos
);
4040 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4041 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4044 /* If we ended up on invisible text, proceed to
4045 skip starting with next_stop. */
4049 /* If there are adjacent invisible texts, don't lose the
4050 second one's ellipsis. */
4052 display_ellipsis_p
= 1;
4056 /* The position newpos is now either ZV or on visible text. */
4057 if (it
->bidi_p
&& newpos
< ZV
)
4059 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4061 if (FETCH_BYTE (bpos
) == '\n'
4062 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4064 /* If the invisible text ends on a newline or the
4065 character after a newline, we can avoid the
4066 costly, character by character, bidi iteration to
4067 newpos, and instead simply reseat the iterator
4068 there. That's because all bidi reordering
4069 information is tossed at the newline. This is a
4070 big win for modes that hide complete lines, like
4071 Outline, Org, etc. (Implementation note: the
4072 call to reseat_1 is necessary, because it signals
4073 to the bidi iterator that it needs to reinit its
4074 internal information when the next element for
4075 display is requested. */
4076 struct text_pos tpos
;
4078 SET_TEXT_POS (tpos
, newpos
, bpos
);
4079 reseat_1 (it
, tpos
, 0);
4081 else /* Must use the slow method. */
4083 /* With bidi iteration, the region of invisible text
4084 could start and/or end in the middle of a
4085 non-base embedding level. Therefore, we need to
4086 skip invisible text using the bidi iterator,
4087 starting at IT's current position, until we find
4088 ourselves outside the invisible text. Skipping
4089 invisible text _after_ bidi iteration avoids
4090 affecting the visual order of the displayed text
4091 when invisible properties are added or
4093 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4095 /* If we were `reseat'ed to a new paragraph,
4096 determine the paragraph base direction. We
4097 need to do it now because
4098 next_element_from_buffer may not have a
4099 chance to do it, if we are going to skip any
4100 text at the beginning, which resets the
4102 bidi_paragraph_init (it
->paragraph_embedding
,
4107 bidi_move_to_visually_next (&it
->bidi_it
);
4109 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4110 && it
->bidi_it
.charpos
< newpos
);
4111 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4112 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4113 /* If we overstepped NEWPOS, record its position in
4114 the iterator, so that we skip invisible text if
4115 later the bidi iteration lands us in the
4116 invisible region again. */
4117 if (IT_CHARPOS (*it
) >= newpos
)
4118 it
->prev_stop
= newpos
;
4123 IT_CHARPOS (*it
) = newpos
;
4124 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4127 /* If there are before-strings at the start of invisible
4128 text, and the text is invisible because of a text
4129 property, arrange to show before-strings because 20.x did
4130 it that way. (If the text is invisible because of an
4131 overlay property instead of a text property, this is
4132 already handled in the overlay code.) */
4134 && get_overlay_strings (it
, it
->stop_charpos
))
4136 handled
= HANDLED_RECOMPUTE_PROPS
;
4137 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4139 else if (display_ellipsis_p
)
4141 /* Make sure that the glyphs of the ellipsis will get
4142 correct `charpos' values. If we would not update
4143 it->position here, the glyphs would belong to the
4144 last visible character _before_ the invisible
4145 text, which confuses `set_cursor_from_row'.
4147 We use the last invisible position instead of the
4148 first because this way the cursor is always drawn on
4149 the first "." of the ellipsis, whenever PT is inside
4150 the invisible text. Otherwise the cursor would be
4151 placed _after_ the ellipsis when the point is after the
4152 first invisible character. */
4153 if (!STRINGP (it
->object
))
4155 it
->position
.charpos
= newpos
- 1;
4156 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4159 /* Let the ellipsis display before
4160 considering any properties of the following char.
4161 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4162 handled
= HANDLED_RETURN
;
4171 /* Make iterator IT return `...' next.
4172 Replaces LEN characters from buffer. */
4175 setup_for_ellipsis (struct it
*it
, int len
)
4177 /* Use the display table definition for `...'. Invalid glyphs
4178 will be handled by the method returning elements from dpvec. */
4179 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4181 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4182 it
->dpvec
= v
->contents
;
4183 it
->dpend
= v
->contents
+ v
->header
.size
;
4187 /* Default `...'. */
4188 it
->dpvec
= default_invis_vector
;
4189 it
->dpend
= default_invis_vector
+ 3;
4192 it
->dpvec_char_len
= len
;
4193 it
->current
.dpvec_index
= 0;
4194 it
->dpvec_face_id
= -1;
4196 /* Remember the current face id in case glyphs specify faces.
4197 IT's face is restored in set_iterator_to_next.
4198 saved_face_id was set to preceding char's face in handle_stop. */
4199 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4200 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4202 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4208 /***********************************************************************
4210 ***********************************************************************/
4212 /* Set up iterator IT from `display' property at its current position.
4213 Called from handle_stop.
4214 We return HANDLED_RETURN if some part of the display property
4215 overrides the display of the buffer text itself.
4216 Otherwise we return HANDLED_NORMALLY. */
4218 static enum prop_handled
4219 handle_display_prop (struct it
*it
)
4221 Lisp_Object propval
, object
, overlay
;
4222 struct text_pos
*position
;
4224 /* Nonzero if some property replaces the display of the text itself. */
4225 int display_replaced_p
= 0;
4227 if (STRINGP (it
->string
))
4229 object
= it
->string
;
4230 position
= &it
->current
.string_pos
;
4231 bufpos
= CHARPOS (it
->current
.pos
);
4235 XSETWINDOW (object
, it
->w
);
4236 position
= &it
->current
.pos
;
4237 bufpos
= CHARPOS (*position
);
4240 /* Reset those iterator values set from display property values. */
4241 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4242 it
->space_width
= Qnil
;
4243 it
->font_height
= Qnil
;
4246 /* We don't support recursive `display' properties, i.e. string
4247 values that have a string `display' property, that have a string
4248 `display' property etc. */
4249 if (!it
->string_from_display_prop_p
)
4250 it
->area
= TEXT_AREA
;
4252 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4253 Qdisplay
, object
, &overlay
);
4255 return HANDLED_NORMALLY
;
4256 /* Now OVERLAY is the overlay that gave us this property, or nil
4257 if it was a text property. */
4259 if (!STRINGP (it
->string
))
4260 object
= it
->w
->buffer
;
4262 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4264 FRAME_WINDOW_P (it
->f
));
4266 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4269 /* Subroutine of handle_display_prop. Returns non-zero if the display
4270 specification in SPEC is a replacing specification, i.e. it would
4271 replace the text covered by `display' property with something else,
4272 such as an image or a display string. If SPEC includes any kind or
4273 `(space ...) specification, the value is 2; this is used by
4274 compute_display_string_pos, which see.
4276 See handle_single_display_spec for documentation of arguments.
4277 frame_window_p is non-zero if the window being redisplayed is on a
4278 GUI frame; this argument is used only if IT is NULL, see below.
4280 IT can be NULL, if this is called by the bidi reordering code
4281 through compute_display_string_pos, which see. In that case, this
4282 function only examines SPEC, but does not otherwise "handle" it, in
4283 the sense that it doesn't set up members of IT from the display
4286 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4287 Lisp_Object overlay
, struct text_pos
*position
,
4288 EMACS_INT bufpos
, int frame_window_p
)
4290 int replacing_p
= 0;
4294 /* Simple specerties. */
4295 && !EQ (XCAR (spec
), Qimage
)
4296 && !EQ (XCAR (spec
), Qspace
)
4297 && !EQ (XCAR (spec
), Qwhen
)
4298 && !EQ (XCAR (spec
), Qslice
)
4299 && !EQ (XCAR (spec
), Qspace_width
)
4300 && !EQ (XCAR (spec
), Qheight
)
4301 && !EQ (XCAR (spec
), Qraise
)
4302 /* Marginal area specifications. */
4303 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4304 && !EQ (XCAR (spec
), Qleft_fringe
)
4305 && !EQ (XCAR (spec
), Qright_fringe
)
4306 && !NILP (XCAR (spec
)))
4308 for (; CONSP (spec
); spec
= XCDR (spec
))
4310 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4311 overlay
, position
, bufpos
,
4312 replacing_p
, frame_window_p
)))
4315 /* If some text in a string is replaced, `position' no
4316 longer points to the position of `object'. */
4317 if (!it
|| STRINGP (object
))
4322 else if (VECTORP (spec
))
4325 for (i
= 0; i
< ASIZE (spec
); ++i
)
4326 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4327 overlay
, position
, bufpos
,
4328 replacing_p
, frame_window_p
)))
4331 /* If some text in a string is replaced, `position' no
4332 longer points to the position of `object'. */
4333 if (!it
|| STRINGP (object
))
4339 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4340 position
, bufpos
, 0,
4348 /* Value is the position of the end of the `display' property starting
4349 at START_POS in OBJECT. */
4351 static struct text_pos
4352 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4355 struct text_pos end_pos
;
4357 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4358 Qdisplay
, object
, Qnil
);
4359 CHARPOS (end_pos
) = XFASTINT (end
);
4360 if (STRINGP (object
))
4361 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4363 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4369 /* Set up IT from a single `display' property specification SPEC. OBJECT
4370 is the object in which the `display' property was found. *POSITION
4371 is the position in OBJECT at which the `display' property was found.
4372 BUFPOS is the buffer position of OBJECT (different from POSITION if
4373 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4374 previously saw a display specification which already replaced text
4375 display with something else, for example an image; we ignore such
4376 properties after the first one has been processed.
4378 OVERLAY is the overlay this `display' property came from,
4379 or nil if it was a text property.
4381 If SPEC is a `space' or `image' specification, and in some other
4382 cases too, set *POSITION to the position where the `display'
4385 If IT is NULL, only examine the property specification in SPEC, but
4386 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4387 is intended to be displayed in a window on a GUI frame.
4389 Value is non-zero if something was found which replaces the display
4390 of buffer or string text. */
4393 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4394 Lisp_Object overlay
, struct text_pos
*position
,
4395 EMACS_INT bufpos
, int display_replaced_p
,
4399 Lisp_Object location
, value
;
4400 struct text_pos start_pos
= *position
;
4403 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4404 If the result is non-nil, use VALUE instead of SPEC. */
4406 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4415 if (!NILP (form
) && !EQ (form
, Qt
))
4417 int count
= SPECPDL_INDEX ();
4418 struct gcpro gcpro1
;
4420 /* Bind `object' to the object having the `display' property, a
4421 buffer or string. Bind `position' to the position in the
4422 object where the property was found, and `buffer-position'
4423 to the current position in the buffer. */
4426 XSETBUFFER (object
, current_buffer
);
4427 specbind (Qobject
, object
);
4428 specbind (Qposition
, make_number (CHARPOS (*position
)));
4429 specbind (Qbuffer_position
, make_number (bufpos
));
4431 form
= safe_eval (form
);
4433 unbind_to (count
, Qnil
);
4439 /* Handle `(height HEIGHT)' specifications. */
4441 && EQ (XCAR (spec
), Qheight
)
4442 && CONSP (XCDR (spec
)))
4446 if (!FRAME_WINDOW_P (it
->f
))
4449 it
->font_height
= XCAR (XCDR (spec
));
4450 if (!NILP (it
->font_height
))
4452 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4453 int new_height
= -1;
4455 if (CONSP (it
->font_height
)
4456 && (EQ (XCAR (it
->font_height
), Qplus
)
4457 || EQ (XCAR (it
->font_height
), Qminus
))
4458 && CONSP (XCDR (it
->font_height
))
4459 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4461 /* `(+ N)' or `(- N)' where N is an integer. */
4462 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4463 if (EQ (XCAR (it
->font_height
), Qplus
))
4465 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4467 else if (FUNCTIONP (it
->font_height
))
4469 /* Call function with current height as argument.
4470 Value is the new height. */
4472 height
= safe_call1 (it
->font_height
,
4473 face
->lface
[LFACE_HEIGHT_INDEX
]);
4474 if (NUMBERP (height
))
4475 new_height
= XFLOATINT (height
);
4477 else if (NUMBERP (it
->font_height
))
4479 /* Value is a multiple of the canonical char height. */
4482 f
= FACE_FROM_ID (it
->f
,
4483 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4484 new_height
= (XFLOATINT (it
->font_height
)
4485 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4489 /* Evaluate IT->font_height with `height' bound to the
4490 current specified height to get the new height. */
4491 int count
= SPECPDL_INDEX ();
4493 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4494 value
= safe_eval (it
->font_height
);
4495 unbind_to (count
, Qnil
);
4497 if (NUMBERP (value
))
4498 new_height
= XFLOATINT (value
);
4502 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4509 /* Handle `(space-width WIDTH)'. */
4511 && EQ (XCAR (spec
), Qspace_width
)
4512 && CONSP (XCDR (spec
)))
4516 if (!FRAME_WINDOW_P (it
->f
))
4519 value
= XCAR (XCDR (spec
));
4520 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4521 it
->space_width
= value
;
4527 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4529 && EQ (XCAR (spec
), Qslice
))
4535 if (!FRAME_WINDOW_P (it
->f
))
4538 if (tem
= XCDR (spec
), CONSP (tem
))
4540 it
->slice
.x
= XCAR (tem
);
4541 if (tem
= XCDR (tem
), CONSP (tem
))
4543 it
->slice
.y
= XCAR (tem
);
4544 if (tem
= XCDR (tem
), CONSP (tem
))
4546 it
->slice
.width
= XCAR (tem
);
4547 if (tem
= XCDR (tem
), CONSP (tem
))
4548 it
->slice
.height
= XCAR (tem
);
4557 /* Handle `(raise FACTOR)'. */
4559 && EQ (XCAR (spec
), Qraise
)
4560 && CONSP (XCDR (spec
)))
4564 if (!FRAME_WINDOW_P (it
->f
))
4567 #ifdef HAVE_WINDOW_SYSTEM
4568 value
= XCAR (XCDR (spec
));
4569 if (NUMBERP (value
))
4571 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4572 it
->voffset
= - (XFLOATINT (value
)
4573 * (FONT_HEIGHT (face
->font
)));
4575 #endif /* HAVE_WINDOW_SYSTEM */
4581 /* Don't handle the other kinds of display specifications
4582 inside a string that we got from a `display' property. */
4583 if (it
&& it
->string_from_display_prop_p
)
4586 /* Characters having this form of property are not displayed, so
4587 we have to find the end of the property. */
4590 start_pos
= *position
;
4591 *position
= display_prop_end (it
, object
, start_pos
);
4595 /* Stop the scan at that end position--we assume that all
4596 text properties change there. */
4598 it
->stop_charpos
= position
->charpos
;
4600 /* Handle `(left-fringe BITMAP [FACE])'
4601 and `(right-fringe BITMAP [FACE])'. */
4603 && (EQ (XCAR (spec
), Qleft_fringe
)
4604 || EQ (XCAR (spec
), Qright_fringe
))
4605 && CONSP (XCDR (spec
)))
4611 if (!FRAME_WINDOW_P (it
->f
))
4612 /* If we return here, POSITION has been advanced
4613 across the text with this property. */
4616 else if (!frame_window_p
)
4619 #ifdef HAVE_WINDOW_SYSTEM
4620 value
= XCAR (XCDR (spec
));
4621 if (!SYMBOLP (value
)
4622 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4623 /* If we return here, POSITION has been advanced
4624 across the text with this property. */
4629 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4631 if (CONSP (XCDR (XCDR (spec
))))
4633 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4634 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4640 /* Save current settings of IT so that we can restore them
4641 when we are finished with the glyph property value. */
4642 push_it (it
, position
);
4644 it
->area
= TEXT_AREA
;
4645 it
->what
= IT_IMAGE
;
4646 it
->image_id
= -1; /* no image */
4647 it
->position
= start_pos
;
4648 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4649 it
->method
= GET_FROM_IMAGE
;
4650 it
->from_overlay
= Qnil
;
4651 it
->face_id
= face_id
;
4652 it
->from_disp_prop_p
= 1;
4654 /* Say that we haven't consumed the characters with
4655 `display' property yet. The call to pop_it in
4656 set_iterator_to_next will clean this up. */
4657 *position
= start_pos
;
4659 if (EQ (XCAR (spec
), Qleft_fringe
))
4661 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4662 it
->left_user_fringe_face_id
= face_id
;
4666 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4667 it
->right_user_fringe_face_id
= face_id
;
4670 #endif /* HAVE_WINDOW_SYSTEM */
4674 /* Prepare to handle `((margin left-margin) ...)',
4675 `((margin right-margin) ...)' and `((margin nil) ...)'
4676 prefixes for display specifications. */
4677 location
= Qunbound
;
4678 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4682 value
= XCDR (spec
);
4684 value
= XCAR (value
);
4687 if (EQ (XCAR (tem
), Qmargin
)
4688 && (tem
= XCDR (tem
),
4689 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4691 || EQ (tem
, Qleft_margin
)
4692 || EQ (tem
, Qright_margin
))))
4696 if (EQ (location
, Qunbound
))
4702 /* After this point, VALUE is the property after any
4703 margin prefix has been stripped. It must be a string,
4704 an image specification, or `(space ...)'.
4706 LOCATION specifies where to display: `left-margin',
4707 `right-margin' or nil. */
4709 valid_p
= (STRINGP (value
)
4710 #ifdef HAVE_WINDOW_SYSTEM
4711 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4712 && valid_image_p (value
))
4713 #endif /* not HAVE_WINDOW_SYSTEM */
4714 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4716 if (valid_p
&& !display_replaced_p
)
4722 /* Callers need to know whether the display spec is any kind
4723 of `(space ...)' spec that is about to affect text-area
4725 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4730 /* Save current settings of IT so that we can restore them
4731 when we are finished with the glyph property value. */
4732 push_it (it
, position
);
4733 it
->from_overlay
= overlay
;
4734 it
->from_disp_prop_p
= 1;
4736 if (NILP (location
))
4737 it
->area
= TEXT_AREA
;
4738 else if (EQ (location
, Qleft_margin
))
4739 it
->area
= LEFT_MARGIN_AREA
;
4741 it
->area
= RIGHT_MARGIN_AREA
;
4743 if (STRINGP (value
))
4746 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4747 it
->current
.overlay_string_index
= -1;
4748 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4749 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4750 it
->method
= GET_FROM_STRING
;
4751 it
->stop_charpos
= 0;
4753 it
->base_level_stop
= 0;
4754 it
->string_from_display_prop_p
= 1;
4755 /* Say that we haven't consumed the characters with
4756 `display' property yet. The call to pop_it in
4757 set_iterator_to_next will clean this up. */
4758 if (BUFFERP (object
))
4759 *position
= start_pos
;
4761 /* Force paragraph direction to be that of the parent
4762 object. If the parent object's paragraph direction is
4763 not yet determined, default to L2R. */
4764 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4765 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4767 it
->paragraph_embedding
= L2R
;
4769 /* Set up the bidi iterator for this display string. */
4772 it
->bidi_it
.string
.lstring
= it
->string
;
4773 it
->bidi_it
.string
.s
= NULL
;
4774 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4775 it
->bidi_it
.string
.bufpos
= bufpos
;
4776 it
->bidi_it
.string
.from_disp_str
= 1;
4777 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4778 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4781 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4783 it
->method
= GET_FROM_STRETCH
;
4785 *position
= it
->position
= start_pos
;
4786 retval
= 1 + (it
->area
== TEXT_AREA
);
4788 #ifdef HAVE_WINDOW_SYSTEM
4791 it
->what
= IT_IMAGE
;
4792 it
->image_id
= lookup_image (it
->f
, value
);
4793 it
->position
= start_pos
;
4794 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4795 it
->method
= GET_FROM_IMAGE
;
4797 /* Say that we haven't consumed the characters with
4798 `display' property yet. The call to pop_it in
4799 set_iterator_to_next will clean this up. */
4800 *position
= start_pos
;
4802 #endif /* HAVE_WINDOW_SYSTEM */
4807 /* Invalid property or property not supported. Restore
4808 POSITION to what it was before. */
4809 *position
= start_pos
;
4813 /* Check if PROP is a display property value whose text should be
4814 treated as intangible. OVERLAY is the overlay from which PROP
4815 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4816 specify the buffer position covered by PROP. */
4819 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4820 EMACS_INT charpos
, EMACS_INT bytepos
)
4822 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4823 struct text_pos position
;
4825 SET_TEXT_POS (position
, charpos
, bytepos
);
4826 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4827 &position
, charpos
, frame_window_p
);
4831 /* Return 1 if PROP is a display sub-property value containing STRING.
4833 Implementation note: this and the following function are really
4834 special cases of handle_display_spec and
4835 handle_single_display_spec, and should ideally use the same code.
4836 Until they do, these two pairs must be consistent and must be
4837 modified in sync. */
4840 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4842 if (EQ (string
, prop
))
4845 /* Skip over `when FORM'. */
4846 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4851 /* Actually, the condition following `when' should be eval'ed,
4852 like handle_single_display_spec does, and we should return
4853 zero if it evaluates to nil. However, this function is
4854 called only when the buffer was already displayed and some
4855 glyph in the glyph matrix was found to come from a display
4856 string. Therefore, the condition was already evaluated, and
4857 the result was non-nil, otherwise the display string wouldn't
4858 have been displayed and we would have never been called for
4859 this property. Thus, we can skip the evaluation and assume
4860 its result is non-nil. */
4865 /* Skip over `margin LOCATION'. */
4866 if (EQ (XCAR (prop
), Qmargin
))
4877 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4881 /* Return 1 if STRING appears in the `display' property PROP. */
4884 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4887 && !EQ (XCAR (prop
), Qwhen
)
4888 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4890 /* A list of sub-properties. */
4891 while (CONSP (prop
))
4893 if (single_display_spec_string_p (XCAR (prop
), string
))
4898 else if (VECTORP (prop
))
4900 /* A vector of sub-properties. */
4902 for (i
= 0; i
< ASIZE (prop
); ++i
)
4903 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4907 return single_display_spec_string_p (prop
, string
);
4912 /* Look for STRING in overlays and text properties in the current
4913 buffer, between character positions FROM and TO (excluding TO).
4914 BACK_P non-zero means look back (in this case, TO is supposed to be
4916 Value is the first character position where STRING was found, or
4917 zero if it wasn't found before hitting TO.
4919 This function may only use code that doesn't eval because it is
4920 called asynchronously from note_mouse_highlight. */
4923 string_buffer_position_lim (Lisp_Object string
,
4924 EMACS_INT from
, EMACS_INT to
, int back_p
)
4926 Lisp_Object limit
, prop
, pos
;
4929 pos
= make_number (from
);
4931 if (!back_p
) /* looking forward */
4933 limit
= make_number (min (to
, ZV
));
4934 while (!found
&& !EQ (pos
, limit
))
4936 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4937 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4940 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4944 else /* looking back */
4946 limit
= make_number (max (to
, BEGV
));
4947 while (!found
&& !EQ (pos
, limit
))
4949 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4950 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4953 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4958 return found
? XINT (pos
) : 0;
4961 /* Determine which buffer position in current buffer STRING comes from.
4962 AROUND_CHARPOS is an approximate position where it could come from.
4963 Value is the buffer position or 0 if it couldn't be determined.
4965 This function is necessary because we don't record buffer positions
4966 in glyphs generated from strings (to keep struct glyph small).
4967 This function may only use code that doesn't eval because it is
4968 called asynchronously from note_mouse_highlight. */
4971 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4973 const int MAX_DISTANCE
= 1000;
4974 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4975 around_charpos
+ MAX_DISTANCE
,
4979 found
= string_buffer_position_lim (string
, around_charpos
,
4980 around_charpos
- MAX_DISTANCE
, 1);
4986 /***********************************************************************
4987 `composition' property
4988 ***********************************************************************/
4990 /* Set up iterator IT from `composition' property at its current
4991 position. Called from handle_stop. */
4993 static enum prop_handled
4994 handle_composition_prop (struct it
*it
)
4996 Lisp_Object prop
, string
;
4997 EMACS_INT pos
, pos_byte
, start
, end
;
4999 if (STRINGP (it
->string
))
5003 pos
= IT_STRING_CHARPOS (*it
);
5004 pos_byte
= IT_STRING_BYTEPOS (*it
);
5005 string
= it
->string
;
5006 s
= SDATA (string
) + pos_byte
;
5007 it
->c
= STRING_CHAR (s
);
5011 pos
= IT_CHARPOS (*it
);
5012 pos_byte
= IT_BYTEPOS (*it
);
5014 it
->c
= FETCH_CHAR (pos_byte
);
5017 /* If there's a valid composition and point is not inside of the
5018 composition (in the case that the composition is from the current
5019 buffer), draw a glyph composed from the composition components. */
5020 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5021 && COMPOSITION_VALID_P (start
, end
, prop
)
5022 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5025 /* As we can't handle this situation (perhaps font-lock added
5026 a new composition), we just return here hoping that next
5027 redisplay will detect this composition much earlier. */
5028 return HANDLED_NORMALLY
;
5031 if (STRINGP (it
->string
))
5032 pos_byte
= string_char_to_byte (it
->string
, start
);
5034 pos_byte
= CHAR_TO_BYTE (start
);
5036 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5039 if (it
->cmp_it
.id
>= 0)
5042 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5043 it
->cmp_it
.nglyphs
= -1;
5047 return HANDLED_NORMALLY
;
5052 /***********************************************************************
5054 ***********************************************************************/
5056 /* The following structure is used to record overlay strings for
5057 later sorting in load_overlay_strings. */
5059 struct overlay_entry
5061 Lisp_Object overlay
;
5068 /* Set up iterator IT from overlay strings at its current position.
5069 Called from handle_stop. */
5071 static enum prop_handled
5072 handle_overlay_change (struct it
*it
)
5074 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5075 return HANDLED_RECOMPUTE_PROPS
;
5077 return HANDLED_NORMALLY
;
5081 /* Set up the next overlay string for delivery by IT, if there is an
5082 overlay string to deliver. Called by set_iterator_to_next when the
5083 end of the current overlay string is reached. If there are more
5084 overlay strings to display, IT->string and
5085 IT->current.overlay_string_index are set appropriately here.
5086 Otherwise IT->string is set to nil. */
5089 next_overlay_string (struct it
*it
)
5091 ++it
->current
.overlay_string_index
;
5092 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5094 /* No more overlay strings. Restore IT's settings to what
5095 they were before overlay strings were processed, and
5096 continue to deliver from current_buffer. */
5098 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5101 || (NILP (it
->string
)
5102 && it
->method
== GET_FROM_BUFFER
5103 && it
->stop_charpos
>= BEGV
5104 && it
->stop_charpos
<= it
->end_charpos
));
5105 it
->current
.overlay_string_index
= -1;
5106 it
->n_overlay_strings
= 0;
5107 it
->overlay_strings_charpos
= -1;
5109 /* If we're at the end of the buffer, record that we have
5110 processed the overlay strings there already, so that
5111 next_element_from_buffer doesn't try it again. */
5112 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5113 it
->overlay_strings_at_end_processed_p
= 1;
5117 /* There are more overlay strings to process. If
5118 IT->current.overlay_string_index has advanced to a position
5119 where we must load IT->overlay_strings with more strings, do
5120 it. We must load at the IT->overlay_strings_charpos where
5121 IT->n_overlay_strings was originally computed; when invisible
5122 text is present, this might not be IT_CHARPOS (Bug#7016). */
5123 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5125 if (it
->current
.overlay_string_index
&& i
== 0)
5126 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5128 /* Initialize IT to deliver display elements from the overlay
5130 it
->string
= it
->overlay_strings
[i
];
5131 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5132 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5133 it
->method
= GET_FROM_STRING
;
5134 it
->stop_charpos
= 0;
5135 if (it
->cmp_it
.stop_pos
>= 0)
5136 it
->cmp_it
.stop_pos
= 0;
5138 it
->base_level_stop
= 0;
5140 /* Set up the bidi iterator for this overlay string. */
5143 it
->bidi_it
.string
.lstring
= it
->string
;
5144 it
->bidi_it
.string
.s
= NULL
;
5145 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5146 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5147 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5148 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5149 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5157 /* Compare two overlay_entry structures E1 and E2. Used as a
5158 comparison function for qsort in load_overlay_strings. Overlay
5159 strings for the same position are sorted so that
5161 1. All after-strings come in front of before-strings, except
5162 when they come from the same overlay.
5164 2. Within after-strings, strings are sorted so that overlay strings
5165 from overlays with higher priorities come first.
5167 2. Within before-strings, strings are sorted so that overlay
5168 strings from overlays with higher priorities come last.
5170 Value is analogous to strcmp. */
5174 compare_overlay_entries (const void *e1
, const void *e2
)
5176 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5177 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5180 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5182 /* Let after-strings appear in front of before-strings if
5183 they come from different overlays. */
5184 if (EQ (entry1
->overlay
, entry2
->overlay
))
5185 result
= entry1
->after_string_p
? 1 : -1;
5187 result
= entry1
->after_string_p
? -1 : 1;
5189 else if (entry1
->after_string_p
)
5190 /* After-strings sorted in order of decreasing priority. */
5191 result
= entry2
->priority
- entry1
->priority
;
5193 /* Before-strings sorted in order of increasing priority. */
5194 result
= entry1
->priority
- entry2
->priority
;
5200 /* Load the vector IT->overlay_strings with overlay strings from IT's
5201 current buffer position, or from CHARPOS if that is > 0. Set
5202 IT->n_overlays to the total number of overlay strings found.
5204 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5205 a time. On entry into load_overlay_strings,
5206 IT->current.overlay_string_index gives the number of overlay
5207 strings that have already been loaded by previous calls to this
5210 IT->add_overlay_start contains an additional overlay start
5211 position to consider for taking overlay strings from, if non-zero.
5212 This position comes into play when the overlay has an `invisible'
5213 property, and both before and after-strings. When we've skipped to
5214 the end of the overlay, because of its `invisible' property, we
5215 nevertheless want its before-string to appear.
5216 IT->add_overlay_start will contain the overlay start position
5219 Overlay strings are sorted so that after-string strings come in
5220 front of before-string strings. Within before and after-strings,
5221 strings are sorted by overlay priority. See also function
5222 compare_overlay_entries. */
5225 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5227 Lisp_Object overlay
, window
, str
, invisible
;
5228 struct Lisp_Overlay
*ov
;
5229 EMACS_INT start
, end
;
5231 int n
= 0, i
, j
, invis_p
;
5232 struct overlay_entry
*entries
5233 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5236 charpos
= IT_CHARPOS (*it
);
5238 /* Append the overlay string STRING of overlay OVERLAY to vector
5239 `entries' which has size `size' and currently contains `n'
5240 elements. AFTER_P non-zero means STRING is an after-string of
5242 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5245 Lisp_Object priority; \
5249 int new_size = 2 * size; \
5250 struct overlay_entry *old = entries; \
5252 (struct overlay_entry *) alloca (new_size \
5253 * sizeof *entries); \
5254 memcpy (entries, old, size * sizeof *entries); \
5258 entries[n].string = (STRING); \
5259 entries[n].overlay = (OVERLAY); \
5260 priority = Foverlay_get ((OVERLAY), Qpriority); \
5261 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5262 entries[n].after_string_p = (AFTER_P); \
5267 /* Process overlay before the overlay center. */
5268 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5270 XSETMISC (overlay
, ov
);
5271 xassert (OVERLAYP (overlay
));
5272 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5273 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5278 /* Skip this overlay if it doesn't start or end at IT's current
5280 if (end
!= charpos
&& start
!= charpos
)
5283 /* Skip this overlay if it doesn't apply to IT->w. */
5284 window
= Foverlay_get (overlay
, Qwindow
);
5285 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5288 /* If the text ``under'' the overlay is invisible, both before-
5289 and after-strings from this overlay are visible; start and
5290 end position are indistinguishable. */
5291 invisible
= Foverlay_get (overlay
, Qinvisible
);
5292 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5294 /* If overlay has a non-empty before-string, record it. */
5295 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5296 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5298 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5300 /* If overlay has a non-empty after-string, record it. */
5301 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5302 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5304 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5307 /* Process overlays after the overlay center. */
5308 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5310 XSETMISC (overlay
, ov
);
5311 xassert (OVERLAYP (overlay
));
5312 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5313 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5315 if (start
> charpos
)
5318 /* Skip this overlay if it doesn't start or end at IT's current
5320 if (end
!= charpos
&& start
!= charpos
)
5323 /* Skip this overlay if it doesn't apply to IT->w. */
5324 window
= Foverlay_get (overlay
, Qwindow
);
5325 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5328 /* If the text ``under'' the overlay is invisible, it has a zero
5329 dimension, and both before- and after-strings apply. */
5330 invisible
= Foverlay_get (overlay
, Qinvisible
);
5331 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5333 /* If overlay has a non-empty before-string, record it. */
5334 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5335 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5337 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5339 /* If overlay has a non-empty after-string, record it. */
5340 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5341 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5343 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5346 #undef RECORD_OVERLAY_STRING
5350 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5352 /* Record number of overlay strings, and where we computed it. */
5353 it
->n_overlay_strings
= n
;
5354 it
->overlay_strings_charpos
= charpos
;
5356 /* IT->current.overlay_string_index is the number of overlay strings
5357 that have already been consumed by IT. Copy some of the
5358 remaining overlay strings to IT->overlay_strings. */
5360 j
= it
->current
.overlay_string_index
;
5361 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5363 it
->overlay_strings
[i
] = entries
[j
].string
;
5364 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5371 /* Get the first chunk of overlay strings at IT's current buffer
5372 position, or at CHARPOS if that is > 0. Value is non-zero if at
5373 least one overlay string was found. */
5376 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5378 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5379 process. This fills IT->overlay_strings with strings, and sets
5380 IT->n_overlay_strings to the total number of strings to process.
5381 IT->pos.overlay_string_index has to be set temporarily to zero
5382 because load_overlay_strings needs this; it must be set to -1
5383 when no overlay strings are found because a zero value would
5384 indicate a position in the first overlay string. */
5385 it
->current
.overlay_string_index
= 0;
5386 load_overlay_strings (it
, charpos
);
5388 /* If we found overlay strings, set up IT to deliver display
5389 elements from the first one. Otherwise set up IT to deliver
5390 from current_buffer. */
5391 if (it
->n_overlay_strings
)
5393 /* Make sure we know settings in current_buffer, so that we can
5394 restore meaningful values when we're done with the overlay
5397 compute_stop_pos (it
);
5398 xassert (it
->face_id
>= 0);
5400 /* Save IT's settings. They are restored after all overlay
5401 strings have been processed. */
5402 xassert (!compute_stop_p
|| it
->sp
== 0);
5404 /* When called from handle_stop, there might be an empty display
5405 string loaded. In that case, don't bother saving it. */
5406 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5409 /* Set up IT to deliver display elements from the first overlay
5411 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5412 it
->string
= it
->overlay_strings
[0];
5413 it
->from_overlay
= Qnil
;
5414 it
->stop_charpos
= 0;
5415 xassert (STRINGP (it
->string
));
5416 it
->end_charpos
= SCHARS (it
->string
);
5418 it
->base_level_stop
= 0;
5419 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5420 it
->method
= GET_FROM_STRING
;
5421 it
->from_disp_prop_p
= 0;
5423 /* Force paragraph direction to be that of the parent
5425 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5426 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5428 it
->paragraph_embedding
= L2R
;
5430 /* Set up the bidi iterator for this overlay string. */
5433 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5435 it
->bidi_it
.string
.lstring
= it
->string
;
5436 it
->bidi_it
.string
.s
= NULL
;
5437 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5438 it
->bidi_it
.string
.bufpos
= pos
;
5439 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5440 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5441 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5446 it
->current
.overlay_string_index
= -1;
5451 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5454 it
->method
= GET_FROM_BUFFER
;
5456 (void) get_overlay_strings_1 (it
, charpos
, 1);
5460 /* Value is non-zero if we found at least one overlay string. */
5461 return STRINGP (it
->string
);
5466 /***********************************************************************
5467 Saving and restoring state
5468 ***********************************************************************/
5470 /* Save current settings of IT on IT->stack. Called, for example,
5471 before setting up IT for an overlay string, to be able to restore
5472 IT's settings to what they were after the overlay string has been
5473 processed. If POSITION is non-NULL, it is the position to save on
5474 the stack instead of IT->position. */
5477 push_it (struct it
*it
, struct text_pos
*position
)
5479 struct iterator_stack_entry
*p
;
5481 xassert (it
->sp
< IT_STACK_SIZE
);
5482 p
= it
->stack
+ it
->sp
;
5484 p
->stop_charpos
= it
->stop_charpos
;
5485 p
->prev_stop
= it
->prev_stop
;
5486 p
->base_level_stop
= it
->base_level_stop
;
5487 p
->cmp_it
= it
->cmp_it
;
5488 xassert (it
->face_id
>= 0);
5489 p
->face_id
= it
->face_id
;
5490 p
->string
= it
->string
;
5491 p
->method
= it
->method
;
5492 p
->from_overlay
= it
->from_overlay
;
5495 case GET_FROM_IMAGE
:
5496 p
->u
.image
.object
= it
->object
;
5497 p
->u
.image
.image_id
= it
->image_id
;
5498 p
->u
.image
.slice
= it
->slice
;
5500 case GET_FROM_STRETCH
:
5501 p
->u
.stretch
.object
= it
->object
;
5504 p
->position
= position
? *position
: it
->position
;
5505 p
->current
= it
->current
;
5506 p
->end_charpos
= it
->end_charpos
;
5507 p
->string_nchars
= it
->string_nchars
;
5509 p
->multibyte_p
= it
->multibyte_p
;
5510 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5511 p
->space_width
= it
->space_width
;
5512 p
->font_height
= it
->font_height
;
5513 p
->voffset
= it
->voffset
;
5514 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5515 p
->display_ellipsis_p
= 0;
5516 p
->line_wrap
= it
->line_wrap
;
5517 p
->bidi_p
= it
->bidi_p
;
5518 p
->paragraph_embedding
= it
->paragraph_embedding
;
5519 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5522 /* Save the state of the bidi iterator as well. */
5524 bidi_push_it (&it
->bidi_it
);
5528 iterate_out_of_display_property (struct it
*it
)
5530 int buffer_p
= BUFFERP (it
->object
);
5531 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5532 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5534 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5536 /* Maybe initialize paragraph direction. If we are at the beginning
5537 of a new paragraph, next_element_from_buffer may not have a
5538 chance to do that. */
5539 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5540 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5541 /* prev_stop can be zero, so check against BEGV as well. */
5542 while (it
->bidi_it
.charpos
>= bob
5543 && it
->prev_stop
<= it
->bidi_it
.charpos
5544 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5545 && it
->bidi_it
.charpos
< eob
)
5546 bidi_move_to_visually_next (&it
->bidi_it
);
5547 /* Record the stop_pos we just crossed, for when we cross it
5549 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5550 it
->prev_stop
= CHARPOS (it
->position
);
5551 /* If we ended up not where pop_it put us, resync IT's
5552 positional members with the bidi iterator. */
5553 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5554 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5556 it
->current
.pos
= it
->position
;
5558 it
->current
.string_pos
= it
->position
;
5561 /* Restore IT's settings from IT->stack. Called, for example, when no
5562 more overlay strings must be processed, and we return to delivering
5563 display elements from a buffer, or when the end of a string from a
5564 `display' property is reached and we return to delivering display
5565 elements from an overlay string, or from a buffer. */
5568 pop_it (struct it
*it
)
5570 struct iterator_stack_entry
*p
;
5571 int from_display_prop
= it
->from_disp_prop_p
;
5573 xassert (it
->sp
> 0);
5575 p
= it
->stack
+ it
->sp
;
5576 it
->stop_charpos
= p
->stop_charpos
;
5577 it
->prev_stop
= p
->prev_stop
;
5578 it
->base_level_stop
= p
->base_level_stop
;
5579 it
->cmp_it
= p
->cmp_it
;
5580 it
->face_id
= p
->face_id
;
5581 it
->current
= p
->current
;
5582 it
->position
= p
->position
;
5583 it
->string
= p
->string
;
5584 it
->from_overlay
= p
->from_overlay
;
5585 if (NILP (it
->string
))
5586 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5587 it
->method
= p
->method
;
5590 case GET_FROM_IMAGE
:
5591 it
->image_id
= p
->u
.image
.image_id
;
5592 it
->object
= p
->u
.image
.object
;
5593 it
->slice
= p
->u
.image
.slice
;
5595 case GET_FROM_STRETCH
:
5596 it
->object
= p
->u
.stretch
.object
;
5598 case GET_FROM_BUFFER
:
5599 it
->object
= it
->w
->buffer
;
5601 case GET_FROM_STRING
:
5602 it
->object
= it
->string
;
5604 case GET_FROM_DISPLAY_VECTOR
:
5606 it
->method
= GET_FROM_C_STRING
;
5607 else if (STRINGP (it
->string
))
5608 it
->method
= GET_FROM_STRING
;
5611 it
->method
= GET_FROM_BUFFER
;
5612 it
->object
= it
->w
->buffer
;
5615 it
->end_charpos
= p
->end_charpos
;
5616 it
->string_nchars
= p
->string_nchars
;
5618 it
->multibyte_p
= p
->multibyte_p
;
5619 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5620 it
->space_width
= p
->space_width
;
5621 it
->font_height
= p
->font_height
;
5622 it
->voffset
= p
->voffset
;
5623 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5624 it
->line_wrap
= p
->line_wrap
;
5625 it
->bidi_p
= p
->bidi_p
;
5626 it
->paragraph_embedding
= p
->paragraph_embedding
;
5627 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5630 bidi_pop_it (&it
->bidi_it
);
5631 /* Bidi-iterate until we get out of the portion of text, if any,
5632 covered by a `display' text property or by an overlay with
5633 `display' property. (We cannot just jump there, because the
5634 internal coherency of the bidi iterator state can not be
5635 preserved across such jumps.) We also must determine the
5636 paragraph base direction if the overlay we just processed is
5637 at the beginning of a new paragraph. */
5638 if (from_display_prop
5639 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5640 iterate_out_of_display_property (it
);
5642 xassert ((BUFFERP (it
->object
)
5643 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5644 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5645 || (STRINGP (it
->object
)
5646 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5647 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5648 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5654 /***********************************************************************
5656 ***********************************************************************/
5658 /* Set IT's current position to the previous line start. */
5661 back_to_previous_line_start (struct it
*it
)
5663 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5664 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5668 /* Move IT to the next line start.
5670 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5671 we skipped over part of the text (as opposed to moving the iterator
5672 continuously over the text). Otherwise, don't change the value
5675 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5676 iterator on the newline, if it was found.
5678 Newlines may come from buffer text, overlay strings, or strings
5679 displayed via the `display' property. That's the reason we can't
5680 simply use find_next_newline_no_quit.
5682 Note that this function may not skip over invisible text that is so
5683 because of text properties and immediately follows a newline. If
5684 it would, function reseat_at_next_visible_line_start, when called
5685 from set_iterator_to_next, would effectively make invisible
5686 characters following a newline part of the wrong glyph row, which
5687 leads to wrong cursor motion. */
5690 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5691 struct bidi_it
*bidi_it_prev
)
5693 EMACS_INT old_selective
;
5694 int newline_found_p
, n
;
5695 const int MAX_NEWLINE_DISTANCE
= 500;
5697 /* If already on a newline, just consume it to avoid unintended
5698 skipping over invisible text below. */
5699 if (it
->what
== IT_CHARACTER
5701 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5703 if (it
->bidi_p
&& bidi_it_prev
)
5704 *bidi_it_prev
= it
->bidi_it
;
5705 set_iterator_to_next (it
, 0);
5710 /* Don't handle selective display in the following. It's (a)
5711 unnecessary because it's done by the caller, and (b) leads to an
5712 infinite recursion because next_element_from_ellipsis indirectly
5713 calls this function. */
5714 old_selective
= it
->selective
;
5717 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5718 from buffer text. */
5719 for (n
= newline_found_p
= 0;
5720 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5721 n
+= STRINGP (it
->string
) ? 0 : 1)
5723 if (!get_next_display_element (it
))
5725 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5726 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5727 *bidi_it_prev
= it
->bidi_it
;
5728 set_iterator_to_next (it
, 0);
5731 /* If we didn't find a newline near enough, see if we can use a
5733 if (!newline_found_p
)
5735 EMACS_INT start
= IT_CHARPOS (*it
);
5736 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5739 xassert (!STRINGP (it
->string
));
5741 /* If there isn't any `display' property in sight, and no
5742 overlays, we can just use the position of the newline in
5744 if (it
->stop_charpos
>= limit
5745 || ((pos
= Fnext_single_property_change (make_number (start
),
5747 make_number (limit
)),
5749 && next_overlay_change (start
) == ZV
))
5753 IT_CHARPOS (*it
) = limit
;
5754 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5758 struct bidi_it bprev
;
5760 /* Help bidi.c avoid expensive searches for display
5761 properties and overlays, by telling it that there are
5762 none up to `limit'. */
5763 if (it
->bidi_it
.disp_pos
< limit
)
5765 it
->bidi_it
.disp_pos
= limit
;
5766 it
->bidi_it
.disp_prop
= 0;
5769 bprev
= it
->bidi_it
;
5770 bidi_move_to_visually_next (&it
->bidi_it
);
5771 } while (it
->bidi_it
.charpos
!= limit
);
5772 IT_CHARPOS (*it
) = limit
;
5773 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5775 *bidi_it_prev
= bprev
;
5777 *skipped_p
= newline_found_p
= 1;
5781 while (get_next_display_element (it
)
5782 && !newline_found_p
)
5784 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5785 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5786 *bidi_it_prev
= it
->bidi_it
;
5787 set_iterator_to_next (it
, 0);
5792 it
->selective
= old_selective
;
5793 return newline_found_p
;
5797 /* Set IT's current position to the previous visible line start. Skip
5798 invisible text that is so either due to text properties or due to
5799 selective display. Caution: this does not change IT->current_x and
5803 back_to_previous_visible_line_start (struct it
*it
)
5805 while (IT_CHARPOS (*it
) > BEGV
)
5807 back_to_previous_line_start (it
);
5809 if (IT_CHARPOS (*it
) <= BEGV
)
5812 /* If selective > 0, then lines indented more than its value are
5814 if (it
->selective
> 0
5815 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5819 /* Check the newline before point for invisibility. */
5822 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5823 Qinvisible
, it
->window
);
5824 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5828 if (IT_CHARPOS (*it
) <= BEGV
)
5833 void *it2data
= NULL
;
5836 Lisp_Object val
, overlay
;
5838 SAVE_IT (it2
, *it
, it2data
);
5840 /* If newline is part of a composition, continue from start of composition */
5841 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5842 && beg
< IT_CHARPOS (*it
))
5845 /* If newline is replaced by a display property, find start of overlay
5846 or interval and continue search from that point. */
5847 pos
= --IT_CHARPOS (it2
);
5850 bidi_unshelve_cache (NULL
, 0);
5851 it2
.string_from_display_prop_p
= 0;
5852 it2
.from_disp_prop_p
= 0;
5853 if (handle_display_prop (&it2
) == HANDLED_RETURN
5854 && !NILP (val
= get_char_property_and_overlay
5855 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5856 && (OVERLAYP (overlay
)
5857 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5858 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5860 RESTORE_IT (it
, it
, it2data
);
5864 /* Newline is not replaced by anything -- so we are done. */
5865 RESTORE_IT (it
, it
, it2data
);
5871 IT_CHARPOS (*it
) = beg
;
5872 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5876 it
->continuation_lines_width
= 0;
5878 xassert (IT_CHARPOS (*it
) >= BEGV
);
5879 xassert (IT_CHARPOS (*it
) == BEGV
5880 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5885 /* Reseat iterator IT at the previous visible line start. Skip
5886 invisible text that is so either due to text properties or due to
5887 selective display. At the end, update IT's overlay information,
5888 face information etc. */
5891 reseat_at_previous_visible_line_start (struct it
*it
)
5893 back_to_previous_visible_line_start (it
);
5894 reseat (it
, it
->current
.pos
, 1);
5899 /* Reseat iterator IT on the next visible line start in the current
5900 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5901 preceding the line start. Skip over invisible text that is so
5902 because of selective display. Compute faces, overlays etc at the
5903 new position. Note that this function does not skip over text that
5904 is invisible because of text properties. */
5907 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5909 int newline_found_p
, skipped_p
= 0;
5910 struct bidi_it bidi_it_prev
;
5912 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5914 /* Skip over lines that are invisible because they are indented
5915 more than the value of IT->selective. */
5916 if (it
->selective
> 0)
5917 while (IT_CHARPOS (*it
) < ZV
5918 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5921 xassert (IT_BYTEPOS (*it
) == BEGV
5922 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5924 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5927 /* Position on the newline if that's what's requested. */
5928 if (on_newline_p
&& newline_found_p
)
5930 if (STRINGP (it
->string
))
5932 if (IT_STRING_CHARPOS (*it
) > 0)
5936 --IT_STRING_CHARPOS (*it
);
5937 --IT_STRING_BYTEPOS (*it
);
5941 /* We need to restore the bidi iterator to the state
5942 it had on the newline, and resync the IT's
5943 position with that. */
5944 it
->bidi_it
= bidi_it_prev
;
5945 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5946 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5950 else if (IT_CHARPOS (*it
) > BEGV
)
5959 /* We need to restore the bidi iterator to the state it
5960 had on the newline and resync IT with that. */
5961 it
->bidi_it
= bidi_it_prev
;
5962 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5963 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5965 reseat (it
, it
->current
.pos
, 0);
5969 reseat (it
, it
->current
.pos
, 0);
5976 /***********************************************************************
5977 Changing an iterator's position
5978 ***********************************************************************/
5980 /* Change IT's current position to POS in current_buffer. If FORCE_P
5981 is non-zero, always check for text properties at the new position.
5982 Otherwise, text properties are only looked up if POS >=
5983 IT->check_charpos of a property. */
5986 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5988 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5990 reseat_1 (it
, pos
, 0);
5992 /* Determine where to check text properties. Avoid doing it
5993 where possible because text property lookup is very expensive. */
5995 || CHARPOS (pos
) > it
->stop_charpos
5996 || CHARPOS (pos
) < original_pos
)
6000 /* For bidi iteration, we need to prime prev_stop and
6001 base_level_stop with our best estimations. */
6002 /* Implementation note: Of course, POS is not necessarily a
6003 stop position, so assigning prev_pos to it is a lie; we
6004 should have called compute_stop_backwards. However, if
6005 the current buffer does not include any R2L characters,
6006 that call would be a waste of cycles, because the
6007 iterator will never move back, and thus never cross this
6008 "fake" stop position. So we delay that backward search
6009 until the time we really need it, in next_element_from_buffer. */
6010 if (CHARPOS (pos
) != it
->prev_stop
)
6011 it
->prev_stop
= CHARPOS (pos
);
6012 if (CHARPOS (pos
) < it
->base_level_stop
)
6013 it
->base_level_stop
= 0; /* meaning it's unknown */
6019 it
->prev_stop
= it
->base_level_stop
= 0;
6028 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6029 IT->stop_pos to POS, also. */
6032 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6034 /* Don't call this function when scanning a C string. */
6035 xassert (it
->s
== NULL
);
6037 /* POS must be a reasonable value. */
6038 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6040 it
->current
.pos
= it
->position
= pos
;
6041 it
->end_charpos
= ZV
;
6043 it
->current
.dpvec_index
= -1;
6044 it
->current
.overlay_string_index
= -1;
6045 IT_STRING_CHARPOS (*it
) = -1;
6046 IT_STRING_BYTEPOS (*it
) = -1;
6048 it
->method
= GET_FROM_BUFFER
;
6049 it
->object
= it
->w
->buffer
;
6050 it
->area
= TEXT_AREA
;
6051 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6053 it
->string_from_display_prop_p
= 0;
6054 it
->from_disp_prop_p
= 0;
6055 it
->face_before_selective_p
= 0;
6058 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6060 bidi_unshelve_cache (NULL
, 0);
6061 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6062 it
->bidi_it
.string
.s
= NULL
;
6063 it
->bidi_it
.string
.lstring
= Qnil
;
6064 it
->bidi_it
.string
.bufpos
= 0;
6065 it
->bidi_it
.string
.unibyte
= 0;
6070 it
->stop_charpos
= CHARPOS (pos
);
6071 it
->base_level_stop
= CHARPOS (pos
);
6076 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6077 If S is non-null, it is a C string to iterate over. Otherwise,
6078 STRING gives a Lisp string to iterate over.
6080 If PRECISION > 0, don't return more then PRECISION number of
6081 characters from the string.
6083 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6084 characters have been returned. FIELD_WIDTH < 0 means an infinite
6087 MULTIBYTE = 0 means disable processing of multibyte characters,
6088 MULTIBYTE > 0 means enable it,
6089 MULTIBYTE < 0 means use IT->multibyte_p.
6091 IT must be initialized via a prior call to init_iterator before
6092 calling this function. */
6095 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6096 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6099 /* No region in strings. */
6100 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6102 /* No text property checks performed by default, but see below. */
6103 it
->stop_charpos
= -1;
6105 /* Set iterator position and end position. */
6106 memset (&it
->current
, 0, sizeof it
->current
);
6107 it
->current
.overlay_string_index
= -1;
6108 it
->current
.dpvec_index
= -1;
6109 xassert (charpos
>= 0);
6111 /* If STRING is specified, use its multibyteness, otherwise use the
6112 setting of MULTIBYTE, if specified. */
6114 it
->multibyte_p
= multibyte
> 0;
6116 /* Bidirectional reordering of strings is controlled by the default
6117 value of bidi-display-reordering. */
6118 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6122 xassert (STRINGP (string
));
6123 it
->string
= string
;
6125 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6126 it
->method
= GET_FROM_STRING
;
6127 it
->current
.string_pos
= string_pos (charpos
, string
);
6131 it
->bidi_it
.string
.lstring
= string
;
6132 it
->bidi_it
.string
.s
= NULL
;
6133 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6134 it
->bidi_it
.string
.bufpos
= 0;
6135 it
->bidi_it
.string
.from_disp_str
= 0;
6136 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6137 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6138 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6143 it
->s
= (const unsigned char *) s
;
6146 /* Note that we use IT->current.pos, not it->current.string_pos,
6147 for displaying C strings. */
6148 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6149 if (it
->multibyte_p
)
6151 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6152 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6156 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6157 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6162 it
->bidi_it
.string
.lstring
= Qnil
;
6163 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6164 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6165 it
->bidi_it
.string
.bufpos
= 0;
6166 it
->bidi_it
.string
.from_disp_str
= 0;
6167 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6168 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6171 it
->method
= GET_FROM_C_STRING
;
6174 /* PRECISION > 0 means don't return more than PRECISION characters
6176 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6178 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6180 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6183 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6184 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6185 FIELD_WIDTH < 0 means infinite field width. This is useful for
6186 padding with `-' at the end of a mode line. */
6187 if (field_width
< 0)
6188 field_width
= INFINITY
;
6189 /* Implementation note: We deliberately don't enlarge
6190 it->bidi_it.string.schars here to fit it->end_charpos, because
6191 the bidi iterator cannot produce characters out of thin air. */
6192 if (field_width
> it
->end_charpos
- charpos
)
6193 it
->end_charpos
= charpos
+ field_width
;
6195 /* Use the standard display table for displaying strings. */
6196 if (DISP_TABLE_P (Vstandard_display_table
))
6197 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6199 it
->stop_charpos
= charpos
;
6200 it
->prev_stop
= charpos
;
6201 it
->base_level_stop
= 0;
6204 it
->bidi_it
.first_elt
= 1;
6205 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6206 it
->bidi_it
.disp_pos
= -1;
6208 if (s
== NULL
&& it
->multibyte_p
)
6210 EMACS_INT endpos
= SCHARS (it
->string
);
6211 if (endpos
> it
->end_charpos
)
6212 endpos
= it
->end_charpos
;
6213 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6221 /***********************************************************************
6223 ***********************************************************************/
6225 /* Map enum it_method value to corresponding next_element_from_* function. */
6227 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6229 next_element_from_buffer
,
6230 next_element_from_display_vector
,
6231 next_element_from_string
,
6232 next_element_from_c_string
,
6233 next_element_from_image
,
6234 next_element_from_stretch
6237 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6240 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6241 (possibly with the following characters). */
6243 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6244 ((IT)->cmp_it.id >= 0 \
6245 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6246 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6247 END_CHARPOS, (IT)->w, \
6248 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6252 /* Lookup the char-table Vglyphless_char_display for character C (-1
6253 if we want information for no-font case), and return the display
6254 method symbol. By side-effect, update it->what and
6255 it->glyphless_method. This function is called from
6256 get_next_display_element for each character element, and from
6257 x_produce_glyphs when no suitable font was found. */
6260 lookup_glyphless_char_display (int c
, struct it
*it
)
6262 Lisp_Object glyphless_method
= Qnil
;
6264 if (CHAR_TABLE_P (Vglyphless_char_display
)
6265 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6269 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6270 if (CONSP (glyphless_method
))
6271 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6272 ? XCAR (glyphless_method
)
6273 : XCDR (glyphless_method
);
6276 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6280 if (NILP (glyphless_method
))
6283 /* The default is to display the character by a proper font. */
6285 /* The default for the no-font case is to display an empty box. */
6286 glyphless_method
= Qempty_box
;
6288 if (EQ (glyphless_method
, Qzero_width
))
6291 return glyphless_method
;
6292 /* This method can't be used for the no-font case. */
6293 glyphless_method
= Qempty_box
;
6295 if (EQ (glyphless_method
, Qthin_space
))
6296 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6297 else if (EQ (glyphless_method
, Qempty_box
))
6298 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6299 else if (EQ (glyphless_method
, Qhex_code
))
6300 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6301 else if (STRINGP (glyphless_method
))
6302 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6305 /* Invalid value. We use the default method. */
6306 glyphless_method
= Qnil
;
6309 it
->what
= IT_GLYPHLESS
;
6310 return glyphless_method
;
6313 /* Load IT's display element fields with information about the next
6314 display element from the current position of IT. Value is zero if
6315 end of buffer (or C string) is reached. */
6317 static struct frame
*last_escape_glyph_frame
= NULL
;
6318 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6319 static int last_escape_glyph_merged_face_id
= 0;
6321 struct frame
*last_glyphless_glyph_frame
= NULL
;
6322 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6323 int last_glyphless_glyph_merged_face_id
= 0;
6326 get_next_display_element (struct it
*it
)
6328 /* Non-zero means that we found a display element. Zero means that
6329 we hit the end of what we iterate over. Performance note: the
6330 function pointer `method' used here turns out to be faster than
6331 using a sequence of if-statements. */
6335 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6337 if (it
->what
== IT_CHARACTER
)
6339 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6340 and only if (a) the resolved directionality of that character
6342 /* FIXME: Do we need an exception for characters from display
6344 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6345 it
->c
= bidi_mirror_char (it
->c
);
6346 /* Map via display table or translate control characters.
6347 IT->c, IT->len etc. have been set to the next character by
6348 the function call above. If we have a display table, and it
6349 contains an entry for IT->c, translate it. Don't do this if
6350 IT->c itself comes from a display table, otherwise we could
6351 end up in an infinite recursion. (An alternative could be to
6352 count the recursion depth of this function and signal an
6353 error when a certain maximum depth is reached.) Is it worth
6355 if (success_p
&& it
->dpvec
== NULL
)
6358 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6359 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6360 nbsp_or_shy
= char_is_other
;
6361 int c
= it
->c
; /* This is the character to display. */
6363 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6365 xassert (SINGLE_BYTE_CHAR_P (c
));
6366 if (unibyte_display_via_language_environment
)
6368 c
= DECODE_CHAR (unibyte
, c
);
6370 c
= BYTE8_TO_CHAR (it
->c
);
6373 c
= BYTE8_TO_CHAR (it
->c
);
6377 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6380 struct Lisp_Vector
*v
= XVECTOR (dv
);
6382 /* Return the first character from the display table
6383 entry, if not empty. If empty, don't display the
6384 current character. */
6387 it
->dpvec_char_len
= it
->len
;
6388 it
->dpvec
= v
->contents
;
6389 it
->dpend
= v
->contents
+ v
->header
.size
;
6390 it
->current
.dpvec_index
= 0;
6391 it
->dpvec_face_id
= -1;
6392 it
->saved_face_id
= it
->face_id
;
6393 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6398 set_iterator_to_next (it
, 0);
6403 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6405 if (it
->what
== IT_GLYPHLESS
)
6407 /* Don't display this character. */
6408 set_iterator_to_next (it
, 0);
6412 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6413 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6414 : c
== 0xAD ? char_is_soft_hyphen
6417 /* Translate control characters into `\003' or `^C' form.
6418 Control characters coming from a display table entry are
6419 currently not translated because we use IT->dpvec to hold
6420 the translation. This could easily be changed but I
6421 don't believe that it is worth doing.
6423 NBSP and SOFT-HYPEN are property translated too.
6425 Non-printable characters and raw-byte characters are also
6426 translated to octal form. */
6427 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6428 ? (it
->area
!= TEXT_AREA
6429 /* In mode line, treat \n, \t like other crl chars. */
6432 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6433 || (c
!= '\n' && c
!= '\t'))
6436 || ! CHAR_PRINTABLE_P (c
))))
6438 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6439 or a non-printable character which must be displayed
6440 either as '\003' or as `^C' where the '\\' and '^'
6441 can be defined in the display table. Fill
6442 IT->ctl_chars with glyphs for what we have to
6443 display. Then, set IT->dpvec to these glyphs. */
6447 EMACS_INT lface_id
= 0;
6450 /* Handle control characters with ^. */
6452 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6456 g
= '^'; /* default glyph for Control */
6457 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6459 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6460 && GLYPH_CODE_CHAR_VALID_P (gc
))
6462 g
= GLYPH_CODE_CHAR (gc
);
6463 lface_id
= GLYPH_CODE_FACE (gc
);
6467 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6469 else if (it
->f
== last_escape_glyph_frame
6470 && it
->face_id
== last_escape_glyph_face_id
)
6472 face_id
= last_escape_glyph_merged_face_id
;
6476 /* Merge the escape-glyph face into the current face. */
6477 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6479 last_escape_glyph_frame
= it
->f
;
6480 last_escape_glyph_face_id
= it
->face_id
;
6481 last_escape_glyph_merged_face_id
= face_id
;
6484 XSETINT (it
->ctl_chars
[0], g
);
6485 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6487 goto display_control
;
6490 /* Handle non-break space in the mode where it only gets
6493 if (EQ (Vnobreak_char_display
, Qt
)
6494 && nbsp_or_shy
== char_is_nbsp
)
6496 /* Merge the no-break-space face into the current face. */
6497 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6501 XSETINT (it
->ctl_chars
[0], ' ');
6503 goto display_control
;
6506 /* Handle sequences that start with the "escape glyph". */
6508 /* the default escape glyph is \. */
6509 escape_glyph
= '\\';
6512 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6513 && GLYPH_CODE_CHAR_VALID_P (gc
))
6515 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6516 lface_id
= GLYPH_CODE_FACE (gc
);
6520 /* The display table specified a face.
6521 Merge it into face_id and also into escape_glyph. */
6522 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6525 else if (it
->f
== last_escape_glyph_frame
6526 && it
->face_id
== last_escape_glyph_face_id
)
6528 face_id
= last_escape_glyph_merged_face_id
;
6532 /* Merge the escape-glyph face into the current face. */
6533 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6535 last_escape_glyph_frame
= it
->f
;
6536 last_escape_glyph_face_id
= it
->face_id
;
6537 last_escape_glyph_merged_face_id
= face_id
;
6540 /* Handle soft hyphens in the mode where they only get
6543 if (EQ (Vnobreak_char_display
, Qt
)
6544 && nbsp_or_shy
== char_is_soft_hyphen
)
6546 XSETINT (it
->ctl_chars
[0], '-');
6548 goto display_control
;
6551 /* Handle non-break space and soft hyphen
6552 with the escape glyph. */
6556 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6557 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6558 XSETINT (it
->ctl_chars
[1], c
);
6560 goto display_control
;
6567 if (CHAR_BYTE8_P (c
))
6568 /* Display \200 instead of \17777600. */
6569 c
= CHAR_TO_BYTE8 (c
);
6570 len
= sprintf (str
, "%03o", c
);
6572 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6573 for (i
= 0; i
< len
; i
++)
6574 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6579 /* Set up IT->dpvec and return first character from it. */
6580 it
->dpvec_char_len
= it
->len
;
6581 it
->dpvec
= it
->ctl_chars
;
6582 it
->dpend
= it
->dpvec
+ ctl_len
;
6583 it
->current
.dpvec_index
= 0;
6584 it
->dpvec_face_id
= face_id
;
6585 it
->saved_face_id
= it
->face_id
;
6586 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6590 it
->char_to_display
= c
;
6594 it
->char_to_display
= it
->c
;
6598 /* Adjust face id for a multibyte character. There are no multibyte
6599 character in unibyte text. */
6600 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6603 && FRAME_WINDOW_P (it
->f
))
6605 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6607 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6609 /* Automatic composition with glyph-string. */
6610 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6612 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6616 EMACS_INT pos
= (it
->s
? -1
6617 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6618 : IT_CHARPOS (*it
));
6621 if (it
->what
== IT_CHARACTER
)
6622 c
= it
->char_to_display
;
6625 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6629 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6630 /* TAB in a composition means display glyphs with
6631 padding space on the left or right. */
6632 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6635 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6640 /* Is this character the last one of a run of characters with
6641 box? If yes, set IT->end_of_box_run_p to 1. */
6645 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6647 int face_id
= underlying_face_id (it
);
6648 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6652 if (face
->box
== FACE_NO_BOX
)
6654 /* If the box comes from face properties in a
6655 display string, check faces in that string. */
6656 int string_face_id
= face_after_it_pos (it
);
6657 it
->end_of_box_run_p
6658 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6661 /* Otherwise, the box comes from the underlying face.
6662 If this is the last string character displayed, check
6663 the next buffer location. */
6664 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6665 && (it
->current
.overlay_string_index
6666 == it
->n_overlay_strings
- 1))
6670 struct text_pos pos
= it
->current
.pos
;
6671 INC_TEXT_POS (pos
, it
->multibyte_p
);
6673 next_face_id
= face_at_buffer_position
6674 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6675 it
->region_end_charpos
, &ignore
,
6676 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6678 it
->end_of_box_run_p
6679 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6686 int face_id
= face_after_it_pos (it
);
6687 it
->end_of_box_run_p
6688 = (face_id
!= it
->face_id
6689 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6693 /* Value is 0 if end of buffer or string reached. */
6698 /* Move IT to the next display element.
6700 RESEAT_P non-zero means if called on a newline in buffer text,
6701 skip to the next visible line start.
6703 Functions get_next_display_element and set_iterator_to_next are
6704 separate because I find this arrangement easier to handle than a
6705 get_next_display_element function that also increments IT's
6706 position. The way it is we can first look at an iterator's current
6707 display element, decide whether it fits on a line, and if it does,
6708 increment the iterator position. The other way around we probably
6709 would either need a flag indicating whether the iterator has to be
6710 incremented the next time, or we would have to implement a
6711 decrement position function which would not be easy to write. */
6714 set_iterator_to_next (struct it
*it
, int reseat_p
)
6716 /* Reset flags indicating start and end of a sequence of characters
6717 with box. Reset them at the start of this function because
6718 moving the iterator to a new position might set them. */
6719 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6723 case GET_FROM_BUFFER
:
6724 /* The current display element of IT is a character from
6725 current_buffer. Advance in the buffer, and maybe skip over
6726 invisible lines that are so because of selective display. */
6727 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6728 reseat_at_next_visible_line_start (it
, 0);
6729 else if (it
->cmp_it
.id
>= 0)
6731 /* We are currently getting glyphs from a composition. */
6736 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6737 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6738 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6740 it
->cmp_it
.from
= it
->cmp_it
.to
;
6745 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6747 it
->end_charpos
, Qnil
);
6750 else if (! it
->cmp_it
.reversed_p
)
6752 /* Composition created while scanning forward. */
6753 /* Update IT's char/byte positions to point to the first
6754 character of the next grapheme cluster, or to the
6755 character visually after the current composition. */
6756 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6757 bidi_move_to_visually_next (&it
->bidi_it
);
6758 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6759 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6761 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6763 /* Proceed to the next grapheme cluster. */
6764 it
->cmp_it
.from
= it
->cmp_it
.to
;
6768 /* No more grapheme clusters in this composition.
6769 Find the next stop position. */
6770 EMACS_INT stop
= it
->end_charpos
;
6771 if (it
->bidi_it
.scan_dir
< 0)
6772 /* Now we are scanning backward and don't know
6775 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6776 IT_BYTEPOS (*it
), stop
, Qnil
);
6781 /* Composition created while scanning backward. */
6782 /* Update IT's char/byte positions to point to the last
6783 character of the previous grapheme cluster, or the
6784 character visually after the current composition. */
6785 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6786 bidi_move_to_visually_next (&it
->bidi_it
);
6787 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6788 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6789 if (it
->cmp_it
.from
> 0)
6791 /* Proceed to the previous grapheme cluster. */
6792 it
->cmp_it
.to
= it
->cmp_it
.from
;
6796 /* No more grapheme clusters in this composition.
6797 Find the next stop position. */
6798 EMACS_INT stop
= it
->end_charpos
;
6799 if (it
->bidi_it
.scan_dir
< 0)
6800 /* Now we are scanning backward and don't know
6803 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6804 IT_BYTEPOS (*it
), stop
, Qnil
);
6810 xassert (it
->len
!= 0);
6814 IT_BYTEPOS (*it
) += it
->len
;
6815 IT_CHARPOS (*it
) += 1;
6819 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6820 /* If this is a new paragraph, determine its base
6821 direction (a.k.a. its base embedding level). */
6822 if (it
->bidi_it
.new_paragraph
)
6823 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6824 bidi_move_to_visually_next (&it
->bidi_it
);
6825 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6826 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6827 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6829 /* As the scan direction was changed, we must
6830 re-compute the stop position for composition. */
6831 EMACS_INT stop
= it
->end_charpos
;
6832 if (it
->bidi_it
.scan_dir
< 0)
6834 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6835 IT_BYTEPOS (*it
), stop
, Qnil
);
6838 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6842 case GET_FROM_C_STRING
:
6843 /* Current display element of IT is from a C string. */
6845 /* If the string position is beyond string's end, it means
6846 next_element_from_c_string is padding the string with
6847 blanks, in which case we bypass the bidi iterator,
6848 because it cannot deal with such virtual characters. */
6849 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6851 IT_BYTEPOS (*it
) += it
->len
;
6852 IT_CHARPOS (*it
) += 1;
6856 bidi_move_to_visually_next (&it
->bidi_it
);
6857 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6858 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6862 case GET_FROM_DISPLAY_VECTOR
:
6863 /* Current display element of IT is from a display table entry.
6864 Advance in the display table definition. Reset it to null if
6865 end reached, and continue with characters from buffers/
6867 ++it
->current
.dpvec_index
;
6869 /* Restore face of the iterator to what they were before the
6870 display vector entry (these entries may contain faces). */
6871 it
->face_id
= it
->saved_face_id
;
6873 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6875 int recheck_faces
= it
->ellipsis_p
;
6878 it
->method
= GET_FROM_C_STRING
;
6879 else if (STRINGP (it
->string
))
6880 it
->method
= GET_FROM_STRING
;
6883 it
->method
= GET_FROM_BUFFER
;
6884 it
->object
= it
->w
->buffer
;
6888 it
->current
.dpvec_index
= -1;
6890 /* Skip over characters which were displayed via IT->dpvec. */
6891 if (it
->dpvec_char_len
< 0)
6892 reseat_at_next_visible_line_start (it
, 1);
6893 else if (it
->dpvec_char_len
> 0)
6895 if (it
->method
== GET_FROM_STRING
6896 && it
->n_overlay_strings
> 0)
6897 it
->ignore_overlay_strings_at_pos_p
= 1;
6898 it
->len
= it
->dpvec_char_len
;
6899 set_iterator_to_next (it
, reseat_p
);
6902 /* Maybe recheck faces after display vector */
6904 it
->stop_charpos
= IT_CHARPOS (*it
);
6908 case GET_FROM_STRING
:
6909 /* Current display element is a character from a Lisp string. */
6910 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6911 if (it
->cmp_it
.id
>= 0)
6917 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6918 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6919 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6920 it
->cmp_it
.from
= it
->cmp_it
.to
;
6924 composition_compute_stop_pos (&it
->cmp_it
,
6925 IT_STRING_CHARPOS (*it
),
6926 IT_STRING_BYTEPOS (*it
),
6927 it
->end_charpos
, it
->string
);
6930 else if (! it
->cmp_it
.reversed_p
)
6932 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6933 bidi_move_to_visually_next (&it
->bidi_it
);
6934 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6935 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6937 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6938 it
->cmp_it
.from
= it
->cmp_it
.to
;
6941 EMACS_INT stop
= it
->end_charpos
;
6942 if (it
->bidi_it
.scan_dir
< 0)
6944 composition_compute_stop_pos (&it
->cmp_it
,
6945 IT_STRING_CHARPOS (*it
),
6946 IT_STRING_BYTEPOS (*it
), stop
,
6952 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6953 bidi_move_to_visually_next (&it
->bidi_it
);
6954 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6955 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6956 if (it
->cmp_it
.from
> 0)
6957 it
->cmp_it
.to
= it
->cmp_it
.from
;
6960 EMACS_INT stop
= it
->end_charpos
;
6961 if (it
->bidi_it
.scan_dir
< 0)
6963 composition_compute_stop_pos (&it
->cmp_it
,
6964 IT_STRING_CHARPOS (*it
),
6965 IT_STRING_BYTEPOS (*it
), stop
,
6973 /* If the string position is beyond string's end, it
6974 means next_element_from_string is padding the string
6975 with blanks, in which case we bypass the bidi
6976 iterator, because it cannot deal with such virtual
6978 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6980 IT_STRING_BYTEPOS (*it
) += it
->len
;
6981 IT_STRING_CHARPOS (*it
) += 1;
6985 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6987 bidi_move_to_visually_next (&it
->bidi_it
);
6988 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6989 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6990 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6992 EMACS_INT stop
= it
->end_charpos
;
6994 if (it
->bidi_it
.scan_dir
< 0)
6996 composition_compute_stop_pos (&it
->cmp_it
,
6997 IT_STRING_CHARPOS (*it
),
6998 IT_STRING_BYTEPOS (*it
), stop
,
7004 consider_string_end
:
7006 if (it
->current
.overlay_string_index
>= 0)
7008 /* IT->string is an overlay string. Advance to the
7009 next, if there is one. */
7010 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7013 next_overlay_string (it
);
7015 setup_for_ellipsis (it
, 0);
7020 /* IT->string is not an overlay string. If we reached
7021 its end, and there is something on IT->stack, proceed
7022 with what is on the stack. This can be either another
7023 string, this time an overlay string, or a buffer. */
7024 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7028 if (it
->method
== GET_FROM_STRING
)
7029 goto consider_string_end
;
7034 case GET_FROM_IMAGE
:
7035 case GET_FROM_STRETCH
:
7036 /* The position etc with which we have to proceed are on
7037 the stack. The position may be at the end of a string,
7038 if the `display' property takes up the whole string. */
7039 xassert (it
->sp
> 0);
7041 if (it
->method
== GET_FROM_STRING
)
7042 goto consider_string_end
;
7046 /* There are no other methods defined, so this should be a bug. */
7050 xassert (it
->method
!= GET_FROM_STRING
7051 || (STRINGP (it
->string
)
7052 && IT_STRING_CHARPOS (*it
) >= 0));
7055 /* Load IT's display element fields with information about the next
7056 display element which comes from a display table entry or from the
7057 result of translating a control character to one of the forms `^C'
7060 IT->dpvec holds the glyphs to return as characters.
7061 IT->saved_face_id holds the face id before the display vector--it
7062 is restored into IT->face_id in set_iterator_to_next. */
7065 next_element_from_display_vector (struct it
*it
)
7070 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7072 it
->face_id
= it
->saved_face_id
;
7074 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7075 That seemed totally bogus - so I changed it... */
7076 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7078 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7080 it
->c
= GLYPH_CODE_CHAR (gc
);
7081 it
->len
= CHAR_BYTES (it
->c
);
7083 /* The entry may contain a face id to use. Such a face id is
7084 the id of a Lisp face, not a realized face. A face id of
7085 zero means no face is specified. */
7086 if (it
->dpvec_face_id
>= 0)
7087 it
->face_id
= it
->dpvec_face_id
;
7090 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7092 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7097 /* Display table entry is invalid. Return a space. */
7098 it
->c
= ' ', it
->len
= 1;
7100 /* Don't change position and object of the iterator here. They are
7101 still the values of the character that had this display table
7102 entry or was translated, and that's what we want. */
7103 it
->what
= IT_CHARACTER
;
7107 /* Get the first element of string/buffer in the visual order, after
7108 being reseated to a new position in a string or a buffer. */
7110 get_visually_first_element (struct it
*it
)
7112 int string_p
= STRINGP (it
->string
) || it
->s
;
7113 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7114 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7116 if (STRINGP (it
->string
))
7118 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7119 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7123 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7124 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7127 if (it
->bidi_it
.charpos
== eob
)
7129 /* Nothing to do, but reset the FIRST_ELT flag, like
7130 bidi_paragraph_init does, because we are not going to
7132 it
->bidi_it
.first_elt
= 0;
7134 else if (it
->bidi_it
.charpos
== bob
7136 /* FIXME: Should support all Unicode line separators. */
7137 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7138 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7140 /* If we are at the beginning of a line/string, we can produce
7141 the next element right away. */
7142 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7143 bidi_move_to_visually_next (&it
->bidi_it
);
7147 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7149 /* We need to prime the bidi iterator starting at the line's or
7150 string's beginning, before we will be able to produce the
7153 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7156 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7158 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7160 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7163 /* Now return to buffer/string position where we were asked
7164 to get the next display element, and produce that. */
7165 bidi_move_to_visually_next (&it
->bidi_it
);
7167 while (it
->bidi_it
.bytepos
!= orig_bytepos
7168 && it
->bidi_it
.charpos
< eob
);
7171 /* Adjust IT's position information to where we ended up. */
7172 if (STRINGP (it
->string
))
7174 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7175 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7179 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7180 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7183 if (STRINGP (it
->string
) || !it
->s
)
7185 EMACS_INT stop
, charpos
, bytepos
;
7187 if (STRINGP (it
->string
))
7190 stop
= SCHARS (it
->string
);
7191 if (stop
> it
->end_charpos
)
7192 stop
= it
->end_charpos
;
7193 charpos
= IT_STRING_CHARPOS (*it
);
7194 bytepos
= IT_STRING_BYTEPOS (*it
);
7198 stop
= it
->end_charpos
;
7199 charpos
= IT_CHARPOS (*it
);
7200 bytepos
= IT_BYTEPOS (*it
);
7202 if (it
->bidi_it
.scan_dir
< 0)
7204 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7209 /* Load IT with the next display element from Lisp string IT->string.
7210 IT->current.string_pos is the current position within the string.
7211 If IT->current.overlay_string_index >= 0, the Lisp string is an
7215 next_element_from_string (struct it
*it
)
7217 struct text_pos position
;
7219 xassert (STRINGP (it
->string
));
7220 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7221 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7222 position
= it
->current
.string_pos
;
7224 /* With bidi reordering, the character to display might not be the
7225 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7226 that we were reseat()ed to a new string, whose paragraph
7227 direction is not known. */
7228 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7230 get_visually_first_element (it
);
7231 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7234 /* Time to check for invisible text? */
7235 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7237 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7240 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7241 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7243 /* With bidi non-linear iteration, we could find
7244 ourselves far beyond the last computed stop_charpos,
7245 with several other stop positions in between that we
7246 missed. Scan them all now, in buffer's logical
7247 order, until we find and handle the last stop_charpos
7248 that precedes our current position. */
7249 handle_stop_backwards (it
, it
->stop_charpos
);
7250 return GET_NEXT_DISPLAY_ELEMENT (it
);
7256 /* Take note of the stop position we just moved
7257 across, for when we will move back across it. */
7258 it
->prev_stop
= it
->stop_charpos
;
7259 /* If we are at base paragraph embedding level, take
7260 note of the last stop position seen at this
7262 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7263 it
->base_level_stop
= it
->stop_charpos
;
7267 /* Since a handler may have changed IT->method, we must
7269 return GET_NEXT_DISPLAY_ELEMENT (it
);
7273 /* If we are before prev_stop, we may have overstepped
7274 on our way backwards a stop_pos, and if so, we need
7275 to handle that stop_pos. */
7276 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7277 /* We can sometimes back up for reasons that have nothing
7278 to do with bidi reordering. E.g., compositions. The
7279 code below is only needed when we are above the base
7280 embedding level, so test for that explicitly. */
7281 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7283 /* If we lost track of base_level_stop, we have no better
7284 place for handle_stop_backwards to start from than string
7285 beginning. This happens, e.g., when we were reseated to
7286 the previous screenful of text by vertical-motion. */
7287 if (it
->base_level_stop
<= 0
7288 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7289 it
->base_level_stop
= 0;
7290 handle_stop_backwards (it
, it
->base_level_stop
);
7291 return GET_NEXT_DISPLAY_ELEMENT (it
);
7295 if (it
->current
.overlay_string_index
>= 0)
7297 /* Get the next character from an overlay string. In overlay
7298 strings, There is no field width or padding with spaces to
7300 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7305 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7306 IT_STRING_BYTEPOS (*it
),
7307 it
->bidi_it
.scan_dir
< 0
7309 : SCHARS (it
->string
))
7310 && next_element_from_composition (it
))
7314 else if (STRING_MULTIBYTE (it
->string
))
7316 const unsigned char *s
= (SDATA (it
->string
)
7317 + IT_STRING_BYTEPOS (*it
));
7318 it
->c
= string_char_and_length (s
, &it
->len
);
7322 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7328 /* Get the next character from a Lisp string that is not an
7329 overlay string. Such strings come from the mode line, for
7330 example. We may have to pad with spaces, or truncate the
7331 string. See also next_element_from_c_string. */
7332 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7337 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7339 /* Pad with spaces. */
7340 it
->c
= ' ', it
->len
= 1;
7341 CHARPOS (position
) = BYTEPOS (position
) = -1;
7343 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7344 IT_STRING_BYTEPOS (*it
),
7345 it
->bidi_it
.scan_dir
< 0
7347 : it
->string_nchars
)
7348 && next_element_from_composition (it
))
7352 else if (STRING_MULTIBYTE (it
->string
))
7354 const unsigned char *s
= (SDATA (it
->string
)
7355 + IT_STRING_BYTEPOS (*it
));
7356 it
->c
= string_char_and_length (s
, &it
->len
);
7360 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7365 /* Record what we have and where it came from. */
7366 it
->what
= IT_CHARACTER
;
7367 it
->object
= it
->string
;
7368 it
->position
= position
;
7373 /* Load IT with next display element from C string IT->s.
7374 IT->string_nchars is the maximum number of characters to return
7375 from the string. IT->end_charpos may be greater than
7376 IT->string_nchars when this function is called, in which case we
7377 may have to return padding spaces. Value is zero if end of string
7378 reached, including padding spaces. */
7381 next_element_from_c_string (struct it
*it
)
7386 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7387 it
->what
= IT_CHARACTER
;
7388 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7391 /* With bidi reordering, the character to display might not be the
7392 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7393 we were reseated to a new string, whose paragraph direction is
7395 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7396 get_visually_first_element (it
);
7398 /* IT's position can be greater than IT->string_nchars in case a
7399 field width or precision has been specified when the iterator was
7401 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7403 /* End of the game. */
7407 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7409 /* Pad with spaces. */
7410 it
->c
= ' ', it
->len
= 1;
7411 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7413 else if (it
->multibyte_p
)
7414 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7416 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7422 /* Set up IT to return characters from an ellipsis, if appropriate.
7423 The definition of the ellipsis glyphs may come from a display table
7424 entry. This function fills IT with the first glyph from the
7425 ellipsis if an ellipsis is to be displayed. */
7428 next_element_from_ellipsis (struct it
*it
)
7430 if (it
->selective_display_ellipsis_p
)
7431 setup_for_ellipsis (it
, it
->len
);
7434 /* The face at the current position may be different from the
7435 face we find after the invisible text. Remember what it
7436 was in IT->saved_face_id, and signal that it's there by
7437 setting face_before_selective_p. */
7438 it
->saved_face_id
= it
->face_id
;
7439 it
->method
= GET_FROM_BUFFER
;
7440 it
->object
= it
->w
->buffer
;
7441 reseat_at_next_visible_line_start (it
, 1);
7442 it
->face_before_selective_p
= 1;
7445 return GET_NEXT_DISPLAY_ELEMENT (it
);
7449 /* Deliver an image display element. The iterator IT is already
7450 filled with image information (done in handle_display_prop). Value
7455 next_element_from_image (struct it
*it
)
7457 it
->what
= IT_IMAGE
;
7458 it
->ignore_overlay_strings_at_pos_p
= 0;
7463 /* Fill iterator IT with next display element from a stretch glyph
7464 property. IT->object is the value of the text property. Value is
7468 next_element_from_stretch (struct it
*it
)
7470 it
->what
= IT_STRETCH
;
7474 /* Scan backwards from IT's current position until we find a stop
7475 position, or until BEGV. This is called when we find ourself
7476 before both the last known prev_stop and base_level_stop while
7477 reordering bidirectional text. */
7480 compute_stop_pos_backwards (struct it
*it
)
7482 const int SCAN_BACK_LIMIT
= 1000;
7483 struct text_pos pos
;
7484 struct display_pos save_current
= it
->current
;
7485 struct text_pos save_position
= it
->position
;
7486 EMACS_INT charpos
= IT_CHARPOS (*it
);
7487 EMACS_INT where_we_are
= charpos
;
7488 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7489 EMACS_INT save_end_pos
= it
->end_charpos
;
7491 xassert (NILP (it
->string
) && !it
->s
);
7492 xassert (it
->bidi_p
);
7496 it
->end_charpos
= min (charpos
+ 1, ZV
);
7497 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7498 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7499 reseat_1 (it
, pos
, 0);
7500 compute_stop_pos (it
);
7501 /* We must advance forward, right? */
7502 if (it
->stop_charpos
<= charpos
)
7505 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7507 if (it
->stop_charpos
<= where_we_are
)
7508 it
->prev_stop
= it
->stop_charpos
;
7510 it
->prev_stop
= BEGV
;
7512 it
->current
= save_current
;
7513 it
->position
= save_position
;
7514 it
->stop_charpos
= save_stop_pos
;
7515 it
->end_charpos
= save_end_pos
;
7518 /* Scan forward from CHARPOS in the current buffer/string, until we
7519 find a stop position > current IT's position. Then handle the stop
7520 position before that. This is called when we bump into a stop
7521 position while reordering bidirectional text. CHARPOS should be
7522 the last previously processed stop_pos (or BEGV/0, if none were
7523 processed yet) whose position is less that IT's current
7527 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7529 int bufp
= !STRINGP (it
->string
);
7530 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7531 struct display_pos save_current
= it
->current
;
7532 struct text_pos save_position
= it
->position
;
7533 struct text_pos pos1
;
7534 EMACS_INT next_stop
;
7536 /* Scan in strict logical order. */
7537 xassert (it
->bidi_p
);
7541 it
->prev_stop
= charpos
;
7544 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7545 reseat_1 (it
, pos1
, 0);
7548 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7549 compute_stop_pos (it
);
7550 /* We must advance forward, right? */
7551 if (it
->stop_charpos
<= it
->prev_stop
)
7553 charpos
= it
->stop_charpos
;
7555 while (charpos
<= where_we_are
);
7558 it
->current
= save_current
;
7559 it
->position
= save_position
;
7560 next_stop
= it
->stop_charpos
;
7561 it
->stop_charpos
= it
->prev_stop
;
7563 it
->stop_charpos
= next_stop
;
7566 /* Load IT with the next display element from current_buffer. Value
7567 is zero if end of buffer reached. IT->stop_charpos is the next
7568 position at which to stop and check for text properties or buffer
7572 next_element_from_buffer (struct it
*it
)
7576 xassert (IT_CHARPOS (*it
) >= BEGV
);
7577 xassert (NILP (it
->string
) && !it
->s
);
7578 xassert (!it
->bidi_p
7579 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7580 && it
->bidi_it
.string
.s
== NULL
));
7582 /* With bidi reordering, the character to display might not be the
7583 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7584 we were reseat()ed to a new buffer position, which is potentially
7585 a different paragraph. */
7586 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7588 get_visually_first_element (it
);
7589 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7592 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7594 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7596 int overlay_strings_follow_p
;
7598 /* End of the game, except when overlay strings follow that
7599 haven't been returned yet. */
7600 if (it
->overlay_strings_at_end_processed_p
)
7601 overlay_strings_follow_p
= 0;
7604 it
->overlay_strings_at_end_processed_p
= 1;
7605 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7608 if (overlay_strings_follow_p
)
7609 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7613 it
->position
= it
->current
.pos
;
7617 else if (!(!it
->bidi_p
7618 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7619 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7621 /* With bidi non-linear iteration, we could find ourselves
7622 far beyond the last computed stop_charpos, with several
7623 other stop positions in between that we missed. Scan
7624 them all now, in buffer's logical order, until we find
7625 and handle the last stop_charpos that precedes our
7626 current position. */
7627 handle_stop_backwards (it
, it
->stop_charpos
);
7628 return GET_NEXT_DISPLAY_ELEMENT (it
);
7634 /* Take note of the stop position we just moved across,
7635 for when we will move back across it. */
7636 it
->prev_stop
= it
->stop_charpos
;
7637 /* If we are at base paragraph embedding level, take
7638 note of the last stop position seen at this
7640 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7641 it
->base_level_stop
= it
->stop_charpos
;
7644 return GET_NEXT_DISPLAY_ELEMENT (it
);
7648 /* If we are before prev_stop, we may have overstepped on
7649 our way backwards a stop_pos, and if so, we need to
7650 handle that stop_pos. */
7651 && IT_CHARPOS (*it
) < it
->prev_stop
7652 /* We can sometimes back up for reasons that have nothing
7653 to do with bidi reordering. E.g., compositions. The
7654 code below is only needed when we are above the base
7655 embedding level, so test for that explicitly. */
7656 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7658 if (it
->base_level_stop
<= 0
7659 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7661 /* If we lost track of base_level_stop, we need to find
7662 prev_stop by looking backwards. This happens, e.g., when
7663 we were reseated to the previous screenful of text by
7665 it
->base_level_stop
= BEGV
;
7666 compute_stop_pos_backwards (it
);
7667 handle_stop_backwards (it
, it
->prev_stop
);
7670 handle_stop_backwards (it
, it
->base_level_stop
);
7671 return GET_NEXT_DISPLAY_ELEMENT (it
);
7675 /* No face changes, overlays etc. in sight, so just return a
7676 character from current_buffer. */
7680 /* Maybe run the redisplay end trigger hook. Performance note:
7681 This doesn't seem to cost measurable time. */
7682 if (it
->redisplay_end_trigger_charpos
7684 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7685 run_redisplay_end_trigger_hook (it
);
7687 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7688 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7690 && next_element_from_composition (it
))
7695 /* Get the next character, maybe multibyte. */
7696 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7697 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7698 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7700 it
->c
= *p
, it
->len
= 1;
7702 /* Record what we have and where it came from. */
7703 it
->what
= IT_CHARACTER
;
7704 it
->object
= it
->w
->buffer
;
7705 it
->position
= it
->current
.pos
;
7707 /* Normally we return the character found above, except when we
7708 really want to return an ellipsis for selective display. */
7713 /* A value of selective > 0 means hide lines indented more
7714 than that number of columns. */
7715 if (it
->selective
> 0
7716 && IT_CHARPOS (*it
) + 1 < ZV
7717 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7718 IT_BYTEPOS (*it
) + 1,
7721 success_p
= next_element_from_ellipsis (it
);
7722 it
->dpvec_char_len
= -1;
7725 else if (it
->c
== '\r' && it
->selective
== -1)
7727 /* A value of selective == -1 means that everything from the
7728 CR to the end of the line is invisible, with maybe an
7729 ellipsis displayed for it. */
7730 success_p
= next_element_from_ellipsis (it
);
7731 it
->dpvec_char_len
= -1;
7736 /* Value is zero if end of buffer reached. */
7737 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7742 /* Run the redisplay end trigger hook for IT. */
7745 run_redisplay_end_trigger_hook (struct it
*it
)
7747 Lisp_Object args
[3];
7749 /* IT->glyph_row should be non-null, i.e. we should be actually
7750 displaying something, or otherwise we should not run the hook. */
7751 xassert (it
->glyph_row
);
7753 /* Set up hook arguments. */
7754 args
[0] = Qredisplay_end_trigger_functions
;
7755 args
[1] = it
->window
;
7756 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7757 it
->redisplay_end_trigger_charpos
= 0;
7759 /* Since we are *trying* to run these functions, don't try to run
7760 them again, even if they get an error. */
7761 it
->w
->redisplay_end_trigger
= Qnil
;
7762 Frun_hook_with_args (3, args
);
7764 /* Notice if it changed the face of the character we are on. */
7765 handle_face_prop (it
);
7769 /* Deliver a composition display element. Unlike the other
7770 next_element_from_XXX, this function is not registered in the array
7771 get_next_element[]. It is called from next_element_from_buffer and
7772 next_element_from_string when necessary. */
7775 next_element_from_composition (struct it
*it
)
7777 it
->what
= IT_COMPOSITION
;
7778 it
->len
= it
->cmp_it
.nbytes
;
7779 if (STRINGP (it
->string
))
7783 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7784 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7787 it
->position
= it
->current
.string_pos
;
7788 it
->object
= it
->string
;
7789 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7790 IT_STRING_BYTEPOS (*it
), it
->string
);
7796 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7797 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7800 if (it
->bidi_it
.new_paragraph
)
7801 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7802 /* Resync the bidi iterator with IT's new position.
7803 FIXME: this doesn't support bidirectional text. */
7804 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7805 bidi_move_to_visually_next (&it
->bidi_it
);
7809 it
->position
= it
->current
.pos
;
7810 it
->object
= it
->w
->buffer
;
7811 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7812 IT_BYTEPOS (*it
), Qnil
);
7819 /***********************************************************************
7820 Moving an iterator without producing glyphs
7821 ***********************************************************************/
7823 /* Check if iterator is at a position corresponding to a valid buffer
7824 position after some move_it_ call. */
7826 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7827 ((it)->method == GET_FROM_STRING \
7828 ? IT_STRING_CHARPOS (*it) == 0 \
7832 /* Move iterator IT to a specified buffer or X position within one
7833 line on the display without producing glyphs.
7835 OP should be a bit mask including some or all of these bits:
7836 MOVE_TO_X: Stop upon reaching x-position TO_X.
7837 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7838 Regardless of OP's value, stop upon reaching the end of the display line.
7840 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7841 This means, in particular, that TO_X includes window's horizontal
7844 The return value has several possible values that
7845 say what condition caused the scan to stop:
7847 MOVE_POS_MATCH_OR_ZV
7848 - when TO_POS or ZV was reached.
7851 -when TO_X was reached before TO_POS or ZV were reached.
7854 - when we reached the end of the display area and the line must
7858 - when we reached the end of the display area and the line is
7862 - when we stopped at a line end, i.e. a newline or a CR and selective
7865 static enum move_it_result
7866 move_it_in_display_line_to (struct it
*it
,
7867 EMACS_INT to_charpos
, int to_x
,
7868 enum move_operation_enum op
)
7870 enum move_it_result result
= MOVE_UNDEFINED
;
7871 struct glyph_row
*saved_glyph_row
;
7872 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7873 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7874 void *ppos_data
= NULL
;
7876 enum it_method prev_method
= it
->method
;
7877 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7878 int saw_smaller_pos
= prev_pos
< to_charpos
;
7880 /* Don't produce glyphs in produce_glyphs. */
7881 saved_glyph_row
= it
->glyph_row
;
7882 it
->glyph_row
= NULL
;
7884 /* Use wrap_it to save a copy of IT wherever a word wrap could
7885 occur. Use atpos_it to save a copy of IT at the desired buffer
7886 position, if found, so that we can scan ahead and check if the
7887 word later overshoots the window edge. Use atx_it similarly, for
7893 /* Use ppos_it under bidi reordering to save a copy of IT for the
7894 position > CHARPOS that is the closest to CHARPOS. We restore
7895 that position in IT when we have scanned the entire display line
7896 without finding a match for CHARPOS and all the character
7897 positions are greater than CHARPOS. */
7900 SAVE_IT (ppos_it
, *it
, ppos_data
);
7901 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7902 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7903 SAVE_IT (ppos_it
, *it
, ppos_data
);
7906 #define BUFFER_POS_REACHED_P() \
7907 ((op & MOVE_TO_POS) != 0 \
7908 && BUFFERP (it->object) \
7909 && (IT_CHARPOS (*it) == to_charpos \
7911 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7912 && IT_CHARPOS (*it) > to_charpos) \
7913 || (it->what == IT_COMPOSITION \
7914 && ((IT_CHARPOS (*it) > to_charpos \
7915 && to_charpos >= it->cmp_it.charpos) \
7916 || (IT_CHARPOS (*it) < to_charpos \
7917 && to_charpos <= it->cmp_it.charpos)))) \
7918 && (it->method == GET_FROM_BUFFER \
7919 || (it->method == GET_FROM_DISPLAY_VECTOR \
7920 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7922 /* If there's a line-/wrap-prefix, handle it. */
7923 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7924 && it
->current_y
< it
->last_visible_y
)
7925 handle_line_prefix (it
);
7927 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7928 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7932 int x
, i
, ascent
= 0, descent
= 0;
7934 /* Utility macro to reset an iterator with x, ascent, and descent. */
7935 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7936 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7937 (IT)->max_descent = descent)
7939 /* Stop if we move beyond TO_CHARPOS (after an image or a
7940 display string or stretch glyph). */
7941 if ((op
& MOVE_TO_POS
) != 0
7942 && BUFFERP (it
->object
)
7943 && it
->method
== GET_FROM_BUFFER
7945 /* When the iterator is at base embedding level, we
7946 are guaranteed that characters are delivered for
7947 display in strictly increasing order of their
7948 buffer positions. */
7949 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7950 && IT_CHARPOS (*it
) > to_charpos
)
7952 && (prev_method
== GET_FROM_IMAGE
7953 || prev_method
== GET_FROM_STRETCH
7954 || prev_method
== GET_FROM_STRING
)
7955 /* Passed TO_CHARPOS from left to right. */
7956 && ((prev_pos
< to_charpos
7957 && IT_CHARPOS (*it
) > to_charpos
)
7958 /* Passed TO_CHARPOS from right to left. */
7959 || (prev_pos
> to_charpos
7960 && IT_CHARPOS (*it
) < to_charpos
)))))
7962 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7964 result
= MOVE_POS_MATCH_OR_ZV
;
7967 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7968 /* If wrap_it is valid, the current position might be in a
7969 word that is wrapped. So, save the iterator in
7970 atpos_it and continue to see if wrapping happens. */
7971 SAVE_IT (atpos_it
, *it
, atpos_data
);
7974 /* Stop when ZV reached.
7975 We used to stop here when TO_CHARPOS reached as well, but that is
7976 too soon if this glyph does not fit on this line. So we handle it
7977 explicitly below. */
7978 if (!get_next_display_element (it
))
7980 result
= MOVE_POS_MATCH_OR_ZV
;
7984 if (it
->line_wrap
== TRUNCATE
)
7986 if (BUFFER_POS_REACHED_P ())
7988 result
= MOVE_POS_MATCH_OR_ZV
;
7994 if (it
->line_wrap
== WORD_WRAP
)
7996 if (IT_DISPLAYING_WHITESPACE (it
))
8000 /* We have reached a glyph that follows one or more
8001 whitespace characters. If the position is
8002 already found, we are done. */
8003 if (atpos_it
.sp
>= 0)
8005 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8006 result
= MOVE_POS_MATCH_OR_ZV
;
8011 RESTORE_IT (it
, &atx_it
, atx_data
);
8012 result
= MOVE_X_REACHED
;
8015 /* Otherwise, we can wrap here. */
8016 SAVE_IT (wrap_it
, *it
, wrap_data
);
8022 /* Remember the line height for the current line, in case
8023 the next element doesn't fit on the line. */
8024 ascent
= it
->max_ascent
;
8025 descent
= it
->max_descent
;
8027 /* The call to produce_glyphs will get the metrics of the
8028 display element IT is loaded with. Record the x-position
8029 before this display element, in case it doesn't fit on the
8033 PRODUCE_GLYPHS (it
);
8035 if (it
->area
!= TEXT_AREA
)
8037 prev_method
= it
->method
;
8038 if (it
->method
== GET_FROM_BUFFER
)
8039 prev_pos
= IT_CHARPOS (*it
);
8040 set_iterator_to_next (it
, 1);
8041 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8042 SET_TEXT_POS (this_line_min_pos
,
8043 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8045 && (op
& MOVE_TO_POS
)
8046 && IT_CHARPOS (*it
) > to_charpos
8047 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8048 SAVE_IT (ppos_it
, *it
, ppos_data
);
8052 /* The number of glyphs we get back in IT->nglyphs will normally
8053 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8054 character on a terminal frame, or (iii) a line end. For the
8055 second case, IT->nglyphs - 1 padding glyphs will be present.
8056 (On X frames, there is only one glyph produced for a
8057 composite character.)
8059 The behavior implemented below means, for continuation lines,
8060 that as many spaces of a TAB as fit on the current line are
8061 displayed there. For terminal frames, as many glyphs of a
8062 multi-glyph character are displayed in the current line, too.
8063 This is what the old redisplay code did, and we keep it that
8064 way. Under X, the whole shape of a complex character must
8065 fit on the line or it will be completely displayed in the
8068 Note that both for tabs and padding glyphs, all glyphs have
8072 /* More than one glyph or glyph doesn't fit on line. All
8073 glyphs have the same width. */
8074 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8076 int x_before_this_char
= x
;
8077 int hpos_before_this_char
= it
->hpos
;
8079 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8081 new_x
= x
+ single_glyph_width
;
8083 /* We want to leave anything reaching TO_X to the caller. */
8084 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8086 if (BUFFER_POS_REACHED_P ())
8088 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8089 goto buffer_pos_reached
;
8090 if (atpos_it
.sp
< 0)
8092 SAVE_IT (atpos_it
, *it
, atpos_data
);
8093 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8098 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8101 result
= MOVE_X_REACHED
;
8106 SAVE_IT (atx_it
, *it
, atx_data
);
8107 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8112 if (/* Lines are continued. */
8113 it
->line_wrap
!= TRUNCATE
8114 && (/* And glyph doesn't fit on the line. */
8115 new_x
> it
->last_visible_x
8116 /* Or it fits exactly and we're on a window
8118 || (new_x
== it
->last_visible_x
8119 && FRAME_WINDOW_P (it
->f
))))
8121 if (/* IT->hpos == 0 means the very first glyph
8122 doesn't fit on the line, e.g. a wide image. */
8124 || (new_x
== it
->last_visible_x
8125 && FRAME_WINDOW_P (it
->f
)))
8128 it
->current_x
= new_x
;
8130 /* The character's last glyph just barely fits
8132 if (i
== it
->nglyphs
- 1)
8134 /* If this is the destination position,
8135 return a position *before* it in this row,
8136 now that we know it fits in this row. */
8137 if (BUFFER_POS_REACHED_P ())
8139 if (it
->line_wrap
!= WORD_WRAP
8142 it
->hpos
= hpos_before_this_char
;
8143 it
->current_x
= x_before_this_char
;
8144 result
= MOVE_POS_MATCH_OR_ZV
;
8147 if (it
->line_wrap
== WORD_WRAP
8150 SAVE_IT (atpos_it
, *it
, atpos_data
);
8151 atpos_it
.current_x
= x_before_this_char
;
8152 atpos_it
.hpos
= hpos_before_this_char
;
8156 prev_method
= it
->method
;
8157 if (it
->method
== GET_FROM_BUFFER
)
8158 prev_pos
= IT_CHARPOS (*it
);
8159 set_iterator_to_next (it
, 1);
8160 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8161 SET_TEXT_POS (this_line_min_pos
,
8162 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8163 /* On graphical terminals, newlines may
8164 "overflow" into the fringe if
8165 overflow-newline-into-fringe is non-nil.
8166 On text-only terminals, newlines may
8167 overflow into the last glyph on the
8169 if (!FRAME_WINDOW_P (it
->f
)
8170 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8172 if (!get_next_display_element (it
))
8174 result
= MOVE_POS_MATCH_OR_ZV
;
8177 if (BUFFER_POS_REACHED_P ())
8179 if (ITERATOR_AT_END_OF_LINE_P (it
))
8180 result
= MOVE_POS_MATCH_OR_ZV
;
8182 result
= MOVE_LINE_CONTINUED
;
8185 if (ITERATOR_AT_END_OF_LINE_P (it
))
8187 result
= MOVE_NEWLINE_OR_CR
;
8194 IT_RESET_X_ASCENT_DESCENT (it
);
8196 if (wrap_it
.sp
>= 0)
8198 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8203 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8205 result
= MOVE_LINE_CONTINUED
;
8209 if (BUFFER_POS_REACHED_P ())
8211 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8212 goto buffer_pos_reached
;
8213 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8215 SAVE_IT (atpos_it
, *it
, atpos_data
);
8216 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8220 if (new_x
> it
->first_visible_x
)
8222 /* Glyph is visible. Increment number of glyphs that
8223 would be displayed. */
8228 if (result
!= MOVE_UNDEFINED
)
8231 else if (BUFFER_POS_REACHED_P ())
8234 IT_RESET_X_ASCENT_DESCENT (it
);
8235 result
= MOVE_POS_MATCH_OR_ZV
;
8238 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8240 /* Stop when TO_X specified and reached. This check is
8241 necessary here because of lines consisting of a line end,
8242 only. The line end will not produce any glyphs and we
8243 would never get MOVE_X_REACHED. */
8244 xassert (it
->nglyphs
== 0);
8245 result
= MOVE_X_REACHED
;
8249 /* Is this a line end? If yes, we're done. */
8250 if (ITERATOR_AT_END_OF_LINE_P (it
))
8252 /* If we are past TO_CHARPOS, but never saw any character
8253 positions smaller than TO_CHARPOS, return
8254 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8256 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8258 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8260 if (IT_CHARPOS (ppos_it
) < ZV
)
8262 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8263 result
= MOVE_POS_MATCH_OR_ZV
;
8266 goto buffer_pos_reached
;
8268 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8269 && IT_CHARPOS (*it
) > to_charpos
)
8270 goto buffer_pos_reached
;
8272 result
= MOVE_NEWLINE_OR_CR
;
8275 result
= MOVE_NEWLINE_OR_CR
;
8279 prev_method
= it
->method
;
8280 if (it
->method
== GET_FROM_BUFFER
)
8281 prev_pos
= IT_CHARPOS (*it
);
8282 /* The current display element has been consumed. Advance
8284 set_iterator_to_next (it
, 1);
8285 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8286 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8287 if (IT_CHARPOS (*it
) < to_charpos
)
8288 saw_smaller_pos
= 1;
8290 && (op
& MOVE_TO_POS
)
8291 && IT_CHARPOS (*it
) >= to_charpos
8292 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8293 SAVE_IT (ppos_it
, *it
, ppos_data
);
8295 /* Stop if lines are truncated and IT's current x-position is
8296 past the right edge of the window now. */
8297 if (it
->line_wrap
== TRUNCATE
8298 && it
->current_x
>= it
->last_visible_x
)
8300 if (!FRAME_WINDOW_P (it
->f
)
8301 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8305 if ((at_eob_p
= !get_next_display_element (it
))
8306 || BUFFER_POS_REACHED_P ()
8307 /* If we are past TO_CHARPOS, but never saw any
8308 character positions smaller than TO_CHARPOS,
8309 return MOVE_POS_MATCH_OR_ZV, like the
8310 unidirectional display did. */
8311 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8313 && IT_CHARPOS (*it
) > to_charpos
))
8316 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8317 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8318 result
= MOVE_POS_MATCH_OR_ZV
;
8321 if (ITERATOR_AT_END_OF_LINE_P (it
))
8323 result
= MOVE_NEWLINE_OR_CR
;
8327 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8329 && IT_CHARPOS (*it
) > to_charpos
)
8331 if (IT_CHARPOS (ppos_it
) < ZV
)
8332 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8333 result
= MOVE_POS_MATCH_OR_ZV
;
8336 result
= MOVE_LINE_TRUNCATED
;
8339 #undef IT_RESET_X_ASCENT_DESCENT
8342 #undef BUFFER_POS_REACHED_P
8344 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8345 restore the saved iterator. */
8346 if (atpos_it
.sp
>= 0)
8347 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8348 else if (atx_it
.sp
>= 0)
8349 RESTORE_IT (it
, &atx_it
, atx_data
);
8354 bidi_unshelve_cache (atpos_data
, 1);
8356 bidi_unshelve_cache (atx_data
, 1);
8358 bidi_unshelve_cache (wrap_data
, 1);
8360 bidi_unshelve_cache (ppos_data
, 1);
8362 /* Restore the iterator settings altered at the beginning of this
8364 it
->glyph_row
= saved_glyph_row
;
8368 /* For external use. */
8370 move_it_in_display_line (struct it
*it
,
8371 EMACS_INT to_charpos
, int to_x
,
8372 enum move_operation_enum op
)
8374 if (it
->line_wrap
== WORD_WRAP
8375 && (op
& MOVE_TO_X
))
8378 void *save_data
= NULL
;
8381 SAVE_IT (save_it
, *it
, save_data
);
8382 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8383 /* When word-wrap is on, TO_X may lie past the end
8384 of a wrapped line. Then it->current is the
8385 character on the next line, so backtrack to the
8386 space before the wrap point. */
8387 if (skip
== MOVE_LINE_CONTINUED
)
8389 int prev_x
= max (it
->current_x
- 1, 0);
8390 RESTORE_IT (it
, &save_it
, save_data
);
8391 move_it_in_display_line_to
8392 (it
, -1, prev_x
, MOVE_TO_X
);
8395 bidi_unshelve_cache (save_data
, 1);
8398 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8402 /* Move IT forward until it satisfies one or more of the criteria in
8403 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8405 OP is a bit-mask that specifies where to stop, and in particular,
8406 which of those four position arguments makes a difference. See the
8407 description of enum move_operation_enum.
8409 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8410 screen line, this function will set IT to the next position that is
8411 displayed to the right of TO_CHARPOS on the screen. */
8414 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8416 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8417 int line_height
, line_start_x
= 0, reached
= 0;
8418 void *backup_data
= NULL
;
8422 if (op
& MOVE_TO_VPOS
)
8424 /* If no TO_CHARPOS and no TO_X specified, stop at the
8425 start of the line TO_VPOS. */
8426 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8428 if (it
->vpos
== to_vpos
)
8434 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8438 /* TO_VPOS >= 0 means stop at TO_X in the line at
8439 TO_VPOS, or at TO_POS, whichever comes first. */
8440 if (it
->vpos
== to_vpos
)
8446 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8448 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8453 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8455 /* We have reached TO_X but not in the line we want. */
8456 skip
= move_it_in_display_line_to (it
, to_charpos
,
8458 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8466 else if (op
& MOVE_TO_Y
)
8468 struct it it_backup
;
8470 if (it
->line_wrap
== WORD_WRAP
)
8471 SAVE_IT (it_backup
, *it
, backup_data
);
8473 /* TO_Y specified means stop at TO_X in the line containing
8474 TO_Y---or at TO_CHARPOS if this is reached first. The
8475 problem is that we can't really tell whether the line
8476 contains TO_Y before we have completely scanned it, and
8477 this may skip past TO_X. What we do is to first scan to
8480 If TO_X is not specified, use a TO_X of zero. The reason
8481 is to make the outcome of this function more predictable.
8482 If we didn't use TO_X == 0, we would stop at the end of
8483 the line which is probably not what a caller would expect
8485 skip
= move_it_in_display_line_to
8486 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8487 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8489 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8490 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8492 else if (skip
== MOVE_X_REACHED
)
8494 /* If TO_X was reached, we want to know whether TO_Y is
8495 in the line. We know this is the case if the already
8496 scanned glyphs make the line tall enough. Otherwise,
8497 we must check by scanning the rest of the line. */
8498 line_height
= it
->max_ascent
+ it
->max_descent
;
8499 if (to_y
>= it
->current_y
8500 && to_y
< it
->current_y
+ line_height
)
8505 SAVE_IT (it_backup
, *it
, backup_data
);
8506 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8507 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8509 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8510 line_height
= it
->max_ascent
+ it
->max_descent
;
8511 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8513 if (to_y
>= it
->current_y
8514 && to_y
< it
->current_y
+ line_height
)
8516 /* If TO_Y is in this line and TO_X was reached
8517 above, we scanned too far. We have to restore
8518 IT's settings to the ones before skipping. */
8519 RESTORE_IT (it
, &it_backup
, backup_data
);
8525 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8531 /* Check whether TO_Y is in this line. */
8532 line_height
= it
->max_ascent
+ it
->max_descent
;
8533 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8535 if (to_y
>= it
->current_y
8536 && to_y
< it
->current_y
+ line_height
)
8538 /* When word-wrap is on, TO_X may lie past the end
8539 of a wrapped line. Then it->current is the
8540 character on the next line, so backtrack to the
8541 space before the wrap point. */
8542 if (skip
== MOVE_LINE_CONTINUED
8543 && it
->line_wrap
== WORD_WRAP
)
8545 int prev_x
= max (it
->current_x
- 1, 0);
8546 RESTORE_IT (it
, &it_backup
, backup_data
);
8547 skip
= move_it_in_display_line_to
8548 (it
, -1, prev_x
, MOVE_TO_X
);
8557 else if (BUFFERP (it
->object
)
8558 && (it
->method
== GET_FROM_BUFFER
8559 || it
->method
== GET_FROM_STRETCH
)
8560 && IT_CHARPOS (*it
) >= to_charpos
8561 /* Under bidi iteration, a call to set_iterator_to_next
8562 can scan far beyond to_charpos if the initial
8563 portion of the next line needs to be reordered. In
8564 that case, give move_it_in_display_line_to another
8567 && it
->bidi_it
.scan_dir
== -1))
8568 skip
= MOVE_POS_MATCH_OR_ZV
;
8570 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8574 case MOVE_POS_MATCH_OR_ZV
:
8578 case MOVE_NEWLINE_OR_CR
:
8579 set_iterator_to_next (it
, 1);
8580 it
->continuation_lines_width
= 0;
8583 case MOVE_LINE_TRUNCATED
:
8584 it
->continuation_lines_width
= 0;
8585 reseat_at_next_visible_line_start (it
, 0);
8586 if ((op
& MOVE_TO_POS
) != 0
8587 && IT_CHARPOS (*it
) > to_charpos
)
8594 case MOVE_LINE_CONTINUED
:
8595 /* For continued lines ending in a tab, some of the glyphs
8596 associated with the tab are displayed on the current
8597 line. Since it->current_x does not include these glyphs,
8598 we use it->last_visible_x instead. */
8601 it
->continuation_lines_width
+= it
->last_visible_x
;
8602 /* When moving by vpos, ensure that the iterator really
8603 advances to the next line (bug#847, bug#969). Fixme:
8604 do we need to do this in other circumstances? */
8605 if (it
->current_x
!= it
->last_visible_x
8606 && (op
& MOVE_TO_VPOS
)
8607 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8609 line_start_x
= it
->current_x
+ it
->pixel_width
8610 - it
->last_visible_x
;
8611 set_iterator_to_next (it
, 0);
8615 it
->continuation_lines_width
+= it
->current_x
;
8622 /* Reset/increment for the next run. */
8623 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8624 it
->current_x
= line_start_x
;
8627 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8629 last_height
= it
->max_ascent
+ it
->max_descent
;
8630 last_max_ascent
= it
->max_ascent
;
8631 it
->max_ascent
= it
->max_descent
= 0;
8636 /* On text terminals, we may stop at the end of a line in the middle
8637 of a multi-character glyph. If the glyph itself is continued,
8638 i.e. it is actually displayed on the next line, don't treat this
8639 stopping point as valid; move to the next line instead (unless
8640 that brings us offscreen). */
8641 if (!FRAME_WINDOW_P (it
->f
)
8643 && IT_CHARPOS (*it
) == to_charpos
8644 && it
->what
== IT_CHARACTER
8646 && it
->line_wrap
== WINDOW_WRAP
8647 && it
->current_x
== it
->last_visible_x
- 1
8650 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8652 it
->continuation_lines_width
+= it
->current_x
;
8653 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8654 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8656 last_height
= it
->max_ascent
+ it
->max_descent
;
8657 last_max_ascent
= it
->max_ascent
;
8661 bidi_unshelve_cache (backup_data
, 1);
8663 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8667 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8669 If DY > 0, move IT backward at least that many pixels. DY = 0
8670 means move IT backward to the preceding line start or BEGV. This
8671 function may move over more than DY pixels if IT->current_y - DY
8672 ends up in the middle of a line; in this case IT->current_y will be
8673 set to the top of the line moved to. */
8676 move_it_vertically_backward (struct it
*it
, int dy
)
8680 void *it2data
= NULL
, *it3data
= NULL
;
8681 EMACS_INT start_pos
;
8686 start_pos
= IT_CHARPOS (*it
);
8688 /* Estimate how many newlines we must move back. */
8689 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8691 /* Set the iterator's position that many lines back. */
8692 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8693 back_to_previous_visible_line_start (it
);
8695 /* Reseat the iterator here. When moving backward, we don't want
8696 reseat to skip forward over invisible text, set up the iterator
8697 to deliver from overlay strings at the new position etc. So,
8698 use reseat_1 here. */
8699 reseat_1 (it
, it
->current
.pos
, 1);
8701 /* We are now surely at a line start. */
8702 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8703 reordering is in effect. */
8704 it
->continuation_lines_width
= 0;
8706 /* Move forward and see what y-distance we moved. First move to the
8707 start of the next line so that we get its height. We need this
8708 height to be able to tell whether we reached the specified
8710 SAVE_IT (it2
, *it
, it2data
);
8711 it2
.max_ascent
= it2
.max_descent
= 0;
8714 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8715 MOVE_TO_POS
| MOVE_TO_VPOS
);
8717 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8718 /* If we are in a display string which starts at START_POS,
8719 and that display string includes a newline, and we are
8720 right after that newline (i.e. at the beginning of a
8721 display line), exit the loop, because otherwise we will
8722 infloop, since move_it_to will see that it is already at
8723 START_POS and will not move. */
8724 || (it2
.method
== GET_FROM_STRING
8725 && IT_CHARPOS (it2
) == start_pos
8726 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8727 xassert (IT_CHARPOS (*it
) >= BEGV
);
8728 SAVE_IT (it3
, it2
, it3data
);
8730 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8731 xassert (IT_CHARPOS (*it
) >= BEGV
);
8732 /* H is the actual vertical distance from the position in *IT
8733 and the starting position. */
8734 h
= it2
.current_y
- it
->current_y
;
8735 /* NLINES is the distance in number of lines. */
8736 nlines
= it2
.vpos
- it
->vpos
;
8738 /* Correct IT's y and vpos position
8739 so that they are relative to the starting point. */
8745 /* DY == 0 means move to the start of the screen line. The
8746 value of nlines is > 0 if continuation lines were involved,
8747 or if the original IT position was at start of a line. */
8748 RESTORE_IT (it
, it
, it2data
);
8750 move_it_by_lines (it
, nlines
);
8751 /* The above code moves us to some position NLINES down,
8752 usually to its first glyph (leftmost in an L2R line), but
8753 that's not necessarily the start of the line, under bidi
8754 reordering. We want to get to the character position
8755 that is immediately after the newline of the previous
8757 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8758 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8761 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8763 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8765 bidi_unshelve_cache (it3data
, 1);
8769 /* The y-position we try to reach, relative to *IT.
8770 Note that H has been subtracted in front of the if-statement. */
8771 int target_y
= it
->current_y
+ h
- dy
;
8772 int y0
= it3
.current_y
;
8776 RESTORE_IT (&it3
, &it3
, it3data
);
8777 y1
= line_bottom_y (&it3
);
8778 line_height
= y1
- y0
;
8779 RESTORE_IT (it
, it
, it2data
);
8780 /* If we did not reach target_y, try to move further backward if
8781 we can. If we moved too far backward, try to move forward. */
8782 if (target_y
< it
->current_y
8783 /* This is heuristic. In a window that's 3 lines high, with
8784 a line height of 13 pixels each, recentering with point
8785 on the bottom line will try to move -39/2 = 19 pixels
8786 backward. Try to avoid moving into the first line. */
8787 && (it
->current_y
- target_y
8788 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8789 && IT_CHARPOS (*it
) > BEGV
)
8791 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8792 target_y
- it
->current_y
));
8793 dy
= it
->current_y
- target_y
;
8794 goto move_further_back
;
8796 else if (target_y
>= it
->current_y
+ line_height
8797 && IT_CHARPOS (*it
) < ZV
)
8799 /* Should move forward by at least one line, maybe more.
8801 Note: Calling move_it_by_lines can be expensive on
8802 terminal frames, where compute_motion is used (via
8803 vmotion) to do the job, when there are very long lines
8804 and truncate-lines is nil. That's the reason for
8805 treating terminal frames specially here. */
8807 if (!FRAME_WINDOW_P (it
->f
))
8808 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8813 move_it_by_lines (it
, 1);
8815 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8822 /* Move IT by a specified amount of pixel lines DY. DY negative means
8823 move backwards. DY = 0 means move to start of screen line. At the
8824 end, IT will be on the start of a screen line. */
8827 move_it_vertically (struct it
*it
, int dy
)
8830 move_it_vertically_backward (it
, -dy
);
8833 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8834 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8835 MOVE_TO_POS
| MOVE_TO_Y
);
8836 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8838 /* If buffer ends in ZV without a newline, move to the start of
8839 the line to satisfy the post-condition. */
8840 if (IT_CHARPOS (*it
) == ZV
8842 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8843 move_it_by_lines (it
, 0);
8848 /* Move iterator IT past the end of the text line it is in. */
8851 move_it_past_eol (struct it
*it
)
8853 enum move_it_result rc
;
8855 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8856 if (rc
== MOVE_NEWLINE_OR_CR
)
8857 set_iterator_to_next (it
, 0);
8861 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8862 negative means move up. DVPOS == 0 means move to the start of the
8865 Optimization idea: If we would know that IT->f doesn't use
8866 a face with proportional font, we could be faster for
8867 truncate-lines nil. */
8870 move_it_by_lines (struct it
*it
, int dvpos
)
8873 /* The commented-out optimization uses vmotion on terminals. This
8874 gives bad results, because elements like it->what, on which
8875 callers such as pos_visible_p rely, aren't updated. */
8876 /* struct position pos;
8877 if (!FRAME_WINDOW_P (it->f))
8879 struct text_pos textpos;
8881 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8882 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8883 reseat (it, textpos, 1);
8884 it->vpos += pos.vpos;
8885 it->current_y += pos.vpos;
8891 /* DVPOS == 0 means move to the start of the screen line. */
8892 move_it_vertically_backward (it
, 0);
8893 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8894 /* Let next call to line_bottom_y calculate real line height */
8899 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8900 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8901 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8906 void *it2data
= NULL
;
8907 EMACS_INT start_charpos
, i
;
8909 /* Start at the beginning of the screen line containing IT's
8910 position. This may actually move vertically backwards,
8911 in case of overlays, so adjust dvpos accordingly. */
8913 move_it_vertically_backward (it
, 0);
8916 /* Go back -DVPOS visible lines and reseat the iterator there. */
8917 start_charpos
= IT_CHARPOS (*it
);
8918 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8919 back_to_previous_visible_line_start (it
);
8920 reseat (it
, it
->current
.pos
, 1);
8922 /* Move further back if we end up in a string or an image. */
8923 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8925 /* First try to move to start of display line. */
8927 move_it_vertically_backward (it
, 0);
8929 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8931 /* If start of line is still in string or image,
8932 move further back. */
8933 back_to_previous_visible_line_start (it
);
8934 reseat (it
, it
->current
.pos
, 1);
8938 it
->current_x
= it
->hpos
= 0;
8940 /* Above call may have moved too far if continuation lines
8941 are involved. Scan forward and see if it did. */
8942 SAVE_IT (it2
, *it
, it2data
);
8943 it2
.vpos
= it2
.current_y
= 0;
8944 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8945 it
->vpos
-= it2
.vpos
;
8946 it
->current_y
-= it2
.current_y
;
8947 it
->current_x
= it
->hpos
= 0;
8949 /* If we moved too far back, move IT some lines forward. */
8950 if (it2
.vpos
> -dvpos
)
8952 int delta
= it2
.vpos
+ dvpos
;
8954 RESTORE_IT (&it2
, &it2
, it2data
);
8955 SAVE_IT (it2
, *it
, it2data
);
8956 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8957 /* Move back again if we got too far ahead. */
8958 if (IT_CHARPOS (*it
) >= start_charpos
)
8959 RESTORE_IT (it
, &it2
, it2data
);
8961 bidi_unshelve_cache (it2data
, 1);
8964 RESTORE_IT (it
, it
, it2data
);
8968 /* Return 1 if IT points into the middle of a display vector. */
8971 in_display_vector_p (struct it
*it
)
8973 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8974 && it
->current
.dpvec_index
> 0
8975 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8979 /***********************************************************************
8981 ***********************************************************************/
8984 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8988 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8990 Lisp_Object args
[3];
8991 Lisp_Object msg
, fmt
;
8994 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8997 /* Do nothing if called asynchronously. Inserting text into
8998 a buffer may call after-change-functions and alike and
8999 that would means running Lisp asynchronously. */
9000 if (handling_signal
)
9004 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9006 args
[0] = fmt
= build_string (format
);
9009 msg
= Fformat (3, args
);
9011 len
= SBYTES (msg
) + 1;
9012 SAFE_ALLOCA (buffer
, char *, len
);
9013 memcpy (buffer
, SDATA (msg
), len
);
9015 message_dolog (buffer
, len
- 1, 1, 0);
9022 /* Output a newline in the *Messages* buffer if "needs" one. */
9025 message_log_maybe_newline (void)
9027 if (message_log_need_newline
)
9028 message_dolog ("", 0, 1, 0);
9032 /* Add a string M of length NBYTES to the message log, optionally
9033 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9034 nonzero, means interpret the contents of M as multibyte. This
9035 function calls low-level routines in order to bypass text property
9036 hooks, etc. which might not be safe to run.
9038 This may GC (insert may run before/after change hooks),
9039 so the buffer M must NOT point to a Lisp string. */
9042 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9044 const unsigned char *msg
= (const unsigned char *) m
;
9046 if (!NILP (Vmemory_full
))
9049 if (!NILP (Vmessage_log_max
))
9051 struct buffer
*oldbuf
;
9052 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9053 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9054 EMACS_INT point_at_end
= 0;
9055 EMACS_INT zv_at_end
= 0;
9056 Lisp_Object old_deactivate_mark
, tem
;
9057 struct gcpro gcpro1
;
9059 old_deactivate_mark
= Vdeactivate_mark
;
9060 oldbuf
= current_buffer
;
9061 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9062 BVAR (current_buffer
, undo_list
) = Qt
;
9064 oldpoint
= message_dolog_marker1
;
9065 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9066 oldbegv
= message_dolog_marker2
;
9067 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9068 oldzv
= message_dolog_marker3
;
9069 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9070 GCPRO1 (old_deactivate_mark
);
9078 BEGV_BYTE
= BEG_BYTE
;
9081 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9083 /* Insert the string--maybe converting multibyte to single byte
9084 or vice versa, so that all the text fits the buffer. */
9086 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9092 /* Convert a multibyte string to single-byte
9093 for the *Message* buffer. */
9094 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9096 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9097 work
[0] = (ASCII_CHAR_P (c
)
9099 : multibyte_char_to_unibyte (c
));
9100 insert_1_both (work
, 1, 1, 1, 0, 0);
9103 else if (! multibyte
9104 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9108 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9109 /* Convert a single-byte string to multibyte
9110 for the *Message* buffer. */
9111 for (i
= 0; i
< nbytes
; i
++)
9114 MAKE_CHAR_MULTIBYTE (c
);
9115 char_bytes
= CHAR_STRING (c
, str
);
9116 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9120 insert_1 (m
, nbytes
, 1, 0, 0);
9124 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9126 insert_1 ("\n", 1, 1, 0, 0);
9128 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9130 this_bol_byte
= PT_BYTE
;
9132 /* See if this line duplicates the previous one.
9133 If so, combine duplicates. */
9136 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9138 prev_bol_byte
= PT_BYTE
;
9140 dups
= message_log_check_duplicate (prev_bol_byte
,
9144 del_range_both (prev_bol
, prev_bol_byte
,
9145 this_bol
, this_bol_byte
, 0);
9148 char dupstr
[sizeof " [ times]"
9149 + INT_STRLEN_BOUND (printmax_t
)];
9152 /* If you change this format, don't forget to also
9153 change message_log_check_duplicate. */
9154 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9155 duplen
= strlen (dupstr
);
9156 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9157 insert_1 (dupstr
, duplen
, 1, 0, 1);
9162 /* If we have more than the desired maximum number of lines
9163 in the *Messages* buffer now, delete the oldest ones.
9164 This is safe because we don't have undo in this buffer. */
9166 if (NATNUMP (Vmessage_log_max
))
9168 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9169 -XFASTINT (Vmessage_log_max
) - 1, 0);
9170 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9173 BEGV
= XMARKER (oldbegv
)->charpos
;
9174 BEGV_BYTE
= marker_byte_position (oldbegv
);
9183 ZV
= XMARKER (oldzv
)->charpos
;
9184 ZV_BYTE
= marker_byte_position (oldzv
);
9188 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9190 /* We can't do Fgoto_char (oldpoint) because it will run some
9192 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9193 XMARKER (oldpoint
)->bytepos
);
9196 unchain_marker (XMARKER (oldpoint
));
9197 unchain_marker (XMARKER (oldbegv
));
9198 unchain_marker (XMARKER (oldzv
));
9200 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9201 set_buffer_internal (oldbuf
);
9203 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9204 message_log_need_newline
= !nlflag
;
9205 Vdeactivate_mark
= old_deactivate_mark
;
9210 /* We are at the end of the buffer after just having inserted a newline.
9211 (Note: We depend on the fact we won't be crossing the gap.)
9212 Check to see if the most recent message looks a lot like the previous one.
9213 Return 0 if different, 1 if the new one should just replace it, or a
9214 value N > 1 if we should also append " [N times]". */
9217 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9220 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9222 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9223 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9225 for (i
= 0; i
< len
; i
++)
9227 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9235 if (*p1
++ == ' ' && *p1
++ == '[')
9238 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9239 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9246 /* Display an echo area message M with a specified length of NBYTES
9247 bytes. The string may include null characters. If M is 0, clear
9248 out any existing message, and let the mini-buffer text show
9251 This may GC, so the buffer M must NOT point to a Lisp string. */
9254 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9256 /* First flush out any partial line written with print. */
9257 message_log_maybe_newline ();
9259 message_dolog (m
, nbytes
, 1, multibyte
);
9260 message2_nolog (m
, nbytes
, multibyte
);
9264 /* The non-logging counterpart of message2. */
9267 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9269 struct frame
*sf
= SELECTED_FRAME ();
9270 message_enable_multibyte
= multibyte
;
9272 if (FRAME_INITIAL_P (sf
))
9274 if (noninteractive_need_newline
)
9275 putc ('\n', stderr
);
9276 noninteractive_need_newline
= 0;
9278 fwrite (m
, nbytes
, 1, stderr
);
9279 if (cursor_in_echo_area
== 0)
9280 fprintf (stderr
, "\n");
9283 /* A null message buffer means that the frame hasn't really been
9284 initialized yet. Error messages get reported properly by
9285 cmd_error, so this must be just an informative message; toss it. */
9286 else if (INTERACTIVE
9287 && sf
->glyphs_initialized_p
9288 && FRAME_MESSAGE_BUF (sf
))
9290 Lisp_Object mini_window
;
9293 /* Get the frame containing the mini-buffer
9294 that the selected frame is using. */
9295 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9296 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9298 FRAME_SAMPLE_VISIBILITY (f
);
9299 if (FRAME_VISIBLE_P (sf
)
9300 && ! FRAME_VISIBLE_P (f
))
9301 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9305 set_message (m
, Qnil
, nbytes
, multibyte
);
9306 if (minibuffer_auto_raise
)
9307 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9310 clear_message (1, 1);
9312 do_pending_window_change (0);
9313 echo_area_display (1);
9314 do_pending_window_change (0);
9315 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9316 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9321 /* Display an echo area message M with a specified length of NBYTES
9322 bytes. The string may include null characters. If M is not a
9323 string, clear out any existing message, and let the mini-buffer
9326 This function cancels echoing. */
9329 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9331 struct gcpro gcpro1
;
9334 clear_message (1,1);
9337 /* First flush out any partial line written with print. */
9338 message_log_maybe_newline ();
9344 SAFE_ALLOCA (buffer
, char *, nbytes
);
9345 memcpy (buffer
, SDATA (m
), nbytes
);
9346 message_dolog (buffer
, nbytes
, 1, multibyte
);
9349 message3_nolog (m
, nbytes
, multibyte
);
9355 /* The non-logging version of message3.
9356 This does not cancel echoing, because it is used for echoing.
9357 Perhaps we need to make a separate function for echoing
9358 and make this cancel echoing. */
9361 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9363 struct frame
*sf
= SELECTED_FRAME ();
9364 message_enable_multibyte
= multibyte
;
9366 if (FRAME_INITIAL_P (sf
))
9368 if (noninteractive_need_newline
)
9369 putc ('\n', stderr
);
9370 noninteractive_need_newline
= 0;
9372 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9373 if (cursor_in_echo_area
== 0)
9374 fprintf (stderr
, "\n");
9377 /* A null message buffer means that the frame hasn't really been
9378 initialized yet. Error messages get reported properly by
9379 cmd_error, so this must be just an informative message; toss it. */
9380 else if (INTERACTIVE
9381 && sf
->glyphs_initialized_p
9382 && FRAME_MESSAGE_BUF (sf
))
9384 Lisp_Object mini_window
;
9388 /* Get the frame containing the mini-buffer
9389 that the selected frame is using. */
9390 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9391 frame
= XWINDOW (mini_window
)->frame
;
9394 FRAME_SAMPLE_VISIBILITY (f
);
9395 if (FRAME_VISIBLE_P (sf
)
9396 && !FRAME_VISIBLE_P (f
))
9397 Fmake_frame_visible (frame
);
9399 if (STRINGP (m
) && SCHARS (m
) > 0)
9401 set_message (NULL
, m
, nbytes
, multibyte
);
9402 if (minibuffer_auto_raise
)
9403 Fraise_frame (frame
);
9404 /* Assume we are not echoing.
9405 (If we are, echo_now will override this.) */
9406 echo_message_buffer
= Qnil
;
9409 clear_message (1, 1);
9411 do_pending_window_change (0);
9412 echo_area_display (1);
9413 do_pending_window_change (0);
9414 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9415 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9420 /* Display a null-terminated echo area message M. If M is 0, clear
9421 out any existing message, and let the mini-buffer text show through.
9423 The buffer M must continue to exist until after the echo area gets
9424 cleared or some other message gets displayed there. Do not pass
9425 text that is stored in a Lisp string. Do not pass text in a buffer
9426 that was alloca'd. */
9429 message1 (const char *m
)
9431 message2 (m
, (m
? strlen (m
) : 0), 0);
9435 /* The non-logging counterpart of message1. */
9438 message1_nolog (const char *m
)
9440 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9443 /* Display a message M which contains a single %s
9444 which gets replaced with STRING. */
9447 message_with_string (const char *m
, Lisp_Object string
, int log
)
9449 CHECK_STRING (string
);
9455 if (noninteractive_need_newline
)
9456 putc ('\n', stderr
);
9457 noninteractive_need_newline
= 0;
9458 fprintf (stderr
, m
, SDATA (string
));
9459 if (!cursor_in_echo_area
)
9460 fprintf (stderr
, "\n");
9464 else if (INTERACTIVE
)
9466 /* The frame whose minibuffer we're going to display the message on.
9467 It may be larger than the selected frame, so we need
9468 to use its buffer, not the selected frame's buffer. */
9469 Lisp_Object mini_window
;
9470 struct frame
*f
, *sf
= SELECTED_FRAME ();
9472 /* Get the frame containing the minibuffer
9473 that the selected frame is using. */
9474 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9475 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9477 /* A null message buffer means that the frame hasn't really been
9478 initialized yet. Error messages get reported properly by
9479 cmd_error, so this must be just an informative message; toss it. */
9480 if (FRAME_MESSAGE_BUF (f
))
9482 Lisp_Object args
[2], msg
;
9483 struct gcpro gcpro1
, gcpro2
;
9485 args
[0] = build_string (m
);
9486 args
[1] = msg
= string
;
9487 GCPRO2 (args
[0], msg
);
9490 msg
= Fformat (2, args
);
9493 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9495 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9499 /* Print should start at the beginning of the message
9500 buffer next time. */
9501 message_buf_print
= 0;
9507 /* Dump an informative message to the minibuf. If M is 0, clear out
9508 any existing message, and let the mini-buffer text show through. */
9511 vmessage (const char *m
, va_list ap
)
9517 if (noninteractive_need_newline
)
9518 putc ('\n', stderr
);
9519 noninteractive_need_newline
= 0;
9520 vfprintf (stderr
, m
, ap
);
9521 if (cursor_in_echo_area
== 0)
9522 fprintf (stderr
, "\n");
9526 else if (INTERACTIVE
)
9528 /* The frame whose mini-buffer we're going to display the message
9529 on. It may be larger than the selected frame, so we need to
9530 use its buffer, not the selected frame's buffer. */
9531 Lisp_Object mini_window
;
9532 struct frame
*f
, *sf
= SELECTED_FRAME ();
9534 /* Get the frame containing the mini-buffer
9535 that the selected frame is using. */
9536 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9537 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9539 /* A null message buffer means that the frame hasn't really been
9540 initialized yet. Error messages get reported properly by
9541 cmd_error, so this must be just an informative message; toss
9543 if (FRAME_MESSAGE_BUF (f
))
9549 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9550 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9552 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9557 /* Print should start at the beginning of the message
9558 buffer next time. */
9559 message_buf_print
= 0;
9565 message (const char *m
, ...)
9575 /* The non-logging version of message. */
9578 message_nolog (const char *m
, ...)
9580 Lisp_Object old_log_max
;
9583 old_log_max
= Vmessage_log_max
;
9584 Vmessage_log_max
= Qnil
;
9586 Vmessage_log_max
= old_log_max
;
9592 /* Display the current message in the current mini-buffer. This is
9593 only called from error handlers in process.c, and is not time
9597 update_echo_area (void)
9599 if (!NILP (echo_area_buffer
[0]))
9602 string
= Fcurrent_message ();
9603 message3 (string
, SBYTES (string
),
9604 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9609 /* Make sure echo area buffers in `echo_buffers' are live.
9610 If they aren't, make new ones. */
9613 ensure_echo_area_buffers (void)
9617 for (i
= 0; i
< 2; ++i
)
9618 if (!BUFFERP (echo_buffer
[i
])
9619 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9622 Lisp_Object old_buffer
;
9625 old_buffer
= echo_buffer
[i
];
9626 sprintf (name
, " *Echo Area %d*", i
);
9627 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9628 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9629 /* to force word wrap in echo area -
9630 it was decided to postpone this*/
9631 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9633 for (j
= 0; j
< 2; ++j
)
9634 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9635 echo_area_buffer
[j
] = echo_buffer
[i
];
9640 /* Call FN with args A1..A4 with either the current or last displayed
9641 echo_area_buffer as current buffer.
9643 WHICH zero means use the current message buffer
9644 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9645 from echo_buffer[] and clear it.
9647 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9648 suitable buffer from echo_buffer[] and clear it.
9650 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9651 that the current message becomes the last displayed one, make
9652 choose a suitable buffer for echo_area_buffer[0], and clear it.
9654 Value is what FN returns. */
9657 with_echo_area_buffer (struct window
*w
, int which
,
9658 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9659 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9662 int this_one
, the_other
, clear_buffer_p
, rc
;
9663 int count
= SPECPDL_INDEX ();
9665 /* If buffers aren't live, make new ones. */
9666 ensure_echo_area_buffers ();
9671 this_one
= 0, the_other
= 1;
9673 this_one
= 1, the_other
= 0;
9676 this_one
= 0, the_other
= 1;
9679 /* We need a fresh one in case the current echo buffer equals
9680 the one containing the last displayed echo area message. */
9681 if (!NILP (echo_area_buffer
[this_one
])
9682 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9683 echo_area_buffer
[this_one
] = Qnil
;
9686 /* Choose a suitable buffer from echo_buffer[] is we don't
9688 if (NILP (echo_area_buffer
[this_one
]))
9690 echo_area_buffer
[this_one
]
9691 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9692 ? echo_buffer
[the_other
]
9693 : echo_buffer
[this_one
]);
9697 buffer
= echo_area_buffer
[this_one
];
9699 /* Don't get confused by reusing the buffer used for echoing
9700 for a different purpose. */
9701 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9704 record_unwind_protect (unwind_with_echo_area_buffer
,
9705 with_echo_area_buffer_unwind_data (w
));
9707 /* Make the echo area buffer current. Note that for display
9708 purposes, it is not necessary that the displayed window's buffer
9709 == current_buffer, except for text property lookup. So, let's
9710 only set that buffer temporarily here without doing a full
9711 Fset_window_buffer. We must also change w->pointm, though,
9712 because otherwise an assertions in unshow_buffer fails, and Emacs
9714 set_buffer_internal_1 (XBUFFER (buffer
));
9718 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9721 BVAR (current_buffer
, undo_list
) = Qt
;
9722 BVAR (current_buffer
, read_only
) = Qnil
;
9723 specbind (Qinhibit_read_only
, Qt
);
9724 specbind (Qinhibit_modification_hooks
, Qt
);
9726 if (clear_buffer_p
&& Z
> BEG
)
9729 xassert (BEGV
>= BEG
);
9730 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9732 rc
= fn (a1
, a2
, a3
, a4
);
9734 xassert (BEGV
>= BEG
);
9735 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9737 unbind_to (count
, Qnil
);
9742 /* Save state that should be preserved around the call to the function
9743 FN called in with_echo_area_buffer. */
9746 with_echo_area_buffer_unwind_data (struct window
*w
)
9749 Lisp_Object vector
, tmp
;
9751 /* Reduce consing by keeping one vector in
9752 Vwith_echo_area_save_vector. */
9753 vector
= Vwith_echo_area_save_vector
;
9754 Vwith_echo_area_save_vector
= Qnil
;
9757 vector
= Fmake_vector (make_number (7), Qnil
);
9759 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9760 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9761 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9765 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9766 ASET (vector
, i
, w
->buffer
); ++i
;
9767 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9768 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9773 for (; i
< end
; ++i
)
9774 ASET (vector
, i
, Qnil
);
9777 xassert (i
== ASIZE (vector
));
9782 /* Restore global state from VECTOR which was created by
9783 with_echo_area_buffer_unwind_data. */
9786 unwind_with_echo_area_buffer (Lisp_Object vector
)
9788 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9789 Vdeactivate_mark
= AREF (vector
, 1);
9790 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9792 if (WINDOWP (AREF (vector
, 3)))
9795 Lisp_Object buffer
, charpos
, bytepos
;
9797 w
= XWINDOW (AREF (vector
, 3));
9798 buffer
= AREF (vector
, 4);
9799 charpos
= AREF (vector
, 5);
9800 bytepos
= AREF (vector
, 6);
9803 set_marker_both (w
->pointm
, buffer
,
9804 XFASTINT (charpos
), XFASTINT (bytepos
));
9807 Vwith_echo_area_save_vector
= vector
;
9812 /* Set up the echo area for use by print functions. MULTIBYTE_P
9813 non-zero means we will print multibyte. */
9816 setup_echo_area_for_printing (int multibyte_p
)
9818 /* If we can't find an echo area any more, exit. */
9819 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9822 ensure_echo_area_buffers ();
9824 if (!message_buf_print
)
9826 /* A message has been output since the last time we printed.
9827 Choose a fresh echo area buffer. */
9828 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9829 echo_area_buffer
[0] = echo_buffer
[1];
9831 echo_area_buffer
[0] = echo_buffer
[0];
9833 /* Switch to that buffer and clear it. */
9834 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9835 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9839 int count
= SPECPDL_INDEX ();
9840 specbind (Qinhibit_read_only
, Qt
);
9841 /* Note that undo recording is always disabled. */
9843 unbind_to (count
, Qnil
);
9845 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9847 /* Set up the buffer for the multibyteness we need. */
9849 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9850 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9852 /* Raise the frame containing the echo area. */
9853 if (minibuffer_auto_raise
)
9855 struct frame
*sf
= SELECTED_FRAME ();
9856 Lisp_Object mini_window
;
9857 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9858 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9861 message_log_maybe_newline ();
9862 message_buf_print
= 1;
9866 if (NILP (echo_area_buffer
[0]))
9868 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9869 echo_area_buffer
[0] = echo_buffer
[1];
9871 echo_area_buffer
[0] = echo_buffer
[0];
9874 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9876 /* Someone switched buffers between print requests. */
9877 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9878 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9884 /* Display an echo area message in window W. Value is non-zero if W's
9885 height is changed. If display_last_displayed_message_p is
9886 non-zero, display the message that was last displayed, otherwise
9887 display the current message. */
9890 display_echo_area (struct window
*w
)
9892 int i
, no_message_p
, window_height_changed_p
, count
;
9894 /* Temporarily disable garbage collections while displaying the echo
9895 area. This is done because a GC can print a message itself.
9896 That message would modify the echo area buffer's contents while a
9897 redisplay of the buffer is going on, and seriously confuse
9899 count
= inhibit_garbage_collection ();
9901 /* If there is no message, we must call display_echo_area_1
9902 nevertheless because it resizes the window. But we will have to
9903 reset the echo_area_buffer in question to nil at the end because
9904 with_echo_area_buffer will sets it to an empty buffer. */
9905 i
= display_last_displayed_message_p
? 1 : 0;
9906 no_message_p
= NILP (echo_area_buffer
[i
]);
9908 window_height_changed_p
9909 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9910 display_echo_area_1
,
9911 (intptr_t) w
, Qnil
, 0, 0);
9914 echo_area_buffer
[i
] = Qnil
;
9916 unbind_to (count
, Qnil
);
9917 return window_height_changed_p
;
9921 /* Helper for display_echo_area. Display the current buffer which
9922 contains the current echo area message in window W, a mini-window,
9923 a pointer to which is passed in A1. A2..A4 are currently not used.
9924 Change the height of W so that all of the message is displayed.
9925 Value is non-zero if height of W was changed. */
9928 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9931 struct window
*w
= (struct window
*) i1
;
9933 struct text_pos start
;
9934 int window_height_changed_p
= 0;
9936 /* Do this before displaying, so that we have a large enough glyph
9937 matrix for the display. If we can't get enough space for the
9938 whole text, display the last N lines. That works by setting w->start. */
9939 window_height_changed_p
= resize_mini_window (w
, 0);
9941 /* Use the starting position chosen by resize_mini_window. */
9942 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9945 clear_glyph_matrix (w
->desired_matrix
);
9946 XSETWINDOW (window
, w
);
9947 try_window (window
, start
, 0);
9949 return window_height_changed_p
;
9953 /* Resize the echo area window to exactly the size needed for the
9954 currently displayed message, if there is one. If a mini-buffer
9955 is active, don't shrink it. */
9958 resize_echo_area_exactly (void)
9960 if (BUFFERP (echo_area_buffer
[0])
9961 && WINDOWP (echo_area_window
))
9963 struct window
*w
= XWINDOW (echo_area_window
);
9965 Lisp_Object resize_exactly
;
9967 if (minibuf_level
== 0)
9968 resize_exactly
= Qt
;
9970 resize_exactly
= Qnil
;
9972 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9973 (intptr_t) w
, resize_exactly
,
9977 ++windows_or_buffers_changed
;
9978 ++update_mode_lines
;
9979 redisplay_internal ();
9985 /* Callback function for with_echo_area_buffer, when used from
9986 resize_echo_area_exactly. A1 contains a pointer to the window to
9987 resize, EXACTLY non-nil means resize the mini-window exactly to the
9988 size of the text displayed. A3 and A4 are not used. Value is what
9989 resize_mini_window returns. */
9992 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9995 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9999 /* Resize mini-window W to fit the size of its contents. EXACT_P
10000 means size the window exactly to the size needed. Otherwise, it's
10001 only enlarged until W's buffer is empty.
10003 Set W->start to the right place to begin display. If the whole
10004 contents fit, start at the beginning. Otherwise, start so as
10005 to make the end of the contents appear. This is particularly
10006 important for y-or-n-p, but seems desirable generally.
10008 Value is non-zero if the window height has been changed. */
10011 resize_mini_window (struct window
*w
, int exact_p
)
10013 struct frame
*f
= XFRAME (w
->frame
);
10014 int window_height_changed_p
= 0;
10016 xassert (MINI_WINDOW_P (w
));
10018 /* By default, start display at the beginning. */
10019 set_marker_both (w
->start
, w
->buffer
,
10020 BUF_BEGV (XBUFFER (w
->buffer
)),
10021 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10023 /* Don't resize windows while redisplaying a window; it would
10024 confuse redisplay functions when the size of the window they are
10025 displaying changes from under them. Such a resizing can happen,
10026 for instance, when which-func prints a long message while
10027 we are running fontification-functions. We're running these
10028 functions with safe_call which binds inhibit-redisplay to t. */
10029 if (!NILP (Vinhibit_redisplay
))
10032 /* Nil means don't try to resize. */
10033 if (NILP (Vresize_mini_windows
)
10034 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10037 if (!FRAME_MINIBUF_ONLY_P (f
))
10040 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10041 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10042 int height
, max_height
;
10043 int unit
= FRAME_LINE_HEIGHT (f
);
10044 struct text_pos start
;
10045 struct buffer
*old_current_buffer
= NULL
;
10047 if (current_buffer
!= XBUFFER (w
->buffer
))
10049 old_current_buffer
= current_buffer
;
10050 set_buffer_internal (XBUFFER (w
->buffer
));
10053 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10055 /* Compute the max. number of lines specified by the user. */
10056 if (FLOATP (Vmax_mini_window_height
))
10057 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10058 else if (INTEGERP (Vmax_mini_window_height
))
10059 max_height
= XINT (Vmax_mini_window_height
);
10061 max_height
= total_height
/ 4;
10063 /* Correct that max. height if it's bogus. */
10064 max_height
= max (1, max_height
);
10065 max_height
= min (total_height
, max_height
);
10067 /* Find out the height of the text in the window. */
10068 if (it
.line_wrap
== TRUNCATE
)
10073 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10074 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10075 height
= it
.current_y
+ last_height
;
10077 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10078 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10079 height
= (height
+ unit
- 1) / unit
;
10082 /* Compute a suitable window start. */
10083 if (height
> max_height
)
10085 height
= max_height
;
10086 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10087 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10088 start
= it
.current
.pos
;
10091 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10092 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10094 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10096 /* Let it grow only, until we display an empty message, in which
10097 case the window shrinks again. */
10098 if (height
> WINDOW_TOTAL_LINES (w
))
10100 int old_height
= WINDOW_TOTAL_LINES (w
);
10101 freeze_window_starts (f
, 1);
10102 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10103 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10105 else if (height
< WINDOW_TOTAL_LINES (w
)
10106 && (exact_p
|| BEGV
== ZV
))
10108 int old_height
= WINDOW_TOTAL_LINES (w
);
10109 freeze_window_starts (f
, 0);
10110 shrink_mini_window (w
);
10111 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10116 /* Always resize to exact size needed. */
10117 if (height
> WINDOW_TOTAL_LINES (w
))
10119 int old_height
= WINDOW_TOTAL_LINES (w
);
10120 freeze_window_starts (f
, 1);
10121 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10122 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10124 else if (height
< WINDOW_TOTAL_LINES (w
))
10126 int old_height
= WINDOW_TOTAL_LINES (w
);
10127 freeze_window_starts (f
, 0);
10128 shrink_mini_window (w
);
10132 freeze_window_starts (f
, 1);
10133 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10136 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10140 if (old_current_buffer
)
10141 set_buffer_internal (old_current_buffer
);
10144 return window_height_changed_p
;
10148 /* Value is the current message, a string, or nil if there is no
10149 current message. */
10152 current_message (void)
10156 if (!BUFFERP (echo_area_buffer
[0]))
10160 with_echo_area_buffer (0, 0, current_message_1
,
10161 (intptr_t) &msg
, Qnil
, 0, 0);
10163 echo_area_buffer
[0] = Qnil
;
10171 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10174 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10177 *msg
= make_buffer_string (BEG
, Z
, 1);
10184 /* Push the current message on Vmessage_stack for later restauration
10185 by restore_message. Value is non-zero if the current message isn't
10186 empty. This is a relatively infrequent operation, so it's not
10187 worth optimizing. */
10190 push_message (void)
10193 msg
= current_message ();
10194 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10195 return STRINGP (msg
);
10199 /* Restore message display from the top of Vmessage_stack. */
10202 restore_message (void)
10206 xassert (CONSP (Vmessage_stack
));
10207 msg
= XCAR (Vmessage_stack
);
10209 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10211 message3_nolog (msg
, 0, 0);
10215 /* Handler for record_unwind_protect calling pop_message. */
10218 pop_message_unwind (Lisp_Object dummy
)
10224 /* Pop the top-most entry off Vmessage_stack. */
10229 xassert (CONSP (Vmessage_stack
));
10230 Vmessage_stack
= XCDR (Vmessage_stack
);
10234 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10235 exits. If the stack is not empty, we have a missing pop_message
10239 check_message_stack (void)
10241 if (!NILP (Vmessage_stack
))
10246 /* Truncate to NCHARS what will be displayed in the echo area the next
10247 time we display it---but don't redisplay it now. */
10250 truncate_echo_area (EMACS_INT nchars
)
10253 echo_area_buffer
[0] = Qnil
;
10254 /* A null message buffer means that the frame hasn't really been
10255 initialized yet. Error messages get reported properly by
10256 cmd_error, so this must be just an informative message; toss it. */
10257 else if (!noninteractive
10259 && !NILP (echo_area_buffer
[0]))
10261 struct frame
*sf
= SELECTED_FRAME ();
10262 if (FRAME_MESSAGE_BUF (sf
))
10263 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10268 /* Helper function for truncate_echo_area. Truncate the current
10269 message to at most NCHARS characters. */
10272 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10274 if (BEG
+ nchars
< Z
)
10275 del_range (BEG
+ nchars
, Z
);
10277 echo_area_buffer
[0] = Qnil
;
10282 /* Set the current message to a substring of S or STRING.
10284 If STRING is a Lisp string, set the message to the first NBYTES
10285 bytes from STRING. NBYTES zero means use the whole string. If
10286 STRING is multibyte, the message will be displayed multibyte.
10288 If S is not null, set the message to the first LEN bytes of S. LEN
10289 zero means use the whole string. MULTIBYTE_P non-zero means S is
10290 multibyte. Display the message multibyte in that case.
10292 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10293 to t before calling set_message_1 (which calls insert).
10297 set_message (const char *s
, Lisp_Object string
,
10298 EMACS_INT nbytes
, int multibyte_p
)
10300 message_enable_multibyte
10301 = ((s
&& multibyte_p
)
10302 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10304 with_echo_area_buffer (0, -1, set_message_1
,
10305 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10306 message_buf_print
= 0;
10307 help_echo_showing_p
= 0;
10311 /* Helper function for set_message. Arguments have the same meaning
10312 as there, with A1 corresponding to S and A2 corresponding to STRING
10313 This function is called with the echo area buffer being
10317 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10320 const char *s
= (const char *) i1
;
10321 const unsigned char *msg
= (const unsigned char *) s
;
10322 Lisp_Object string
= a2
;
10324 /* Change multibyteness of the echo buffer appropriately. */
10325 if (message_enable_multibyte
10326 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10327 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10329 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10330 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10331 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10333 /* Insert new message at BEG. */
10334 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10336 if (STRINGP (string
))
10341 nbytes
= SBYTES (string
);
10342 nchars
= string_byte_to_char (string
, nbytes
);
10344 /* This function takes care of single/multibyte conversion. We
10345 just have to ensure that the echo area buffer has the right
10346 setting of enable_multibyte_characters. */
10347 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10352 nbytes
= strlen (s
);
10354 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10356 /* Convert from multi-byte to single-byte. */
10361 /* Convert a multibyte string to single-byte. */
10362 for (i
= 0; i
< nbytes
; i
+= n
)
10364 c
= string_char_and_length (msg
+ i
, &n
);
10365 work
[0] = (ASCII_CHAR_P (c
)
10367 : multibyte_char_to_unibyte (c
));
10368 insert_1_both (work
, 1, 1, 1, 0, 0);
10371 else if (!multibyte_p
10372 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10374 /* Convert from single-byte to multi-byte. */
10377 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10379 /* Convert a single-byte string to multibyte. */
10380 for (i
= 0; i
< nbytes
; i
++)
10383 MAKE_CHAR_MULTIBYTE (c
);
10384 n
= CHAR_STRING (c
, str
);
10385 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10389 insert_1 (s
, nbytes
, 1, 0, 0);
10396 /* Clear messages. CURRENT_P non-zero means clear the current
10397 message. LAST_DISPLAYED_P non-zero means clear the message
10401 clear_message (int current_p
, int last_displayed_p
)
10405 echo_area_buffer
[0] = Qnil
;
10406 message_cleared_p
= 1;
10409 if (last_displayed_p
)
10410 echo_area_buffer
[1] = Qnil
;
10412 message_buf_print
= 0;
10415 /* Clear garbaged frames.
10417 This function is used where the old redisplay called
10418 redraw_garbaged_frames which in turn called redraw_frame which in
10419 turn called clear_frame. The call to clear_frame was a source of
10420 flickering. I believe a clear_frame is not necessary. It should
10421 suffice in the new redisplay to invalidate all current matrices,
10422 and ensure a complete redisplay of all windows. */
10425 clear_garbaged_frames (void)
10427 if (frame_garbaged
)
10429 Lisp_Object tail
, frame
;
10430 int changed_count
= 0;
10432 FOR_EACH_FRAME (tail
, frame
)
10434 struct frame
*f
= XFRAME (frame
);
10436 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10440 Fredraw_frame (frame
);
10441 f
->force_flush_display_p
= 1;
10443 clear_current_matrices (f
);
10450 frame_garbaged
= 0;
10452 ++windows_or_buffers_changed
;
10457 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10458 is non-zero update selected_frame. Value is non-zero if the
10459 mini-windows height has been changed. */
10462 echo_area_display (int update_frame_p
)
10464 Lisp_Object mini_window
;
10467 int window_height_changed_p
= 0;
10468 struct frame
*sf
= SELECTED_FRAME ();
10470 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10471 w
= XWINDOW (mini_window
);
10472 f
= XFRAME (WINDOW_FRAME (w
));
10474 /* Don't display if frame is invisible or not yet initialized. */
10475 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10478 #ifdef HAVE_WINDOW_SYSTEM
10479 /* When Emacs starts, selected_frame may be the initial terminal
10480 frame. If we let this through, a message would be displayed on
10482 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10484 #endif /* HAVE_WINDOW_SYSTEM */
10486 /* Redraw garbaged frames. */
10487 if (frame_garbaged
)
10488 clear_garbaged_frames ();
10490 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10492 echo_area_window
= mini_window
;
10493 window_height_changed_p
= display_echo_area (w
);
10494 w
->must_be_updated_p
= 1;
10496 /* Update the display, unless called from redisplay_internal.
10497 Also don't update the screen during redisplay itself. The
10498 update will happen at the end of redisplay, and an update
10499 here could cause confusion. */
10500 if (update_frame_p
&& !redisplaying_p
)
10504 /* If the display update has been interrupted by pending
10505 input, update mode lines in the frame. Due to the
10506 pending input, it might have been that redisplay hasn't
10507 been called, so that mode lines above the echo area are
10508 garbaged. This looks odd, so we prevent it here. */
10509 if (!display_completed
)
10510 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10512 if (window_height_changed_p
10513 /* Don't do this if Emacs is shutting down. Redisplay
10514 needs to run hooks. */
10515 && !NILP (Vrun_hooks
))
10517 /* Must update other windows. Likewise as in other
10518 cases, don't let this update be interrupted by
10520 int count
= SPECPDL_INDEX ();
10521 specbind (Qredisplay_dont_pause
, Qt
);
10522 windows_or_buffers_changed
= 1;
10523 redisplay_internal ();
10524 unbind_to (count
, Qnil
);
10526 else if (FRAME_WINDOW_P (f
) && n
== 0)
10528 /* Window configuration is the same as before.
10529 Can do with a display update of the echo area,
10530 unless we displayed some mode lines. */
10531 update_single_window (w
, 1);
10532 FRAME_RIF (f
)->flush_display (f
);
10535 update_frame (f
, 1, 1);
10537 /* If cursor is in the echo area, make sure that the next
10538 redisplay displays the minibuffer, so that the cursor will
10539 be replaced with what the minibuffer wants. */
10540 if (cursor_in_echo_area
)
10541 ++windows_or_buffers_changed
;
10544 else if (!EQ (mini_window
, selected_window
))
10545 windows_or_buffers_changed
++;
10547 /* Last displayed message is now the current message. */
10548 echo_area_buffer
[1] = echo_area_buffer
[0];
10549 /* Inform read_char that we're not echoing. */
10550 echo_message_buffer
= Qnil
;
10552 /* Prevent redisplay optimization in redisplay_internal by resetting
10553 this_line_start_pos. This is done because the mini-buffer now
10554 displays the message instead of its buffer text. */
10555 if (EQ (mini_window
, selected_window
))
10556 CHARPOS (this_line_start_pos
) = 0;
10558 return window_height_changed_p
;
10563 /***********************************************************************
10564 Mode Lines and Frame Titles
10565 ***********************************************************************/
10567 /* A buffer for constructing non-propertized mode-line strings and
10568 frame titles in it; allocated from the heap in init_xdisp and
10569 resized as needed in store_mode_line_noprop_char. */
10571 static char *mode_line_noprop_buf
;
10573 /* The buffer's end, and a current output position in it. */
10575 static char *mode_line_noprop_buf_end
;
10576 static char *mode_line_noprop_ptr
;
10578 #define MODE_LINE_NOPROP_LEN(start) \
10579 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10582 MODE_LINE_DISPLAY
= 0,
10586 } mode_line_target
;
10588 /* Alist that caches the results of :propertize.
10589 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10590 static Lisp_Object mode_line_proptrans_alist
;
10592 /* List of strings making up the mode-line. */
10593 static Lisp_Object mode_line_string_list
;
10595 /* Base face property when building propertized mode line string. */
10596 static Lisp_Object mode_line_string_face
;
10597 static Lisp_Object mode_line_string_face_prop
;
10600 /* Unwind data for mode line strings */
10602 static Lisp_Object Vmode_line_unwind_vector
;
10605 format_mode_line_unwind_data (struct buffer
*obuf
,
10607 int save_proptrans
)
10609 Lisp_Object vector
, tmp
;
10611 /* Reduce consing by keeping one vector in
10612 Vwith_echo_area_save_vector. */
10613 vector
= Vmode_line_unwind_vector
;
10614 Vmode_line_unwind_vector
= Qnil
;
10617 vector
= Fmake_vector (make_number (8), Qnil
);
10619 ASET (vector
, 0, make_number (mode_line_target
));
10620 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10621 ASET (vector
, 2, mode_line_string_list
);
10622 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10623 ASET (vector
, 4, mode_line_string_face
);
10624 ASET (vector
, 5, mode_line_string_face_prop
);
10627 XSETBUFFER (tmp
, obuf
);
10630 ASET (vector
, 6, tmp
);
10631 ASET (vector
, 7, owin
);
10637 unwind_format_mode_line (Lisp_Object vector
)
10639 mode_line_target
= XINT (AREF (vector
, 0));
10640 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10641 mode_line_string_list
= AREF (vector
, 2);
10642 if (! EQ (AREF (vector
, 3), Qt
))
10643 mode_line_proptrans_alist
= AREF (vector
, 3);
10644 mode_line_string_face
= AREF (vector
, 4);
10645 mode_line_string_face_prop
= AREF (vector
, 5);
10647 if (!NILP (AREF (vector
, 7)))
10648 /* Select window before buffer, since it may change the buffer. */
10649 Fselect_window (AREF (vector
, 7), Qt
);
10651 if (!NILP (AREF (vector
, 6)))
10653 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10654 ASET (vector
, 6, Qnil
);
10657 Vmode_line_unwind_vector
= vector
;
10662 /* Store a single character C for the frame title in mode_line_noprop_buf.
10663 Re-allocate mode_line_noprop_buf if necessary. */
10666 store_mode_line_noprop_char (char c
)
10668 /* If output position has reached the end of the allocated buffer,
10669 increase the buffer's size. */
10670 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10672 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10673 ptrdiff_t size
= len
;
10674 mode_line_noprop_buf
=
10675 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10676 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10677 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10680 *mode_line_noprop_ptr
++ = c
;
10684 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10685 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10686 characters that yield more columns than PRECISION; PRECISION <= 0
10687 means copy the whole string. Pad with spaces until FIELD_WIDTH
10688 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10689 pad. Called from display_mode_element when it is used to build a
10693 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10695 const unsigned char *str
= (const unsigned char *) string
;
10697 EMACS_INT dummy
, nbytes
;
10699 /* Copy at most PRECISION chars from STR. */
10700 nbytes
= strlen (string
);
10701 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10703 store_mode_line_noprop_char (*str
++);
10705 /* Fill up with spaces until FIELD_WIDTH reached. */
10706 while (field_width
> 0
10707 && n
< field_width
)
10709 store_mode_line_noprop_char (' ');
10716 /***********************************************************************
10718 ***********************************************************************/
10720 #ifdef HAVE_WINDOW_SYSTEM
10722 /* Set the title of FRAME, if it has changed. The title format is
10723 Vicon_title_format if FRAME is iconified, otherwise it is
10724 frame_title_format. */
10727 x_consider_frame_title (Lisp_Object frame
)
10729 struct frame
*f
= XFRAME (frame
);
10731 if (FRAME_WINDOW_P (f
)
10732 || FRAME_MINIBUF_ONLY_P (f
)
10733 || f
->explicit_name
)
10735 /* Do we have more than one visible frame on this X display? */
10738 ptrdiff_t title_start
;
10742 int count
= SPECPDL_INDEX ();
10744 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10746 Lisp_Object other_frame
= XCAR (tail
);
10747 struct frame
*tf
= XFRAME (other_frame
);
10750 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10751 && !FRAME_MINIBUF_ONLY_P (tf
)
10752 && !EQ (other_frame
, tip_frame
)
10753 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10757 /* Set global variable indicating that multiple frames exist. */
10758 multiple_frames
= CONSP (tail
);
10760 /* Switch to the buffer of selected window of the frame. Set up
10761 mode_line_target so that display_mode_element will output into
10762 mode_line_noprop_buf; then display the title. */
10763 record_unwind_protect (unwind_format_mode_line
,
10764 format_mode_line_unwind_data
10765 (current_buffer
, selected_window
, 0));
10767 Fselect_window (f
->selected_window
, Qt
);
10768 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10769 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10771 mode_line_target
= MODE_LINE_TITLE
;
10772 title_start
= MODE_LINE_NOPROP_LEN (0);
10773 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10774 NULL
, DEFAULT_FACE_ID
);
10775 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10776 len
= MODE_LINE_NOPROP_LEN (title_start
);
10777 title
= mode_line_noprop_buf
+ title_start
;
10778 unbind_to (count
, Qnil
);
10780 /* Set the title only if it's changed. This avoids consing in
10781 the common case where it hasn't. (If it turns out that we've
10782 already wasted too much time by walking through the list with
10783 display_mode_element, then we might need to optimize at a
10784 higher level than this.) */
10785 if (! STRINGP (f
->name
)
10786 || SBYTES (f
->name
) != len
10787 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10788 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10792 #endif /* not HAVE_WINDOW_SYSTEM */
10797 /***********************************************************************
10799 ***********************************************************************/
10802 /* Prepare for redisplay by updating menu-bar item lists when
10803 appropriate. This can call eval. */
10806 prepare_menu_bars (void)
10809 struct gcpro gcpro1
, gcpro2
;
10811 Lisp_Object tooltip_frame
;
10813 #ifdef HAVE_WINDOW_SYSTEM
10814 tooltip_frame
= tip_frame
;
10816 tooltip_frame
= Qnil
;
10819 /* Update all frame titles based on their buffer names, etc. We do
10820 this before the menu bars so that the buffer-menu will show the
10821 up-to-date frame titles. */
10822 #ifdef HAVE_WINDOW_SYSTEM
10823 if (windows_or_buffers_changed
|| update_mode_lines
)
10825 Lisp_Object tail
, frame
;
10827 FOR_EACH_FRAME (tail
, frame
)
10829 f
= XFRAME (frame
);
10830 if (!EQ (frame
, tooltip_frame
)
10831 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10832 x_consider_frame_title (frame
);
10835 #endif /* HAVE_WINDOW_SYSTEM */
10837 /* Update the menu bar item lists, if appropriate. This has to be
10838 done before any actual redisplay or generation of display lines. */
10839 all_windows
= (update_mode_lines
10840 || buffer_shared
> 1
10841 || windows_or_buffers_changed
);
10844 Lisp_Object tail
, frame
;
10845 int count
= SPECPDL_INDEX ();
10846 /* 1 means that update_menu_bar has run its hooks
10847 so any further calls to update_menu_bar shouldn't do so again. */
10848 int menu_bar_hooks_run
= 0;
10850 record_unwind_save_match_data ();
10852 FOR_EACH_FRAME (tail
, frame
)
10854 f
= XFRAME (frame
);
10856 /* Ignore tooltip frame. */
10857 if (EQ (frame
, tooltip_frame
))
10860 /* If a window on this frame changed size, report that to
10861 the user and clear the size-change flag. */
10862 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10864 Lisp_Object functions
;
10866 /* Clear flag first in case we get an error below. */
10867 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10868 functions
= Vwindow_size_change_functions
;
10869 GCPRO2 (tail
, functions
);
10871 while (CONSP (functions
))
10873 if (!EQ (XCAR (functions
), Qt
))
10874 call1 (XCAR (functions
), frame
);
10875 functions
= XCDR (functions
);
10881 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10882 #ifdef HAVE_WINDOW_SYSTEM
10883 update_tool_bar (f
, 0);
10886 if (windows_or_buffers_changed
10888 ns_set_doc_edited (f
, Fbuffer_modified_p
10889 (XWINDOW (f
->selected_window
)->buffer
));
10894 unbind_to (count
, Qnil
);
10898 struct frame
*sf
= SELECTED_FRAME ();
10899 update_menu_bar (sf
, 1, 0);
10900 #ifdef HAVE_WINDOW_SYSTEM
10901 update_tool_bar (sf
, 1);
10907 /* Update the menu bar item list for frame F. This has to be done
10908 before we start to fill in any display lines, because it can call
10911 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10913 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10914 already ran the menu bar hooks for this redisplay, so there
10915 is no need to run them again. The return value is the
10916 updated value of this flag, to pass to the next call. */
10919 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10921 Lisp_Object window
;
10922 register struct window
*w
;
10924 /* If called recursively during a menu update, do nothing. This can
10925 happen when, for instance, an activate-menubar-hook causes a
10927 if (inhibit_menubar_update
)
10930 window
= FRAME_SELECTED_WINDOW (f
);
10931 w
= XWINDOW (window
);
10933 if (FRAME_WINDOW_P (f
)
10935 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10936 || defined (HAVE_NS) || defined (USE_GTK)
10937 FRAME_EXTERNAL_MENU_BAR (f
)
10939 FRAME_MENU_BAR_LINES (f
) > 0
10941 : FRAME_MENU_BAR_LINES (f
) > 0)
10943 /* If the user has switched buffers or windows, we need to
10944 recompute to reflect the new bindings. But we'll
10945 recompute when update_mode_lines is set too; that means
10946 that people can use force-mode-line-update to request
10947 that the menu bar be recomputed. The adverse effect on
10948 the rest of the redisplay algorithm is about the same as
10949 windows_or_buffers_changed anyway. */
10950 if (windows_or_buffers_changed
10951 /* This used to test w->update_mode_line, but we believe
10952 there is no need to recompute the menu in that case. */
10953 || update_mode_lines
10954 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10955 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10956 != !NILP (w
->last_had_star
))
10957 || ((!NILP (Vtransient_mark_mode
)
10958 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10959 != !NILP (w
->region_showing
)))
10961 struct buffer
*prev
= current_buffer
;
10962 int count
= SPECPDL_INDEX ();
10964 specbind (Qinhibit_menubar_update
, Qt
);
10966 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10967 if (save_match_data
)
10968 record_unwind_save_match_data ();
10969 if (NILP (Voverriding_local_map_menu_flag
))
10971 specbind (Qoverriding_terminal_local_map
, Qnil
);
10972 specbind (Qoverriding_local_map
, Qnil
);
10977 /* Run the Lucid hook. */
10978 safe_run_hooks (Qactivate_menubar_hook
);
10980 /* If it has changed current-menubar from previous value,
10981 really recompute the menu-bar from the value. */
10982 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10983 call0 (Qrecompute_lucid_menubar
);
10985 safe_run_hooks (Qmenu_bar_update_hook
);
10990 XSETFRAME (Vmenu_updating_frame
, f
);
10991 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10993 /* Redisplay the menu bar in case we changed it. */
10994 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10995 || defined (HAVE_NS) || defined (USE_GTK)
10996 if (FRAME_WINDOW_P (f
))
10998 #if defined (HAVE_NS)
10999 /* All frames on Mac OS share the same menubar. So only
11000 the selected frame should be allowed to set it. */
11001 if (f
== SELECTED_FRAME ())
11003 set_frame_menubar (f
, 0, 0);
11006 /* On a terminal screen, the menu bar is an ordinary screen
11007 line, and this makes it get updated. */
11008 w
->update_mode_line
= Qt
;
11009 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11010 /* In the non-toolkit version, the menu bar is an ordinary screen
11011 line, and this makes it get updated. */
11012 w
->update_mode_line
= Qt
;
11013 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11015 unbind_to (count
, Qnil
);
11016 set_buffer_internal_1 (prev
);
11025 /***********************************************************************
11027 ***********************************************************************/
11029 #ifdef HAVE_WINDOW_SYSTEM
11032 Nominal cursor position -- where to draw output.
11033 HPOS and VPOS are window relative glyph matrix coordinates.
11034 X and Y are window relative pixel coordinates. */
11036 struct cursor_pos output_cursor
;
11040 Set the global variable output_cursor to CURSOR. All cursor
11041 positions are relative to updated_window. */
11044 set_output_cursor (struct cursor_pos
*cursor
)
11046 output_cursor
.hpos
= cursor
->hpos
;
11047 output_cursor
.vpos
= cursor
->vpos
;
11048 output_cursor
.x
= cursor
->x
;
11049 output_cursor
.y
= cursor
->y
;
11054 Set a nominal cursor position.
11056 HPOS and VPOS are column/row positions in a window glyph matrix. X
11057 and Y are window text area relative pixel positions.
11059 If this is done during an update, updated_window will contain the
11060 window that is being updated and the position is the future output
11061 cursor position for that window. If updated_window is null, use
11062 selected_window and display the cursor at the given position. */
11065 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11069 /* If updated_window is not set, work on selected_window. */
11070 if (updated_window
)
11071 w
= updated_window
;
11073 w
= XWINDOW (selected_window
);
11075 /* Set the output cursor. */
11076 output_cursor
.hpos
= hpos
;
11077 output_cursor
.vpos
= vpos
;
11078 output_cursor
.x
= x
;
11079 output_cursor
.y
= y
;
11081 /* If not called as part of an update, really display the cursor.
11082 This will also set the cursor position of W. */
11083 if (updated_window
== NULL
)
11086 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11087 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11088 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11093 #endif /* HAVE_WINDOW_SYSTEM */
11096 /***********************************************************************
11098 ***********************************************************************/
11100 #ifdef HAVE_WINDOW_SYSTEM
11102 /* Where the mouse was last time we reported a mouse event. */
11104 FRAME_PTR last_mouse_frame
;
11106 /* Tool-bar item index of the item on which a mouse button was pressed
11109 int last_tool_bar_item
;
11113 update_tool_bar_unwind (Lisp_Object frame
)
11115 selected_frame
= frame
;
11119 /* Update the tool-bar item list for frame F. This has to be done
11120 before we start to fill in any display lines. Called from
11121 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11122 and restore it here. */
11125 update_tool_bar (struct frame
*f
, int save_match_data
)
11127 #if defined (USE_GTK) || defined (HAVE_NS)
11128 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11130 int do_update
= WINDOWP (f
->tool_bar_window
)
11131 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11136 Lisp_Object window
;
11139 window
= FRAME_SELECTED_WINDOW (f
);
11140 w
= XWINDOW (window
);
11142 /* If the user has switched buffers or windows, we need to
11143 recompute to reflect the new bindings. But we'll
11144 recompute when update_mode_lines is set too; that means
11145 that people can use force-mode-line-update to request
11146 that the menu bar be recomputed. The adverse effect on
11147 the rest of the redisplay algorithm is about the same as
11148 windows_or_buffers_changed anyway. */
11149 if (windows_or_buffers_changed
11150 || !NILP (w
->update_mode_line
)
11151 || update_mode_lines
11152 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11153 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11154 != !NILP (w
->last_had_star
))
11155 || ((!NILP (Vtransient_mark_mode
)
11156 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11157 != !NILP (w
->region_showing
)))
11159 struct buffer
*prev
= current_buffer
;
11160 int count
= SPECPDL_INDEX ();
11161 Lisp_Object frame
, new_tool_bar
;
11162 int new_n_tool_bar
;
11163 struct gcpro gcpro1
;
11165 /* Set current_buffer to the buffer of the selected
11166 window of the frame, so that we get the right local
11168 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11170 /* Save match data, if we must. */
11171 if (save_match_data
)
11172 record_unwind_save_match_data ();
11174 /* Make sure that we don't accidentally use bogus keymaps. */
11175 if (NILP (Voverriding_local_map_menu_flag
))
11177 specbind (Qoverriding_terminal_local_map
, Qnil
);
11178 specbind (Qoverriding_local_map
, Qnil
);
11181 GCPRO1 (new_tool_bar
);
11183 /* We must temporarily set the selected frame to this frame
11184 before calling tool_bar_items, because the calculation of
11185 the tool-bar keymap uses the selected frame (see
11186 `tool-bar-make-keymap' in tool-bar.el). */
11187 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11188 XSETFRAME (frame
, f
);
11189 selected_frame
= frame
;
11191 /* Build desired tool-bar items from keymaps. */
11192 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11195 /* Redisplay the tool-bar if we changed it. */
11196 if (new_n_tool_bar
!= f
->n_tool_bar_items
11197 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11199 /* Redisplay that happens asynchronously due to an expose event
11200 may access f->tool_bar_items. Make sure we update both
11201 variables within BLOCK_INPUT so no such event interrupts. */
11203 f
->tool_bar_items
= new_tool_bar
;
11204 f
->n_tool_bar_items
= new_n_tool_bar
;
11205 w
->update_mode_line
= Qt
;
11211 unbind_to (count
, Qnil
);
11212 set_buffer_internal_1 (prev
);
11218 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11219 F's desired tool-bar contents. F->tool_bar_items must have
11220 been set up previously by calling prepare_menu_bars. */
11223 build_desired_tool_bar_string (struct frame
*f
)
11225 int i
, size
, size_needed
;
11226 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11227 Lisp_Object image
, plist
, props
;
11229 image
= plist
= props
= Qnil
;
11230 GCPRO3 (image
, plist
, props
);
11232 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11233 Otherwise, make a new string. */
11235 /* The size of the string we might be able to reuse. */
11236 size
= (STRINGP (f
->desired_tool_bar_string
)
11237 ? SCHARS (f
->desired_tool_bar_string
)
11240 /* We need one space in the string for each image. */
11241 size_needed
= f
->n_tool_bar_items
;
11243 /* Reuse f->desired_tool_bar_string, if possible. */
11244 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11245 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11246 make_number (' '));
11249 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11250 Fremove_text_properties (make_number (0), make_number (size
),
11251 props
, f
->desired_tool_bar_string
);
11254 /* Put a `display' property on the string for the images to display,
11255 put a `menu_item' property on tool-bar items with a value that
11256 is the index of the item in F's tool-bar item vector. */
11257 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11259 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11261 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11262 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11263 int hmargin
, vmargin
, relief
, idx
, end
;
11265 /* If image is a vector, choose the image according to the
11267 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11268 if (VECTORP (image
))
11272 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11273 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11276 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11277 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11279 xassert (ASIZE (image
) >= idx
);
11280 image
= AREF (image
, idx
);
11285 /* Ignore invalid image specifications. */
11286 if (!valid_image_p (image
))
11289 /* Display the tool-bar button pressed, or depressed. */
11290 plist
= Fcopy_sequence (XCDR (image
));
11292 /* Compute margin and relief to draw. */
11293 relief
= (tool_bar_button_relief
>= 0
11294 ? tool_bar_button_relief
11295 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11296 hmargin
= vmargin
= relief
;
11298 if (INTEGERP (Vtool_bar_button_margin
)
11299 && XINT (Vtool_bar_button_margin
) > 0)
11301 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11302 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11304 else if (CONSP (Vtool_bar_button_margin
))
11306 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11307 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11308 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11310 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11311 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11312 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11315 if (auto_raise_tool_bar_buttons_p
)
11317 /* Add a `:relief' property to the image spec if the item is
11321 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11328 /* If image is selected, display it pressed, i.e. with a
11329 negative relief. If it's not selected, display it with a
11331 plist
= Fplist_put (plist
, QCrelief
,
11333 ? make_number (-relief
)
11334 : make_number (relief
)));
11339 /* Put a margin around the image. */
11340 if (hmargin
|| vmargin
)
11342 if (hmargin
== vmargin
)
11343 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11345 plist
= Fplist_put (plist
, QCmargin
,
11346 Fcons (make_number (hmargin
),
11347 make_number (vmargin
)));
11350 /* If button is not enabled, and we don't have special images
11351 for the disabled state, make the image appear disabled by
11352 applying an appropriate algorithm to it. */
11353 if (!enabled_p
&& idx
< 0)
11354 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11356 /* Put a `display' text property on the string for the image to
11357 display. Put a `menu-item' property on the string that gives
11358 the start of this item's properties in the tool-bar items
11360 image
= Fcons (Qimage
, plist
);
11361 props
= list4 (Qdisplay
, image
,
11362 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11364 /* Let the last image hide all remaining spaces in the tool bar
11365 string. The string can be longer than needed when we reuse a
11366 previous string. */
11367 if (i
+ 1 == f
->n_tool_bar_items
)
11368 end
= SCHARS (f
->desired_tool_bar_string
);
11371 Fadd_text_properties (make_number (i
), make_number (end
),
11372 props
, f
->desired_tool_bar_string
);
11380 /* Display one line of the tool-bar of frame IT->f.
11382 HEIGHT specifies the desired height of the tool-bar line.
11383 If the actual height of the glyph row is less than HEIGHT, the
11384 row's height is increased to HEIGHT, and the icons are centered
11385 vertically in the new height.
11387 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11388 count a final empty row in case the tool-bar width exactly matches
11393 display_tool_bar_line (struct it
*it
, int height
)
11395 struct glyph_row
*row
= it
->glyph_row
;
11396 int max_x
= it
->last_visible_x
;
11397 struct glyph
*last
;
11399 prepare_desired_row (row
);
11400 row
->y
= it
->current_y
;
11402 /* Note that this isn't made use of if the face hasn't a box,
11403 so there's no need to check the face here. */
11404 it
->start_of_box_run_p
= 1;
11406 while (it
->current_x
< max_x
)
11408 int x
, n_glyphs_before
, i
, nglyphs
;
11409 struct it it_before
;
11411 /* Get the next display element. */
11412 if (!get_next_display_element (it
))
11414 /* Don't count empty row if we are counting needed tool-bar lines. */
11415 if (height
< 0 && !it
->hpos
)
11420 /* Produce glyphs. */
11421 n_glyphs_before
= row
->used
[TEXT_AREA
];
11424 PRODUCE_GLYPHS (it
);
11426 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11428 x
= it_before
.current_x
;
11429 while (i
< nglyphs
)
11431 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11433 if (x
+ glyph
->pixel_width
> max_x
)
11435 /* Glyph doesn't fit on line. Backtrack. */
11436 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11438 /* If this is the only glyph on this line, it will never fit on the
11439 tool-bar, so skip it. But ensure there is at least one glyph,
11440 so we don't accidentally disable the tool-bar. */
11441 if (n_glyphs_before
== 0
11442 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11448 x
+= glyph
->pixel_width
;
11452 /* Stop at line end. */
11453 if (ITERATOR_AT_END_OF_LINE_P (it
))
11456 set_iterator_to_next (it
, 1);
11461 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11463 /* Use default face for the border below the tool bar.
11465 FIXME: When auto-resize-tool-bars is grow-only, there is
11466 no additional border below the possibly empty tool-bar lines.
11467 So to make the extra empty lines look "normal", we have to
11468 use the tool-bar face for the border too. */
11469 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11470 it
->face_id
= DEFAULT_FACE_ID
;
11472 extend_face_to_end_of_line (it
);
11473 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11474 last
->right_box_line_p
= 1;
11475 if (last
== row
->glyphs
[TEXT_AREA
])
11476 last
->left_box_line_p
= 1;
11478 /* Make line the desired height and center it vertically. */
11479 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11481 /* Don't add more than one line height. */
11482 height
%= FRAME_LINE_HEIGHT (it
->f
);
11483 it
->max_ascent
+= height
/ 2;
11484 it
->max_descent
+= (height
+ 1) / 2;
11487 compute_line_metrics (it
);
11489 /* If line is empty, make it occupy the rest of the tool-bar. */
11490 if (!row
->displays_text_p
)
11492 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11493 row
->visible_height
= row
->height
;
11494 row
->ascent
= row
->phys_ascent
= 0;
11495 row
->extra_line_spacing
= 0;
11498 row
->full_width_p
= 1;
11499 row
->continued_p
= 0;
11500 row
->truncated_on_left_p
= 0;
11501 row
->truncated_on_right_p
= 0;
11503 it
->current_x
= it
->hpos
= 0;
11504 it
->current_y
+= row
->height
;
11510 /* Max tool-bar height. */
11512 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11513 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11515 /* Value is the number of screen lines needed to make all tool-bar
11516 items of frame F visible. The number of actual rows needed is
11517 returned in *N_ROWS if non-NULL. */
11520 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11522 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11524 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11525 the desired matrix, so use (unused) mode-line row as temporary row to
11526 avoid destroying the first tool-bar row. */
11527 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11529 /* Initialize an iterator for iteration over
11530 F->desired_tool_bar_string in the tool-bar window of frame F. */
11531 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11532 it
.first_visible_x
= 0;
11533 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11534 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11535 it
.paragraph_embedding
= L2R
;
11537 while (!ITERATOR_AT_END_P (&it
))
11539 clear_glyph_row (temp_row
);
11540 it
.glyph_row
= temp_row
;
11541 display_tool_bar_line (&it
, -1);
11543 clear_glyph_row (temp_row
);
11545 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11547 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11549 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11553 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11555 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11556 (Lisp_Object frame
)
11563 frame
= selected_frame
;
11565 CHECK_FRAME (frame
);
11566 f
= XFRAME (frame
);
11568 if (WINDOWP (f
->tool_bar_window
)
11569 && (w
= XWINDOW (f
->tool_bar_window
),
11570 WINDOW_TOTAL_LINES (w
) > 0))
11572 update_tool_bar (f
, 1);
11573 if (f
->n_tool_bar_items
)
11575 build_desired_tool_bar_string (f
);
11576 nlines
= tool_bar_lines_needed (f
, NULL
);
11580 return make_number (nlines
);
11584 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11585 height should be changed. */
11588 redisplay_tool_bar (struct frame
*f
)
11592 struct glyph_row
*row
;
11594 #if defined (USE_GTK) || defined (HAVE_NS)
11595 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11596 update_frame_tool_bar (f
);
11600 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11601 do anything. This means you must start with tool-bar-lines
11602 non-zero to get the auto-sizing effect. Or in other words, you
11603 can turn off tool-bars by specifying tool-bar-lines zero. */
11604 if (!WINDOWP (f
->tool_bar_window
)
11605 || (w
= XWINDOW (f
->tool_bar_window
),
11606 WINDOW_TOTAL_LINES (w
) == 0))
11609 /* Set up an iterator for the tool-bar window. */
11610 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11611 it
.first_visible_x
= 0;
11612 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11613 row
= it
.glyph_row
;
11615 /* Build a string that represents the contents of the tool-bar. */
11616 build_desired_tool_bar_string (f
);
11617 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11618 /* FIXME: This should be controlled by a user option. But it
11619 doesn't make sense to have an R2L tool bar if the menu bar cannot
11620 be drawn also R2L, and making the menu bar R2L is tricky due
11621 toolkit-specific code that implements it. If an R2L tool bar is
11622 ever supported, display_tool_bar_line should also be augmented to
11623 call unproduce_glyphs like display_line and display_string
11625 it
.paragraph_embedding
= L2R
;
11627 if (f
->n_tool_bar_rows
== 0)
11631 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11632 nlines
!= WINDOW_TOTAL_LINES (w
)))
11635 int old_height
= WINDOW_TOTAL_LINES (w
);
11637 XSETFRAME (frame
, f
);
11638 Fmodify_frame_parameters (frame
,
11639 Fcons (Fcons (Qtool_bar_lines
,
11640 make_number (nlines
)),
11642 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11644 clear_glyph_matrix (w
->desired_matrix
);
11645 fonts_changed_p
= 1;
11651 /* Display as many lines as needed to display all tool-bar items. */
11653 if (f
->n_tool_bar_rows
> 0)
11655 int border
, rows
, height
, extra
;
11657 if (INTEGERP (Vtool_bar_border
))
11658 border
= XINT (Vtool_bar_border
);
11659 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11660 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11661 else if (EQ (Vtool_bar_border
, Qborder_width
))
11662 border
= f
->border_width
;
11668 rows
= f
->n_tool_bar_rows
;
11669 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11670 extra
= it
.last_visible_y
- border
- height
* rows
;
11672 while (it
.current_y
< it
.last_visible_y
)
11675 if (extra
> 0 && rows
-- > 0)
11677 h
= (extra
+ rows
- 1) / rows
;
11680 display_tool_bar_line (&it
, height
+ h
);
11685 while (it
.current_y
< it
.last_visible_y
)
11686 display_tool_bar_line (&it
, 0);
11689 /* It doesn't make much sense to try scrolling in the tool-bar
11690 window, so don't do it. */
11691 w
->desired_matrix
->no_scrolling_p
= 1;
11692 w
->must_be_updated_p
= 1;
11694 if (!NILP (Vauto_resize_tool_bars
))
11696 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11697 int change_height_p
= 0;
11699 /* If we couldn't display everything, change the tool-bar's
11700 height if there is room for more. */
11701 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11702 && it
.current_y
< max_tool_bar_height
)
11703 change_height_p
= 1;
11705 row
= it
.glyph_row
- 1;
11707 /* If there are blank lines at the end, except for a partially
11708 visible blank line at the end that is smaller than
11709 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11710 if (!row
->displays_text_p
11711 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11712 change_height_p
= 1;
11714 /* If row displays tool-bar items, but is partially visible,
11715 change the tool-bar's height. */
11716 if (row
->displays_text_p
11717 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11718 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11719 change_height_p
= 1;
11721 /* Resize windows as needed by changing the `tool-bar-lines'
11722 frame parameter. */
11723 if (change_height_p
)
11726 int old_height
= WINDOW_TOTAL_LINES (w
);
11728 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11730 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11731 && !f
->minimize_tool_bar_window_p
)
11732 ? (nlines
> old_height
)
11733 : (nlines
!= old_height
));
11734 f
->minimize_tool_bar_window_p
= 0;
11736 if (change_height_p
)
11738 XSETFRAME (frame
, f
);
11739 Fmodify_frame_parameters (frame
,
11740 Fcons (Fcons (Qtool_bar_lines
,
11741 make_number (nlines
)),
11743 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11745 clear_glyph_matrix (w
->desired_matrix
);
11746 f
->n_tool_bar_rows
= nrows
;
11747 fonts_changed_p
= 1;
11754 f
->minimize_tool_bar_window_p
= 0;
11759 /* Get information about the tool-bar item which is displayed in GLYPH
11760 on frame F. Return in *PROP_IDX the index where tool-bar item
11761 properties start in F->tool_bar_items. Value is zero if
11762 GLYPH doesn't display a tool-bar item. */
11765 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11771 /* This function can be called asynchronously, which means we must
11772 exclude any possibility that Fget_text_property signals an
11774 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11775 charpos
= max (0, charpos
);
11777 /* Get the text property `menu-item' at pos. The value of that
11778 property is the start index of this item's properties in
11779 F->tool_bar_items. */
11780 prop
= Fget_text_property (make_number (charpos
),
11781 Qmenu_item
, f
->current_tool_bar_string
);
11782 if (INTEGERP (prop
))
11784 *prop_idx
= XINT (prop
);
11794 /* Get information about the tool-bar item at position X/Y on frame F.
11795 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11796 the current matrix of the tool-bar window of F, or NULL if not
11797 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11798 item in F->tool_bar_items. Value is
11800 -1 if X/Y is not on a tool-bar item
11801 0 if X/Y is on the same item that was highlighted before.
11805 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11806 int *hpos
, int *vpos
, int *prop_idx
)
11808 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11809 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11812 /* Find the glyph under X/Y. */
11813 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11814 if (*glyph
== NULL
)
11817 /* Get the start of this tool-bar item's properties in
11818 f->tool_bar_items. */
11819 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11822 /* Is mouse on the highlighted item? */
11823 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11824 && *vpos
>= hlinfo
->mouse_face_beg_row
11825 && *vpos
<= hlinfo
->mouse_face_end_row
11826 && (*vpos
> hlinfo
->mouse_face_beg_row
11827 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11828 && (*vpos
< hlinfo
->mouse_face_end_row
11829 || *hpos
< hlinfo
->mouse_face_end_col
11830 || hlinfo
->mouse_face_past_end
))
11838 Handle mouse button event on the tool-bar of frame F, at
11839 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11840 0 for button release. MODIFIERS is event modifiers for button
11844 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11845 unsigned int modifiers
)
11847 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11848 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11849 int hpos
, vpos
, prop_idx
;
11850 struct glyph
*glyph
;
11851 Lisp_Object enabled_p
;
11853 /* If not on the highlighted tool-bar item, return. */
11854 frame_to_window_pixel_xy (w
, &x
, &y
);
11855 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11858 /* If item is disabled, do nothing. */
11859 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11860 if (NILP (enabled_p
))
11865 /* Show item in pressed state. */
11866 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11867 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11868 last_tool_bar_item
= prop_idx
;
11872 Lisp_Object key
, frame
;
11873 struct input_event event
;
11874 EVENT_INIT (event
);
11876 /* Show item in released state. */
11877 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11878 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11880 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11882 XSETFRAME (frame
, f
);
11883 event
.kind
= TOOL_BAR_EVENT
;
11884 event
.frame_or_window
= frame
;
11886 kbd_buffer_store_event (&event
);
11888 event
.kind
= TOOL_BAR_EVENT
;
11889 event
.frame_or_window
= frame
;
11891 event
.modifiers
= modifiers
;
11892 kbd_buffer_store_event (&event
);
11893 last_tool_bar_item
= -1;
11898 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11899 tool-bar window-relative coordinates X/Y. Called from
11900 note_mouse_highlight. */
11903 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11905 Lisp_Object window
= f
->tool_bar_window
;
11906 struct window
*w
= XWINDOW (window
);
11907 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11908 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11910 struct glyph
*glyph
;
11911 struct glyph_row
*row
;
11913 Lisp_Object enabled_p
;
11915 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11916 int mouse_down_p
, rc
;
11918 /* Function note_mouse_highlight is called with negative X/Y
11919 values when mouse moves outside of the frame. */
11920 if (x
<= 0 || y
<= 0)
11922 clear_mouse_face (hlinfo
);
11926 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11929 /* Not on tool-bar item. */
11930 clear_mouse_face (hlinfo
);
11934 /* On same tool-bar item as before. */
11935 goto set_help_echo
;
11937 clear_mouse_face (hlinfo
);
11939 /* Mouse is down, but on different tool-bar item? */
11940 mouse_down_p
= (dpyinfo
->grabbed
11941 && f
== last_mouse_frame
11942 && FRAME_LIVE_P (f
));
11944 && last_tool_bar_item
!= prop_idx
)
11947 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11948 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11950 /* If tool-bar item is not enabled, don't highlight it. */
11951 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11952 if (!NILP (enabled_p
))
11954 /* Compute the x-position of the glyph. In front and past the
11955 image is a space. We include this in the highlighted area. */
11956 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11957 for (i
= x
= 0; i
< hpos
; ++i
)
11958 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11960 /* Record this as the current active region. */
11961 hlinfo
->mouse_face_beg_col
= hpos
;
11962 hlinfo
->mouse_face_beg_row
= vpos
;
11963 hlinfo
->mouse_face_beg_x
= x
;
11964 hlinfo
->mouse_face_beg_y
= row
->y
;
11965 hlinfo
->mouse_face_past_end
= 0;
11967 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11968 hlinfo
->mouse_face_end_row
= vpos
;
11969 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11970 hlinfo
->mouse_face_end_y
= row
->y
;
11971 hlinfo
->mouse_face_window
= window
;
11972 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11974 /* Display it as active. */
11975 show_mouse_face (hlinfo
, draw
);
11976 hlinfo
->mouse_face_image_state
= draw
;
11981 /* Set help_echo_string to a help string to display for this tool-bar item.
11982 XTread_socket does the rest. */
11983 help_echo_object
= help_echo_window
= Qnil
;
11984 help_echo_pos
= -1;
11985 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11986 if (NILP (help_echo_string
))
11987 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11990 #endif /* HAVE_WINDOW_SYSTEM */
11994 /************************************************************************
11995 Horizontal scrolling
11996 ************************************************************************/
11998 static int hscroll_window_tree (Lisp_Object
);
11999 static int hscroll_windows (Lisp_Object
);
12001 /* For all leaf windows in the window tree rooted at WINDOW, set their
12002 hscroll value so that PT is (i) visible in the window, and (ii) so
12003 that it is not within a certain margin at the window's left and
12004 right border. Value is non-zero if any window's hscroll has been
12008 hscroll_window_tree (Lisp_Object window
)
12010 int hscrolled_p
= 0;
12011 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12012 int hscroll_step_abs
= 0;
12013 double hscroll_step_rel
= 0;
12015 if (hscroll_relative_p
)
12017 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12018 if (hscroll_step_rel
< 0)
12020 hscroll_relative_p
= 0;
12021 hscroll_step_abs
= 0;
12024 else if (INTEGERP (Vhscroll_step
))
12026 hscroll_step_abs
= XINT (Vhscroll_step
);
12027 if (hscroll_step_abs
< 0)
12028 hscroll_step_abs
= 0;
12031 hscroll_step_abs
= 0;
12033 while (WINDOWP (window
))
12035 struct window
*w
= XWINDOW (window
);
12037 if (WINDOWP (w
->hchild
))
12038 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12039 else if (WINDOWP (w
->vchild
))
12040 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12041 else if (w
->cursor
.vpos
>= 0)
12044 int text_area_width
;
12045 struct glyph_row
*current_cursor_row
12046 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12047 struct glyph_row
*desired_cursor_row
12048 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12049 struct glyph_row
*cursor_row
12050 = (desired_cursor_row
->enabled_p
12051 ? desired_cursor_row
12052 : current_cursor_row
);
12054 text_area_width
= window_box_width (w
, TEXT_AREA
);
12056 /* Scroll when cursor is inside this scroll margin. */
12057 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12059 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12060 && ((XFASTINT (w
->hscroll
)
12061 && w
->cursor
.x
<= h_margin
)
12062 || (cursor_row
->enabled_p
12063 && cursor_row
->truncated_on_right_p
12064 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12068 struct buffer
*saved_current_buffer
;
12072 /* Find point in a display of infinite width. */
12073 saved_current_buffer
= current_buffer
;
12074 current_buffer
= XBUFFER (w
->buffer
);
12076 if (w
== XWINDOW (selected_window
))
12080 pt
= marker_position (w
->pointm
);
12081 pt
= max (BEGV
, pt
);
12085 /* Move iterator to pt starting at cursor_row->start in
12086 a line with infinite width. */
12087 init_to_row_start (&it
, w
, cursor_row
);
12088 it
.last_visible_x
= INFINITY
;
12089 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12090 current_buffer
= saved_current_buffer
;
12092 /* Position cursor in window. */
12093 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12094 hscroll
= max (0, (it
.current_x
12095 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12096 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12097 : (text_area_width
/ 2))))
12098 / FRAME_COLUMN_WIDTH (it
.f
);
12099 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
12101 if (hscroll_relative_p
)
12102 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12105 wanted_x
= text_area_width
12106 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12109 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12113 if (hscroll_relative_p
)
12114 wanted_x
= text_area_width
* hscroll_step_rel
12117 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12120 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12122 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12124 /* Don't prevent redisplay optimizations if hscroll
12125 hasn't changed, as it will unnecessarily slow down
12127 if (XFASTINT (w
->hscroll
) != hscroll
)
12129 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12130 w
->hscroll
= make_number (hscroll
);
12139 /* Value is non-zero if hscroll of any leaf window has been changed. */
12140 return hscrolled_p
;
12144 /* Set hscroll so that cursor is visible and not inside horizontal
12145 scroll margins for all windows in the tree rooted at WINDOW. See
12146 also hscroll_window_tree above. Value is non-zero if any window's
12147 hscroll has been changed. If it has, desired matrices on the frame
12148 of WINDOW are cleared. */
12151 hscroll_windows (Lisp_Object window
)
12153 int hscrolled_p
= hscroll_window_tree (window
);
12155 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12156 return hscrolled_p
;
12161 /************************************************************************
12163 ************************************************************************/
12165 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12166 to a non-zero value. This is sometimes handy to have in a debugger
12171 /* First and last unchanged row for try_window_id. */
12173 static int debug_first_unchanged_at_end_vpos
;
12174 static int debug_last_unchanged_at_beg_vpos
;
12176 /* Delta vpos and y. */
12178 static int debug_dvpos
, debug_dy
;
12180 /* Delta in characters and bytes for try_window_id. */
12182 static EMACS_INT debug_delta
, debug_delta_bytes
;
12184 /* Values of window_end_pos and window_end_vpos at the end of
12187 static EMACS_INT debug_end_vpos
;
12189 /* Append a string to W->desired_matrix->method. FMT is a printf
12190 format string. If trace_redisplay_p is non-zero also printf the
12191 resulting string to stderr. */
12193 static void debug_method_add (struct window
*, char const *, ...)
12194 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12197 debug_method_add (struct window
*w
, char const *fmt
, ...)
12200 char *method
= w
->desired_matrix
->method
;
12201 int len
= strlen (method
);
12202 int size
= sizeof w
->desired_matrix
->method
;
12203 int remaining
= size
- len
- 1;
12206 va_start (ap
, fmt
);
12207 vsprintf (buffer
, fmt
, ap
);
12209 if (len
&& remaining
)
12212 --remaining
, ++len
;
12215 strncpy (method
+ len
, buffer
, remaining
);
12217 if (trace_redisplay_p
)
12218 fprintf (stderr
, "%p (%s): %s\n",
12220 ((BUFFERP (w
->buffer
)
12221 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12222 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12227 #endif /* GLYPH_DEBUG */
12230 /* Value is non-zero if all changes in window W, which displays
12231 current_buffer, are in the text between START and END. START is a
12232 buffer position, END is given as a distance from Z. Used in
12233 redisplay_internal for display optimization. */
12236 text_outside_line_unchanged_p (struct window
*w
,
12237 EMACS_INT start
, EMACS_INT end
)
12239 int unchanged_p
= 1;
12241 /* If text or overlays have changed, see where. */
12242 if (XFASTINT (w
->last_modified
) < MODIFF
12243 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12245 /* Gap in the line? */
12246 if (GPT
< start
|| Z
- GPT
< end
)
12249 /* Changes start in front of the line, or end after it? */
12251 && (BEG_UNCHANGED
< start
- 1
12252 || END_UNCHANGED
< end
))
12255 /* If selective display, can't optimize if changes start at the
12256 beginning of the line. */
12258 && INTEGERP (BVAR (current_buffer
, selective_display
))
12259 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12260 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12263 /* If there are overlays at the start or end of the line, these
12264 may have overlay strings with newlines in them. A change at
12265 START, for instance, may actually concern the display of such
12266 overlay strings as well, and they are displayed on different
12267 lines. So, quickly rule out this case. (For the future, it
12268 might be desirable to implement something more telling than
12269 just BEG/END_UNCHANGED.) */
12272 if (BEG
+ BEG_UNCHANGED
== start
12273 && overlay_touches_p (start
))
12275 if (END_UNCHANGED
== end
12276 && overlay_touches_p (Z
- end
))
12280 /* Under bidi reordering, adding or deleting a character in the
12281 beginning of a paragraph, before the first strong directional
12282 character, can change the base direction of the paragraph (unless
12283 the buffer specifies a fixed paragraph direction), which will
12284 require to redisplay the whole paragraph. It might be worthwhile
12285 to find the paragraph limits and widen the range of redisplayed
12286 lines to that, but for now just give up this optimization. */
12287 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12288 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12292 return unchanged_p
;
12296 /* Do a frame update, taking possible shortcuts into account. This is
12297 the main external entry point for redisplay.
12299 If the last redisplay displayed an echo area message and that message
12300 is no longer requested, we clear the echo area or bring back the
12301 mini-buffer if that is in use. */
12306 redisplay_internal ();
12311 overlay_arrow_string_or_property (Lisp_Object var
)
12315 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12318 return Voverlay_arrow_string
;
12321 /* Return 1 if there are any overlay-arrows in current_buffer. */
12323 overlay_arrow_in_current_buffer_p (void)
12327 for (vlist
= Voverlay_arrow_variable_list
;
12329 vlist
= XCDR (vlist
))
12331 Lisp_Object var
= XCAR (vlist
);
12334 if (!SYMBOLP (var
))
12336 val
= find_symbol_value (var
);
12338 && current_buffer
== XMARKER (val
)->buffer
)
12345 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12349 overlay_arrows_changed_p (void)
12353 for (vlist
= Voverlay_arrow_variable_list
;
12355 vlist
= XCDR (vlist
))
12357 Lisp_Object var
= XCAR (vlist
);
12358 Lisp_Object val
, pstr
;
12360 if (!SYMBOLP (var
))
12362 val
= find_symbol_value (var
);
12363 if (!MARKERP (val
))
12365 if (! EQ (COERCE_MARKER (val
),
12366 Fget (var
, Qlast_arrow_position
))
12367 || ! (pstr
= overlay_arrow_string_or_property (var
),
12368 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12374 /* Mark overlay arrows to be updated on next redisplay. */
12377 update_overlay_arrows (int up_to_date
)
12381 for (vlist
= Voverlay_arrow_variable_list
;
12383 vlist
= XCDR (vlist
))
12385 Lisp_Object var
= XCAR (vlist
);
12387 if (!SYMBOLP (var
))
12390 if (up_to_date
> 0)
12392 Lisp_Object val
= find_symbol_value (var
);
12393 Fput (var
, Qlast_arrow_position
,
12394 COERCE_MARKER (val
));
12395 Fput (var
, Qlast_arrow_string
,
12396 overlay_arrow_string_or_property (var
));
12398 else if (up_to_date
< 0
12399 || !NILP (Fget (var
, Qlast_arrow_position
)))
12401 Fput (var
, Qlast_arrow_position
, Qt
);
12402 Fput (var
, Qlast_arrow_string
, Qt
);
12408 /* Return overlay arrow string to display at row.
12409 Return integer (bitmap number) for arrow bitmap in left fringe.
12410 Return nil if no overlay arrow. */
12413 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12417 for (vlist
= Voverlay_arrow_variable_list
;
12419 vlist
= XCDR (vlist
))
12421 Lisp_Object var
= XCAR (vlist
);
12424 if (!SYMBOLP (var
))
12427 val
= find_symbol_value (var
);
12430 && current_buffer
== XMARKER (val
)->buffer
12431 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12433 if (FRAME_WINDOW_P (it
->f
)
12434 /* FIXME: if ROW->reversed_p is set, this should test
12435 the right fringe, not the left one. */
12436 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12438 #ifdef HAVE_WINDOW_SYSTEM
12439 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12442 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12443 return make_number (fringe_bitmap
);
12446 return make_number (-1); /* Use default arrow bitmap */
12448 return overlay_arrow_string_or_property (var
);
12455 /* Return 1 if point moved out of or into a composition. Otherwise
12456 return 0. PREV_BUF and PREV_PT are the last point buffer and
12457 position. BUF and PT are the current point buffer and position. */
12460 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12461 struct buffer
*buf
, EMACS_INT pt
)
12463 EMACS_INT start
, end
;
12465 Lisp_Object buffer
;
12467 XSETBUFFER (buffer
, buf
);
12468 /* Check a composition at the last point if point moved within the
12470 if (prev_buf
== buf
)
12473 /* Point didn't move. */
12476 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12477 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12478 && COMPOSITION_VALID_P (start
, end
, prop
)
12479 && start
< prev_pt
&& end
> prev_pt
)
12480 /* The last point was within the composition. Return 1 iff
12481 point moved out of the composition. */
12482 return (pt
<= start
|| pt
>= end
);
12485 /* Check a composition at the current point. */
12486 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12487 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12488 && COMPOSITION_VALID_P (start
, end
, prop
)
12489 && start
< pt
&& end
> pt
);
12493 /* Reconsider the setting of B->clip_changed which is displayed
12497 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12499 if (b
->clip_changed
12500 && !NILP (w
->window_end_valid
)
12501 && w
->current_matrix
->buffer
== b
12502 && w
->current_matrix
->zv
== BUF_ZV (b
)
12503 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12504 b
->clip_changed
= 0;
12506 /* If display wasn't paused, and W is not a tool bar window, see if
12507 point has been moved into or out of a composition. In that case,
12508 we set b->clip_changed to 1 to force updating the screen. If
12509 b->clip_changed has already been set to 1, we can skip this
12511 if (!b
->clip_changed
12512 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12516 if (w
== XWINDOW (selected_window
))
12519 pt
= marker_position (w
->pointm
);
12521 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12522 || pt
!= XINT (w
->last_point
))
12523 && check_point_in_composition (w
->current_matrix
->buffer
,
12524 XINT (w
->last_point
),
12525 XBUFFER (w
->buffer
), pt
))
12526 b
->clip_changed
= 1;
12531 /* Select FRAME to forward the values of frame-local variables into C
12532 variables so that the redisplay routines can access those values
12536 select_frame_for_redisplay (Lisp_Object frame
)
12538 Lisp_Object tail
, tem
;
12539 Lisp_Object old
= selected_frame
;
12540 struct Lisp_Symbol
*sym
;
12542 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12544 selected_frame
= frame
;
12547 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12548 if (CONSP (XCAR (tail
))
12549 && (tem
= XCAR (XCAR (tail
)),
12551 && (sym
= indirect_variable (XSYMBOL (tem
)),
12552 sym
->redirect
== SYMBOL_LOCALIZED
)
12553 && sym
->val
.blv
->frame_local
)
12554 /* Use find_symbol_value rather than Fsymbol_value
12555 to avoid an error if it is void. */
12556 find_symbol_value (tem
);
12557 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12561 #define STOP_POLLING \
12562 do { if (! polling_stopped_here) stop_polling (); \
12563 polling_stopped_here = 1; } while (0)
12565 #define RESUME_POLLING \
12566 do { if (polling_stopped_here) start_polling (); \
12567 polling_stopped_here = 0; } while (0)
12570 /* Perhaps in the future avoid recentering windows if it
12571 is not necessary; currently that causes some problems. */
12574 redisplay_internal (void)
12576 struct window
*w
= XWINDOW (selected_window
);
12580 int must_finish
= 0;
12581 struct text_pos tlbufpos
, tlendpos
;
12582 int number_of_visible_frames
;
12585 int polling_stopped_here
= 0;
12586 Lisp_Object old_frame
= selected_frame
;
12588 /* Non-zero means redisplay has to consider all windows on all
12589 frames. Zero means, only selected_window is considered. */
12590 int consider_all_windows_p
;
12592 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12594 /* No redisplay if running in batch mode or frame is not yet fully
12595 initialized, or redisplay is explicitly turned off by setting
12596 Vinhibit_redisplay. */
12597 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12598 || !NILP (Vinhibit_redisplay
))
12601 /* Don't examine these until after testing Vinhibit_redisplay.
12602 When Emacs is shutting down, perhaps because its connection to
12603 X has dropped, we should not look at them at all. */
12604 fr
= XFRAME (w
->frame
);
12605 sf
= SELECTED_FRAME ();
12607 if (!fr
->glyphs_initialized_p
)
12610 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12611 if (popup_activated ())
12615 /* I don't think this happens but let's be paranoid. */
12616 if (redisplaying_p
)
12619 /* Record a function that resets redisplaying_p to its old value
12620 when we leave this function. */
12621 count
= SPECPDL_INDEX ();
12622 record_unwind_protect (unwind_redisplay
,
12623 Fcons (make_number (redisplaying_p
), selected_frame
));
12625 specbind (Qinhibit_free_realized_faces
, Qnil
);
12628 Lisp_Object tail
, frame
;
12630 FOR_EACH_FRAME (tail
, frame
)
12632 struct frame
*f
= XFRAME (frame
);
12633 f
->already_hscrolled_p
= 0;
12638 /* Remember the currently selected window. */
12641 if (!EQ (old_frame
, selected_frame
)
12642 && FRAME_LIVE_P (XFRAME (old_frame
)))
12643 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12644 selected_frame and selected_window to be temporarily out-of-sync so
12645 when we come back here via `goto retry', we need to resync because we
12646 may need to run Elisp code (via prepare_menu_bars). */
12647 select_frame_for_redisplay (old_frame
);
12650 reconsider_clip_changes (w
, current_buffer
);
12651 last_escape_glyph_frame
= NULL
;
12652 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12653 last_glyphless_glyph_frame
= NULL
;
12654 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12656 /* If new fonts have been loaded that make a glyph matrix adjustment
12657 necessary, do it. */
12658 if (fonts_changed_p
)
12660 adjust_glyphs (NULL
);
12661 ++windows_or_buffers_changed
;
12662 fonts_changed_p
= 0;
12665 /* If face_change_count is non-zero, init_iterator will free all
12666 realized faces, which includes the faces referenced from current
12667 matrices. So, we can't reuse current matrices in this case. */
12668 if (face_change_count
)
12669 ++windows_or_buffers_changed
;
12671 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12672 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12674 /* Since frames on a single ASCII terminal share the same
12675 display area, displaying a different frame means redisplay
12676 the whole thing. */
12677 windows_or_buffers_changed
++;
12678 SET_FRAME_GARBAGED (sf
);
12680 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12682 FRAME_TTY (sf
)->previous_frame
= sf
;
12685 /* Set the visible flags for all frames. Do this before checking
12686 for resized or garbaged frames; they want to know if their frames
12687 are visible. See the comment in frame.h for
12688 FRAME_SAMPLE_VISIBILITY. */
12690 Lisp_Object tail
, frame
;
12692 number_of_visible_frames
= 0;
12694 FOR_EACH_FRAME (tail
, frame
)
12696 struct frame
*f
= XFRAME (frame
);
12698 FRAME_SAMPLE_VISIBILITY (f
);
12699 if (FRAME_VISIBLE_P (f
))
12700 ++number_of_visible_frames
;
12701 clear_desired_matrices (f
);
12705 /* Notice any pending interrupt request to change frame size. */
12706 do_pending_window_change (1);
12708 /* do_pending_window_change could change the selected_window due to
12709 frame resizing which makes the selected window too small. */
12710 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12713 reconsider_clip_changes (w
, current_buffer
);
12716 /* Clear frames marked as garbaged. */
12717 if (frame_garbaged
)
12718 clear_garbaged_frames ();
12720 /* Build menubar and tool-bar items. */
12721 if (NILP (Vmemory_full
))
12722 prepare_menu_bars ();
12724 if (windows_or_buffers_changed
)
12725 update_mode_lines
++;
12727 /* Detect case that we need to write or remove a star in the mode line. */
12728 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12730 w
->update_mode_line
= Qt
;
12731 if (buffer_shared
> 1)
12732 update_mode_lines
++;
12735 /* Avoid invocation of point motion hooks by `current_column' below. */
12736 count1
= SPECPDL_INDEX ();
12737 specbind (Qinhibit_point_motion_hooks
, Qt
);
12739 /* If %c is in the mode line, update it if needed. */
12740 if (!NILP (w
->column_number_displayed
)
12741 /* This alternative quickly identifies a common case
12742 where no change is needed. */
12743 && !(PT
== XFASTINT (w
->last_point
)
12744 && XFASTINT (w
->last_modified
) >= MODIFF
12745 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12746 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12747 w
->update_mode_line
= Qt
;
12749 unbind_to (count1
, Qnil
);
12751 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12753 /* The variable buffer_shared is set in redisplay_window and
12754 indicates that we redisplay a buffer in different windows. See
12756 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12757 || cursor_type_changed
);
12759 /* If specs for an arrow have changed, do thorough redisplay
12760 to ensure we remove any arrow that should no longer exist. */
12761 if (overlay_arrows_changed_p ())
12762 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12764 /* Normally the message* functions will have already displayed and
12765 updated the echo area, but the frame may have been trashed, or
12766 the update may have been preempted, so display the echo area
12767 again here. Checking message_cleared_p captures the case that
12768 the echo area should be cleared. */
12769 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12770 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12771 || (message_cleared_p
12772 && minibuf_level
== 0
12773 /* If the mini-window is currently selected, this means the
12774 echo-area doesn't show through. */
12775 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12777 int window_height_changed_p
= echo_area_display (0);
12780 /* If we don't display the current message, don't clear the
12781 message_cleared_p flag, because, if we did, we wouldn't clear
12782 the echo area in the next redisplay which doesn't preserve
12784 if (!display_last_displayed_message_p
)
12785 message_cleared_p
= 0;
12787 if (fonts_changed_p
)
12789 else if (window_height_changed_p
)
12791 consider_all_windows_p
= 1;
12792 ++update_mode_lines
;
12793 ++windows_or_buffers_changed
;
12795 /* If window configuration was changed, frames may have been
12796 marked garbaged. Clear them or we will experience
12797 surprises wrt scrolling. */
12798 if (frame_garbaged
)
12799 clear_garbaged_frames ();
12802 else if (EQ (selected_window
, minibuf_window
)
12803 && (current_buffer
->clip_changed
12804 || XFASTINT (w
->last_modified
) < MODIFF
12805 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12806 && resize_mini_window (w
, 0))
12808 /* Resized active mini-window to fit the size of what it is
12809 showing if its contents might have changed. */
12811 /* FIXME: this causes all frames to be updated, which seems unnecessary
12812 since only the current frame needs to be considered. This function needs
12813 to be rewritten with two variables, consider_all_windows and
12814 consider_all_frames. */
12815 consider_all_windows_p
= 1;
12816 ++windows_or_buffers_changed
;
12817 ++update_mode_lines
;
12819 /* If window configuration was changed, frames may have been
12820 marked garbaged. Clear them or we will experience
12821 surprises wrt scrolling. */
12822 if (frame_garbaged
)
12823 clear_garbaged_frames ();
12827 /* If showing the region, and mark has changed, we must redisplay
12828 the whole window. The assignment to this_line_start_pos prevents
12829 the optimization directly below this if-statement. */
12830 if (((!NILP (Vtransient_mark_mode
)
12831 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12832 != !NILP (w
->region_showing
))
12833 || (!NILP (w
->region_showing
)
12834 && !EQ (w
->region_showing
,
12835 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12836 CHARPOS (this_line_start_pos
) = 0;
12838 /* Optimize the case that only the line containing the cursor in the
12839 selected window has changed. Variables starting with this_ are
12840 set in display_line and record information about the line
12841 containing the cursor. */
12842 tlbufpos
= this_line_start_pos
;
12843 tlendpos
= this_line_end_pos
;
12844 if (!consider_all_windows_p
12845 && CHARPOS (tlbufpos
) > 0
12846 && NILP (w
->update_mode_line
)
12847 && !current_buffer
->clip_changed
12848 && !current_buffer
->prevent_redisplay_optimizations_p
12849 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12850 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12851 /* Make sure recorded data applies to current buffer, etc. */
12852 && this_line_buffer
== current_buffer
12853 && current_buffer
== XBUFFER (w
->buffer
)
12854 && NILP (w
->force_start
)
12855 && NILP (w
->optional_new_start
)
12856 /* Point must be on the line that we have info recorded about. */
12857 && PT
>= CHARPOS (tlbufpos
)
12858 && PT
<= Z
- CHARPOS (tlendpos
)
12859 /* All text outside that line, including its final newline,
12860 must be unchanged. */
12861 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12862 CHARPOS (tlendpos
)))
12864 if (CHARPOS (tlbufpos
) > BEGV
12865 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12866 && (CHARPOS (tlbufpos
) == ZV
12867 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12868 /* Former continuation line has disappeared by becoming empty. */
12870 else if (XFASTINT (w
->last_modified
) < MODIFF
12871 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12872 || MINI_WINDOW_P (w
))
12874 /* We have to handle the case of continuation around a
12875 wide-column character (see the comment in indent.c around
12878 For instance, in the following case:
12880 -------- Insert --------
12881 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12882 J_I_ ==> J_I_ `^^' are cursors.
12886 As we have to redraw the line above, we cannot use this
12890 int line_height_before
= this_line_pixel_height
;
12892 /* Note that start_display will handle the case that the
12893 line starting at tlbufpos is a continuation line. */
12894 start_display (&it
, w
, tlbufpos
);
12896 /* Implementation note: It this still necessary? */
12897 if (it
.current_x
!= this_line_start_x
)
12900 TRACE ((stderr
, "trying display optimization 1\n"));
12901 w
->cursor
.vpos
= -1;
12902 overlay_arrow_seen
= 0;
12903 it
.vpos
= this_line_vpos
;
12904 it
.current_y
= this_line_y
;
12905 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12906 display_line (&it
);
12908 /* If line contains point, is not continued,
12909 and ends at same distance from eob as before, we win. */
12910 if (w
->cursor
.vpos
>= 0
12911 /* Line is not continued, otherwise this_line_start_pos
12912 would have been set to 0 in display_line. */
12913 && CHARPOS (this_line_start_pos
)
12914 /* Line ends as before. */
12915 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12916 /* Line has same height as before. Otherwise other lines
12917 would have to be shifted up or down. */
12918 && this_line_pixel_height
== line_height_before
)
12920 /* If this is not the window's last line, we must adjust
12921 the charstarts of the lines below. */
12922 if (it
.current_y
< it
.last_visible_y
)
12924 struct glyph_row
*row
12925 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12926 EMACS_INT delta
, delta_bytes
;
12928 /* We used to distinguish between two cases here,
12929 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12930 when the line ends in a newline or the end of the
12931 buffer's accessible portion. But both cases did
12932 the same, so they were collapsed. */
12934 - CHARPOS (tlendpos
)
12935 - MATRIX_ROW_START_CHARPOS (row
));
12936 delta_bytes
= (Z_BYTE
12937 - BYTEPOS (tlendpos
)
12938 - MATRIX_ROW_START_BYTEPOS (row
));
12940 increment_matrix_positions (w
->current_matrix
,
12941 this_line_vpos
+ 1,
12942 w
->current_matrix
->nrows
,
12943 delta
, delta_bytes
);
12946 /* If this row displays text now but previously didn't,
12947 or vice versa, w->window_end_vpos may have to be
12949 if ((it
.glyph_row
- 1)->displays_text_p
)
12951 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12952 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12954 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12955 && this_line_vpos
> 0)
12956 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12957 w
->window_end_valid
= Qnil
;
12959 /* Update hint: No need to try to scroll in update_window. */
12960 w
->desired_matrix
->no_scrolling_p
= 1;
12963 *w
->desired_matrix
->method
= 0;
12964 debug_method_add (w
, "optimization 1");
12966 #ifdef HAVE_WINDOW_SYSTEM
12967 update_window_fringes (w
, 0);
12974 else if (/* Cursor position hasn't changed. */
12975 PT
== XFASTINT (w
->last_point
)
12976 /* Make sure the cursor was last displayed
12977 in this window. Otherwise we have to reposition it. */
12978 && 0 <= w
->cursor
.vpos
12979 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12983 do_pending_window_change (1);
12984 /* If selected_window changed, redisplay again. */
12985 if (WINDOWP (selected_window
)
12986 && (w
= XWINDOW (selected_window
)) != sw
)
12989 /* We used to always goto end_of_redisplay here, but this
12990 isn't enough if we have a blinking cursor. */
12991 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12992 goto end_of_redisplay
;
12996 /* If highlighting the region, or if the cursor is in the echo area,
12997 then we can't just move the cursor. */
12998 else if (! (!NILP (Vtransient_mark_mode
)
12999 && !NILP (BVAR (current_buffer
, mark_active
)))
13000 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13001 || highlight_nonselected_windows
)
13002 && NILP (w
->region_showing
)
13003 && NILP (Vshow_trailing_whitespace
)
13004 && !cursor_in_echo_area
)
13007 struct glyph_row
*row
;
13009 /* Skip from tlbufpos to PT and see where it is. Note that
13010 PT may be in invisible text. If so, we will end at the
13011 next visible position. */
13012 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13013 NULL
, DEFAULT_FACE_ID
);
13014 it
.current_x
= this_line_start_x
;
13015 it
.current_y
= this_line_y
;
13016 it
.vpos
= this_line_vpos
;
13018 /* The call to move_it_to stops in front of PT, but
13019 moves over before-strings. */
13020 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13022 if (it
.vpos
== this_line_vpos
13023 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13026 xassert (this_line_vpos
== it
.vpos
);
13027 xassert (this_line_y
== it
.current_y
);
13028 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13030 *w
->desired_matrix
->method
= 0;
13031 debug_method_add (w
, "optimization 3");
13040 /* Text changed drastically or point moved off of line. */
13041 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13044 CHARPOS (this_line_start_pos
) = 0;
13045 consider_all_windows_p
|= buffer_shared
> 1;
13046 ++clear_face_cache_count
;
13047 #ifdef HAVE_WINDOW_SYSTEM
13048 ++clear_image_cache_count
;
13051 /* Build desired matrices, and update the display. If
13052 consider_all_windows_p is non-zero, do it for all windows on all
13053 frames. Otherwise do it for selected_window, only. */
13055 if (consider_all_windows_p
)
13057 Lisp_Object tail
, frame
;
13059 FOR_EACH_FRAME (tail
, frame
)
13060 XFRAME (frame
)->updated_p
= 0;
13062 /* Recompute # windows showing selected buffer. This will be
13063 incremented each time such a window is displayed. */
13066 FOR_EACH_FRAME (tail
, frame
)
13068 struct frame
*f
= XFRAME (frame
);
13070 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13072 if (! EQ (frame
, selected_frame
))
13073 /* Select the frame, for the sake of frame-local
13075 select_frame_for_redisplay (frame
);
13077 /* Mark all the scroll bars to be removed; we'll redeem
13078 the ones we want when we redisplay their windows. */
13079 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13080 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13082 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13083 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13085 /* The X error handler may have deleted that frame. */
13086 if (!FRAME_LIVE_P (f
))
13089 /* Any scroll bars which redisplay_windows should have
13090 nuked should now go away. */
13091 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13092 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13094 /* If fonts changed, display again. */
13095 /* ??? rms: I suspect it is a mistake to jump all the way
13096 back to retry here. It should just retry this frame. */
13097 if (fonts_changed_p
)
13100 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13102 /* See if we have to hscroll. */
13103 if (!f
->already_hscrolled_p
)
13105 f
->already_hscrolled_p
= 1;
13106 if (hscroll_windows (f
->root_window
))
13110 /* Prevent various kinds of signals during display
13111 update. stdio is not robust about handling
13112 signals, which can cause an apparent I/O
13114 if (interrupt_input
)
13115 unrequest_sigio ();
13118 /* Update the display. */
13119 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13120 pending
|= update_frame (f
, 0, 0);
13126 if (!EQ (old_frame
, selected_frame
)
13127 && FRAME_LIVE_P (XFRAME (old_frame
)))
13128 /* We played a bit fast-and-loose above and allowed selected_frame
13129 and selected_window to be temporarily out-of-sync but let's make
13130 sure this stays contained. */
13131 select_frame_for_redisplay (old_frame
);
13132 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13136 /* Do the mark_window_display_accurate after all windows have
13137 been redisplayed because this call resets flags in buffers
13138 which are needed for proper redisplay. */
13139 FOR_EACH_FRAME (tail
, frame
)
13141 struct frame
*f
= XFRAME (frame
);
13144 mark_window_display_accurate (f
->root_window
, 1);
13145 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13146 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13151 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13153 Lisp_Object mini_window
;
13154 struct frame
*mini_frame
;
13156 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13157 /* Use list_of_error, not Qerror, so that
13158 we catch only errors and don't run the debugger. */
13159 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13161 redisplay_window_error
);
13163 /* Compare desired and current matrices, perform output. */
13166 /* If fonts changed, display again. */
13167 if (fonts_changed_p
)
13170 /* Prevent various kinds of signals during display update.
13171 stdio is not robust about handling signals,
13172 which can cause an apparent I/O error. */
13173 if (interrupt_input
)
13174 unrequest_sigio ();
13177 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13179 if (hscroll_windows (selected_window
))
13182 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13183 pending
= update_frame (sf
, 0, 0);
13186 /* We may have called echo_area_display at the top of this
13187 function. If the echo area is on another frame, that may
13188 have put text on a frame other than the selected one, so the
13189 above call to update_frame would not have caught it. Catch
13191 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13192 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13194 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13196 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13197 pending
|= update_frame (mini_frame
, 0, 0);
13198 if (!pending
&& hscroll_windows (mini_window
))
13203 /* If display was paused because of pending input, make sure we do a
13204 thorough update the next time. */
13207 /* Prevent the optimization at the beginning of
13208 redisplay_internal that tries a single-line update of the
13209 line containing the cursor in the selected window. */
13210 CHARPOS (this_line_start_pos
) = 0;
13212 /* Let the overlay arrow be updated the next time. */
13213 update_overlay_arrows (0);
13215 /* If we pause after scrolling, some rows in the current
13216 matrices of some windows are not valid. */
13217 if (!WINDOW_FULL_WIDTH_P (w
)
13218 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13219 update_mode_lines
= 1;
13223 if (!consider_all_windows_p
)
13225 /* This has already been done above if
13226 consider_all_windows_p is set. */
13227 mark_window_display_accurate_1 (w
, 1);
13229 /* Say overlay arrows are up to date. */
13230 update_overlay_arrows (1);
13232 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13233 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13236 update_mode_lines
= 0;
13237 windows_or_buffers_changed
= 0;
13238 cursor_type_changed
= 0;
13241 /* Start SIGIO interrupts coming again. Having them off during the
13242 code above makes it less likely one will discard output, but not
13243 impossible, since there might be stuff in the system buffer here.
13244 But it is much hairier to try to do anything about that. */
13245 if (interrupt_input
)
13249 /* If a frame has become visible which was not before, redisplay
13250 again, so that we display it. Expose events for such a frame
13251 (which it gets when becoming visible) don't call the parts of
13252 redisplay constructing glyphs, so simply exposing a frame won't
13253 display anything in this case. So, we have to display these
13254 frames here explicitly. */
13257 Lisp_Object tail
, frame
;
13260 FOR_EACH_FRAME (tail
, frame
)
13262 int this_is_visible
= 0;
13264 if (XFRAME (frame
)->visible
)
13265 this_is_visible
= 1;
13266 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13267 if (XFRAME (frame
)->visible
)
13268 this_is_visible
= 1;
13270 if (this_is_visible
)
13274 if (new_count
!= number_of_visible_frames
)
13275 windows_or_buffers_changed
++;
13278 /* Change frame size now if a change is pending. */
13279 do_pending_window_change (1);
13281 /* If we just did a pending size change, or have additional
13282 visible frames, or selected_window changed, redisplay again. */
13283 if ((windows_or_buffers_changed
&& !pending
)
13284 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13287 /* Clear the face and image caches.
13289 We used to do this only if consider_all_windows_p. But the cache
13290 needs to be cleared if a timer creates images in the current
13291 buffer (e.g. the test case in Bug#6230). */
13293 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13295 clear_face_cache (0);
13296 clear_face_cache_count
= 0;
13299 #ifdef HAVE_WINDOW_SYSTEM
13300 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13302 clear_image_caches (Qnil
);
13303 clear_image_cache_count
= 0;
13305 #endif /* HAVE_WINDOW_SYSTEM */
13308 unbind_to (count
, Qnil
);
13313 /* Redisplay, but leave alone any recent echo area message unless
13314 another message has been requested in its place.
13316 This is useful in situations where you need to redisplay but no
13317 user action has occurred, making it inappropriate for the message
13318 area to be cleared. See tracking_off and
13319 wait_reading_process_output for examples of these situations.
13321 FROM_WHERE is an integer saying from where this function was
13322 called. This is useful for debugging. */
13325 redisplay_preserve_echo_area (int from_where
)
13327 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13329 if (!NILP (echo_area_buffer
[1]))
13331 /* We have a previously displayed message, but no current
13332 message. Redisplay the previous message. */
13333 display_last_displayed_message_p
= 1;
13334 redisplay_internal ();
13335 display_last_displayed_message_p
= 0;
13338 redisplay_internal ();
13340 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13341 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13342 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13346 /* Function registered with record_unwind_protect in
13347 redisplay_internal. Reset redisplaying_p to the value it had
13348 before redisplay_internal was called, and clear
13349 prevent_freeing_realized_faces_p. It also selects the previously
13350 selected frame, unless it has been deleted (by an X connection
13351 failure during redisplay, for example). */
13354 unwind_redisplay (Lisp_Object val
)
13356 Lisp_Object old_redisplaying_p
, old_frame
;
13358 old_redisplaying_p
= XCAR (val
);
13359 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13360 old_frame
= XCDR (val
);
13361 if (! EQ (old_frame
, selected_frame
)
13362 && FRAME_LIVE_P (XFRAME (old_frame
)))
13363 select_frame_for_redisplay (old_frame
);
13368 /* Mark the display of window W as accurate or inaccurate. If
13369 ACCURATE_P is non-zero mark display of W as accurate. If
13370 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13371 redisplay_internal is called. */
13374 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13376 if (BUFFERP (w
->buffer
))
13378 struct buffer
*b
= XBUFFER (w
->buffer
);
13381 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13382 w
->last_overlay_modified
13383 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13385 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13389 b
->clip_changed
= 0;
13390 b
->prevent_redisplay_optimizations_p
= 0;
13392 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13393 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13394 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13395 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13397 w
->current_matrix
->buffer
= b
;
13398 w
->current_matrix
->begv
= BUF_BEGV (b
);
13399 w
->current_matrix
->zv
= BUF_ZV (b
);
13401 w
->last_cursor
= w
->cursor
;
13402 w
->last_cursor_off_p
= w
->cursor_off_p
;
13404 if (w
== XWINDOW (selected_window
))
13405 w
->last_point
= make_number (BUF_PT (b
));
13407 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13413 w
->window_end_valid
= w
->buffer
;
13414 w
->update_mode_line
= Qnil
;
13419 /* Mark the display of windows in the window tree rooted at WINDOW as
13420 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13421 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13422 be redisplayed the next time redisplay_internal is called. */
13425 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13429 for (; !NILP (window
); window
= w
->next
)
13431 w
= XWINDOW (window
);
13432 mark_window_display_accurate_1 (w
, accurate_p
);
13434 if (!NILP (w
->vchild
))
13435 mark_window_display_accurate (w
->vchild
, accurate_p
);
13436 if (!NILP (w
->hchild
))
13437 mark_window_display_accurate (w
->hchild
, accurate_p
);
13442 update_overlay_arrows (1);
13446 /* Force a thorough redisplay the next time by setting
13447 last_arrow_position and last_arrow_string to t, which is
13448 unequal to any useful value of Voverlay_arrow_... */
13449 update_overlay_arrows (-1);
13454 /* Return value in display table DP (Lisp_Char_Table *) for character
13455 C. Since a display table doesn't have any parent, we don't have to
13456 follow parent. Do not call this function directly but use the
13457 macro DISP_CHAR_VECTOR. */
13460 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13464 if (ASCII_CHAR_P (c
))
13467 if (SUB_CHAR_TABLE_P (val
))
13468 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13474 XSETCHAR_TABLE (table
, dp
);
13475 val
= char_table_ref (table
, c
);
13484 /***********************************************************************
13486 ***********************************************************************/
13488 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13491 redisplay_windows (Lisp_Object window
)
13493 while (!NILP (window
))
13495 struct window
*w
= XWINDOW (window
);
13497 if (!NILP (w
->hchild
))
13498 redisplay_windows (w
->hchild
);
13499 else if (!NILP (w
->vchild
))
13500 redisplay_windows (w
->vchild
);
13501 else if (!NILP (w
->buffer
))
13503 displayed_buffer
= XBUFFER (w
->buffer
);
13504 /* Use list_of_error, not Qerror, so that
13505 we catch only errors and don't run the debugger. */
13506 internal_condition_case_1 (redisplay_window_0
, window
,
13508 redisplay_window_error
);
13516 redisplay_window_error (Lisp_Object ignore
)
13518 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13523 redisplay_window_0 (Lisp_Object window
)
13525 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13526 redisplay_window (window
, 0);
13531 redisplay_window_1 (Lisp_Object window
)
13533 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13534 redisplay_window (window
, 1);
13539 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13540 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13541 which positions recorded in ROW differ from current buffer
13544 Return 0 if cursor is not on this row, 1 otherwise. */
13547 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13548 struct glyph_matrix
*matrix
,
13549 EMACS_INT delta
, EMACS_INT delta_bytes
,
13552 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13553 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13554 struct glyph
*cursor
= NULL
;
13555 /* The last known character position in row. */
13556 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13558 EMACS_INT pt_old
= PT
- delta
;
13559 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13560 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13561 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13562 /* A glyph beyond the edge of TEXT_AREA which we should never
13564 struct glyph
*glyphs_end
= end
;
13565 /* Non-zero means we've found a match for cursor position, but that
13566 glyph has the avoid_cursor_p flag set. */
13567 int match_with_avoid_cursor
= 0;
13568 /* Non-zero means we've seen at least one glyph that came from a
13570 int string_seen
= 0;
13571 /* Largest and smalles buffer positions seen so far during scan of
13573 EMACS_INT bpos_max
= pos_before
;
13574 EMACS_INT bpos_min
= pos_after
;
13575 /* Last buffer position covered by an overlay string with an integer
13576 `cursor' property. */
13577 EMACS_INT bpos_covered
= 0;
13578 /* Non-zero means the display string on which to display the cursor
13579 comes from a text property, not from an overlay. */
13580 int string_from_text_prop
= 0;
13582 /* Skip over glyphs not having an object at the start and the end of
13583 the row. These are special glyphs like truncation marks on
13584 terminal frames. */
13585 if (row
->displays_text_p
)
13587 if (!row
->reversed_p
)
13590 && INTEGERP (glyph
->object
)
13591 && glyph
->charpos
< 0)
13593 x
+= glyph
->pixel_width
;
13597 && INTEGERP ((end
- 1)->object
)
13598 /* CHARPOS is zero for blanks and stretch glyphs
13599 inserted by extend_face_to_end_of_line. */
13600 && (end
- 1)->charpos
<= 0)
13602 glyph_before
= glyph
- 1;
13609 /* If the glyph row is reversed, we need to process it from back
13610 to front, so swap the edge pointers. */
13611 glyphs_end
= end
= glyph
- 1;
13612 glyph
+= row
->used
[TEXT_AREA
] - 1;
13614 while (glyph
> end
+ 1
13615 && INTEGERP (glyph
->object
)
13616 && glyph
->charpos
< 0)
13619 x
-= glyph
->pixel_width
;
13621 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13623 /* By default, in reversed rows we put the cursor on the
13624 rightmost (first in the reading order) glyph. */
13625 for (g
= end
+ 1; g
< glyph
; g
++)
13626 x
+= g
->pixel_width
;
13628 && INTEGERP ((end
+ 1)->object
)
13629 && (end
+ 1)->charpos
<= 0)
13631 glyph_before
= glyph
+ 1;
13635 else if (row
->reversed_p
)
13637 /* In R2L rows that don't display text, put the cursor on the
13638 rightmost glyph. Case in point: an empty last line that is
13639 part of an R2L paragraph. */
13641 /* Avoid placing the cursor on the last glyph of the row, where
13642 on terminal frames we hold the vertical border between
13643 adjacent windows. */
13644 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13645 && !WINDOW_RIGHTMOST_P (w
)
13646 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13648 x
= -1; /* will be computed below, at label compute_x */
13651 /* Step 1: Try to find the glyph whose character position
13652 corresponds to point. If that's not possible, find 2 glyphs
13653 whose character positions are the closest to point, one before
13654 point, the other after it. */
13655 if (!row
->reversed_p
)
13656 while (/* not marched to end of glyph row */
13658 /* glyph was not inserted by redisplay for internal purposes */
13659 && !INTEGERP (glyph
->object
))
13661 if (BUFFERP (glyph
->object
))
13663 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13665 if (glyph
->charpos
> bpos_max
)
13666 bpos_max
= glyph
->charpos
;
13667 if (glyph
->charpos
< bpos_min
)
13668 bpos_min
= glyph
->charpos
;
13669 if (!glyph
->avoid_cursor_p
)
13671 /* If we hit point, we've found the glyph on which to
13672 display the cursor. */
13675 match_with_avoid_cursor
= 0;
13678 /* See if we've found a better approximation to
13679 POS_BEFORE or to POS_AFTER. Note that we want the
13680 first (leftmost) glyph of all those that are the
13681 closest from below, and the last (rightmost) of all
13682 those from above. */
13683 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13685 pos_before
= glyph
->charpos
;
13686 glyph_before
= glyph
;
13688 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13690 pos_after
= glyph
->charpos
;
13691 glyph_after
= glyph
;
13694 else if (dpos
== 0)
13695 match_with_avoid_cursor
= 1;
13697 else if (STRINGP (glyph
->object
))
13699 Lisp_Object chprop
;
13700 EMACS_INT glyph_pos
= glyph
->charpos
;
13702 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13704 if (INTEGERP (chprop
))
13706 bpos_covered
= bpos_max
+ XINT (chprop
);
13707 /* If the `cursor' property covers buffer positions up
13708 to and including point, we should display cursor on
13709 this glyph. Note that overlays and text properties
13710 with string values stop bidi reordering, so every
13711 buffer position to the left of the string is always
13712 smaller than any position to the right of the
13713 string. Therefore, if a `cursor' property on one
13714 of the string's characters has an integer value, we
13715 will break out of the loop below _before_ we get to
13716 the position match above. IOW, integer values of
13717 the `cursor' property override the "exact match for
13718 point" strategy of positioning the cursor. */
13719 /* Implementation note: bpos_max == pt_old when, e.g.,
13720 we are in an empty line, where bpos_max is set to
13721 MATRIX_ROW_START_CHARPOS, see above. */
13722 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13731 x
+= glyph
->pixel_width
;
13734 else if (glyph
> end
) /* row is reversed */
13735 while (!INTEGERP (glyph
->object
))
13737 if (BUFFERP (glyph
->object
))
13739 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13741 if (glyph
->charpos
> bpos_max
)
13742 bpos_max
= glyph
->charpos
;
13743 if (glyph
->charpos
< bpos_min
)
13744 bpos_min
= glyph
->charpos
;
13745 if (!glyph
->avoid_cursor_p
)
13749 match_with_avoid_cursor
= 0;
13752 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13754 pos_before
= glyph
->charpos
;
13755 glyph_before
= glyph
;
13757 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13759 pos_after
= glyph
->charpos
;
13760 glyph_after
= glyph
;
13763 else if (dpos
== 0)
13764 match_with_avoid_cursor
= 1;
13766 else if (STRINGP (glyph
->object
))
13768 Lisp_Object chprop
;
13769 EMACS_INT glyph_pos
= glyph
->charpos
;
13771 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13773 if (INTEGERP (chprop
))
13775 bpos_covered
= bpos_max
+ XINT (chprop
);
13776 /* If the `cursor' property covers buffer positions up
13777 to and including point, we should display cursor on
13779 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13788 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13790 x
--; /* can't use any pixel_width */
13793 x
-= glyph
->pixel_width
;
13796 /* Step 2: If we didn't find an exact match for point, we need to
13797 look for a proper place to put the cursor among glyphs between
13798 GLYPH_BEFORE and GLYPH_AFTER. */
13799 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13800 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13801 && bpos_covered
< pt_old
)
13803 /* An empty line has a single glyph whose OBJECT is zero and
13804 whose CHARPOS is the position of a newline on that line.
13805 Note that on a TTY, there are more glyphs after that, which
13806 were produced by extend_face_to_end_of_line, but their
13807 CHARPOS is zero or negative. */
13809 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13810 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13812 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13814 EMACS_INT ellipsis_pos
;
13816 /* Scan back over the ellipsis glyphs. */
13817 if (!row
->reversed_p
)
13819 ellipsis_pos
= (glyph
- 1)->charpos
;
13820 while (glyph
> row
->glyphs
[TEXT_AREA
]
13821 && (glyph
- 1)->charpos
== ellipsis_pos
)
13822 glyph
--, x
-= glyph
->pixel_width
;
13823 /* That loop always goes one position too far, including
13824 the glyph before the ellipsis. So scan forward over
13826 x
+= glyph
->pixel_width
;
13829 else /* row is reversed */
13831 ellipsis_pos
= (glyph
+ 1)->charpos
;
13832 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13833 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13834 glyph
++, x
+= glyph
->pixel_width
;
13835 x
-= glyph
->pixel_width
;
13839 else if (match_with_avoid_cursor
13840 /* A truncated row may not include PT among its
13841 character positions. Setting the cursor inside the
13842 scroll margin will trigger recalculation of hscroll
13843 in hscroll_window_tree. But if a display string
13844 covers point, defer to the string-handling code
13845 below to figure this out. */
13847 && ((row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13848 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13849 /* Zero-width characters produce no glyphs. */
13851 && (row
->reversed_p
13852 ? glyph_after
> glyphs_end
13853 : glyph_after
< glyphs_end
)))))
13855 cursor
= glyph_after
;
13858 else if (string_seen
)
13860 int incr
= row
->reversed_p
? -1 : +1;
13862 /* Need to find the glyph that came out of a string which is
13863 present at point. That glyph is somewhere between
13864 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13865 positioned between POS_BEFORE and POS_AFTER in the
13867 struct glyph
*start
, *stop
;
13868 EMACS_INT pos
= pos_before
;
13872 /* If the row ends in a newline from a display string,
13873 reordering could have moved the glyphs belonging to the
13874 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13875 in this case we extend the search to the last glyph in
13876 the row that was not inserted by redisplay. */
13877 if (row
->ends_in_newline_from_string_p
)
13880 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13883 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13884 correspond to POS_BEFORE and POS_AFTER, respectively. We
13885 need START and STOP in the order that corresponds to the
13886 row's direction as given by its reversed_p flag. If the
13887 directionality of characters between POS_BEFORE and
13888 POS_AFTER is the opposite of the row's base direction,
13889 these characters will have been reordered for display,
13890 and we need to reverse START and STOP. */
13891 if (!row
->reversed_p
)
13893 start
= min (glyph_before
, glyph_after
);
13894 stop
= max (glyph_before
, glyph_after
);
13898 start
= max (glyph_before
, glyph_after
);
13899 stop
= min (glyph_before
, glyph_after
);
13901 for (glyph
= start
+ incr
;
13902 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13905 /* Any glyphs that come from the buffer are here because
13906 of bidi reordering. Skip them, and only pay
13907 attention to glyphs that came from some string. */
13908 if (STRINGP (glyph
->object
))
13912 /* If the display property covers the newline, we
13913 need to search for it one position farther. */
13914 EMACS_INT lim
= pos_after
13915 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13917 string_from_text_prop
= 0;
13918 str
= glyph
->object
;
13919 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13920 if (tem
== 0 /* from overlay */
13923 /* If the string from which this glyph came is
13924 found in the buffer at point, then we've
13925 found the glyph we've been looking for. If
13926 it comes from an overlay (tem == 0), and it
13927 has the `cursor' property on one of its
13928 glyphs, record that glyph as a candidate for
13929 displaying the cursor. (As in the
13930 unidirectional version, we will display the
13931 cursor on the last candidate we find.) */
13932 if (tem
== 0 || tem
== pt_old
)
13934 /* The glyphs from this string could have
13935 been reordered. Find the one with the
13936 smallest string position. Or there could
13937 be a character in the string with the
13938 `cursor' property, which means display
13939 cursor on that character's glyph. */
13940 EMACS_INT strpos
= glyph
->charpos
;
13945 string_from_text_prop
= 1;
13948 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13949 && EQ (glyph
->object
, str
);
13953 EMACS_INT gpos
= glyph
->charpos
;
13955 cprop
= Fget_char_property (make_number (gpos
),
13963 if (tem
&& glyph
->charpos
< strpos
)
13965 strpos
= glyph
->charpos
;
13974 pos
= tem
+ 1; /* don't find previous instances */
13976 /* This string is not what we want; skip all of the
13977 glyphs that came from it. */
13978 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13979 && EQ (glyph
->object
, str
))
13986 /* If we reached the end of the line, and END was from a string,
13987 the cursor is not on this line. */
13989 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13990 && STRINGP (end
->object
)
13991 && row
->continued_p
)
13997 if (cursor
!= NULL
)
14003 /* Need to compute x that corresponds to GLYPH. */
14004 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14006 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14008 x
+= g
->pixel_width
;
14012 /* ROW could be part of a continued line, which, under bidi
14013 reordering, might have other rows whose start and end charpos
14014 occlude point. Only set w->cursor if we found a better
14015 approximation to the cursor position than we have from previously
14016 examined candidate rows belonging to the same continued line. */
14017 if (/* we already have a candidate row */
14018 w
->cursor
.vpos
>= 0
14019 /* that candidate is not the row we are processing */
14020 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14021 /* Make sure cursor.vpos specifies a row whose start and end
14022 charpos occlude point, and it is valid candidate for being a
14023 cursor-row. This is because some callers of this function
14024 leave cursor.vpos at the row where the cursor was displayed
14025 during the last redisplay cycle. */
14026 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14027 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14028 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14031 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14033 /* Don't consider glyphs that are outside TEXT_AREA. */
14034 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14036 /* Keep the candidate whose buffer position is the closest to
14037 point or has the `cursor' property. */
14038 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14039 w
->cursor
.hpos
>= 0
14040 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14041 && ((BUFFERP (g1
->object
)
14042 && (g1
->charpos
== pt_old
/* an exact match always wins */
14043 || (BUFFERP (glyph
->object
)
14044 && eabs (g1
->charpos
- pt_old
)
14045 < eabs (glyph
->charpos
- pt_old
))))
14046 /* previous candidate is a glyph from a string that has
14047 a non-nil `cursor' property */
14048 || (STRINGP (g1
->object
)
14049 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14050 Qcursor
, g1
->object
))
14051 /* pevious candidate is from the same display
14052 string as this one, and the display string
14053 came from a text property */
14054 || (EQ (g1
->object
, glyph
->object
)
14055 && string_from_text_prop
)
14056 /* this candidate is from newline and its
14057 position is not an exact match */
14058 || (INTEGERP (glyph
->object
)
14059 && glyph
->charpos
!= pt_old
)))))
14061 /* If this candidate gives an exact match, use that. */
14062 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14063 /* If this candidate is a glyph created for the
14064 terminating newline of a line, and point is on that
14065 newline, it wins because it's an exact match. */
14066 || (!row
->continued_p
14067 && INTEGERP (glyph
->object
)
14068 && glyph
->charpos
== 0
14069 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14070 /* Otherwise, keep the candidate that comes from a row
14071 spanning less buffer positions. This may win when one or
14072 both candidate positions are on glyphs that came from
14073 display strings, for which we cannot compare buffer
14075 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14076 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14077 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14080 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14082 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14083 w
->cursor
.y
= row
->y
+ dy
;
14085 if (w
== XWINDOW (selected_window
))
14087 if (!row
->continued_p
14088 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14091 this_line_buffer
= XBUFFER (w
->buffer
);
14093 CHARPOS (this_line_start_pos
)
14094 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14095 BYTEPOS (this_line_start_pos
)
14096 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14098 CHARPOS (this_line_end_pos
)
14099 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14100 BYTEPOS (this_line_end_pos
)
14101 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14103 this_line_y
= w
->cursor
.y
;
14104 this_line_pixel_height
= row
->height
;
14105 this_line_vpos
= w
->cursor
.vpos
;
14106 this_line_start_x
= row
->x
;
14109 CHARPOS (this_line_start_pos
) = 0;
14116 /* Run window scroll functions, if any, for WINDOW with new window
14117 start STARTP. Sets the window start of WINDOW to that position.
14119 We assume that the window's buffer is really current. */
14121 static inline struct text_pos
14122 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14124 struct window
*w
= XWINDOW (window
);
14125 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14127 if (current_buffer
!= XBUFFER (w
->buffer
))
14130 if (!NILP (Vwindow_scroll_functions
))
14132 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14133 make_number (CHARPOS (startp
)));
14134 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14135 /* In case the hook functions switch buffers. */
14136 if (current_buffer
!= XBUFFER (w
->buffer
))
14137 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14144 /* Make sure the line containing the cursor is fully visible.
14145 A value of 1 means there is nothing to be done.
14146 (Either the line is fully visible, or it cannot be made so,
14147 or we cannot tell.)
14149 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14150 is higher than window.
14152 A value of 0 means the caller should do scrolling
14153 as if point had gone off the screen. */
14156 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14158 struct glyph_matrix
*matrix
;
14159 struct glyph_row
*row
;
14162 if (!make_cursor_line_fully_visible_p
)
14165 /* It's not always possible to find the cursor, e.g, when a window
14166 is full of overlay strings. Don't do anything in that case. */
14167 if (w
->cursor
.vpos
< 0)
14170 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14171 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14173 /* If the cursor row is not partially visible, there's nothing to do. */
14174 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14177 /* If the row the cursor is in is taller than the window's height,
14178 it's not clear what to do, so do nothing. */
14179 window_height
= window_box_height (w
);
14180 if (row
->height
>= window_height
)
14182 if (!force_p
|| MINI_WINDOW_P (w
)
14183 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14190 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14191 non-zero means only WINDOW is redisplayed in redisplay_internal.
14192 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14193 in redisplay_window to bring a partially visible line into view in
14194 the case that only the cursor has moved.
14196 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14197 last screen line's vertical height extends past the end of the screen.
14201 1 if scrolling succeeded
14203 0 if scrolling didn't find point.
14205 -1 if new fonts have been loaded so that we must interrupt
14206 redisplay, adjust glyph matrices, and try again. */
14212 SCROLLING_NEED_LARGER_MATRICES
14215 /* If scroll-conservatively is more than this, never recenter.
14217 If you change this, don't forget to update the doc string of
14218 `scroll-conservatively' and the Emacs manual. */
14219 #define SCROLL_LIMIT 100
14222 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14223 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14224 int temp_scroll_step
, int last_line_misfit
)
14226 struct window
*w
= XWINDOW (window
);
14227 struct frame
*f
= XFRAME (w
->frame
);
14228 struct text_pos pos
, startp
;
14230 int this_scroll_margin
, scroll_max
, rc
, height
;
14231 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14232 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14233 Lisp_Object aggressive
;
14234 /* We will never try scrolling more than this number of lines. */
14235 int scroll_limit
= SCROLL_LIMIT
;
14238 debug_method_add (w
, "try_scrolling");
14241 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14243 /* Compute scroll margin height in pixels. We scroll when point is
14244 within this distance from the top or bottom of the window. */
14245 if (scroll_margin
> 0)
14246 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14247 * FRAME_LINE_HEIGHT (f
);
14249 this_scroll_margin
= 0;
14251 /* Force arg_scroll_conservatively to have a reasonable value, to
14252 avoid scrolling too far away with slow move_it_* functions. Note
14253 that the user can supply scroll-conservatively equal to
14254 `most-positive-fixnum', which can be larger than INT_MAX. */
14255 if (arg_scroll_conservatively
> scroll_limit
)
14257 arg_scroll_conservatively
= scroll_limit
+ 1;
14258 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14260 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14261 /* Compute how much we should try to scroll maximally to bring
14262 point into view. */
14263 scroll_max
= (max (scroll_step
,
14264 max (arg_scroll_conservatively
, temp_scroll_step
))
14265 * FRAME_LINE_HEIGHT (f
));
14266 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14267 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14268 /* We're trying to scroll because of aggressive scrolling but no
14269 scroll_step is set. Choose an arbitrary one. */
14270 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14276 /* Decide whether to scroll down. */
14277 if (PT
> CHARPOS (startp
))
14279 int scroll_margin_y
;
14281 /* Compute the pixel ypos of the scroll margin, then move it to
14282 either that ypos or PT, whichever comes first. */
14283 start_display (&it
, w
, startp
);
14284 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14285 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14286 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14287 (MOVE_TO_POS
| MOVE_TO_Y
));
14289 if (PT
> CHARPOS (it
.current
.pos
))
14291 int y0
= line_bottom_y (&it
);
14292 /* Compute how many pixels below window bottom to stop searching
14293 for PT. This avoids costly search for PT that is far away if
14294 the user limited scrolling by a small number of lines, but
14295 always finds PT if scroll_conservatively is set to a large
14296 number, such as most-positive-fixnum. */
14297 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14298 int y_to_move
= it
.last_visible_y
+ slack
;
14300 /* Compute the distance from the scroll margin to PT or to
14301 the scroll limit, whichever comes first. This should
14302 include the height of the cursor line, to make that line
14304 move_it_to (&it
, PT
, -1, y_to_move
,
14305 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14306 dy
= line_bottom_y (&it
) - y0
;
14308 if (dy
> scroll_max
)
14309 return SCROLLING_FAILED
;
14317 /* Point is in or below the bottom scroll margin, so move the
14318 window start down. If scrolling conservatively, move it just
14319 enough down to make point visible. If scroll_step is set,
14320 move it down by scroll_step. */
14321 if (arg_scroll_conservatively
)
14323 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14324 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14325 else if (scroll_step
|| temp_scroll_step
)
14326 amount_to_scroll
= scroll_max
;
14329 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14330 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14331 if (NUMBERP (aggressive
))
14333 double float_amount
= XFLOATINT (aggressive
) * height
;
14334 amount_to_scroll
= float_amount
;
14335 if (amount_to_scroll
== 0 && float_amount
> 0)
14336 amount_to_scroll
= 1;
14337 /* Don't let point enter the scroll margin near top of
14339 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14340 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14344 if (amount_to_scroll
<= 0)
14345 return SCROLLING_FAILED
;
14347 start_display (&it
, w
, startp
);
14348 if (arg_scroll_conservatively
<= scroll_limit
)
14349 move_it_vertically (&it
, amount_to_scroll
);
14352 /* Extra precision for users who set scroll-conservatively
14353 to a large number: make sure the amount we scroll
14354 the window start is never less than amount_to_scroll,
14355 which was computed as distance from window bottom to
14356 point. This matters when lines at window top and lines
14357 below window bottom have different height. */
14359 void *it1data
= NULL
;
14360 /* We use a temporary it1 because line_bottom_y can modify
14361 its argument, if it moves one line down; see there. */
14364 SAVE_IT (it1
, it
, it1data
);
14365 start_y
= line_bottom_y (&it1
);
14367 RESTORE_IT (&it
, &it
, it1data
);
14368 move_it_by_lines (&it
, 1);
14369 SAVE_IT (it1
, it
, it1data
);
14370 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14373 /* If STARTP is unchanged, move it down another screen line. */
14374 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14375 move_it_by_lines (&it
, 1);
14376 startp
= it
.current
.pos
;
14380 struct text_pos scroll_margin_pos
= startp
;
14382 /* See if point is inside the scroll margin at the top of the
14384 if (this_scroll_margin
)
14386 start_display (&it
, w
, startp
);
14387 move_it_vertically (&it
, this_scroll_margin
);
14388 scroll_margin_pos
= it
.current
.pos
;
14391 if (PT
< CHARPOS (scroll_margin_pos
))
14393 /* Point is in the scroll margin at the top of the window or
14394 above what is displayed in the window. */
14397 /* Compute the vertical distance from PT to the scroll
14398 margin position. Move as far as scroll_max allows, or
14399 one screenful, or 10 screen lines, whichever is largest.
14400 Give up if distance is greater than scroll_max. */
14401 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14402 start_display (&it
, w
, pos
);
14404 y_to_move
= max (it
.last_visible_y
,
14405 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14406 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14408 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14409 dy
= it
.current_y
- y0
;
14410 if (dy
> scroll_max
)
14411 return SCROLLING_FAILED
;
14413 /* Compute new window start. */
14414 start_display (&it
, w
, startp
);
14416 if (arg_scroll_conservatively
)
14417 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14418 max (scroll_step
, temp_scroll_step
));
14419 else if (scroll_step
|| temp_scroll_step
)
14420 amount_to_scroll
= scroll_max
;
14423 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14424 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14425 if (NUMBERP (aggressive
))
14427 double float_amount
= XFLOATINT (aggressive
) * height
;
14428 amount_to_scroll
= float_amount
;
14429 if (amount_to_scroll
== 0 && float_amount
> 0)
14430 amount_to_scroll
= 1;
14431 amount_to_scroll
-=
14432 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14433 /* Don't let point enter the scroll margin near
14434 bottom of the window. */
14435 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14436 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14440 if (amount_to_scroll
<= 0)
14441 return SCROLLING_FAILED
;
14443 move_it_vertically_backward (&it
, amount_to_scroll
);
14444 startp
= it
.current
.pos
;
14448 /* Run window scroll functions. */
14449 startp
= run_window_scroll_functions (window
, startp
);
14451 /* Display the window. Give up if new fonts are loaded, or if point
14453 if (!try_window (window
, startp
, 0))
14454 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14455 else if (w
->cursor
.vpos
< 0)
14457 clear_glyph_matrix (w
->desired_matrix
);
14458 rc
= SCROLLING_FAILED
;
14462 /* Maybe forget recorded base line for line number display. */
14463 if (!just_this_one_p
14464 || current_buffer
->clip_changed
14465 || BEG_UNCHANGED
< CHARPOS (startp
))
14466 w
->base_line_number
= Qnil
;
14468 /* If cursor ends up on a partially visible line,
14469 treat that as being off the bottom of the screen. */
14470 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14471 /* It's possible that the cursor is on the first line of the
14472 buffer, which is partially obscured due to a vscroll
14473 (Bug#7537). In that case, avoid looping forever . */
14474 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14476 clear_glyph_matrix (w
->desired_matrix
);
14477 ++extra_scroll_margin_lines
;
14480 rc
= SCROLLING_SUCCESS
;
14487 /* Compute a suitable window start for window W if display of W starts
14488 on a continuation line. Value is non-zero if a new window start
14491 The new window start will be computed, based on W's width, starting
14492 from the start of the continued line. It is the start of the
14493 screen line with the minimum distance from the old start W->start. */
14496 compute_window_start_on_continuation_line (struct window
*w
)
14498 struct text_pos pos
, start_pos
;
14499 int window_start_changed_p
= 0;
14501 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14503 /* If window start is on a continuation line... Window start may be
14504 < BEGV in case there's invisible text at the start of the
14505 buffer (M-x rmail, for example). */
14506 if (CHARPOS (start_pos
) > BEGV
14507 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14510 struct glyph_row
*row
;
14512 /* Handle the case that the window start is out of range. */
14513 if (CHARPOS (start_pos
) < BEGV
)
14514 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14515 else if (CHARPOS (start_pos
) > ZV
)
14516 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14518 /* Find the start of the continued line. This should be fast
14519 because scan_buffer is fast (newline cache). */
14520 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14521 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14522 row
, DEFAULT_FACE_ID
);
14523 reseat_at_previous_visible_line_start (&it
);
14525 /* If the line start is "too far" away from the window start,
14526 say it takes too much time to compute a new window start. */
14527 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14528 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14530 int min_distance
, distance
;
14532 /* Move forward by display lines to find the new window
14533 start. If window width was enlarged, the new start can
14534 be expected to be > the old start. If window width was
14535 decreased, the new window start will be < the old start.
14536 So, we're looking for the display line start with the
14537 minimum distance from the old window start. */
14538 pos
= it
.current
.pos
;
14539 min_distance
= INFINITY
;
14540 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14541 distance
< min_distance
)
14543 min_distance
= distance
;
14544 pos
= it
.current
.pos
;
14545 move_it_by_lines (&it
, 1);
14548 /* Set the window start there. */
14549 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14550 window_start_changed_p
= 1;
14554 return window_start_changed_p
;
14558 /* Try cursor movement in case text has not changed in window WINDOW,
14559 with window start STARTP. Value is
14561 CURSOR_MOVEMENT_SUCCESS if successful
14563 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14565 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14566 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14567 we want to scroll as if scroll-step were set to 1. See the code.
14569 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14570 which case we have to abort this redisplay, and adjust matrices
14575 CURSOR_MOVEMENT_SUCCESS
,
14576 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14577 CURSOR_MOVEMENT_MUST_SCROLL
,
14578 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14582 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14584 struct window
*w
= XWINDOW (window
);
14585 struct frame
*f
= XFRAME (w
->frame
);
14586 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14589 if (inhibit_try_cursor_movement
)
14593 /* Handle case where text has not changed, only point, and it has
14594 not moved off the frame. */
14595 if (/* Point may be in this window. */
14596 PT
>= CHARPOS (startp
)
14597 /* Selective display hasn't changed. */
14598 && !current_buffer
->clip_changed
14599 /* Function force-mode-line-update is used to force a thorough
14600 redisplay. It sets either windows_or_buffers_changed or
14601 update_mode_lines. So don't take a shortcut here for these
14603 && !update_mode_lines
14604 && !windows_or_buffers_changed
14605 && !cursor_type_changed
14606 /* Can't use this case if highlighting a region. When a
14607 region exists, cursor movement has to do more than just
14609 && !(!NILP (Vtransient_mark_mode
)
14610 && !NILP (BVAR (current_buffer
, mark_active
)))
14611 && NILP (w
->region_showing
)
14612 && NILP (Vshow_trailing_whitespace
)
14613 /* Right after splitting windows, last_point may be nil. */
14614 && INTEGERP (w
->last_point
)
14615 /* This code is not used for mini-buffer for the sake of the case
14616 of redisplaying to replace an echo area message; since in
14617 that case the mini-buffer contents per se are usually
14618 unchanged. This code is of no real use in the mini-buffer
14619 since the handling of this_line_start_pos, etc., in redisplay
14620 handles the same cases. */
14621 && !EQ (window
, minibuf_window
)
14622 /* When splitting windows or for new windows, it happens that
14623 redisplay is called with a nil window_end_vpos or one being
14624 larger than the window. This should really be fixed in
14625 window.c. I don't have this on my list, now, so we do
14626 approximately the same as the old redisplay code. --gerd. */
14627 && INTEGERP (w
->window_end_vpos
)
14628 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14629 && (FRAME_WINDOW_P (f
)
14630 || !overlay_arrow_in_current_buffer_p ()))
14632 int this_scroll_margin
, top_scroll_margin
;
14633 struct glyph_row
*row
= NULL
;
14636 debug_method_add (w
, "cursor movement");
14639 /* Scroll if point within this distance from the top or bottom
14640 of the window. This is a pixel value. */
14641 if (scroll_margin
> 0)
14643 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14644 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14647 this_scroll_margin
= 0;
14649 top_scroll_margin
= this_scroll_margin
;
14650 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14651 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14653 /* Start with the row the cursor was displayed during the last
14654 not paused redisplay. Give up if that row is not valid. */
14655 if (w
->last_cursor
.vpos
< 0
14656 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14660 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14661 if (row
->mode_line_p
)
14663 if (!row
->enabled_p
)
14664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14667 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14669 int scroll_p
= 0, must_scroll
= 0;
14670 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14672 if (PT
> XFASTINT (w
->last_point
))
14674 /* Point has moved forward. */
14675 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14676 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14678 xassert (row
->enabled_p
);
14682 /* If the end position of a row equals the start
14683 position of the next row, and PT is at that position,
14684 we would rather display cursor in the next line. */
14685 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14686 && MATRIX_ROW_END_CHARPOS (row
) == PT
14687 && row
< w
->current_matrix
->rows
14688 + w
->current_matrix
->nrows
- 1
14689 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14690 && !cursor_row_p (row
))
14693 /* If within the scroll margin, scroll. Note that
14694 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14695 the next line would be drawn, and that
14696 this_scroll_margin can be zero. */
14697 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14698 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14699 /* Line is completely visible last line in window
14700 and PT is to be set in the next line. */
14701 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14702 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14703 && !row
->ends_at_zv_p
14704 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14707 else if (PT
< XFASTINT (w
->last_point
))
14709 /* Cursor has to be moved backward. Note that PT >=
14710 CHARPOS (startp) because of the outer if-statement. */
14711 while (!row
->mode_line_p
14712 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14713 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14714 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14715 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14716 row
> w
->current_matrix
->rows
14717 && (row
-1)->ends_in_newline_from_string_p
))))
14718 && (row
->y
> top_scroll_margin
14719 || CHARPOS (startp
) == BEGV
))
14721 xassert (row
->enabled_p
);
14725 /* Consider the following case: Window starts at BEGV,
14726 there is invisible, intangible text at BEGV, so that
14727 display starts at some point START > BEGV. It can
14728 happen that we are called with PT somewhere between
14729 BEGV and START. Try to handle that case. */
14730 if (row
< w
->current_matrix
->rows
14731 || row
->mode_line_p
)
14733 row
= w
->current_matrix
->rows
;
14734 if (row
->mode_line_p
)
14738 /* Due to newlines in overlay strings, we may have to
14739 skip forward over overlay strings. */
14740 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14741 && MATRIX_ROW_END_CHARPOS (row
) == PT
14742 && !cursor_row_p (row
))
14745 /* If within the scroll margin, scroll. */
14746 if (row
->y
< top_scroll_margin
14747 && CHARPOS (startp
) != BEGV
)
14752 /* Cursor did not move. So don't scroll even if cursor line
14753 is partially visible, as it was so before. */
14754 rc
= CURSOR_MOVEMENT_SUCCESS
;
14757 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14758 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14760 /* if PT is not in the glyph row, give up. */
14761 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14764 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14765 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14767 /* If rows are bidi-reordered and point moved, back up
14768 until we find a row that does not belong to a
14769 continuation line. This is because we must consider
14770 all rows of a continued line as candidates for the
14771 new cursor positioning, since row start and end
14772 positions change non-linearly with vertical position
14774 /* FIXME: Revisit this when glyph ``spilling'' in
14775 continuation lines' rows is implemented for
14776 bidi-reordered rows. */
14777 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14779 xassert (row
->enabled_p
);
14781 /* If we hit the beginning of the displayed portion
14782 without finding the first row of a continued
14784 if (row
<= w
->current_matrix
->rows
)
14786 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14794 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14795 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14796 && make_cursor_line_fully_visible_p
)
14798 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14799 && !row
->ends_at_zv_p
14800 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14801 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14802 else if (row
->height
> window_box_height (w
))
14804 /* If we end up in a partially visible line, let's
14805 make it fully visible, except when it's taller
14806 than the window, in which case we can't do much
14809 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14813 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14814 if (!cursor_row_fully_visible_p (w
, 0, 1))
14815 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14817 rc
= CURSOR_MOVEMENT_SUCCESS
;
14821 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14822 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14823 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14825 /* With bidi-reordered rows, there could be more than
14826 one candidate row whose start and end positions
14827 occlude point. We need to let set_cursor_from_row
14828 find the best candidate. */
14829 /* FIXME: Revisit this when glyph ``spilling'' in
14830 continuation lines' rows is implemented for
14831 bidi-reordered rows. */
14836 int at_zv_p
= 0, exact_match_p
= 0;
14838 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14839 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14840 && cursor_row_p (row
))
14841 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14843 /* As soon as we've found the exact match for point,
14844 or the first suitable row whose ends_at_zv_p flag
14845 is set, we are done. */
14847 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14849 && w
->cursor
.hpos
>= 0
14850 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14853 struct glyph_row
*candidate
=
14854 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14856 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14857 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14860 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14861 || (INTEGERP (g
->object
)
14862 && (g
->charpos
== PT
14863 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14865 if (rv
&& (at_zv_p
|| exact_match_p
))
14867 rc
= CURSOR_MOVEMENT_SUCCESS
;
14870 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14874 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14875 || row
->continued_p
)
14876 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14877 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14878 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14879 /* If we didn't find any candidate rows, or exited the
14880 loop before all the candidates were examined, signal
14881 to the caller that this method failed. */
14882 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14884 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14885 && !row
->continued_p
))
14886 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14888 rc
= CURSOR_MOVEMENT_SUCCESS
;
14894 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14896 rc
= CURSOR_MOVEMENT_SUCCESS
;
14901 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14902 && MATRIX_ROW_START_CHARPOS (row
) == PT
14903 && cursor_row_p (row
));
14911 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14915 set_vertical_scroll_bar (struct window
*w
)
14917 EMACS_INT start
, end
, whole
;
14919 /* Calculate the start and end positions for the current window.
14920 At some point, it would be nice to choose between scrollbars
14921 which reflect the whole buffer size, with special markers
14922 indicating narrowing, and scrollbars which reflect only the
14925 Note that mini-buffers sometimes aren't displaying any text. */
14926 if (!MINI_WINDOW_P (w
)
14927 || (w
== XWINDOW (minibuf_window
)
14928 && NILP (echo_area_buffer
[0])))
14930 struct buffer
*buf
= XBUFFER (w
->buffer
);
14931 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14932 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14933 /* I don't think this is guaranteed to be right. For the
14934 moment, we'll pretend it is. */
14935 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14939 if (whole
< (end
- start
))
14940 whole
= end
- start
;
14943 start
= end
= whole
= 0;
14945 /* Indicate what this scroll bar ought to be displaying now. */
14946 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14947 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14948 (w
, end
- start
, whole
, start
);
14952 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14953 selected_window is redisplayed.
14955 We can return without actually redisplaying the window if
14956 fonts_changed_p is nonzero. In that case, redisplay_internal will
14960 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14962 struct window
*w
= XWINDOW (window
);
14963 struct frame
*f
= XFRAME (w
->frame
);
14964 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14965 struct buffer
*old
= current_buffer
;
14966 struct text_pos lpoint
, opoint
, startp
;
14967 int update_mode_line
;
14970 /* Record it now because it's overwritten. */
14971 int current_matrix_up_to_date_p
= 0;
14972 int used_current_matrix_p
= 0;
14973 /* This is less strict than current_matrix_up_to_date_p.
14974 It indictes that the buffer contents and narrowing are unchanged. */
14975 int buffer_unchanged_p
= 0;
14976 int temp_scroll_step
= 0;
14977 int count
= SPECPDL_INDEX ();
14979 int centering_position
= -1;
14980 int last_line_misfit
= 0;
14981 EMACS_INT beg_unchanged
, end_unchanged
;
14983 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14986 /* W must be a leaf window here. */
14987 xassert (!NILP (w
->buffer
));
14989 *w
->desired_matrix
->method
= 0;
14993 reconsider_clip_changes (w
, buffer
);
14995 /* Has the mode line to be updated? */
14996 update_mode_line
= (!NILP (w
->update_mode_line
)
14997 || update_mode_lines
14998 || buffer
->clip_changed
14999 || buffer
->prevent_redisplay_optimizations_p
);
15001 if (MINI_WINDOW_P (w
))
15003 if (w
== XWINDOW (echo_area_window
)
15004 && !NILP (echo_area_buffer
[0]))
15006 if (update_mode_line
)
15007 /* We may have to update a tty frame's menu bar or a
15008 tool-bar. Example `M-x C-h C-h C-g'. */
15009 goto finish_menu_bars
;
15011 /* We've already displayed the echo area glyphs in this window. */
15012 goto finish_scroll_bars
;
15014 else if ((w
!= XWINDOW (minibuf_window
)
15015 || minibuf_level
== 0)
15016 /* When buffer is nonempty, redisplay window normally. */
15017 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15018 /* Quail displays non-mini buffers in minibuffer window.
15019 In that case, redisplay the window normally. */
15020 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15022 /* W is a mini-buffer window, but it's not active, so clear
15024 int yb
= window_text_bottom_y (w
);
15025 struct glyph_row
*row
;
15028 for (y
= 0, row
= w
->desired_matrix
->rows
;
15030 y
+= row
->height
, ++row
)
15031 blank_row (w
, row
, y
);
15032 goto finish_scroll_bars
;
15035 clear_glyph_matrix (w
->desired_matrix
);
15038 /* Otherwise set up data on this window; select its buffer and point
15040 /* Really select the buffer, for the sake of buffer-local
15042 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15044 current_matrix_up_to_date_p
15045 = (!NILP (w
->window_end_valid
)
15046 && !current_buffer
->clip_changed
15047 && !current_buffer
->prevent_redisplay_optimizations_p
15048 && XFASTINT (w
->last_modified
) >= MODIFF
15049 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15051 /* Run the window-bottom-change-functions
15052 if it is possible that the text on the screen has changed
15053 (either due to modification of the text, or any other reason). */
15054 if (!current_matrix_up_to_date_p
15055 && !NILP (Vwindow_text_change_functions
))
15057 safe_run_hooks (Qwindow_text_change_functions
);
15061 beg_unchanged
= BEG_UNCHANGED
;
15062 end_unchanged
= END_UNCHANGED
;
15064 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15066 specbind (Qinhibit_point_motion_hooks
, Qt
);
15069 = (!NILP (w
->window_end_valid
)
15070 && !current_buffer
->clip_changed
15071 && XFASTINT (w
->last_modified
) >= MODIFF
15072 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15074 /* When windows_or_buffers_changed is non-zero, we can't rely on
15075 the window end being valid, so set it to nil there. */
15076 if (windows_or_buffers_changed
)
15078 /* If window starts on a continuation line, maybe adjust the
15079 window start in case the window's width changed. */
15080 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15081 compute_window_start_on_continuation_line (w
);
15083 w
->window_end_valid
= Qnil
;
15086 /* Some sanity checks. */
15087 CHECK_WINDOW_END (w
);
15088 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15090 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15093 /* If %c is in mode line, update it if needed. */
15094 if (!NILP (w
->column_number_displayed
)
15095 /* This alternative quickly identifies a common case
15096 where no change is needed. */
15097 && !(PT
== XFASTINT (w
->last_point
)
15098 && XFASTINT (w
->last_modified
) >= MODIFF
15099 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15100 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15101 update_mode_line
= 1;
15103 /* Count number of windows showing the selected buffer. An indirect
15104 buffer counts as its base buffer. */
15105 if (!just_this_one_p
)
15107 struct buffer
*current_base
, *window_base
;
15108 current_base
= current_buffer
;
15109 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15110 if (current_base
->base_buffer
)
15111 current_base
= current_base
->base_buffer
;
15112 if (window_base
->base_buffer
)
15113 window_base
= window_base
->base_buffer
;
15114 if (current_base
== window_base
)
15118 /* Point refers normally to the selected window. For any other
15119 window, set up appropriate value. */
15120 if (!EQ (window
, selected_window
))
15122 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15123 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15127 new_pt_byte
= BEGV_BYTE
;
15128 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15130 else if (new_pt
> (ZV
- 1))
15133 new_pt_byte
= ZV_BYTE
;
15134 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15137 /* We don't use SET_PT so that the point-motion hooks don't run. */
15138 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15141 /* If any of the character widths specified in the display table
15142 have changed, invalidate the width run cache. It's true that
15143 this may be a bit late to catch such changes, but the rest of
15144 redisplay goes (non-fatally) haywire when the display table is
15145 changed, so why should we worry about doing any better? */
15146 if (current_buffer
->width_run_cache
)
15148 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15150 if (! disptab_matches_widthtab (disptab
,
15151 XVECTOR (BVAR (current_buffer
, width_table
))))
15153 invalidate_region_cache (current_buffer
,
15154 current_buffer
->width_run_cache
,
15156 recompute_width_table (current_buffer
, disptab
);
15160 /* If window-start is screwed up, choose a new one. */
15161 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15164 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15166 /* If someone specified a new starting point but did not insist,
15167 check whether it can be used. */
15168 if (!NILP (w
->optional_new_start
)
15169 && CHARPOS (startp
) >= BEGV
15170 && CHARPOS (startp
) <= ZV
)
15172 w
->optional_new_start
= Qnil
;
15173 start_display (&it
, w
, startp
);
15174 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15175 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15176 if (IT_CHARPOS (it
) == PT
)
15177 w
->force_start
= Qt
;
15178 /* IT may overshoot PT if text at PT is invisible. */
15179 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15180 w
->force_start
= Qt
;
15185 /* Handle case where place to start displaying has been specified,
15186 unless the specified location is outside the accessible range. */
15187 if (!NILP (w
->force_start
)
15188 || w
->frozen_window_start_p
)
15190 /* We set this later on if we have to adjust point. */
15193 w
->force_start
= Qnil
;
15195 w
->window_end_valid
= Qnil
;
15197 /* Forget any recorded base line for line number display. */
15198 if (!buffer_unchanged_p
)
15199 w
->base_line_number
= Qnil
;
15201 /* Redisplay the mode line. Select the buffer properly for that.
15202 Also, run the hook window-scroll-functions
15203 because we have scrolled. */
15204 /* Note, we do this after clearing force_start because
15205 if there's an error, it is better to forget about force_start
15206 than to get into an infinite loop calling the hook functions
15207 and having them get more errors. */
15208 if (!update_mode_line
15209 || ! NILP (Vwindow_scroll_functions
))
15211 update_mode_line
= 1;
15212 w
->update_mode_line
= Qt
;
15213 startp
= run_window_scroll_functions (window
, startp
);
15216 w
->last_modified
= make_number (0);
15217 w
->last_overlay_modified
= make_number (0);
15218 if (CHARPOS (startp
) < BEGV
)
15219 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15220 else if (CHARPOS (startp
) > ZV
)
15221 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15223 /* Redisplay, then check if cursor has been set during the
15224 redisplay. Give up if new fonts were loaded. */
15225 /* We used to issue a CHECK_MARGINS argument to try_window here,
15226 but this causes scrolling to fail when point begins inside
15227 the scroll margin (bug#148) -- cyd */
15228 if (!try_window (window
, startp
, 0))
15230 w
->force_start
= Qt
;
15231 clear_glyph_matrix (w
->desired_matrix
);
15232 goto need_larger_matrices
;
15235 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15237 /* If point does not appear, try to move point so it does
15238 appear. The desired matrix has been built above, so we
15239 can use it here. */
15240 new_vpos
= window_box_height (w
) / 2;
15243 if (!cursor_row_fully_visible_p (w
, 0, 0))
15245 /* Point does appear, but on a line partly visible at end of window.
15246 Move it back to a fully-visible line. */
15247 new_vpos
= window_box_height (w
);
15250 /* If we need to move point for either of the above reasons,
15251 now actually do it. */
15254 struct glyph_row
*row
;
15256 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15257 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15260 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15261 MATRIX_ROW_START_BYTEPOS (row
));
15263 if (w
!= XWINDOW (selected_window
))
15264 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15265 else if (current_buffer
== old
)
15266 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15268 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15270 /* If we are highlighting the region, then we just changed
15271 the region, so redisplay to show it. */
15272 if (!NILP (Vtransient_mark_mode
)
15273 && !NILP (BVAR (current_buffer
, mark_active
)))
15275 clear_glyph_matrix (w
->desired_matrix
);
15276 if (!try_window (window
, startp
, 0))
15277 goto need_larger_matrices
;
15282 debug_method_add (w
, "forced window start");
15287 /* Handle case where text has not changed, only point, and it has
15288 not moved off the frame, and we are not retrying after hscroll.
15289 (current_matrix_up_to_date_p is nonzero when retrying.) */
15290 if (current_matrix_up_to_date_p
15291 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15292 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15296 case CURSOR_MOVEMENT_SUCCESS
:
15297 used_current_matrix_p
= 1;
15300 case CURSOR_MOVEMENT_MUST_SCROLL
:
15301 goto try_to_scroll
;
15307 /* If current starting point was originally the beginning of a line
15308 but no longer is, find a new starting point. */
15309 else if (!NILP (w
->start_at_line_beg
)
15310 && !(CHARPOS (startp
) <= BEGV
15311 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15314 debug_method_add (w
, "recenter 1");
15319 /* Try scrolling with try_window_id. Value is > 0 if update has
15320 been done, it is -1 if we know that the same window start will
15321 not work. It is 0 if unsuccessful for some other reason. */
15322 else if ((tem
= try_window_id (w
)) != 0)
15325 debug_method_add (w
, "try_window_id %d", tem
);
15328 if (fonts_changed_p
)
15329 goto need_larger_matrices
;
15333 /* Otherwise try_window_id has returned -1 which means that we
15334 don't want the alternative below this comment to execute. */
15336 else if (CHARPOS (startp
) >= BEGV
15337 && CHARPOS (startp
) <= ZV
15338 && PT
>= CHARPOS (startp
)
15339 && (CHARPOS (startp
) < ZV
15340 /* Avoid starting at end of buffer. */
15341 || CHARPOS (startp
) == BEGV
15342 || (XFASTINT (w
->last_modified
) >= MODIFF
15343 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15345 int d1
, d2
, d3
, d4
, d5
, d6
;
15347 /* If first window line is a continuation line, and window start
15348 is inside the modified region, but the first change is before
15349 current window start, we must select a new window start.
15351 However, if this is the result of a down-mouse event (e.g. by
15352 extending the mouse-drag-overlay), we don't want to select a
15353 new window start, since that would change the position under
15354 the mouse, resulting in an unwanted mouse-movement rather
15355 than a simple mouse-click. */
15356 if (NILP (w
->start_at_line_beg
)
15357 && NILP (do_mouse_tracking
)
15358 && CHARPOS (startp
) > BEGV
15359 && CHARPOS (startp
) > BEG
+ beg_unchanged
15360 && CHARPOS (startp
) <= Z
- end_unchanged
15361 /* Even if w->start_at_line_beg is nil, a new window may
15362 start at a line_beg, since that's how set_buffer_window
15363 sets it. So, we need to check the return value of
15364 compute_window_start_on_continuation_line. (See also
15366 && XMARKER (w
->start
)->buffer
== current_buffer
15367 && compute_window_start_on_continuation_line (w
)
15368 /* It doesn't make sense to force the window start like we
15369 do at label force_start if it is already known that point
15370 will not be visible in the resulting window, because
15371 doing so will move point from its correct position
15372 instead of scrolling the window to bring point into view.
15374 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15376 w
->force_start
= Qt
;
15377 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15382 debug_method_add (w
, "same window start");
15385 /* Try to redisplay starting at same place as before.
15386 If point has not moved off frame, accept the results. */
15387 if (!current_matrix_up_to_date_p
15388 /* Don't use try_window_reusing_current_matrix in this case
15389 because a window scroll function can have changed the
15391 || !NILP (Vwindow_scroll_functions
)
15392 || MINI_WINDOW_P (w
)
15393 || !(used_current_matrix_p
15394 = try_window_reusing_current_matrix (w
)))
15396 IF_DEBUG (debug_method_add (w
, "1"));
15397 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15398 /* -1 means we need to scroll.
15399 0 means we need new matrices, but fonts_changed_p
15400 is set in that case, so we will detect it below. */
15401 goto try_to_scroll
;
15404 if (fonts_changed_p
)
15405 goto need_larger_matrices
;
15407 if (w
->cursor
.vpos
>= 0)
15409 if (!just_this_one_p
15410 || current_buffer
->clip_changed
15411 || BEG_UNCHANGED
< CHARPOS (startp
))
15412 /* Forget any recorded base line for line number display. */
15413 w
->base_line_number
= Qnil
;
15415 if (!cursor_row_fully_visible_p (w
, 1, 0))
15417 clear_glyph_matrix (w
->desired_matrix
);
15418 last_line_misfit
= 1;
15420 /* Drop through and scroll. */
15425 clear_glyph_matrix (w
->desired_matrix
);
15430 w
->last_modified
= make_number (0);
15431 w
->last_overlay_modified
= make_number (0);
15433 /* Redisplay the mode line. Select the buffer properly for that. */
15434 if (!update_mode_line
)
15436 update_mode_line
= 1;
15437 w
->update_mode_line
= Qt
;
15440 /* Try to scroll by specified few lines. */
15441 if ((scroll_conservatively
15442 || emacs_scroll_step
15443 || temp_scroll_step
15444 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15445 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15446 && CHARPOS (startp
) >= BEGV
15447 && CHARPOS (startp
) <= ZV
)
15449 /* The function returns -1 if new fonts were loaded, 1 if
15450 successful, 0 if not successful. */
15451 int ss
= try_scrolling (window
, just_this_one_p
,
15452 scroll_conservatively
,
15454 temp_scroll_step
, last_line_misfit
);
15457 case SCROLLING_SUCCESS
:
15460 case SCROLLING_NEED_LARGER_MATRICES
:
15461 goto need_larger_matrices
;
15463 case SCROLLING_FAILED
:
15471 /* Finally, just choose a place to start which positions point
15472 according to user preferences. */
15477 debug_method_add (w
, "recenter");
15480 /* w->vscroll = 0; */
15482 /* Forget any previously recorded base line for line number display. */
15483 if (!buffer_unchanged_p
)
15484 w
->base_line_number
= Qnil
;
15486 /* Determine the window start relative to point. */
15487 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15488 it
.current_y
= it
.last_visible_y
;
15489 if (centering_position
< 0)
15493 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15495 EMACS_INT margin_pos
= CHARPOS (startp
);
15497 Lisp_Object aggressive
;
15499 /* If there is a scroll margin at the top of the window, find
15500 its character position. */
15502 /* Cannot call start_display if startp is not in the
15503 accessible region of the buffer. This can happen when we
15504 have just switched to a different buffer and/or changed
15505 its restriction. In that case, startp is initialized to
15506 the character position 1 (BEG) because we did not yet
15507 have chance to display the buffer even once. */
15508 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15511 void *it1data
= NULL
;
15513 SAVE_IT (it1
, it
, it1data
);
15514 start_display (&it1
, w
, startp
);
15515 move_it_vertically (&it1
, margin
);
15516 margin_pos
= IT_CHARPOS (it1
);
15517 RESTORE_IT (&it
, &it
, it1data
);
15519 scrolling_up
= PT
> margin_pos
;
15522 ? BVAR (current_buffer
, scroll_up_aggressively
)
15523 : BVAR (current_buffer
, scroll_down_aggressively
);
15525 if (!MINI_WINDOW_P (w
)
15526 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15530 /* Setting scroll-conservatively overrides
15531 scroll-*-aggressively. */
15532 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15534 double float_amount
= XFLOATINT (aggressive
);
15536 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15537 if (pt_offset
== 0 && float_amount
> 0)
15542 /* Compute how much to move the window start backward from
15543 point so that point will be displayed where the user
15547 centering_position
= it
.last_visible_y
;
15549 centering_position
-= pt_offset
;
15550 centering_position
-=
15551 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15552 + WINDOW_HEADER_LINE_HEIGHT (w
);
15553 /* Don't let point enter the scroll margin near top of
15555 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15556 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15559 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15562 /* Set the window start half the height of the window backward
15564 centering_position
= window_box_height (w
) / 2;
15566 move_it_vertically_backward (&it
, centering_position
);
15568 xassert (IT_CHARPOS (it
) >= BEGV
);
15570 /* The function move_it_vertically_backward may move over more
15571 than the specified y-distance. If it->w is small, e.g. a
15572 mini-buffer window, we may end up in front of the window's
15573 display area. Start displaying at the start of the line
15574 containing PT in this case. */
15575 if (it
.current_y
<= 0)
15577 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15578 move_it_vertically_backward (&it
, 0);
15582 it
.current_x
= it
.hpos
= 0;
15584 /* Set the window start position here explicitly, to avoid an
15585 infinite loop in case the functions in window-scroll-functions
15587 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15589 /* Run scroll hooks. */
15590 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15592 /* Redisplay the window. */
15593 if (!current_matrix_up_to_date_p
15594 || windows_or_buffers_changed
15595 || cursor_type_changed
15596 /* Don't use try_window_reusing_current_matrix in this case
15597 because it can have changed the buffer. */
15598 || !NILP (Vwindow_scroll_functions
)
15599 || !just_this_one_p
15600 || MINI_WINDOW_P (w
)
15601 || !(used_current_matrix_p
15602 = try_window_reusing_current_matrix (w
)))
15603 try_window (window
, startp
, 0);
15605 /* If new fonts have been loaded (due to fontsets), give up. We
15606 have to start a new redisplay since we need to re-adjust glyph
15608 if (fonts_changed_p
)
15609 goto need_larger_matrices
;
15611 /* If cursor did not appear assume that the middle of the window is
15612 in the first line of the window. Do it again with the next line.
15613 (Imagine a window of height 100, displaying two lines of height
15614 60. Moving back 50 from it->last_visible_y will end in the first
15616 if (w
->cursor
.vpos
< 0)
15618 if (!NILP (w
->window_end_valid
)
15619 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15621 clear_glyph_matrix (w
->desired_matrix
);
15622 move_it_by_lines (&it
, 1);
15623 try_window (window
, it
.current
.pos
, 0);
15625 else if (PT
< IT_CHARPOS (it
))
15627 clear_glyph_matrix (w
->desired_matrix
);
15628 move_it_by_lines (&it
, -1);
15629 try_window (window
, it
.current
.pos
, 0);
15633 /* Not much we can do about it. */
15637 /* Consider the following case: Window starts at BEGV, there is
15638 invisible, intangible text at BEGV, so that display starts at
15639 some point START > BEGV. It can happen that we are called with
15640 PT somewhere between BEGV and START. Try to handle that case. */
15641 if (w
->cursor
.vpos
< 0)
15643 struct glyph_row
*row
= w
->current_matrix
->rows
;
15644 if (row
->mode_line_p
)
15646 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15649 if (!cursor_row_fully_visible_p (w
, 0, 0))
15651 /* If vscroll is enabled, disable it and try again. */
15655 clear_glyph_matrix (w
->desired_matrix
);
15659 /* If centering point failed to make the whole line visible,
15660 put point at the top instead. That has to make the whole line
15661 visible, if it can be done. */
15662 if (centering_position
== 0)
15665 clear_glyph_matrix (w
->desired_matrix
);
15666 centering_position
= 0;
15672 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15673 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15674 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15677 /* Display the mode line, if we must. */
15678 if ((update_mode_line
15679 /* If window not full width, must redo its mode line
15680 if (a) the window to its side is being redone and
15681 (b) we do a frame-based redisplay. This is a consequence
15682 of how inverted lines are drawn in frame-based redisplay. */
15683 || (!just_this_one_p
15684 && !FRAME_WINDOW_P (f
)
15685 && !WINDOW_FULL_WIDTH_P (w
))
15686 /* Line number to display. */
15687 || INTEGERP (w
->base_line_pos
)
15688 /* Column number is displayed and different from the one displayed. */
15689 || (!NILP (w
->column_number_displayed
)
15690 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15691 /* This means that the window has a mode line. */
15692 && (WINDOW_WANTS_MODELINE_P (w
)
15693 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15695 display_mode_lines (w
);
15697 /* If mode line height has changed, arrange for a thorough
15698 immediate redisplay using the correct mode line height. */
15699 if (WINDOW_WANTS_MODELINE_P (w
)
15700 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15702 fonts_changed_p
= 1;
15703 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15704 = DESIRED_MODE_LINE_HEIGHT (w
);
15707 /* If header line height has changed, arrange for a thorough
15708 immediate redisplay using the correct header line height. */
15709 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15710 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15712 fonts_changed_p
= 1;
15713 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15714 = DESIRED_HEADER_LINE_HEIGHT (w
);
15717 if (fonts_changed_p
)
15718 goto need_larger_matrices
;
15721 if (!line_number_displayed
15722 && !BUFFERP (w
->base_line_pos
))
15724 w
->base_line_pos
= Qnil
;
15725 w
->base_line_number
= Qnil
;
15730 /* When we reach a frame's selected window, redo the frame's menu bar. */
15731 if (update_mode_line
15732 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15734 int redisplay_menu_p
= 0;
15736 if (FRAME_WINDOW_P (f
))
15738 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15739 || defined (HAVE_NS) || defined (USE_GTK)
15740 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15742 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15746 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15748 if (redisplay_menu_p
)
15749 display_menu_bar (w
);
15751 #ifdef HAVE_WINDOW_SYSTEM
15752 if (FRAME_WINDOW_P (f
))
15754 #if defined (USE_GTK) || defined (HAVE_NS)
15755 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15756 redisplay_tool_bar (f
);
15758 if (WINDOWP (f
->tool_bar_window
)
15759 && (FRAME_TOOL_BAR_LINES (f
) > 0
15760 || !NILP (Vauto_resize_tool_bars
))
15761 && redisplay_tool_bar (f
))
15762 ignore_mouse_drag_p
= 1;
15768 #ifdef HAVE_WINDOW_SYSTEM
15769 if (FRAME_WINDOW_P (f
)
15770 && update_window_fringes (w
, (just_this_one_p
15771 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15772 || w
->pseudo_window_p
)))
15776 if (draw_window_fringes (w
, 1))
15777 x_draw_vertical_border (w
);
15781 #endif /* HAVE_WINDOW_SYSTEM */
15783 /* We go to this label, with fonts_changed_p nonzero,
15784 if it is necessary to try again using larger glyph matrices.
15785 We have to redeem the scroll bar even in this case,
15786 because the loop in redisplay_internal expects that. */
15787 need_larger_matrices
:
15789 finish_scroll_bars
:
15791 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15793 /* Set the thumb's position and size. */
15794 set_vertical_scroll_bar (w
);
15796 /* Note that we actually used the scroll bar attached to this
15797 window, so it shouldn't be deleted at the end of redisplay. */
15798 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15799 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15802 /* Restore current_buffer and value of point in it. The window
15803 update may have changed the buffer, so first make sure `opoint'
15804 is still valid (Bug#6177). */
15805 if (CHARPOS (opoint
) < BEGV
)
15806 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15807 else if (CHARPOS (opoint
) > ZV
)
15808 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15810 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15812 set_buffer_internal_1 (old
);
15813 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15814 shorter. This can be caused by log truncation in *Messages*. */
15815 if (CHARPOS (lpoint
) <= ZV
)
15816 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15818 unbind_to (count
, Qnil
);
15822 /* Build the complete desired matrix of WINDOW with a window start
15823 buffer position POS.
15825 Value is 1 if successful. It is zero if fonts were loaded during
15826 redisplay which makes re-adjusting glyph matrices necessary, and -1
15827 if point would appear in the scroll margins.
15828 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15829 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15833 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15835 struct window
*w
= XWINDOW (window
);
15837 struct glyph_row
*last_text_row
= NULL
;
15838 struct frame
*f
= XFRAME (w
->frame
);
15840 /* Make POS the new window start. */
15841 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15843 /* Mark cursor position as unknown. No overlay arrow seen. */
15844 w
->cursor
.vpos
= -1;
15845 overlay_arrow_seen
= 0;
15847 /* Initialize iterator and info to start at POS. */
15848 start_display (&it
, w
, pos
);
15850 /* Display all lines of W. */
15851 while (it
.current_y
< it
.last_visible_y
)
15853 if (display_line (&it
))
15854 last_text_row
= it
.glyph_row
- 1;
15855 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15859 /* Don't let the cursor end in the scroll margins. */
15860 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15861 && !MINI_WINDOW_P (w
))
15863 int this_scroll_margin
;
15865 if (scroll_margin
> 0)
15867 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15868 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15871 this_scroll_margin
= 0;
15873 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15874 && w
->cursor
.y
< this_scroll_margin
15875 && CHARPOS (pos
) > BEGV
15876 && IT_CHARPOS (it
) < ZV
)
15877 /* rms: considering make_cursor_line_fully_visible_p here
15878 seems to give wrong results. We don't want to recenter
15879 when the last line is partly visible, we want to allow
15880 that case to be handled in the usual way. */
15881 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15883 w
->cursor
.vpos
= -1;
15884 clear_glyph_matrix (w
->desired_matrix
);
15889 /* If bottom moved off end of frame, change mode line percentage. */
15890 if (XFASTINT (w
->window_end_pos
) <= 0
15891 && Z
!= IT_CHARPOS (it
))
15892 w
->update_mode_line
= Qt
;
15894 /* Set window_end_pos to the offset of the last character displayed
15895 on the window from the end of current_buffer. Set
15896 window_end_vpos to its row number. */
15899 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15900 w
->window_end_bytepos
15901 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15903 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15905 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15906 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15907 ->displays_text_p
);
15911 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15912 w
->window_end_pos
= make_number (Z
- ZV
);
15913 w
->window_end_vpos
= make_number (0);
15916 /* But that is not valid info until redisplay finishes. */
15917 w
->window_end_valid
= Qnil
;
15923 /************************************************************************
15924 Window redisplay reusing current matrix when buffer has not changed
15925 ************************************************************************/
15927 /* Try redisplay of window W showing an unchanged buffer with a
15928 different window start than the last time it was displayed by
15929 reusing its current matrix. Value is non-zero if successful.
15930 W->start is the new window start. */
15933 try_window_reusing_current_matrix (struct window
*w
)
15935 struct frame
*f
= XFRAME (w
->frame
);
15936 struct glyph_row
*bottom_row
;
15939 struct text_pos start
, new_start
;
15940 int nrows_scrolled
, i
;
15941 struct glyph_row
*last_text_row
;
15942 struct glyph_row
*last_reused_text_row
;
15943 struct glyph_row
*start_row
;
15944 int start_vpos
, min_y
, max_y
;
15947 if (inhibit_try_window_reusing
)
15951 if (/* This function doesn't handle terminal frames. */
15952 !FRAME_WINDOW_P (f
)
15953 /* Don't try to reuse the display if windows have been split
15955 || windows_or_buffers_changed
15956 || cursor_type_changed
)
15959 /* Can't do this if region may have changed. */
15960 if ((!NILP (Vtransient_mark_mode
)
15961 && !NILP (BVAR (current_buffer
, mark_active
)))
15962 || !NILP (w
->region_showing
)
15963 || !NILP (Vshow_trailing_whitespace
))
15966 /* If top-line visibility has changed, give up. */
15967 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15968 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15971 /* Give up if old or new display is scrolled vertically. We could
15972 make this function handle this, but right now it doesn't. */
15973 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15974 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15977 /* The variable new_start now holds the new window start. The old
15978 start `start' can be determined from the current matrix. */
15979 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15980 start
= start_row
->minpos
;
15981 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15983 /* Clear the desired matrix for the display below. */
15984 clear_glyph_matrix (w
->desired_matrix
);
15986 if (CHARPOS (new_start
) <= CHARPOS (start
))
15988 /* Don't use this method if the display starts with an ellipsis
15989 displayed for invisible text. It's not easy to handle that case
15990 below, and it's certainly not worth the effort since this is
15991 not a frequent case. */
15992 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15995 IF_DEBUG (debug_method_add (w
, "twu1"));
15997 /* Display up to a row that can be reused. The variable
15998 last_text_row is set to the last row displayed that displays
15999 text. Note that it.vpos == 0 if or if not there is a
16000 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16001 start_display (&it
, w
, new_start
);
16002 w
->cursor
.vpos
= -1;
16003 last_text_row
= last_reused_text_row
= NULL
;
16005 while (it
.current_y
< it
.last_visible_y
16006 && !fonts_changed_p
)
16008 /* If we have reached into the characters in the START row,
16009 that means the line boundaries have changed. So we
16010 can't start copying with the row START. Maybe it will
16011 work to start copying with the following row. */
16012 while (IT_CHARPOS (it
) > CHARPOS (start
))
16014 /* Advance to the next row as the "start". */
16016 start
= start_row
->minpos
;
16017 /* If there are no more rows to try, or just one, give up. */
16018 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16019 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16020 || CHARPOS (start
) == ZV
)
16022 clear_glyph_matrix (w
->desired_matrix
);
16026 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16028 /* If we have reached alignment,
16029 we can copy the rest of the rows. */
16030 if (IT_CHARPOS (it
) == CHARPOS (start
))
16033 if (display_line (&it
))
16034 last_text_row
= it
.glyph_row
- 1;
16037 /* A value of current_y < last_visible_y means that we stopped
16038 at the previous window start, which in turn means that we
16039 have at least one reusable row. */
16040 if (it
.current_y
< it
.last_visible_y
)
16042 struct glyph_row
*row
;
16044 /* IT.vpos always starts from 0; it counts text lines. */
16045 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16047 /* Find PT if not already found in the lines displayed. */
16048 if (w
->cursor
.vpos
< 0)
16050 int dy
= it
.current_y
- start_row
->y
;
16052 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16053 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16055 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16056 dy
, nrows_scrolled
);
16059 clear_glyph_matrix (w
->desired_matrix
);
16064 /* Scroll the display. Do it before the current matrix is
16065 changed. The problem here is that update has not yet
16066 run, i.e. part of the current matrix is not up to date.
16067 scroll_run_hook will clear the cursor, and use the
16068 current matrix to get the height of the row the cursor is
16070 run
.current_y
= start_row
->y
;
16071 run
.desired_y
= it
.current_y
;
16072 run
.height
= it
.last_visible_y
- it
.current_y
;
16074 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16077 FRAME_RIF (f
)->update_window_begin_hook (w
);
16078 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16079 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16080 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16084 /* Shift current matrix down by nrows_scrolled lines. */
16085 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16086 rotate_matrix (w
->current_matrix
,
16088 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16091 /* Disable lines that must be updated. */
16092 for (i
= 0; i
< nrows_scrolled
; ++i
)
16093 (start_row
+ i
)->enabled_p
= 0;
16095 /* Re-compute Y positions. */
16096 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16097 max_y
= it
.last_visible_y
;
16098 for (row
= start_row
+ nrows_scrolled
;
16102 row
->y
= it
.current_y
;
16103 row
->visible_height
= row
->height
;
16105 if (row
->y
< min_y
)
16106 row
->visible_height
-= min_y
- row
->y
;
16107 if (row
->y
+ row
->height
> max_y
)
16108 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16109 if (row
->fringe_bitmap_periodic_p
)
16110 row
->redraw_fringe_bitmaps_p
= 1;
16112 it
.current_y
+= row
->height
;
16114 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16115 last_reused_text_row
= row
;
16116 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16120 /* Disable lines in the current matrix which are now
16121 below the window. */
16122 for (++row
; row
< bottom_row
; ++row
)
16123 row
->enabled_p
= row
->mode_line_p
= 0;
16126 /* Update window_end_pos etc.; last_reused_text_row is the last
16127 reused row from the current matrix containing text, if any.
16128 The value of last_text_row is the last displayed line
16129 containing text. */
16130 if (last_reused_text_row
)
16132 w
->window_end_bytepos
16133 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16135 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16137 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16138 w
->current_matrix
));
16140 else if (last_text_row
)
16142 w
->window_end_bytepos
16143 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16145 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16147 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16151 /* This window must be completely empty. */
16152 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16153 w
->window_end_pos
= make_number (Z
- ZV
);
16154 w
->window_end_vpos
= make_number (0);
16156 w
->window_end_valid
= Qnil
;
16158 /* Update hint: don't try scrolling again in update_window. */
16159 w
->desired_matrix
->no_scrolling_p
= 1;
16162 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16166 else if (CHARPOS (new_start
) > CHARPOS (start
))
16168 struct glyph_row
*pt_row
, *row
;
16169 struct glyph_row
*first_reusable_row
;
16170 struct glyph_row
*first_row_to_display
;
16172 int yb
= window_text_bottom_y (w
);
16174 /* Find the row starting at new_start, if there is one. Don't
16175 reuse a partially visible line at the end. */
16176 first_reusable_row
= start_row
;
16177 while (first_reusable_row
->enabled_p
16178 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16179 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16180 < CHARPOS (new_start
)))
16181 ++first_reusable_row
;
16183 /* Give up if there is no row to reuse. */
16184 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16185 || !first_reusable_row
->enabled_p
16186 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16187 != CHARPOS (new_start
)))
16190 /* We can reuse fully visible rows beginning with
16191 first_reusable_row to the end of the window. Set
16192 first_row_to_display to the first row that cannot be reused.
16193 Set pt_row to the row containing point, if there is any. */
16195 for (first_row_to_display
= first_reusable_row
;
16196 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16197 ++first_row_to_display
)
16199 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16200 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16201 pt_row
= first_row_to_display
;
16204 /* Start displaying at the start of first_row_to_display. */
16205 xassert (first_row_to_display
->y
< yb
);
16206 init_to_row_start (&it
, w
, first_row_to_display
);
16208 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16210 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16212 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16213 + WINDOW_HEADER_LINE_HEIGHT (w
));
16215 /* Display lines beginning with first_row_to_display in the
16216 desired matrix. Set last_text_row to the last row displayed
16217 that displays text. */
16218 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16219 if (pt_row
== NULL
)
16220 w
->cursor
.vpos
= -1;
16221 last_text_row
= NULL
;
16222 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16223 if (display_line (&it
))
16224 last_text_row
= it
.glyph_row
- 1;
16226 /* If point is in a reused row, adjust y and vpos of the cursor
16230 w
->cursor
.vpos
-= nrows_scrolled
;
16231 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16234 /* Give up if point isn't in a row displayed or reused. (This
16235 also handles the case where w->cursor.vpos < nrows_scrolled
16236 after the calls to display_line, which can happen with scroll
16237 margins. See bug#1295.) */
16238 if (w
->cursor
.vpos
< 0)
16240 clear_glyph_matrix (w
->desired_matrix
);
16244 /* Scroll the display. */
16245 run
.current_y
= first_reusable_row
->y
;
16246 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16247 run
.height
= it
.last_visible_y
- run
.current_y
;
16248 dy
= run
.current_y
- run
.desired_y
;
16253 FRAME_RIF (f
)->update_window_begin_hook (w
);
16254 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16255 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16256 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16260 /* Adjust Y positions of reused rows. */
16261 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16262 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16263 max_y
= it
.last_visible_y
;
16264 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16267 row
->visible_height
= row
->height
;
16268 if (row
->y
< min_y
)
16269 row
->visible_height
-= min_y
- row
->y
;
16270 if (row
->y
+ row
->height
> max_y
)
16271 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16272 if (row
->fringe_bitmap_periodic_p
)
16273 row
->redraw_fringe_bitmaps_p
= 1;
16276 /* Scroll the current matrix. */
16277 xassert (nrows_scrolled
> 0);
16278 rotate_matrix (w
->current_matrix
,
16280 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16283 /* Disable rows not reused. */
16284 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16285 row
->enabled_p
= 0;
16287 /* Point may have moved to a different line, so we cannot assume that
16288 the previous cursor position is valid; locate the correct row. */
16291 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16292 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16296 w
->cursor
.y
= row
->y
;
16298 if (row
< bottom_row
)
16300 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16301 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16303 /* Can't use this optimization with bidi-reordered glyph
16304 rows, unless cursor is already at point. */
16305 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16307 if (!(w
->cursor
.hpos
>= 0
16308 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16309 && BUFFERP (glyph
->object
)
16310 && glyph
->charpos
== PT
))
16315 && (!BUFFERP (glyph
->object
)
16316 || glyph
->charpos
< PT
);
16320 w
->cursor
.x
+= glyph
->pixel_width
;
16325 /* Adjust window end. A null value of last_text_row means that
16326 the window end is in reused rows which in turn means that
16327 only its vpos can have changed. */
16330 w
->window_end_bytepos
16331 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16333 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16335 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16340 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16343 w
->window_end_valid
= Qnil
;
16344 w
->desired_matrix
->no_scrolling_p
= 1;
16347 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16357 /************************************************************************
16358 Window redisplay reusing current matrix when buffer has changed
16359 ************************************************************************/
16361 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16362 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16363 EMACS_INT
*, EMACS_INT
*);
16364 static struct glyph_row
*
16365 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16366 struct glyph_row
*);
16369 /* Return the last row in MATRIX displaying text. If row START is
16370 non-null, start searching with that row. IT gives the dimensions
16371 of the display. Value is null if matrix is empty; otherwise it is
16372 a pointer to the row found. */
16374 static struct glyph_row
*
16375 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16376 struct glyph_row
*start
)
16378 struct glyph_row
*row
, *row_found
;
16380 /* Set row_found to the last row in IT->w's current matrix
16381 displaying text. The loop looks funny but think of partially
16384 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16385 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16387 xassert (row
->enabled_p
);
16389 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16398 /* Return the last row in the current matrix of W that is not affected
16399 by changes at the start of current_buffer that occurred since W's
16400 current matrix was built. Value is null if no such row exists.
16402 BEG_UNCHANGED us the number of characters unchanged at the start of
16403 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16404 first changed character in current_buffer. Characters at positions <
16405 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16406 when the current matrix was built. */
16408 static struct glyph_row
*
16409 find_last_unchanged_at_beg_row (struct window
*w
)
16411 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16412 struct glyph_row
*row
;
16413 struct glyph_row
*row_found
= NULL
;
16414 int yb
= window_text_bottom_y (w
);
16416 /* Find the last row displaying unchanged text. */
16417 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16418 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16419 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16422 if (/* If row ends before first_changed_pos, it is unchanged,
16423 except in some case. */
16424 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16425 /* When row ends in ZV and we write at ZV it is not
16427 && !row
->ends_at_zv_p
16428 /* When first_changed_pos is the end of a continued line,
16429 row is not unchanged because it may be no longer
16431 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16432 && (row
->continued_p
16433 || row
->exact_window_width_line_p
)))
16436 /* Stop if last visible row. */
16437 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16445 /* Find the first glyph row in the current matrix of W that is not
16446 affected by changes at the end of current_buffer since the
16447 time W's current matrix was built.
16449 Return in *DELTA the number of chars by which buffer positions in
16450 unchanged text at the end of current_buffer must be adjusted.
16452 Return in *DELTA_BYTES the corresponding number of bytes.
16454 Value is null if no such row exists, i.e. all rows are affected by
16457 static struct glyph_row
*
16458 find_first_unchanged_at_end_row (struct window
*w
,
16459 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16461 struct glyph_row
*row
;
16462 struct glyph_row
*row_found
= NULL
;
16464 *delta
= *delta_bytes
= 0;
16466 /* Display must not have been paused, otherwise the current matrix
16467 is not up to date. */
16468 eassert (!NILP (w
->window_end_valid
));
16470 /* A value of window_end_pos >= END_UNCHANGED means that the window
16471 end is in the range of changed text. If so, there is no
16472 unchanged row at the end of W's current matrix. */
16473 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16476 /* Set row to the last row in W's current matrix displaying text. */
16477 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16479 /* If matrix is entirely empty, no unchanged row exists. */
16480 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16482 /* The value of row is the last glyph row in the matrix having a
16483 meaningful buffer position in it. The end position of row
16484 corresponds to window_end_pos. This allows us to translate
16485 buffer positions in the current matrix to current buffer
16486 positions for characters not in changed text. */
16488 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16489 EMACS_INT Z_BYTE_old
=
16490 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16491 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16492 struct glyph_row
*first_text_row
16493 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16495 *delta
= Z
- Z_old
;
16496 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16498 /* Set last_unchanged_pos to the buffer position of the last
16499 character in the buffer that has not been changed. Z is the
16500 index + 1 of the last character in current_buffer, i.e. by
16501 subtracting END_UNCHANGED we get the index of the last
16502 unchanged character, and we have to add BEG to get its buffer
16504 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16505 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16507 /* Search backward from ROW for a row displaying a line that
16508 starts at a minimum position >= last_unchanged_pos_old. */
16509 for (; row
> first_text_row
; --row
)
16511 /* This used to abort, but it can happen.
16512 It is ok to just stop the search instead here. KFS. */
16513 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16516 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16521 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16527 /* Make sure that glyph rows in the current matrix of window W
16528 reference the same glyph memory as corresponding rows in the
16529 frame's frame matrix. This function is called after scrolling W's
16530 current matrix on a terminal frame in try_window_id and
16531 try_window_reusing_current_matrix. */
16534 sync_frame_with_window_matrix_rows (struct window
*w
)
16536 struct frame
*f
= XFRAME (w
->frame
);
16537 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16539 /* Preconditions: W must be a leaf window and full-width. Its frame
16540 must have a frame matrix. */
16541 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16542 xassert (WINDOW_FULL_WIDTH_P (w
));
16543 xassert (!FRAME_WINDOW_P (f
));
16545 /* If W is a full-width window, glyph pointers in W's current matrix
16546 have, by definition, to be the same as glyph pointers in the
16547 corresponding frame matrix. Note that frame matrices have no
16548 marginal areas (see build_frame_matrix). */
16549 window_row
= w
->current_matrix
->rows
;
16550 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16551 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16552 while (window_row
< window_row_end
)
16554 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16555 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16557 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16558 frame_row
->glyphs
[TEXT_AREA
] = start
;
16559 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16560 frame_row
->glyphs
[LAST_AREA
] = end
;
16562 /* Disable frame rows whose corresponding window rows have
16563 been disabled in try_window_id. */
16564 if (!window_row
->enabled_p
)
16565 frame_row
->enabled_p
= 0;
16567 ++window_row
, ++frame_row
;
16572 /* Find the glyph row in window W containing CHARPOS. Consider all
16573 rows between START and END (not inclusive). END null means search
16574 all rows to the end of the display area of W. Value is the row
16575 containing CHARPOS or null. */
16578 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16579 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16581 struct glyph_row
*row
= start
;
16582 struct glyph_row
*best_row
= NULL
;
16583 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16586 /* If we happen to start on a header-line, skip that. */
16587 if (row
->mode_line_p
)
16590 if ((end
&& row
>= end
) || !row
->enabled_p
)
16593 last_y
= window_text_bottom_y (w
) - dy
;
16597 /* Give up if we have gone too far. */
16598 if (end
&& row
>= end
)
16600 /* This formerly returned if they were equal.
16601 I think that both quantities are of a "last plus one" type;
16602 if so, when they are equal, the row is within the screen. -- rms. */
16603 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16606 /* If it is in this row, return this row. */
16607 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16608 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16609 /* The end position of a row equals the start
16610 position of the next row. If CHARPOS is there, we
16611 would rather display it in the next line, except
16612 when this line ends in ZV. */
16613 && !row
->ends_at_zv_p
16614 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16615 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16619 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16620 || (!best_row
&& !row
->continued_p
))
16622 /* In bidi-reordered rows, there could be several rows
16623 occluding point, all of them belonging to the same
16624 continued line. We need to find the row which fits
16625 CHARPOS the best. */
16626 for (g
= row
->glyphs
[TEXT_AREA
];
16627 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16630 if (!STRINGP (g
->object
))
16632 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16634 mindif
= eabs (g
->charpos
- charpos
);
16636 /* Exact match always wins. */
16643 else if (best_row
&& !row
->continued_p
)
16650 /* Try to redisplay window W by reusing its existing display. W's
16651 current matrix must be up to date when this function is called,
16652 i.e. window_end_valid must not be nil.
16656 1 if display has been updated
16657 0 if otherwise unsuccessful
16658 -1 if redisplay with same window start is known not to succeed
16660 The following steps are performed:
16662 1. Find the last row in the current matrix of W that is not
16663 affected by changes at the start of current_buffer. If no such row
16666 2. Find the first row in W's current matrix that is not affected by
16667 changes at the end of current_buffer. Maybe there is no such row.
16669 3. Display lines beginning with the row + 1 found in step 1 to the
16670 row found in step 2 or, if step 2 didn't find a row, to the end of
16673 4. If cursor is not known to appear on the window, give up.
16675 5. If display stopped at the row found in step 2, scroll the
16676 display and current matrix as needed.
16678 6. Maybe display some lines at the end of W, if we must. This can
16679 happen under various circumstances, like a partially visible line
16680 becoming fully visible, or because newly displayed lines are displayed
16681 in smaller font sizes.
16683 7. Update W's window end information. */
16686 try_window_id (struct window
*w
)
16688 struct frame
*f
= XFRAME (w
->frame
);
16689 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16690 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16691 struct glyph_row
*last_unchanged_at_beg_row
;
16692 struct glyph_row
*first_unchanged_at_end_row
;
16693 struct glyph_row
*row
;
16694 struct glyph_row
*bottom_row
;
16697 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16699 struct text_pos start_pos
;
16701 int first_unchanged_at_end_vpos
= 0;
16702 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16703 struct text_pos start
;
16704 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16707 if (inhibit_try_window_id
)
16711 /* This is handy for debugging. */
16713 #define GIVE_UP(X) \
16715 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16719 #define GIVE_UP(X) return 0
16722 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16724 /* Don't use this for mini-windows because these can show
16725 messages and mini-buffers, and we don't handle that here. */
16726 if (MINI_WINDOW_P (w
))
16729 /* This flag is used to prevent redisplay optimizations. */
16730 if (windows_or_buffers_changed
|| cursor_type_changed
)
16733 /* Verify that narrowing has not changed.
16734 Also verify that we were not told to prevent redisplay optimizations.
16735 It would be nice to further
16736 reduce the number of cases where this prevents try_window_id. */
16737 if (current_buffer
->clip_changed
16738 || current_buffer
->prevent_redisplay_optimizations_p
)
16741 /* Window must either use window-based redisplay or be full width. */
16742 if (!FRAME_WINDOW_P (f
)
16743 && (!FRAME_LINE_INS_DEL_OK (f
)
16744 || !WINDOW_FULL_WIDTH_P (w
)))
16747 /* Give up if point is known NOT to appear in W. */
16748 if (PT
< CHARPOS (start
))
16751 /* Another way to prevent redisplay optimizations. */
16752 if (XFASTINT (w
->last_modified
) == 0)
16755 /* Verify that window is not hscrolled. */
16756 if (XFASTINT (w
->hscroll
) != 0)
16759 /* Verify that display wasn't paused. */
16760 if (NILP (w
->window_end_valid
))
16763 /* Can't use this if highlighting a region because a cursor movement
16764 will do more than just set the cursor. */
16765 if (!NILP (Vtransient_mark_mode
)
16766 && !NILP (BVAR (current_buffer
, mark_active
)))
16769 /* Likewise if highlighting trailing whitespace. */
16770 if (!NILP (Vshow_trailing_whitespace
))
16773 /* Likewise if showing a region. */
16774 if (!NILP (w
->region_showing
))
16777 /* Can't use this if overlay arrow position and/or string have
16779 if (overlay_arrows_changed_p ())
16782 /* When word-wrap is on, adding a space to the first word of a
16783 wrapped line can change the wrap position, altering the line
16784 above it. It might be worthwhile to handle this more
16785 intelligently, but for now just redisplay from scratch. */
16786 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16789 /* Under bidi reordering, adding or deleting a character in the
16790 beginning of a paragraph, before the first strong directional
16791 character, can change the base direction of the paragraph (unless
16792 the buffer specifies a fixed paragraph direction), which will
16793 require to redisplay the whole paragraph. It might be worthwhile
16794 to find the paragraph limits and widen the range of redisplayed
16795 lines to that, but for now just give up this optimization and
16796 redisplay from scratch. */
16797 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16798 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16801 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16802 only if buffer has really changed. The reason is that the gap is
16803 initially at Z for freshly visited files. The code below would
16804 set end_unchanged to 0 in that case. */
16805 if (MODIFF
> SAVE_MODIFF
16806 /* This seems to happen sometimes after saving a buffer. */
16807 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16809 if (GPT
- BEG
< BEG_UNCHANGED
)
16810 BEG_UNCHANGED
= GPT
- BEG
;
16811 if (Z
- GPT
< END_UNCHANGED
)
16812 END_UNCHANGED
= Z
- GPT
;
16815 /* The position of the first and last character that has been changed. */
16816 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16817 last_changed_charpos
= Z
- END_UNCHANGED
;
16819 /* If window starts after a line end, and the last change is in
16820 front of that newline, then changes don't affect the display.
16821 This case happens with stealth-fontification. Note that although
16822 the display is unchanged, glyph positions in the matrix have to
16823 be adjusted, of course. */
16824 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16825 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16826 && ((last_changed_charpos
< CHARPOS (start
)
16827 && CHARPOS (start
) == BEGV
)
16828 || (last_changed_charpos
< CHARPOS (start
) - 1
16829 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16831 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16832 struct glyph_row
*r0
;
16834 /* Compute how many chars/bytes have been added to or removed
16835 from the buffer. */
16836 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16837 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16838 Z_delta
= Z
- Z_old
;
16839 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16841 /* Give up if PT is not in the window. Note that it already has
16842 been checked at the start of try_window_id that PT is not in
16843 front of the window start. */
16844 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16847 /* If window start is unchanged, we can reuse the whole matrix
16848 as is, after adjusting glyph positions. No need to compute
16849 the window end again, since its offset from Z hasn't changed. */
16850 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16851 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16852 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16853 /* PT must not be in a partially visible line. */
16854 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16855 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16857 /* Adjust positions in the glyph matrix. */
16858 if (Z_delta
|| Z_delta_bytes
)
16860 struct glyph_row
*r1
16861 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16862 increment_matrix_positions (w
->current_matrix
,
16863 MATRIX_ROW_VPOS (r0
, current_matrix
),
16864 MATRIX_ROW_VPOS (r1
, current_matrix
),
16865 Z_delta
, Z_delta_bytes
);
16868 /* Set the cursor. */
16869 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16871 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16878 /* Handle the case that changes are all below what is displayed in
16879 the window, and that PT is in the window. This shortcut cannot
16880 be taken if ZV is visible in the window, and text has been added
16881 there that is visible in the window. */
16882 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16883 /* ZV is not visible in the window, or there are no
16884 changes at ZV, actually. */
16885 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16886 || first_changed_charpos
== last_changed_charpos
))
16888 struct glyph_row
*r0
;
16890 /* Give up if PT is not in the window. Note that it already has
16891 been checked at the start of try_window_id that PT is not in
16892 front of the window start. */
16893 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16896 /* If window start is unchanged, we can reuse the whole matrix
16897 as is, without changing glyph positions since no text has
16898 been added/removed in front of the window end. */
16899 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16900 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16901 /* PT must not be in a partially visible line. */
16902 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16903 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16905 /* We have to compute the window end anew since text
16906 could have been added/removed after it. */
16908 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16909 w
->window_end_bytepos
16910 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16912 /* Set the cursor. */
16913 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16915 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16922 /* Give up if window start is in the changed area.
16924 The condition used to read
16926 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16928 but why that was tested escapes me at the moment. */
16929 if (CHARPOS (start
) >= first_changed_charpos
16930 && CHARPOS (start
) <= last_changed_charpos
)
16933 /* Check that window start agrees with the start of the first glyph
16934 row in its current matrix. Check this after we know the window
16935 start is not in changed text, otherwise positions would not be
16937 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16938 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16941 /* Give up if the window ends in strings. Overlay strings
16942 at the end are difficult to handle, so don't try. */
16943 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16944 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16947 /* Compute the position at which we have to start displaying new
16948 lines. Some of the lines at the top of the window might be
16949 reusable because they are not displaying changed text. Find the
16950 last row in W's current matrix not affected by changes at the
16951 start of current_buffer. Value is null if changes start in the
16952 first line of window. */
16953 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16954 if (last_unchanged_at_beg_row
)
16956 /* Avoid starting to display in the moddle of a character, a TAB
16957 for instance. This is easier than to set up the iterator
16958 exactly, and it's not a frequent case, so the additional
16959 effort wouldn't really pay off. */
16960 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16961 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16962 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16963 --last_unchanged_at_beg_row
;
16965 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16968 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16970 start_pos
= it
.current
.pos
;
16972 /* Start displaying new lines in the desired matrix at the same
16973 vpos we would use in the current matrix, i.e. below
16974 last_unchanged_at_beg_row. */
16975 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16977 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16978 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16980 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16984 /* There are no reusable lines at the start of the window.
16985 Start displaying in the first text line. */
16986 start_display (&it
, w
, start
);
16987 it
.vpos
= it
.first_vpos
;
16988 start_pos
= it
.current
.pos
;
16991 /* Find the first row that is not affected by changes at the end of
16992 the buffer. Value will be null if there is no unchanged row, in
16993 which case we must redisplay to the end of the window. delta
16994 will be set to the value by which buffer positions beginning with
16995 first_unchanged_at_end_row have to be adjusted due to text
16997 first_unchanged_at_end_row
16998 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16999 IF_DEBUG (debug_delta
= delta
);
17000 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17002 /* Set stop_pos to the buffer position up to which we will have to
17003 display new lines. If first_unchanged_at_end_row != NULL, this
17004 is the buffer position of the start of the line displayed in that
17005 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17006 that we don't stop at a buffer position. */
17008 if (first_unchanged_at_end_row
)
17010 xassert (last_unchanged_at_beg_row
== NULL
17011 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17013 /* If this is a continuation line, move forward to the next one
17014 that isn't. Changes in lines above affect this line.
17015 Caution: this may move first_unchanged_at_end_row to a row
17016 not displaying text. */
17017 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17018 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17019 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17020 < it
.last_visible_y
))
17021 ++first_unchanged_at_end_row
;
17023 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17024 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17025 >= it
.last_visible_y
))
17026 first_unchanged_at_end_row
= NULL
;
17029 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17031 first_unchanged_at_end_vpos
17032 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17033 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17036 else if (last_unchanged_at_beg_row
== NULL
)
17042 /* Either there is no unchanged row at the end, or the one we have
17043 now displays text. This is a necessary condition for the window
17044 end pos calculation at the end of this function. */
17045 xassert (first_unchanged_at_end_row
== NULL
17046 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17048 debug_last_unchanged_at_beg_vpos
17049 = (last_unchanged_at_beg_row
17050 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17052 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17054 #endif /* GLYPH_DEBUG != 0 */
17057 /* Display new lines. Set last_text_row to the last new line
17058 displayed which has text on it, i.e. might end up as being the
17059 line where the window_end_vpos is. */
17060 w
->cursor
.vpos
= -1;
17061 last_text_row
= NULL
;
17062 overlay_arrow_seen
= 0;
17063 while (it
.current_y
< it
.last_visible_y
17064 && !fonts_changed_p
17065 && (first_unchanged_at_end_row
== NULL
17066 || IT_CHARPOS (it
) < stop_pos
))
17068 if (display_line (&it
))
17069 last_text_row
= it
.glyph_row
- 1;
17072 if (fonts_changed_p
)
17076 /* Compute differences in buffer positions, y-positions etc. for
17077 lines reused at the bottom of the window. Compute what we can
17079 if (first_unchanged_at_end_row
17080 /* No lines reused because we displayed everything up to the
17081 bottom of the window. */
17082 && it
.current_y
< it
.last_visible_y
)
17085 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17087 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17088 run
.current_y
= first_unchanged_at_end_row
->y
;
17089 run
.desired_y
= run
.current_y
+ dy
;
17090 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17094 delta
= delta_bytes
= dvpos
= dy
17095 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17096 first_unchanged_at_end_row
= NULL
;
17098 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17101 /* Find the cursor if not already found. We have to decide whether
17102 PT will appear on this window (it sometimes doesn't, but this is
17103 not a very frequent case.) This decision has to be made before
17104 the current matrix is altered. A value of cursor.vpos < 0 means
17105 that PT is either in one of the lines beginning at
17106 first_unchanged_at_end_row or below the window. Don't care for
17107 lines that might be displayed later at the window end; as
17108 mentioned, this is not a frequent case. */
17109 if (w
->cursor
.vpos
< 0)
17111 /* Cursor in unchanged rows at the top? */
17112 if (PT
< CHARPOS (start_pos
)
17113 && last_unchanged_at_beg_row
)
17115 row
= row_containing_pos (w
, PT
,
17116 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17117 last_unchanged_at_beg_row
+ 1, 0);
17119 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17122 /* Start from first_unchanged_at_end_row looking for PT. */
17123 else if (first_unchanged_at_end_row
)
17125 row
= row_containing_pos (w
, PT
- delta
,
17126 first_unchanged_at_end_row
, NULL
, 0);
17128 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17129 delta_bytes
, dy
, dvpos
);
17132 /* Give up if cursor was not found. */
17133 if (w
->cursor
.vpos
< 0)
17135 clear_glyph_matrix (w
->desired_matrix
);
17140 /* Don't let the cursor end in the scroll margins. */
17142 int this_scroll_margin
, cursor_height
;
17144 this_scroll_margin
=
17145 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17146 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17147 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17149 if ((w
->cursor
.y
< this_scroll_margin
17150 && CHARPOS (start
) > BEGV
)
17151 /* Old redisplay didn't take scroll margin into account at the bottom,
17152 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17153 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17154 ? cursor_height
+ this_scroll_margin
17155 : 1)) > it
.last_visible_y
)
17157 w
->cursor
.vpos
= -1;
17158 clear_glyph_matrix (w
->desired_matrix
);
17163 /* Scroll the display. Do it before changing the current matrix so
17164 that xterm.c doesn't get confused about where the cursor glyph is
17166 if (dy
&& run
.height
)
17170 if (FRAME_WINDOW_P (f
))
17172 FRAME_RIF (f
)->update_window_begin_hook (w
);
17173 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17174 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17175 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17179 /* Terminal frame. In this case, dvpos gives the number of
17180 lines to scroll by; dvpos < 0 means scroll up. */
17182 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17183 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17184 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17185 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17186 + window_internal_height (w
));
17188 #if defined (HAVE_GPM) || defined (MSDOS)
17189 x_clear_window_mouse_face (w
);
17191 /* Perform the operation on the screen. */
17194 /* Scroll last_unchanged_at_beg_row to the end of the
17195 window down dvpos lines. */
17196 set_terminal_window (f
, end
);
17198 /* On dumb terminals delete dvpos lines at the end
17199 before inserting dvpos empty lines. */
17200 if (!FRAME_SCROLL_REGION_OK (f
))
17201 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17203 /* Insert dvpos empty lines in front of
17204 last_unchanged_at_beg_row. */
17205 ins_del_lines (f
, from
, dvpos
);
17207 else if (dvpos
< 0)
17209 /* Scroll up last_unchanged_at_beg_vpos to the end of
17210 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17211 set_terminal_window (f
, end
);
17213 /* Delete dvpos lines in front of
17214 last_unchanged_at_beg_vpos. ins_del_lines will set
17215 the cursor to the given vpos and emit |dvpos| delete
17217 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17219 /* On a dumb terminal insert dvpos empty lines at the
17221 if (!FRAME_SCROLL_REGION_OK (f
))
17222 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17225 set_terminal_window (f
, 0);
17231 /* Shift reused rows of the current matrix to the right position.
17232 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17234 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17235 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17238 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17239 bottom_vpos
, dvpos
);
17240 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17243 else if (dvpos
> 0)
17245 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17246 bottom_vpos
, dvpos
);
17247 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17248 first_unchanged_at_end_vpos
+ dvpos
, 0);
17251 /* For frame-based redisplay, make sure that current frame and window
17252 matrix are in sync with respect to glyph memory. */
17253 if (!FRAME_WINDOW_P (f
))
17254 sync_frame_with_window_matrix_rows (w
);
17256 /* Adjust buffer positions in reused rows. */
17257 if (delta
|| delta_bytes
)
17258 increment_matrix_positions (current_matrix
,
17259 first_unchanged_at_end_vpos
+ dvpos
,
17260 bottom_vpos
, delta
, delta_bytes
);
17262 /* Adjust Y positions. */
17264 shift_glyph_matrix (w
, current_matrix
,
17265 first_unchanged_at_end_vpos
+ dvpos
,
17268 if (first_unchanged_at_end_row
)
17270 first_unchanged_at_end_row
+= dvpos
;
17271 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17272 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17273 first_unchanged_at_end_row
= NULL
;
17276 /* If scrolling up, there may be some lines to display at the end of
17278 last_text_row_at_end
= NULL
;
17281 /* Scrolling up can leave for example a partially visible line
17282 at the end of the window to be redisplayed. */
17283 /* Set last_row to the glyph row in the current matrix where the
17284 window end line is found. It has been moved up or down in
17285 the matrix by dvpos. */
17286 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17287 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17289 /* If last_row is the window end line, it should display text. */
17290 xassert (last_row
->displays_text_p
);
17292 /* If window end line was partially visible before, begin
17293 displaying at that line. Otherwise begin displaying with the
17294 line following it. */
17295 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17297 init_to_row_start (&it
, w
, last_row
);
17298 it
.vpos
= last_vpos
;
17299 it
.current_y
= last_row
->y
;
17303 init_to_row_end (&it
, w
, last_row
);
17304 it
.vpos
= 1 + last_vpos
;
17305 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17309 /* We may start in a continuation line. If so, we have to
17310 get the right continuation_lines_width and current_x. */
17311 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17312 it
.hpos
= it
.current_x
= 0;
17314 /* Display the rest of the lines at the window end. */
17315 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17316 while (it
.current_y
< it
.last_visible_y
17317 && !fonts_changed_p
)
17319 /* Is it always sure that the display agrees with lines in
17320 the current matrix? I don't think so, so we mark rows
17321 displayed invalid in the current matrix by setting their
17322 enabled_p flag to zero. */
17323 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17324 if (display_line (&it
))
17325 last_text_row_at_end
= it
.glyph_row
- 1;
17329 /* Update window_end_pos and window_end_vpos. */
17330 if (first_unchanged_at_end_row
17331 && !last_text_row_at_end
)
17333 /* Window end line if one of the preserved rows from the current
17334 matrix. Set row to the last row displaying text in current
17335 matrix starting at first_unchanged_at_end_row, after
17337 xassert (first_unchanged_at_end_row
->displays_text_p
);
17338 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17339 first_unchanged_at_end_row
);
17340 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17342 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17343 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17345 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17346 xassert (w
->window_end_bytepos
>= 0);
17347 IF_DEBUG (debug_method_add (w
, "A"));
17349 else if (last_text_row_at_end
)
17352 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17353 w
->window_end_bytepos
17354 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17356 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17357 xassert (w
->window_end_bytepos
>= 0);
17358 IF_DEBUG (debug_method_add (w
, "B"));
17360 else if (last_text_row
)
17362 /* We have displayed either to the end of the window or at the
17363 end of the window, i.e. the last row with text is to be found
17364 in the desired matrix. */
17366 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17367 w
->window_end_bytepos
17368 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17370 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17371 xassert (w
->window_end_bytepos
>= 0);
17373 else if (first_unchanged_at_end_row
== NULL
17374 && last_text_row
== NULL
17375 && last_text_row_at_end
== NULL
)
17377 /* Displayed to end of window, but no line containing text was
17378 displayed. Lines were deleted at the end of the window. */
17379 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17380 int vpos
= XFASTINT (w
->window_end_vpos
);
17381 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17382 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17385 row
== NULL
&& vpos
>= first_vpos
;
17386 --vpos
, --current_row
, --desired_row
)
17388 if (desired_row
->enabled_p
)
17390 if (desired_row
->displays_text_p
)
17393 else if (current_row
->displays_text_p
)
17397 xassert (row
!= NULL
);
17398 w
->window_end_vpos
= make_number (vpos
+ 1);
17399 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17400 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17401 xassert (w
->window_end_bytepos
>= 0);
17402 IF_DEBUG (debug_method_add (w
, "C"));
17407 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17408 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17410 /* Record that display has not been completed. */
17411 w
->window_end_valid
= Qnil
;
17412 w
->desired_matrix
->no_scrolling_p
= 1;
17420 /***********************************************************************
17421 More debugging support
17422 ***********************************************************************/
17426 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17427 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17428 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17431 /* Dump the contents of glyph matrix MATRIX on stderr.
17433 GLYPHS 0 means don't show glyph contents.
17434 GLYPHS 1 means show glyphs in short form
17435 GLYPHS > 1 means show glyphs in long form. */
17438 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17441 for (i
= 0; i
< matrix
->nrows
; ++i
)
17442 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17446 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17447 the glyph row and area where the glyph comes from. */
17450 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17452 if (glyph
->type
== CHAR_GLYPH
)
17455 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17456 glyph
- row
->glyphs
[TEXT_AREA
],
17459 (BUFFERP (glyph
->object
)
17461 : (STRINGP (glyph
->object
)
17464 glyph
->pixel_width
,
17466 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17470 glyph
->left_box_line_p
,
17471 glyph
->right_box_line_p
);
17473 else if (glyph
->type
== STRETCH_GLYPH
)
17476 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17477 glyph
- row
->glyphs
[TEXT_AREA
],
17480 (BUFFERP (glyph
->object
)
17482 : (STRINGP (glyph
->object
)
17485 glyph
->pixel_width
,
17489 glyph
->left_box_line_p
,
17490 glyph
->right_box_line_p
);
17492 else if (glyph
->type
== IMAGE_GLYPH
)
17495 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17496 glyph
- row
->glyphs
[TEXT_AREA
],
17499 (BUFFERP (glyph
->object
)
17501 : (STRINGP (glyph
->object
)
17504 glyph
->pixel_width
,
17508 glyph
->left_box_line_p
,
17509 glyph
->right_box_line_p
);
17511 else if (glyph
->type
== COMPOSITE_GLYPH
)
17514 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17515 glyph
- row
->glyphs
[TEXT_AREA
],
17518 (BUFFERP (glyph
->object
)
17520 : (STRINGP (glyph
->object
)
17523 glyph
->pixel_width
,
17525 if (glyph
->u
.cmp
.automatic
)
17528 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17529 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17531 glyph
->left_box_line_p
,
17532 glyph
->right_box_line_p
);
17537 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17538 GLYPHS 0 means don't show glyph contents.
17539 GLYPHS 1 means show glyphs in short form
17540 GLYPHS > 1 means show glyphs in long form. */
17543 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17547 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17548 fprintf (stderr
, "======================================================================\n");
17550 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17551 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17553 MATRIX_ROW_START_CHARPOS (row
),
17554 MATRIX_ROW_END_CHARPOS (row
),
17555 row
->used
[TEXT_AREA
],
17556 row
->contains_overlapping_glyphs_p
,
17558 row
->truncated_on_left_p
,
17559 row
->truncated_on_right_p
,
17561 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17562 row
->displays_text_p
,
17565 row
->ends_in_middle_of_char_p
,
17566 row
->starts_in_middle_of_char_p
,
17572 row
->visible_height
,
17575 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17576 row
->end
.overlay_string_index
,
17577 row
->continuation_lines_width
);
17578 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17579 CHARPOS (row
->start
.string_pos
),
17580 CHARPOS (row
->end
.string_pos
));
17581 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17582 row
->end
.dpvec_index
);
17589 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17591 struct glyph
*glyph
= row
->glyphs
[area
];
17592 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17594 /* Glyph for a line end in text. */
17595 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17598 if (glyph
< glyph_end
)
17599 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17601 for (; glyph
< glyph_end
; ++glyph
)
17602 dump_glyph (row
, glyph
, area
);
17605 else if (glyphs
== 1)
17609 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17611 char *s
= (char *) alloca (row
->used
[area
] + 1);
17614 for (i
= 0; i
< row
->used
[area
]; ++i
)
17616 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17617 if (glyph
->type
== CHAR_GLYPH
17618 && glyph
->u
.ch
< 0x80
17619 && glyph
->u
.ch
>= ' ')
17620 s
[i
] = glyph
->u
.ch
;
17626 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17632 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17633 Sdump_glyph_matrix
, 0, 1, "p",
17634 doc
: /* Dump the current matrix of the selected window to stderr.
17635 Shows contents of glyph row structures. With non-nil
17636 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17637 glyphs in short form, otherwise show glyphs in long form. */)
17638 (Lisp_Object glyphs
)
17640 struct window
*w
= XWINDOW (selected_window
);
17641 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17643 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17644 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17645 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17646 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17647 fprintf (stderr
, "=============================================\n");
17648 dump_glyph_matrix (w
->current_matrix
,
17649 NILP (glyphs
) ? 0 : XINT (glyphs
));
17654 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17655 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17658 struct frame
*f
= XFRAME (selected_frame
);
17659 dump_glyph_matrix (f
->current_matrix
, 1);
17664 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17665 doc
: /* Dump glyph row ROW to stderr.
17666 GLYPH 0 means don't dump glyphs.
17667 GLYPH 1 means dump glyphs in short form.
17668 GLYPH > 1 or omitted means dump glyphs in long form. */)
17669 (Lisp_Object row
, Lisp_Object glyphs
)
17671 struct glyph_matrix
*matrix
;
17674 CHECK_NUMBER (row
);
17675 matrix
= XWINDOW (selected_window
)->current_matrix
;
17677 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17678 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17680 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17685 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17686 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17687 GLYPH 0 means don't dump glyphs.
17688 GLYPH 1 means dump glyphs in short form.
17689 GLYPH > 1 or omitted means dump glyphs in long form. */)
17690 (Lisp_Object row
, Lisp_Object glyphs
)
17692 struct frame
*sf
= SELECTED_FRAME ();
17693 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17696 CHECK_NUMBER (row
);
17698 if (vpos
>= 0 && vpos
< m
->nrows
)
17699 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17700 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17705 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17706 doc
: /* Toggle tracing of redisplay.
17707 With ARG, turn tracing on if and only if ARG is positive. */)
17711 trace_redisplay_p
= !trace_redisplay_p
;
17714 arg
= Fprefix_numeric_value (arg
);
17715 trace_redisplay_p
= XINT (arg
) > 0;
17722 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17723 doc
: /* Like `format', but print result to stderr.
17724 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17725 (ptrdiff_t nargs
, Lisp_Object
*args
)
17727 Lisp_Object s
= Fformat (nargs
, args
);
17728 fprintf (stderr
, "%s", SDATA (s
));
17732 #endif /* GLYPH_DEBUG */
17736 /***********************************************************************
17737 Building Desired Matrix Rows
17738 ***********************************************************************/
17740 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17741 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17743 static struct glyph_row
*
17744 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17746 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17747 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17748 struct buffer
*old
= current_buffer
;
17749 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17750 int arrow_len
= SCHARS (overlay_arrow_string
);
17751 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17752 const unsigned char *p
;
17755 int n_glyphs_before
;
17757 set_buffer_temp (buffer
);
17758 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17759 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17760 SET_TEXT_POS (it
.position
, 0, 0);
17762 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17764 while (p
< arrow_end
)
17766 Lisp_Object face
, ilisp
;
17768 /* Get the next character. */
17770 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17773 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17774 if (! ASCII_CHAR_P (it
.c
))
17775 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17779 /* Get its face. */
17780 ilisp
= make_number (p
- arrow_string
);
17781 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17782 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17784 /* Compute its width, get its glyphs. */
17785 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17786 SET_TEXT_POS (it
.position
, -1, -1);
17787 PRODUCE_GLYPHS (&it
);
17789 /* If this character doesn't fit any more in the line, we have
17790 to remove some glyphs. */
17791 if (it
.current_x
> it
.last_visible_x
)
17793 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17798 set_buffer_temp (old
);
17799 return it
.glyph_row
;
17803 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17804 glyphs are only inserted for terminal frames since we can't really
17805 win with truncation glyphs when partially visible glyphs are
17806 involved. Which glyphs to insert is determined by
17807 produce_special_glyphs. */
17810 insert_left_trunc_glyphs (struct it
*it
)
17812 struct it truncate_it
;
17813 struct glyph
*from
, *end
, *to
, *toend
;
17815 xassert (!FRAME_WINDOW_P (it
->f
));
17817 /* Get the truncation glyphs. */
17819 truncate_it
.current_x
= 0;
17820 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17821 truncate_it
.glyph_row
= &scratch_glyph_row
;
17822 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17823 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17824 truncate_it
.object
= make_number (0);
17825 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17827 /* Overwrite glyphs from IT with truncation glyphs. */
17828 if (!it
->glyph_row
->reversed_p
)
17830 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17831 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17832 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17833 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17838 /* There may be padding glyphs left over. Overwrite them too. */
17839 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17841 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17847 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17851 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17852 that back to front. */
17853 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17854 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17855 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17856 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17858 while (from
>= end
&& to
>= toend
)
17860 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17863 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17864 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17865 while (from
>= end
&& to
>= toend
)
17870 /* Need to free some room before prepending additional
17872 int move_by
= from
- end
+ 1;
17873 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17874 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17876 for ( ; g
>= g0
; g
--)
17878 while (from
>= end
)
17880 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17886 /* Compute the pixel height and width of IT->glyph_row.
17888 Most of the time, ascent and height of a display line will be equal
17889 to the max_ascent and max_height values of the display iterator
17890 structure. This is not the case if
17892 1. We hit ZV without displaying anything. In this case, max_ascent
17893 and max_height will be zero.
17895 2. We have some glyphs that don't contribute to the line height.
17896 (The glyph row flag contributes_to_line_height_p is for future
17897 pixmap extensions).
17899 The first case is easily covered by using default values because in
17900 these cases, the line height does not really matter, except that it
17901 must not be zero. */
17904 compute_line_metrics (struct it
*it
)
17906 struct glyph_row
*row
= it
->glyph_row
;
17908 if (FRAME_WINDOW_P (it
->f
))
17910 int i
, min_y
, max_y
;
17912 /* The line may consist of one space only, that was added to
17913 place the cursor on it. If so, the row's height hasn't been
17915 if (row
->height
== 0)
17917 if (it
->max_ascent
+ it
->max_descent
== 0)
17918 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17919 row
->ascent
= it
->max_ascent
;
17920 row
->height
= it
->max_ascent
+ it
->max_descent
;
17921 row
->phys_ascent
= it
->max_phys_ascent
;
17922 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17923 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17926 /* Compute the width of this line. */
17927 row
->pixel_width
= row
->x
;
17928 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17929 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17931 xassert (row
->pixel_width
>= 0);
17932 xassert (row
->ascent
>= 0 && row
->height
> 0);
17934 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17935 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17937 /* If first line's physical ascent is larger than its logical
17938 ascent, use the physical ascent, and make the row taller.
17939 This makes accented characters fully visible. */
17940 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17941 && row
->phys_ascent
> row
->ascent
)
17943 row
->height
+= row
->phys_ascent
- row
->ascent
;
17944 row
->ascent
= row
->phys_ascent
;
17947 /* Compute how much of the line is visible. */
17948 row
->visible_height
= row
->height
;
17950 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17951 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17953 if (row
->y
< min_y
)
17954 row
->visible_height
-= min_y
- row
->y
;
17955 if (row
->y
+ row
->height
> max_y
)
17956 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17960 row
->pixel_width
= row
->used
[TEXT_AREA
];
17961 if (row
->continued_p
)
17962 row
->pixel_width
-= it
->continuation_pixel_width
;
17963 else if (row
->truncated_on_right_p
)
17964 row
->pixel_width
-= it
->truncation_pixel_width
;
17965 row
->ascent
= row
->phys_ascent
= 0;
17966 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17967 row
->extra_line_spacing
= 0;
17970 /* Compute a hash code for this row. */
17974 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17975 for (i
= 0; i
< row
->used
[area
]; ++i
)
17976 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17977 + row
->glyphs
[area
][i
].u
.val
17978 + row
->glyphs
[area
][i
].face_id
17979 + row
->glyphs
[area
][i
].padding_p
17980 + (row
->glyphs
[area
][i
].type
<< 2));
17983 it
->max_ascent
= it
->max_descent
= 0;
17984 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17988 /* Append one space to the glyph row of iterator IT if doing a
17989 window-based redisplay. The space has the same face as
17990 IT->face_id. Value is non-zero if a space was added.
17992 This function is called to make sure that there is always one glyph
17993 at the end of a glyph row that the cursor can be set on under
17994 window-systems. (If there weren't such a glyph we would not know
17995 how wide and tall a box cursor should be displayed).
17997 At the same time this space let's a nicely handle clearing to the
17998 end of the line if the row ends in italic text. */
18001 append_space_for_newline (struct it
*it
, int default_face_p
)
18003 if (FRAME_WINDOW_P (it
->f
))
18005 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18007 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18008 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18010 /* Save some values that must not be changed.
18011 Must save IT->c and IT->len because otherwise
18012 ITERATOR_AT_END_P wouldn't work anymore after
18013 append_space_for_newline has been called. */
18014 enum display_element_type saved_what
= it
->what
;
18015 int saved_c
= it
->c
, saved_len
= it
->len
;
18016 int saved_char_to_display
= it
->char_to_display
;
18017 int saved_x
= it
->current_x
;
18018 int saved_face_id
= it
->face_id
;
18019 struct text_pos saved_pos
;
18020 Lisp_Object saved_object
;
18023 saved_object
= it
->object
;
18024 saved_pos
= it
->position
;
18026 it
->what
= IT_CHARACTER
;
18027 memset (&it
->position
, 0, sizeof it
->position
);
18028 it
->object
= make_number (0);
18029 it
->c
= it
->char_to_display
= ' ';
18032 if (default_face_p
)
18033 it
->face_id
= DEFAULT_FACE_ID
;
18034 else if (it
->face_before_selective_p
)
18035 it
->face_id
= it
->saved_face_id
;
18036 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18037 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18039 PRODUCE_GLYPHS (it
);
18041 it
->override_ascent
= -1;
18042 it
->constrain_row_ascent_descent_p
= 0;
18043 it
->current_x
= saved_x
;
18044 it
->object
= saved_object
;
18045 it
->position
= saved_pos
;
18046 it
->what
= saved_what
;
18047 it
->face_id
= saved_face_id
;
18048 it
->len
= saved_len
;
18050 it
->char_to_display
= saved_char_to_display
;
18059 /* Extend the face of the last glyph in the text area of IT->glyph_row
18060 to the end of the display line. Called from display_line. If the
18061 glyph row is empty, add a space glyph to it so that we know the
18062 face to draw. Set the glyph row flag fill_line_p. If the glyph
18063 row is R2L, prepend a stretch glyph to cover the empty space to the
18064 left of the leftmost glyph. */
18067 extend_face_to_end_of_line (struct it
*it
)
18070 struct frame
*f
= it
->f
;
18072 /* If line is already filled, do nothing. Non window-system frames
18073 get a grace of one more ``pixel'' because their characters are
18074 1-``pixel'' wide, so they hit the equality too early. This grace
18075 is needed only for R2L rows that are not continued, to produce
18076 one extra blank where we could display the cursor. */
18077 if (it
->current_x
>= it
->last_visible_x
18078 + (!FRAME_WINDOW_P (f
)
18079 && it
->glyph_row
->reversed_p
18080 && !it
->glyph_row
->continued_p
))
18083 /* Face extension extends the background and box of IT->face_id
18084 to the end of the line. If the background equals the background
18085 of the frame, we don't have to do anything. */
18086 if (it
->face_before_selective_p
)
18087 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18089 face
= FACE_FROM_ID (f
, it
->face_id
);
18091 if (FRAME_WINDOW_P (f
)
18092 && it
->glyph_row
->displays_text_p
18093 && face
->box
== FACE_NO_BOX
18094 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18096 && !it
->glyph_row
->reversed_p
)
18099 /* Set the glyph row flag indicating that the face of the last glyph
18100 in the text area has to be drawn to the end of the text area. */
18101 it
->glyph_row
->fill_line_p
= 1;
18103 /* If current character of IT is not ASCII, make sure we have the
18104 ASCII face. This will be automatically undone the next time
18105 get_next_display_element returns a multibyte character. Note
18106 that the character will always be single byte in unibyte
18108 if (!ASCII_CHAR_P (it
->c
))
18110 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18113 if (FRAME_WINDOW_P (f
))
18115 /* If the row is empty, add a space with the current face of IT,
18116 so that we know which face to draw. */
18117 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18119 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18120 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18121 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18123 #ifdef HAVE_WINDOW_SYSTEM
18124 if (it
->glyph_row
->reversed_p
)
18126 /* Prepend a stretch glyph to the row, such that the
18127 rightmost glyph will be drawn flushed all the way to the
18128 right margin of the window. The stretch glyph that will
18129 occupy the empty space, if any, to the left of the
18131 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18132 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18133 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18135 int row_width
, stretch_ascent
, stretch_width
;
18136 struct text_pos saved_pos
;
18137 int saved_face_id
, saved_avoid_cursor
;
18139 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18140 row_width
+= g
->pixel_width
;
18141 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18142 if (stretch_width
> 0)
18145 (((it
->ascent
+ it
->descent
)
18146 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18147 saved_pos
= it
->position
;
18148 memset (&it
->position
, 0, sizeof it
->position
);
18149 saved_avoid_cursor
= it
->avoid_cursor_p
;
18150 it
->avoid_cursor_p
= 1;
18151 saved_face_id
= it
->face_id
;
18152 /* The last row's stretch glyph should get the default
18153 face, to avoid painting the rest of the window with
18154 the region face, if the region ends at ZV. */
18155 if (it
->glyph_row
->ends_at_zv_p
)
18156 it
->face_id
= DEFAULT_FACE_ID
;
18158 it
->face_id
= face
->id
;
18159 append_stretch_glyph (it
, make_number (0), stretch_width
,
18160 it
->ascent
+ it
->descent
, stretch_ascent
);
18161 it
->position
= saved_pos
;
18162 it
->avoid_cursor_p
= saved_avoid_cursor
;
18163 it
->face_id
= saved_face_id
;
18166 #endif /* HAVE_WINDOW_SYSTEM */
18170 /* Save some values that must not be changed. */
18171 int saved_x
= it
->current_x
;
18172 struct text_pos saved_pos
;
18173 Lisp_Object saved_object
;
18174 enum display_element_type saved_what
= it
->what
;
18175 int saved_face_id
= it
->face_id
;
18177 saved_object
= it
->object
;
18178 saved_pos
= it
->position
;
18180 it
->what
= IT_CHARACTER
;
18181 memset (&it
->position
, 0, sizeof it
->position
);
18182 it
->object
= make_number (0);
18183 it
->c
= it
->char_to_display
= ' ';
18185 /* The last row's blank glyphs should get the default face, to
18186 avoid painting the rest of the window with the region face,
18187 if the region ends at ZV. */
18188 if (it
->glyph_row
->ends_at_zv_p
)
18189 it
->face_id
= DEFAULT_FACE_ID
;
18191 it
->face_id
= face
->id
;
18193 PRODUCE_GLYPHS (it
);
18195 while (it
->current_x
<= it
->last_visible_x
)
18196 PRODUCE_GLYPHS (it
);
18198 /* Don't count these blanks really. It would let us insert a left
18199 truncation glyph below and make us set the cursor on them, maybe. */
18200 it
->current_x
= saved_x
;
18201 it
->object
= saved_object
;
18202 it
->position
= saved_pos
;
18203 it
->what
= saved_what
;
18204 it
->face_id
= saved_face_id
;
18209 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18210 trailing whitespace. */
18213 trailing_whitespace_p (EMACS_INT charpos
)
18215 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18218 while (bytepos
< ZV_BYTE
18219 && (c
= FETCH_CHAR (bytepos
),
18220 c
== ' ' || c
== '\t'))
18223 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18225 if (bytepos
!= PT_BYTE
)
18232 /* Highlight trailing whitespace, if any, in ROW. */
18235 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18237 int used
= row
->used
[TEXT_AREA
];
18241 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18242 struct glyph
*glyph
= start
+ used
- 1;
18244 if (row
->reversed_p
)
18246 /* Right-to-left rows need to be processed in the opposite
18247 direction, so swap the edge pointers. */
18249 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18252 /* Skip over glyphs inserted to display the cursor at the
18253 end of a line, for extending the face of the last glyph
18254 to the end of the line on terminals, and for truncation
18255 and continuation glyphs. */
18256 if (!row
->reversed_p
)
18258 while (glyph
>= start
18259 && glyph
->type
== CHAR_GLYPH
18260 && INTEGERP (glyph
->object
))
18265 while (glyph
<= start
18266 && glyph
->type
== CHAR_GLYPH
18267 && INTEGERP (glyph
->object
))
18271 /* If last glyph is a space or stretch, and it's trailing
18272 whitespace, set the face of all trailing whitespace glyphs in
18273 IT->glyph_row to `trailing-whitespace'. */
18274 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18275 && BUFFERP (glyph
->object
)
18276 && (glyph
->type
== STRETCH_GLYPH
18277 || (glyph
->type
== CHAR_GLYPH
18278 && glyph
->u
.ch
== ' '))
18279 && trailing_whitespace_p (glyph
->charpos
))
18281 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18285 if (!row
->reversed_p
)
18287 while (glyph
>= start
18288 && BUFFERP (glyph
->object
)
18289 && (glyph
->type
== STRETCH_GLYPH
18290 || (glyph
->type
== CHAR_GLYPH
18291 && glyph
->u
.ch
== ' ')))
18292 (glyph
--)->face_id
= face_id
;
18296 while (glyph
<= start
18297 && BUFFERP (glyph
->object
)
18298 && (glyph
->type
== STRETCH_GLYPH
18299 || (glyph
->type
== CHAR_GLYPH
18300 && glyph
->u
.ch
== ' ')))
18301 (glyph
++)->face_id
= face_id
;
18308 /* Value is non-zero if glyph row ROW should be
18309 used to hold the cursor. */
18312 cursor_row_p (struct glyph_row
*row
)
18316 if (PT
== CHARPOS (row
->end
.pos
)
18317 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18319 /* Suppose the row ends on a string.
18320 Unless the row is continued, that means it ends on a newline
18321 in the string. If it's anything other than a display string
18322 (e.g. a before-string from an overlay), we don't want the
18323 cursor there. (This heuristic seems to give the optimal
18324 behavior for the various types of multi-line strings.) */
18325 if (CHARPOS (row
->end
.string_pos
) >= 0)
18327 if (row
->continued_p
)
18331 /* Check for `display' property. */
18332 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18333 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18334 struct glyph
*glyph
;
18337 for (glyph
= end
; glyph
>= beg
; --glyph
)
18338 if (STRINGP (glyph
->object
))
18341 = Fget_char_property (make_number (PT
),
18345 && display_prop_string_p (prop
, glyph
->object
));
18350 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18352 /* If the row ends in middle of a real character,
18353 and the line is continued, we want the cursor here.
18354 That's because CHARPOS (ROW->end.pos) would equal
18355 PT if PT is before the character. */
18356 if (!row
->ends_in_ellipsis_p
)
18357 result
= row
->continued_p
;
18359 /* If the row ends in an ellipsis, then
18360 CHARPOS (ROW->end.pos) will equal point after the
18361 invisible text. We want that position to be displayed
18362 after the ellipsis. */
18365 /* If the row ends at ZV, display the cursor at the end of that
18366 row instead of at the start of the row below. */
18367 else if (row
->ends_at_zv_p
)
18378 /* Push the property PROP so that it will be rendered at the current
18379 position in IT. Return 1 if PROP was successfully pushed, 0
18380 otherwise. Called from handle_line_prefix to handle the
18381 `line-prefix' and `wrap-prefix' properties. */
18384 push_display_prop (struct it
*it
, Lisp_Object prop
)
18386 struct text_pos pos
=
18387 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18389 xassert (it
->method
== GET_FROM_BUFFER
18390 || it
->method
== GET_FROM_STRING
);
18392 /* We need to save the current buffer/string position, so it will be
18393 restored by pop_it, because iterate_out_of_display_property
18394 depends on that being set correctly, but some situations leave
18395 it->position not yet set when this function is called. */
18396 push_it (it
, &pos
);
18398 if (STRINGP (prop
))
18400 if (SCHARS (prop
) == 0)
18407 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18408 it
->current
.overlay_string_index
= -1;
18409 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18410 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18411 it
->method
= GET_FROM_STRING
;
18412 it
->stop_charpos
= 0;
18414 it
->base_level_stop
= 0;
18416 /* Force paragraph direction to be that of the parent
18418 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18419 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18421 it
->paragraph_embedding
= L2R
;
18423 /* Set up the bidi iterator for this display string. */
18426 it
->bidi_it
.string
.lstring
= it
->string
;
18427 it
->bidi_it
.string
.s
= NULL
;
18428 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18429 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18430 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18431 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18432 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18435 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18437 it
->method
= GET_FROM_STRETCH
;
18440 #ifdef HAVE_WINDOW_SYSTEM
18441 else if (IMAGEP (prop
))
18443 it
->what
= IT_IMAGE
;
18444 it
->image_id
= lookup_image (it
->f
, prop
);
18445 it
->method
= GET_FROM_IMAGE
;
18447 #endif /* HAVE_WINDOW_SYSTEM */
18450 pop_it (it
); /* bogus display property, give up */
18457 /* Return the character-property PROP at the current position in IT. */
18460 get_it_property (struct it
*it
, Lisp_Object prop
)
18462 Lisp_Object position
;
18464 if (STRINGP (it
->object
))
18465 position
= make_number (IT_STRING_CHARPOS (*it
));
18466 else if (BUFFERP (it
->object
))
18467 position
= make_number (IT_CHARPOS (*it
));
18471 return Fget_char_property (position
, prop
, it
->object
);
18474 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18477 handle_line_prefix (struct it
*it
)
18479 Lisp_Object prefix
;
18481 if (it
->continuation_lines_width
> 0)
18483 prefix
= get_it_property (it
, Qwrap_prefix
);
18485 prefix
= Vwrap_prefix
;
18489 prefix
= get_it_property (it
, Qline_prefix
);
18491 prefix
= Vline_prefix
;
18493 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18495 /* If the prefix is wider than the window, and we try to wrap
18496 it, it would acquire its own wrap prefix, and so on till the
18497 iterator stack overflows. So, don't wrap the prefix. */
18498 it
->line_wrap
= TRUNCATE
;
18499 it
->avoid_cursor_p
= 1;
18505 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18506 only for R2L lines from display_line and display_string, when they
18507 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18508 the line/string needs to be continued on the next glyph row. */
18510 unproduce_glyphs (struct it
*it
, int n
)
18512 struct glyph
*glyph
, *end
;
18514 xassert (it
->glyph_row
);
18515 xassert (it
->glyph_row
->reversed_p
);
18516 xassert (it
->area
== TEXT_AREA
);
18517 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18519 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18520 n
= it
->glyph_row
->used
[TEXT_AREA
];
18521 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18522 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18523 for ( ; glyph
< end
; glyph
++)
18524 glyph
[-n
] = *glyph
;
18527 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18528 and ROW->maxpos. */
18530 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18531 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18532 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18534 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18535 lines' rows is implemented for bidi-reordered rows. */
18537 /* ROW->minpos is the value of min_pos, the minimal buffer position
18538 we have in ROW, or ROW->start.pos if that is smaller. */
18539 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18540 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18542 /* We didn't find buffer positions smaller than ROW->start, or
18543 didn't find _any_ valid buffer positions in any of the glyphs,
18544 so we must trust the iterator's computed positions. */
18545 row
->minpos
= row
->start
.pos
;
18548 max_pos
= CHARPOS (it
->current
.pos
);
18549 max_bpos
= BYTEPOS (it
->current
.pos
);
18552 /* Here are the various use-cases for ending the row, and the
18553 corresponding values for ROW->maxpos:
18555 Line ends in a newline from buffer eol_pos + 1
18556 Line is continued from buffer max_pos + 1
18557 Line is truncated on right it->current.pos
18558 Line ends in a newline from string max_pos + 1(*)
18559 (*) + 1 only when line ends in a forward scan
18560 Line is continued from string max_pos
18561 Line is continued from display vector max_pos
18562 Line is entirely from a string min_pos == max_pos
18563 Line is entirely from a display vector min_pos == max_pos
18564 Line that ends at ZV ZV
18566 If you discover other use-cases, please add them here as
18568 if (row
->ends_at_zv_p
)
18569 row
->maxpos
= it
->current
.pos
;
18570 else if (row
->used
[TEXT_AREA
])
18572 int seen_this_string
= 0;
18573 struct glyph_row
*r1
= row
- 1;
18575 /* Did we see the same display string on the previous row? */
18576 if (STRINGP (it
->object
)
18577 /* this is not the first row */
18578 && row
> it
->w
->desired_matrix
->rows
18579 /* previous row is not the header line */
18580 && !r1
->mode_line_p
18581 /* previous row also ends in a newline from a string */
18582 && r1
->ends_in_newline_from_string_p
)
18584 struct glyph
*start
, *end
;
18586 /* Search for the last glyph of the previous row that came
18587 from buffer or string. Depending on whether the row is
18588 L2R or R2L, we need to process it front to back or the
18589 other way round. */
18590 if (!r1
->reversed_p
)
18592 start
= r1
->glyphs
[TEXT_AREA
];
18593 end
= start
+ r1
->used
[TEXT_AREA
];
18594 /* Glyphs inserted by redisplay have an integer (zero)
18595 as their object. */
18597 && INTEGERP ((end
- 1)->object
)
18598 && (end
- 1)->charpos
<= 0)
18602 if (EQ ((end
- 1)->object
, it
->object
))
18603 seen_this_string
= 1;
18610 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18611 start
= end
+ r1
->used
[TEXT_AREA
];
18613 && INTEGERP ((end
+ 1)->object
)
18614 && (end
+ 1)->charpos
<= 0)
18618 if (EQ ((end
+ 1)->object
, it
->object
))
18619 seen_this_string
= 1;
18625 /* Take note of each display string that covers a newline only
18626 once, the first time we see it. This is for when a display
18627 string includes more than one newline in it. */
18628 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18630 /* If we were scanning the buffer forward when we displayed
18631 the string, we want to account for at least one buffer
18632 position that belongs to this row (position covered by
18633 the display string), so that cursor positioning will
18634 consider this row as a candidate when point is at the end
18635 of the visual line represented by this row. This is not
18636 required when scanning back, because max_pos will already
18637 have a much larger value. */
18638 if (CHARPOS (row
->end
.pos
) > max_pos
)
18639 INC_BOTH (max_pos
, max_bpos
);
18640 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18642 else if (CHARPOS (it
->eol_pos
) > 0)
18643 SET_TEXT_POS (row
->maxpos
,
18644 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18645 else if (row
->continued_p
)
18647 /* If max_pos is different from IT's current position, it
18648 means IT->method does not belong to the display element
18649 at max_pos. However, it also means that the display
18650 element at max_pos was displayed in its entirety on this
18651 line, which is equivalent to saying that the next line
18652 starts at the next buffer position. */
18653 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18654 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18657 INC_BOTH (max_pos
, max_bpos
);
18658 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18661 else if (row
->truncated_on_right_p
)
18662 /* display_line already called reseat_at_next_visible_line_start,
18663 which puts the iterator at the beginning of the next line, in
18664 the logical order. */
18665 row
->maxpos
= it
->current
.pos
;
18666 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18667 /* A line that is entirely from a string/image/stretch... */
18668 row
->maxpos
= row
->minpos
;
18673 row
->maxpos
= it
->current
.pos
;
18676 /* Construct the glyph row IT->glyph_row in the desired matrix of
18677 IT->w from text at the current position of IT. See dispextern.h
18678 for an overview of struct it. Value is non-zero if
18679 IT->glyph_row displays text, as opposed to a line displaying ZV
18683 display_line (struct it
*it
)
18685 struct glyph_row
*row
= it
->glyph_row
;
18686 Lisp_Object overlay_arrow_string
;
18688 void *wrap_data
= NULL
;
18689 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18690 int wrap_row_used
= -1;
18691 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18692 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18693 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18694 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18695 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18697 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18698 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18700 /* We always start displaying at hpos zero even if hscrolled. */
18701 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18703 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18704 >= it
->w
->desired_matrix
->nrows
)
18706 it
->w
->nrows_scale_factor
++;
18707 fonts_changed_p
= 1;
18711 /* Is IT->w showing the region? */
18712 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18714 /* Clear the result glyph row and enable it. */
18715 prepare_desired_row (row
);
18717 row
->y
= it
->current_y
;
18718 row
->start
= it
->start
;
18719 row
->continuation_lines_width
= it
->continuation_lines_width
;
18720 row
->displays_text_p
= 1;
18721 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18722 it
->starts_in_middle_of_char_p
= 0;
18724 /* Arrange the overlays nicely for our purposes. Usually, we call
18725 display_line on only one line at a time, in which case this
18726 can't really hurt too much, or we call it on lines which appear
18727 one after another in the buffer, in which case all calls to
18728 recenter_overlay_lists but the first will be pretty cheap. */
18729 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18731 /* Move over display elements that are not visible because we are
18732 hscrolled. This may stop at an x-position < IT->first_visible_x
18733 if the first glyph is partially visible or if we hit a line end. */
18734 if (it
->current_x
< it
->first_visible_x
)
18736 this_line_min_pos
= row
->start
.pos
;
18737 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18738 MOVE_TO_POS
| MOVE_TO_X
);
18739 /* Record the smallest positions seen while we moved over
18740 display elements that are not visible. This is needed by
18741 redisplay_internal for optimizing the case where the cursor
18742 stays inside the same line. The rest of this function only
18743 considers positions that are actually displayed, so
18744 RECORD_MAX_MIN_POS will not otherwise record positions that
18745 are hscrolled to the left of the left edge of the window. */
18746 min_pos
= CHARPOS (this_line_min_pos
);
18747 min_bpos
= BYTEPOS (this_line_min_pos
);
18751 /* We only do this when not calling `move_it_in_display_line_to'
18752 above, because move_it_in_display_line_to calls
18753 handle_line_prefix itself. */
18754 handle_line_prefix (it
);
18757 /* Get the initial row height. This is either the height of the
18758 text hscrolled, if there is any, or zero. */
18759 row
->ascent
= it
->max_ascent
;
18760 row
->height
= it
->max_ascent
+ it
->max_descent
;
18761 row
->phys_ascent
= it
->max_phys_ascent
;
18762 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18763 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18765 /* Utility macro to record max and min buffer positions seen until now. */
18766 #define RECORD_MAX_MIN_POS(IT) \
18769 int composition_p = (IT)->what == IT_COMPOSITION; \
18770 EMACS_INT current_pos = \
18771 composition_p ? (IT)->cmp_it.charpos \
18772 : IT_CHARPOS (*(IT)); \
18773 EMACS_INT current_bpos = \
18774 composition_p ? CHAR_TO_BYTE (current_pos) \
18775 : IT_BYTEPOS (*(IT)); \
18776 if (current_pos < min_pos) \
18778 min_pos = current_pos; \
18779 min_bpos = current_bpos; \
18781 if (IT_CHARPOS (*it) > max_pos) \
18783 max_pos = IT_CHARPOS (*it); \
18784 max_bpos = IT_BYTEPOS (*it); \
18789 /* Loop generating characters. The loop is left with IT on the next
18790 character to display. */
18793 int n_glyphs_before
, hpos_before
, x_before
;
18795 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18797 /* Retrieve the next thing to display. Value is zero if end of
18799 if (!get_next_display_element (it
))
18801 /* Maybe add a space at the end of this line that is used to
18802 display the cursor there under X. Set the charpos of the
18803 first glyph of blank lines not corresponding to any text
18805 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18806 row
->exact_window_width_line_p
= 1;
18807 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18808 || row
->used
[TEXT_AREA
] == 0)
18810 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18811 row
->displays_text_p
= 0;
18813 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18814 && (!MINI_WINDOW_P (it
->w
)
18815 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18816 row
->indicate_empty_line_p
= 1;
18819 it
->continuation_lines_width
= 0;
18820 row
->ends_at_zv_p
= 1;
18821 /* A row that displays right-to-left text must always have
18822 its last face extended all the way to the end of line,
18823 even if this row ends in ZV, because we still write to
18824 the screen left to right. */
18825 if (row
->reversed_p
)
18826 extend_face_to_end_of_line (it
);
18830 /* Now, get the metrics of what we want to display. This also
18831 generates glyphs in `row' (which is IT->glyph_row). */
18832 n_glyphs_before
= row
->used
[TEXT_AREA
];
18835 /* Remember the line height so far in case the next element doesn't
18836 fit on the line. */
18837 if (it
->line_wrap
!= TRUNCATE
)
18839 ascent
= it
->max_ascent
;
18840 descent
= it
->max_descent
;
18841 phys_ascent
= it
->max_phys_ascent
;
18842 phys_descent
= it
->max_phys_descent
;
18844 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18846 if (IT_DISPLAYING_WHITESPACE (it
))
18850 SAVE_IT (wrap_it
, *it
, wrap_data
);
18852 wrap_row_used
= row
->used
[TEXT_AREA
];
18853 wrap_row_ascent
= row
->ascent
;
18854 wrap_row_height
= row
->height
;
18855 wrap_row_phys_ascent
= row
->phys_ascent
;
18856 wrap_row_phys_height
= row
->phys_height
;
18857 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18858 wrap_row_min_pos
= min_pos
;
18859 wrap_row_min_bpos
= min_bpos
;
18860 wrap_row_max_pos
= max_pos
;
18861 wrap_row_max_bpos
= max_bpos
;
18867 PRODUCE_GLYPHS (it
);
18869 /* If this display element was in marginal areas, continue with
18871 if (it
->area
!= TEXT_AREA
)
18873 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18874 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18875 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18876 row
->phys_height
= max (row
->phys_height
,
18877 it
->max_phys_ascent
+ it
->max_phys_descent
);
18878 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18879 it
->max_extra_line_spacing
);
18880 set_iterator_to_next (it
, 1);
18884 /* Does the display element fit on the line? If we truncate
18885 lines, we should draw past the right edge of the window. If
18886 we don't truncate, we want to stop so that we can display the
18887 continuation glyph before the right margin. If lines are
18888 continued, there are two possible strategies for characters
18889 resulting in more than 1 glyph (e.g. tabs): Display as many
18890 glyphs as possible in this line and leave the rest for the
18891 continuation line, or display the whole element in the next
18892 line. Original redisplay did the former, so we do it also. */
18893 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18894 hpos_before
= it
->hpos
;
18897 if (/* Not a newline. */
18899 /* Glyphs produced fit entirely in the line. */
18900 && it
->current_x
< it
->last_visible_x
)
18902 it
->hpos
+= nglyphs
;
18903 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18904 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18905 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18906 row
->phys_height
= max (row
->phys_height
,
18907 it
->max_phys_ascent
+ it
->max_phys_descent
);
18908 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18909 it
->max_extra_line_spacing
);
18910 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18911 row
->x
= x
- it
->first_visible_x
;
18912 /* Record the maximum and minimum buffer positions seen so
18913 far in glyphs that will be displayed by this row. */
18915 RECORD_MAX_MIN_POS (it
);
18920 struct glyph
*glyph
;
18922 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18924 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18925 new_x
= x
+ glyph
->pixel_width
;
18927 if (/* Lines are continued. */
18928 it
->line_wrap
!= TRUNCATE
18929 && (/* Glyph doesn't fit on the line. */
18930 new_x
> it
->last_visible_x
18931 /* Or it fits exactly on a window system frame. */
18932 || (new_x
== it
->last_visible_x
18933 && FRAME_WINDOW_P (it
->f
))))
18935 /* End of a continued line. */
18938 || (new_x
== it
->last_visible_x
18939 && FRAME_WINDOW_P (it
->f
)))
18941 /* Current glyph is the only one on the line or
18942 fits exactly on the line. We must continue
18943 the line because we can't draw the cursor
18944 after the glyph. */
18945 row
->continued_p
= 1;
18946 it
->current_x
= new_x
;
18947 it
->continuation_lines_width
+= new_x
;
18949 if (i
== nglyphs
- 1)
18951 /* If line-wrap is on, check if a previous
18952 wrap point was found. */
18953 if (wrap_row_used
> 0
18954 /* Even if there is a previous wrap
18955 point, continue the line here as
18956 usual, if (i) the previous character
18957 was a space or tab AND (ii) the
18958 current character is not. */
18960 || IT_DISPLAYING_WHITESPACE (it
)))
18963 /* Record the maximum and minimum buffer
18964 positions seen so far in glyphs that will be
18965 displayed by this row. */
18967 RECORD_MAX_MIN_POS (it
);
18968 set_iterator_to_next (it
, 1);
18969 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18971 if (!get_next_display_element (it
))
18973 row
->exact_window_width_line_p
= 1;
18974 it
->continuation_lines_width
= 0;
18975 row
->continued_p
= 0;
18976 row
->ends_at_zv_p
= 1;
18978 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18980 row
->continued_p
= 0;
18981 row
->exact_window_width_line_p
= 1;
18985 else if (it
->bidi_p
)
18986 RECORD_MAX_MIN_POS (it
);
18988 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18989 && !FRAME_WINDOW_P (it
->f
))
18991 /* A padding glyph that doesn't fit on this line.
18992 This means the whole character doesn't fit
18994 if (row
->reversed_p
)
18995 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18996 - n_glyphs_before
);
18997 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18999 /* Fill the rest of the row with continuation
19000 glyphs like in 20.x. */
19001 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19002 < row
->glyphs
[1 + TEXT_AREA
])
19003 produce_special_glyphs (it
, IT_CONTINUATION
);
19005 row
->continued_p
= 1;
19006 it
->current_x
= x_before
;
19007 it
->continuation_lines_width
+= x_before
;
19009 /* Restore the height to what it was before the
19010 element not fitting on the line. */
19011 it
->max_ascent
= ascent
;
19012 it
->max_descent
= descent
;
19013 it
->max_phys_ascent
= phys_ascent
;
19014 it
->max_phys_descent
= phys_descent
;
19016 else if (wrap_row_used
> 0)
19019 if (row
->reversed_p
)
19020 unproduce_glyphs (it
,
19021 row
->used
[TEXT_AREA
] - wrap_row_used
);
19022 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19023 it
->continuation_lines_width
+= wrap_x
;
19024 row
->used
[TEXT_AREA
] = wrap_row_used
;
19025 row
->ascent
= wrap_row_ascent
;
19026 row
->height
= wrap_row_height
;
19027 row
->phys_ascent
= wrap_row_phys_ascent
;
19028 row
->phys_height
= wrap_row_phys_height
;
19029 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19030 min_pos
= wrap_row_min_pos
;
19031 min_bpos
= wrap_row_min_bpos
;
19032 max_pos
= wrap_row_max_pos
;
19033 max_bpos
= wrap_row_max_bpos
;
19034 row
->continued_p
= 1;
19035 row
->ends_at_zv_p
= 0;
19036 row
->exact_window_width_line_p
= 0;
19037 it
->continuation_lines_width
+= x
;
19039 /* Make sure that a non-default face is extended
19040 up to the right margin of the window. */
19041 extend_face_to_end_of_line (it
);
19043 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19045 /* A TAB that extends past the right edge of the
19046 window. This produces a single glyph on
19047 window system frames. We leave the glyph in
19048 this row and let it fill the row, but don't
19049 consume the TAB. */
19050 it
->continuation_lines_width
+= it
->last_visible_x
;
19051 row
->ends_in_middle_of_char_p
= 1;
19052 row
->continued_p
= 1;
19053 glyph
->pixel_width
= it
->last_visible_x
- x
;
19054 it
->starts_in_middle_of_char_p
= 1;
19058 /* Something other than a TAB that draws past
19059 the right edge of the window. Restore
19060 positions to values before the element. */
19061 if (row
->reversed_p
)
19062 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19063 - (n_glyphs_before
+ i
));
19064 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19066 /* Display continuation glyphs. */
19067 if (!FRAME_WINDOW_P (it
->f
))
19068 produce_special_glyphs (it
, IT_CONTINUATION
);
19069 row
->continued_p
= 1;
19071 it
->current_x
= x_before
;
19072 it
->continuation_lines_width
+= x
;
19073 extend_face_to_end_of_line (it
);
19075 if (nglyphs
> 1 && i
> 0)
19077 row
->ends_in_middle_of_char_p
= 1;
19078 it
->starts_in_middle_of_char_p
= 1;
19081 /* Restore the height to what it was before the
19082 element not fitting on the line. */
19083 it
->max_ascent
= ascent
;
19084 it
->max_descent
= descent
;
19085 it
->max_phys_ascent
= phys_ascent
;
19086 it
->max_phys_descent
= phys_descent
;
19091 else if (new_x
> it
->first_visible_x
)
19093 /* Increment number of glyphs actually displayed. */
19096 /* Record the maximum and minimum buffer positions
19097 seen so far in glyphs that will be displayed by
19100 RECORD_MAX_MIN_POS (it
);
19102 if (x
< it
->first_visible_x
)
19103 /* Glyph is partially visible, i.e. row starts at
19104 negative X position. */
19105 row
->x
= x
- it
->first_visible_x
;
19109 /* Glyph is completely off the left margin of the
19110 window. This should not happen because of the
19111 move_it_in_display_line at the start of this
19112 function, unless the text display area of the
19113 window is empty. */
19114 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19117 /* Even if this display element produced no glyphs at all,
19118 we want to record its position. */
19119 if (it
->bidi_p
&& nglyphs
== 0)
19120 RECORD_MAX_MIN_POS (it
);
19122 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19123 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19124 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19125 row
->phys_height
= max (row
->phys_height
,
19126 it
->max_phys_ascent
+ it
->max_phys_descent
);
19127 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19128 it
->max_extra_line_spacing
);
19130 /* End of this display line if row is continued. */
19131 if (row
->continued_p
|| row
->ends_at_zv_p
)
19136 /* Is this a line end? If yes, we're also done, after making
19137 sure that a non-default face is extended up to the right
19138 margin of the window. */
19139 if (ITERATOR_AT_END_OF_LINE_P (it
))
19141 int used_before
= row
->used
[TEXT_AREA
];
19143 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19145 /* Add a space at the end of the line that is used to
19146 display the cursor there. */
19147 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19148 append_space_for_newline (it
, 0);
19150 /* Extend the face to the end of the line. */
19151 extend_face_to_end_of_line (it
);
19153 /* Make sure we have the position. */
19154 if (used_before
== 0)
19155 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19157 /* Record the position of the newline, for use in
19159 it
->eol_pos
= it
->current
.pos
;
19161 /* Consume the line end. This skips over invisible lines. */
19162 set_iterator_to_next (it
, 1);
19163 it
->continuation_lines_width
= 0;
19167 /* Proceed with next display element. Note that this skips
19168 over lines invisible because of selective display. */
19169 set_iterator_to_next (it
, 1);
19171 /* If we truncate lines, we are done when the last displayed
19172 glyphs reach past the right margin of the window. */
19173 if (it
->line_wrap
== TRUNCATE
19174 && (FRAME_WINDOW_P (it
->f
)
19175 ? (it
->current_x
>= it
->last_visible_x
)
19176 : (it
->current_x
> it
->last_visible_x
)))
19178 /* Maybe add truncation glyphs. */
19179 if (!FRAME_WINDOW_P (it
->f
))
19183 if (!row
->reversed_p
)
19185 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19186 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19191 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19192 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19194 /* Remove any padding glyphs at the front of ROW, to
19195 make room for the truncation glyphs we will be
19196 adding below. The loop below always inserts at
19197 least one truncation glyph, so also remove the
19198 last glyph added to ROW. */
19199 unproduce_glyphs (it
, i
+ 1);
19200 /* Adjust i for the loop below. */
19201 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19204 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19206 row
->used
[TEXT_AREA
] = i
;
19207 produce_special_glyphs (it
, IT_TRUNCATION
);
19210 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19212 /* Don't truncate if we can overflow newline into fringe. */
19213 if (!get_next_display_element (it
))
19215 it
->continuation_lines_width
= 0;
19216 row
->ends_at_zv_p
= 1;
19217 row
->exact_window_width_line_p
= 1;
19220 if (ITERATOR_AT_END_OF_LINE_P (it
))
19222 row
->exact_window_width_line_p
= 1;
19223 goto at_end_of_line
;
19227 row
->truncated_on_right_p
= 1;
19228 it
->continuation_lines_width
= 0;
19229 reseat_at_next_visible_line_start (it
, 0);
19230 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19231 it
->hpos
= hpos_before
;
19232 it
->current_x
= x_before
;
19238 bidi_unshelve_cache (wrap_data
, 1);
19240 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19241 at the left window margin. */
19242 if (it
->first_visible_x
19243 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19245 if (!FRAME_WINDOW_P (it
->f
))
19246 insert_left_trunc_glyphs (it
);
19247 row
->truncated_on_left_p
= 1;
19250 /* Remember the position at which this line ends.
19252 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19253 cannot be before the call to find_row_edges below, since that is
19254 where these positions are determined. */
19255 row
->end
= it
->current
;
19258 row
->minpos
= row
->start
.pos
;
19259 row
->maxpos
= row
->end
.pos
;
19263 /* ROW->minpos and ROW->maxpos must be the smallest and
19264 `1 + the largest' buffer positions in ROW. But if ROW was
19265 bidi-reordered, these two positions can be anywhere in the
19266 row, so we must determine them now. */
19267 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19270 /* If the start of this line is the overlay arrow-position, then
19271 mark this glyph row as the one containing the overlay arrow.
19272 This is clearly a mess with variable size fonts. It would be
19273 better to let it be displayed like cursors under X. */
19274 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19275 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19276 !NILP (overlay_arrow_string
)))
19278 /* Overlay arrow in window redisplay is a fringe bitmap. */
19279 if (STRINGP (overlay_arrow_string
))
19281 struct glyph_row
*arrow_row
19282 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19283 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19284 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19285 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19286 struct glyph
*p2
, *end
;
19288 /* Copy the arrow glyphs. */
19289 while (glyph
< arrow_end
)
19292 /* Throw away padding glyphs. */
19294 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19295 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19301 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19306 xassert (INTEGERP (overlay_arrow_string
));
19307 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19309 overlay_arrow_seen
= 1;
19312 /* Compute pixel dimensions of this line. */
19313 compute_line_metrics (it
);
19315 /* Record whether this row ends inside an ellipsis. */
19316 row
->ends_in_ellipsis_p
19317 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19318 && it
->ellipsis_p
);
19320 /* Save fringe bitmaps in this row. */
19321 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19322 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19323 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19324 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19326 it
->left_user_fringe_bitmap
= 0;
19327 it
->left_user_fringe_face_id
= 0;
19328 it
->right_user_fringe_bitmap
= 0;
19329 it
->right_user_fringe_face_id
= 0;
19331 /* Maybe set the cursor. */
19332 cvpos
= it
->w
->cursor
.vpos
;
19334 /* In bidi-reordered rows, keep checking for proper cursor
19335 position even if one has been found already, because buffer
19336 positions in such rows change non-linearly with ROW->VPOS,
19337 when a line is continued. One exception: when we are at ZV,
19338 display cursor on the first suitable glyph row, since all
19339 the empty rows after that also have their position set to ZV. */
19340 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19341 lines' rows is implemented for bidi-reordered rows. */
19343 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19344 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19345 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19346 && cursor_row_p (row
))
19347 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19349 /* Highlight trailing whitespace. */
19350 if (!NILP (Vshow_trailing_whitespace
))
19351 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19353 /* Prepare for the next line. This line starts horizontally at (X
19354 HPOS) = (0 0). Vertical positions are incremented. As a
19355 convenience for the caller, IT->glyph_row is set to the next
19357 it
->current_x
= it
->hpos
= 0;
19358 it
->current_y
+= row
->height
;
19359 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19362 /* The next row should by default use the same value of the
19363 reversed_p flag as this one. set_iterator_to_next decides when
19364 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19365 the flag accordingly. */
19366 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19367 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19368 it
->start
= row
->end
;
19369 return row
->displays_text_p
;
19371 #undef RECORD_MAX_MIN_POS
19374 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19375 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19376 doc
: /* Return paragraph direction at point in BUFFER.
19377 Value is either `left-to-right' or `right-to-left'.
19378 If BUFFER is omitted or nil, it defaults to the current buffer.
19380 Paragraph direction determines how the text in the paragraph is displayed.
19381 In left-to-right paragraphs, text begins at the left margin of the window
19382 and the reading direction is generally left to right. In right-to-left
19383 paragraphs, text begins at the right margin and is read from right to left.
19385 See also `bidi-paragraph-direction'. */)
19386 (Lisp_Object buffer
)
19388 struct buffer
*buf
= current_buffer
;
19389 struct buffer
*old
= buf
;
19391 if (! NILP (buffer
))
19393 CHECK_BUFFER (buffer
);
19394 buf
= XBUFFER (buffer
);
19397 if (NILP (BVAR (buf
, bidi_display_reordering
))
19398 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19399 return Qleft_to_right
;
19400 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19401 return BVAR (buf
, bidi_paragraph_direction
);
19404 /* Determine the direction from buffer text. We could try to
19405 use current_matrix if it is up to date, but this seems fast
19406 enough as it is. */
19407 struct bidi_it itb
;
19408 EMACS_INT pos
= BUF_PT (buf
);
19409 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19411 void *itb_data
= bidi_shelve_cache ();
19413 set_buffer_temp (buf
);
19414 /* bidi_paragraph_init finds the base direction of the paragraph
19415 by searching forward from paragraph start. We need the base
19416 direction of the current or _previous_ paragraph, so we need
19417 to make sure we are within that paragraph. To that end, find
19418 the previous non-empty line. */
19419 if (pos
>= ZV
&& pos
> BEGV
)
19422 bytepos
= CHAR_TO_BYTE (pos
);
19424 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19425 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19427 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19428 || c
== ' ' || c
== '\t' || c
== '\f')
19430 if (bytepos
<= BEGV_BYTE
)
19435 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19438 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19439 itb
.string
.s
= NULL
;
19440 itb
.string
.lstring
= Qnil
;
19441 itb
.string
.bufpos
= 0;
19442 itb
.string
.unibyte
= 0;
19443 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19444 bidi_unshelve_cache (itb_data
, 0);
19445 set_buffer_temp (old
);
19446 switch (itb
.paragraph_dir
)
19449 return Qleft_to_right
;
19452 return Qright_to_left
;
19462 /***********************************************************************
19464 ***********************************************************************/
19466 /* Redisplay the menu bar in the frame for window W.
19468 The menu bar of X frames that don't have X toolkit support is
19469 displayed in a special window W->frame->menu_bar_window.
19471 The menu bar of terminal frames is treated specially as far as
19472 glyph matrices are concerned. Menu bar lines are not part of
19473 windows, so the update is done directly on the frame matrix rows
19474 for the menu bar. */
19477 display_menu_bar (struct window
*w
)
19479 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19484 /* Don't do all this for graphical frames. */
19486 if (FRAME_W32_P (f
))
19489 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19495 if (FRAME_NS_P (f
))
19497 #endif /* HAVE_NS */
19499 #ifdef USE_X_TOOLKIT
19500 xassert (!FRAME_WINDOW_P (f
));
19501 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19502 it
.first_visible_x
= 0;
19503 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19504 #else /* not USE_X_TOOLKIT */
19505 if (FRAME_WINDOW_P (f
))
19507 /* Menu bar lines are displayed in the desired matrix of the
19508 dummy window menu_bar_window. */
19509 struct window
*menu_w
;
19510 xassert (WINDOWP (f
->menu_bar_window
));
19511 menu_w
= XWINDOW (f
->menu_bar_window
);
19512 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19514 it
.first_visible_x
= 0;
19515 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19519 /* This is a TTY frame, i.e. character hpos/vpos are used as
19521 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19523 it
.first_visible_x
= 0;
19524 it
.last_visible_x
= FRAME_COLS (f
);
19526 #endif /* not USE_X_TOOLKIT */
19528 /* FIXME: This should be controlled by a user option. See the
19529 comments in redisplay_tool_bar and display_mode_line about
19531 it
.paragraph_embedding
= L2R
;
19533 if (! mode_line_inverse_video
)
19534 /* Force the menu-bar to be displayed in the default face. */
19535 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19537 /* Clear all rows of the menu bar. */
19538 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19540 struct glyph_row
*row
= it
.glyph_row
+ i
;
19541 clear_glyph_row (row
);
19542 row
->enabled_p
= 1;
19543 row
->full_width_p
= 1;
19546 /* Display all items of the menu bar. */
19547 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19548 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19550 Lisp_Object string
;
19552 /* Stop at nil string. */
19553 string
= AREF (items
, i
+ 1);
19557 /* Remember where item was displayed. */
19558 ASET (items
, i
+ 3, make_number (it
.hpos
));
19560 /* Display the item, pad with one space. */
19561 if (it
.current_x
< it
.last_visible_x
)
19562 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19563 SCHARS (string
) + 1, 0, 0, -1);
19566 /* Fill out the line with spaces. */
19567 if (it
.current_x
< it
.last_visible_x
)
19568 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19570 /* Compute the total height of the lines. */
19571 compute_line_metrics (&it
);
19576 /***********************************************************************
19578 ***********************************************************************/
19580 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19581 FORCE is non-zero, redisplay mode lines unconditionally.
19582 Otherwise, redisplay only mode lines that are garbaged. Value is
19583 the number of windows whose mode lines were redisplayed. */
19586 redisplay_mode_lines (Lisp_Object window
, int force
)
19590 while (!NILP (window
))
19592 struct window
*w
= XWINDOW (window
);
19594 if (WINDOWP (w
->hchild
))
19595 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19596 else if (WINDOWP (w
->vchild
))
19597 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19599 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19600 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19602 struct text_pos lpoint
;
19603 struct buffer
*old
= current_buffer
;
19605 /* Set the window's buffer for the mode line display. */
19606 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19607 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19609 /* Point refers normally to the selected window. For any
19610 other window, set up appropriate value. */
19611 if (!EQ (window
, selected_window
))
19613 struct text_pos pt
;
19615 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19616 if (CHARPOS (pt
) < BEGV
)
19617 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19618 else if (CHARPOS (pt
) > (ZV
- 1))
19619 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19621 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19624 /* Display mode lines. */
19625 clear_glyph_matrix (w
->desired_matrix
);
19626 if (display_mode_lines (w
))
19629 w
->must_be_updated_p
= 1;
19632 /* Restore old settings. */
19633 set_buffer_internal_1 (old
);
19634 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19644 /* Display the mode and/or header line of window W. Value is the
19645 sum number of mode lines and header lines displayed. */
19648 display_mode_lines (struct window
*w
)
19650 Lisp_Object old_selected_window
, old_selected_frame
;
19653 old_selected_frame
= selected_frame
;
19654 selected_frame
= w
->frame
;
19655 old_selected_window
= selected_window
;
19656 XSETWINDOW (selected_window
, w
);
19658 /* These will be set while the mode line specs are processed. */
19659 line_number_displayed
= 0;
19660 w
->column_number_displayed
= Qnil
;
19662 if (WINDOW_WANTS_MODELINE_P (w
))
19664 struct window
*sel_w
= XWINDOW (old_selected_window
);
19666 /* Select mode line face based on the real selected window. */
19667 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19668 BVAR (current_buffer
, mode_line_format
));
19672 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19674 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19675 BVAR (current_buffer
, header_line_format
));
19679 selected_frame
= old_selected_frame
;
19680 selected_window
= old_selected_window
;
19685 /* Display mode or header line of window W. FACE_ID specifies which
19686 line to display; it is either MODE_LINE_FACE_ID or
19687 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19688 display. Value is the pixel height of the mode/header line
19692 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19696 int count
= SPECPDL_INDEX ();
19698 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19699 /* Don't extend on a previously drawn mode-line.
19700 This may happen if called from pos_visible_p. */
19701 it
.glyph_row
->enabled_p
= 0;
19702 prepare_desired_row (it
.glyph_row
);
19704 it
.glyph_row
->mode_line_p
= 1;
19706 if (! mode_line_inverse_video
)
19707 /* Force the mode-line to be displayed in the default face. */
19708 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19710 /* FIXME: This should be controlled by a user option. But
19711 supporting such an option is not trivial, since the mode line is
19712 made up of many separate strings. */
19713 it
.paragraph_embedding
= L2R
;
19715 record_unwind_protect (unwind_format_mode_line
,
19716 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19718 mode_line_target
= MODE_LINE_DISPLAY
;
19720 /* Temporarily make frame's keyboard the current kboard so that
19721 kboard-local variables in the mode_line_format will get the right
19723 push_kboard (FRAME_KBOARD (it
.f
));
19724 record_unwind_save_match_data ();
19725 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19728 unbind_to (count
, Qnil
);
19730 /* Fill up with spaces. */
19731 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19733 compute_line_metrics (&it
);
19734 it
.glyph_row
->full_width_p
= 1;
19735 it
.glyph_row
->continued_p
= 0;
19736 it
.glyph_row
->truncated_on_left_p
= 0;
19737 it
.glyph_row
->truncated_on_right_p
= 0;
19739 /* Make a 3D mode-line have a shadow at its right end. */
19740 face
= FACE_FROM_ID (it
.f
, face_id
);
19741 extend_face_to_end_of_line (&it
);
19742 if (face
->box
!= FACE_NO_BOX
)
19744 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19745 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19746 last
->right_box_line_p
= 1;
19749 return it
.glyph_row
->height
;
19752 /* Move element ELT in LIST to the front of LIST.
19753 Return the updated list. */
19756 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19758 register Lisp_Object tail
, prev
;
19759 register Lisp_Object tem
;
19763 while (CONSP (tail
))
19769 /* Splice out the link TAIL. */
19771 list
= XCDR (tail
);
19773 Fsetcdr (prev
, XCDR (tail
));
19775 /* Now make it the first. */
19776 Fsetcdr (tail
, list
);
19781 tail
= XCDR (tail
);
19785 /* Not found--return unchanged LIST. */
19789 /* Contribute ELT to the mode line for window IT->w. How it
19790 translates into text depends on its data type.
19792 IT describes the display environment in which we display, as usual.
19794 DEPTH is the depth in recursion. It is used to prevent
19795 infinite recursion here.
19797 FIELD_WIDTH is the number of characters the display of ELT should
19798 occupy in the mode line, and PRECISION is the maximum number of
19799 characters to display from ELT's representation. See
19800 display_string for details.
19802 Returns the hpos of the end of the text generated by ELT.
19804 PROPS is a property list to add to any string we encounter.
19806 If RISKY is nonzero, remove (disregard) any properties in any string
19807 we encounter, and ignore :eval and :propertize.
19809 The global variable `mode_line_target' determines whether the
19810 output is passed to `store_mode_line_noprop',
19811 `store_mode_line_string', or `display_string'. */
19814 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19815 Lisp_Object elt
, Lisp_Object props
, int risky
)
19817 int n
= 0, field
, prec
;
19822 elt
= build_string ("*too-deep*");
19826 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19830 /* A string: output it and check for %-constructs within it. */
19832 EMACS_INT offset
= 0;
19834 if (SCHARS (elt
) > 0
19835 && (!NILP (props
) || risky
))
19837 Lisp_Object oprops
, aelt
;
19838 oprops
= Ftext_properties_at (make_number (0), elt
);
19840 /* If the starting string's properties are not what
19841 we want, translate the string. Also, if the string
19842 is risky, do that anyway. */
19844 if (NILP (Fequal (props
, oprops
)) || risky
)
19846 /* If the starting string has properties,
19847 merge the specified ones onto the existing ones. */
19848 if (! NILP (oprops
) && !risky
)
19852 oprops
= Fcopy_sequence (oprops
);
19854 while (CONSP (tem
))
19856 oprops
= Fplist_put (oprops
, XCAR (tem
),
19857 XCAR (XCDR (tem
)));
19858 tem
= XCDR (XCDR (tem
));
19863 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19864 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19866 /* AELT is what we want. Move it to the front
19867 without consing. */
19869 mode_line_proptrans_alist
19870 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19876 /* If AELT has the wrong props, it is useless.
19877 so get rid of it. */
19879 mode_line_proptrans_alist
19880 = Fdelq (aelt
, mode_line_proptrans_alist
);
19882 elt
= Fcopy_sequence (elt
);
19883 Fset_text_properties (make_number (0), Flength (elt
),
19885 /* Add this item to mode_line_proptrans_alist. */
19886 mode_line_proptrans_alist
19887 = Fcons (Fcons (elt
, props
),
19888 mode_line_proptrans_alist
);
19889 /* Truncate mode_line_proptrans_alist
19890 to at most 50 elements. */
19891 tem
= Fnthcdr (make_number (50),
19892 mode_line_proptrans_alist
);
19894 XSETCDR (tem
, Qnil
);
19903 prec
= precision
- n
;
19904 switch (mode_line_target
)
19906 case MODE_LINE_NOPROP
:
19907 case MODE_LINE_TITLE
:
19908 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19910 case MODE_LINE_STRING
:
19911 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19913 case MODE_LINE_DISPLAY
:
19914 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19915 0, prec
, 0, STRING_MULTIBYTE (elt
));
19922 /* Handle the non-literal case. */
19924 while ((precision
<= 0 || n
< precision
)
19925 && SREF (elt
, offset
) != 0
19926 && (mode_line_target
!= MODE_LINE_DISPLAY
19927 || it
->current_x
< it
->last_visible_x
))
19929 EMACS_INT last_offset
= offset
;
19931 /* Advance to end of string or next format specifier. */
19932 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19935 if (offset
- 1 != last_offset
)
19937 EMACS_INT nchars
, nbytes
;
19939 /* Output to end of string or up to '%'. Field width
19940 is length of string. Don't output more than
19941 PRECISION allows us. */
19944 prec
= c_string_width (SDATA (elt
) + last_offset
,
19945 offset
- last_offset
, precision
- n
,
19948 switch (mode_line_target
)
19950 case MODE_LINE_NOPROP
:
19951 case MODE_LINE_TITLE
:
19952 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19954 case MODE_LINE_STRING
:
19956 EMACS_INT bytepos
= last_offset
;
19957 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19958 EMACS_INT endpos
= (precision
<= 0
19959 ? string_byte_to_char (elt
, offset
)
19960 : charpos
+ nchars
);
19962 n
+= store_mode_line_string (NULL
,
19963 Fsubstring (elt
, make_number (charpos
),
19964 make_number (endpos
)),
19968 case MODE_LINE_DISPLAY
:
19970 EMACS_INT bytepos
= last_offset
;
19971 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19973 if (precision
<= 0)
19974 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19975 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19977 STRING_MULTIBYTE (elt
));
19982 else /* c == '%' */
19984 EMACS_INT percent_position
= offset
;
19986 /* Get the specified minimum width. Zero means
19989 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19990 field
= field
* 10 + c
- '0';
19992 /* Don't pad beyond the total padding allowed. */
19993 if (field_width
- n
> 0 && field
> field_width
- n
)
19994 field
= field_width
- n
;
19996 /* Note that either PRECISION <= 0 or N < PRECISION. */
19997 prec
= precision
- n
;
20000 n
+= display_mode_element (it
, depth
, field
, prec
,
20001 Vglobal_mode_string
, props
,
20006 EMACS_INT bytepos
, charpos
;
20008 Lisp_Object string
;
20010 bytepos
= percent_position
;
20011 charpos
= (STRING_MULTIBYTE (elt
)
20012 ? string_byte_to_char (elt
, bytepos
)
20014 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20015 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20017 switch (mode_line_target
)
20019 case MODE_LINE_NOPROP
:
20020 case MODE_LINE_TITLE
:
20021 n
+= store_mode_line_noprop (spec
, field
, prec
);
20023 case MODE_LINE_STRING
:
20025 Lisp_Object tem
= build_string (spec
);
20026 props
= Ftext_properties_at (make_number (charpos
), elt
);
20027 /* Should only keep face property in props */
20028 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20031 case MODE_LINE_DISPLAY
:
20033 int nglyphs_before
, nwritten
;
20035 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20036 nwritten
= display_string (spec
, string
, elt
,
20041 /* Assign to the glyphs written above the
20042 string where the `%x' came from, position
20046 struct glyph
*glyph
20047 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20051 for (i
= 0; i
< nwritten
; ++i
)
20053 glyph
[i
].object
= elt
;
20054 glyph
[i
].charpos
= charpos
;
20071 /* A symbol: process the value of the symbol recursively
20072 as if it appeared here directly. Avoid error if symbol void.
20073 Special case: if value of symbol is a string, output the string
20076 register Lisp_Object tem
;
20078 /* If the variable is not marked as risky to set
20079 then its contents are risky to use. */
20080 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20083 tem
= Fboundp (elt
);
20086 tem
= Fsymbol_value (elt
);
20087 /* If value is a string, output that string literally:
20088 don't check for % within it. */
20092 if (!EQ (tem
, elt
))
20094 /* Give up right away for nil or t. */
20104 register Lisp_Object car
, tem
;
20106 /* A cons cell: five distinct cases.
20107 If first element is :eval or :propertize, do something special.
20108 If first element is a string or a cons, process all the elements
20109 and effectively concatenate them.
20110 If first element is a negative number, truncate displaying cdr to
20111 at most that many characters. If positive, pad (with spaces)
20112 to at least that many characters.
20113 If first element is a symbol, process the cadr or caddr recursively
20114 according to whether the symbol's value is non-nil or nil. */
20116 if (EQ (car
, QCeval
))
20118 /* An element of the form (:eval FORM) means evaluate FORM
20119 and use the result as mode line elements. */
20124 if (CONSP (XCDR (elt
)))
20127 spec
= safe_eval (XCAR (XCDR (elt
)));
20128 n
+= display_mode_element (it
, depth
, field_width
- n
,
20129 precision
- n
, spec
, props
,
20133 else if (EQ (car
, QCpropertize
))
20135 /* An element of the form (:propertize ELT PROPS...)
20136 means display ELT but applying properties PROPS. */
20141 if (CONSP (XCDR (elt
)))
20142 n
+= display_mode_element (it
, depth
, field_width
- n
,
20143 precision
- n
, XCAR (XCDR (elt
)),
20144 XCDR (XCDR (elt
)), risky
);
20146 else if (SYMBOLP (car
))
20148 tem
= Fboundp (car
);
20152 /* elt is now the cdr, and we know it is a cons cell.
20153 Use its car if CAR has a non-nil value. */
20156 tem
= Fsymbol_value (car
);
20163 /* Symbol's value is nil (or symbol is unbound)
20164 Get the cddr of the original list
20165 and if possible find the caddr and use that. */
20169 else if (!CONSP (elt
))
20174 else if (INTEGERP (car
))
20176 register int lim
= XINT (car
);
20180 /* Negative int means reduce maximum width. */
20181 if (precision
<= 0)
20184 precision
= min (precision
, -lim
);
20188 /* Padding specified. Don't let it be more than
20189 current maximum. */
20191 lim
= min (precision
, lim
);
20193 /* If that's more padding than already wanted, queue it.
20194 But don't reduce padding already specified even if
20195 that is beyond the current truncation point. */
20196 field_width
= max (lim
, field_width
);
20200 else if (STRINGP (car
) || CONSP (car
))
20202 Lisp_Object halftail
= elt
;
20206 && (precision
<= 0 || n
< precision
))
20208 n
+= display_mode_element (it
, depth
,
20209 /* Do padding only after the last
20210 element in the list. */
20211 (! CONSP (XCDR (elt
))
20214 precision
- n
, XCAR (elt
),
20218 if ((len
& 1) == 0)
20219 halftail
= XCDR (halftail
);
20220 /* Check for cycle. */
20221 if (EQ (halftail
, elt
))
20230 elt
= build_string ("*invalid*");
20234 /* Pad to FIELD_WIDTH. */
20235 if (field_width
> 0 && n
< field_width
)
20237 switch (mode_line_target
)
20239 case MODE_LINE_NOPROP
:
20240 case MODE_LINE_TITLE
:
20241 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20243 case MODE_LINE_STRING
:
20244 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20246 case MODE_LINE_DISPLAY
:
20247 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20256 /* Store a mode-line string element in mode_line_string_list.
20258 If STRING is non-null, display that C string. Otherwise, the Lisp
20259 string LISP_STRING is displayed.
20261 FIELD_WIDTH is the minimum number of output glyphs to produce.
20262 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20263 with spaces. FIELD_WIDTH <= 0 means don't pad.
20265 PRECISION is the maximum number of characters to output from
20266 STRING. PRECISION <= 0 means don't truncate the string.
20268 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20269 properties to the string.
20271 PROPS are the properties to add to the string.
20272 The mode_line_string_face face property is always added to the string.
20276 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20277 int field_width
, int precision
, Lisp_Object props
)
20282 if (string
!= NULL
)
20284 len
= strlen (string
);
20285 if (precision
> 0 && len
> precision
)
20287 lisp_string
= make_string (string
, len
);
20289 props
= mode_line_string_face_prop
;
20290 else if (!NILP (mode_line_string_face
))
20292 Lisp_Object face
= Fplist_get (props
, Qface
);
20293 props
= Fcopy_sequence (props
);
20295 face
= mode_line_string_face
;
20297 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20298 props
= Fplist_put (props
, Qface
, face
);
20300 Fadd_text_properties (make_number (0), make_number (len
),
20301 props
, lisp_string
);
20305 len
= XFASTINT (Flength (lisp_string
));
20306 if (precision
> 0 && len
> precision
)
20309 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20312 if (!NILP (mode_line_string_face
))
20316 props
= Ftext_properties_at (make_number (0), lisp_string
);
20317 face
= Fplist_get (props
, Qface
);
20319 face
= mode_line_string_face
;
20321 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20322 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20324 lisp_string
= Fcopy_sequence (lisp_string
);
20327 Fadd_text_properties (make_number (0), make_number (len
),
20328 props
, lisp_string
);
20333 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20337 if (field_width
> len
)
20339 field_width
-= len
;
20340 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20342 Fadd_text_properties (make_number (0), make_number (field_width
),
20343 props
, lisp_string
);
20344 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20352 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20354 doc
: /* Format a string out of a mode line format specification.
20355 First arg FORMAT specifies the mode line format (see `mode-line-format'
20356 for details) to use.
20358 By default, the format is evaluated for the currently selected window.
20360 Optional second arg FACE specifies the face property to put on all
20361 characters for which no face is specified. The value nil means the
20362 default face. The value t means whatever face the window's mode line
20363 currently uses (either `mode-line' or `mode-line-inactive',
20364 depending on whether the window is the selected window or not).
20365 An integer value means the value string has no text
20368 Optional third and fourth args WINDOW and BUFFER specify the window
20369 and buffer to use as the context for the formatting (defaults
20370 are the selected window and the WINDOW's buffer). */)
20371 (Lisp_Object format
, Lisp_Object face
,
20372 Lisp_Object window
, Lisp_Object buffer
)
20377 struct buffer
*old_buffer
= NULL
;
20379 int no_props
= INTEGERP (face
);
20380 int count
= SPECPDL_INDEX ();
20382 int string_start
= 0;
20385 window
= selected_window
;
20386 CHECK_WINDOW (window
);
20387 w
= XWINDOW (window
);
20390 buffer
= w
->buffer
;
20391 CHECK_BUFFER (buffer
);
20393 /* Make formatting the modeline a non-op when noninteractive, otherwise
20394 there will be problems later caused by a partially initialized frame. */
20395 if (NILP (format
) || noninteractive
)
20396 return empty_unibyte_string
;
20401 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20402 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20403 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20404 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20405 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20406 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20407 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20410 if (XBUFFER (buffer
) != current_buffer
)
20411 old_buffer
= current_buffer
;
20413 /* Save things including mode_line_proptrans_alist,
20414 and set that to nil so that we don't alter the outer value. */
20415 record_unwind_protect (unwind_format_mode_line
,
20416 format_mode_line_unwind_data
20417 (old_buffer
, selected_window
, 1));
20418 mode_line_proptrans_alist
= Qnil
;
20420 Fselect_window (window
, Qt
);
20422 set_buffer_internal_1 (XBUFFER (buffer
));
20424 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20428 mode_line_target
= MODE_LINE_NOPROP
;
20429 mode_line_string_face_prop
= Qnil
;
20430 mode_line_string_list
= Qnil
;
20431 string_start
= MODE_LINE_NOPROP_LEN (0);
20435 mode_line_target
= MODE_LINE_STRING
;
20436 mode_line_string_list
= Qnil
;
20437 mode_line_string_face
= face
;
20438 mode_line_string_face_prop
20439 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20442 push_kboard (FRAME_KBOARD (it
.f
));
20443 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20448 len
= MODE_LINE_NOPROP_LEN (string_start
);
20449 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20453 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20454 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20455 empty_unibyte_string
);
20458 unbind_to (count
, Qnil
);
20462 /* Write a null-terminated, right justified decimal representation of
20463 the positive integer D to BUF using a minimal field width WIDTH. */
20466 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20468 register char *p
= buf
;
20476 *p
++ = d
% 10 + '0';
20481 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20492 /* Write a null-terminated, right justified decimal and "human
20493 readable" representation of the nonnegative integer D to BUF using
20494 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20496 static const char power_letter
[] =
20510 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20512 /* We aim to represent the nonnegative integer D as
20513 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20514 EMACS_INT quotient
= d
;
20516 /* -1 means: do not use TENTHS. */
20520 /* Length of QUOTIENT.TENTHS as a string. */
20526 if (1000 <= quotient
)
20528 /* Scale to the appropriate EXPONENT. */
20531 remainder
= quotient
% 1000;
20535 while (1000 <= quotient
);
20537 /* Round to nearest and decide whether to use TENTHS or not. */
20540 tenths
= remainder
/ 100;
20541 if (50 <= remainder
% 100)
20548 if (quotient
== 10)
20556 if (500 <= remainder
)
20558 if (quotient
< 999)
20569 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20570 if (tenths
== -1 && quotient
<= 99)
20577 p
= psuffix
= buf
+ max (width
, length
);
20579 /* Print EXPONENT. */
20580 *psuffix
++ = power_letter
[exponent
];
20583 /* Print TENTHS. */
20586 *--p
= '0' + tenths
;
20590 /* Print QUOTIENT. */
20593 int digit
= quotient
% 10;
20594 *--p
= '0' + digit
;
20596 while ((quotient
/= 10) != 0);
20598 /* Print leading spaces. */
20603 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20604 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20605 type of CODING_SYSTEM. Return updated pointer into BUF. */
20607 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20610 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20613 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20614 const unsigned char *eol_str
;
20616 /* The EOL conversion we are using. */
20617 Lisp_Object eoltype
;
20619 val
= CODING_SYSTEM_SPEC (coding_system
);
20622 if (!VECTORP (val
)) /* Not yet decided. */
20627 eoltype
= eol_mnemonic_undecided
;
20628 /* Don't mention EOL conversion if it isn't decided. */
20633 Lisp_Object eolvalue
;
20635 attrs
= AREF (val
, 0);
20636 eolvalue
= AREF (val
, 2);
20639 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20643 /* The EOL conversion that is normal on this system. */
20645 if (NILP (eolvalue
)) /* Not yet decided. */
20646 eoltype
= eol_mnemonic_undecided
;
20647 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20648 eoltype
= eol_mnemonic_undecided
;
20649 else /* eolvalue is Qunix, Qdos, or Qmac. */
20650 eoltype
= (EQ (eolvalue
, Qunix
)
20651 ? eol_mnemonic_unix
20652 : (EQ (eolvalue
, Qdos
) == 1
20653 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20659 /* Mention the EOL conversion if it is not the usual one. */
20660 if (STRINGP (eoltype
))
20662 eol_str
= SDATA (eoltype
);
20663 eol_str_len
= SBYTES (eoltype
);
20665 else if (CHARACTERP (eoltype
))
20667 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20668 int c
= XFASTINT (eoltype
);
20669 eol_str_len
= CHAR_STRING (c
, tmp
);
20674 eol_str
= invalid_eol_type
;
20675 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20677 memcpy (buf
, eol_str
, eol_str_len
);
20678 buf
+= eol_str_len
;
20684 /* Return a string for the output of a mode line %-spec for window W,
20685 generated by character C. FIELD_WIDTH > 0 means pad the string
20686 returned with spaces to that value. Return a Lisp string in
20687 *STRING if the resulting string is taken from that Lisp string.
20689 Note we operate on the current buffer for most purposes,
20690 the exception being w->base_line_pos. */
20692 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20694 static const char *
20695 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20696 Lisp_Object
*string
)
20699 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20700 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20701 struct buffer
*b
= current_buffer
;
20709 if (!NILP (BVAR (b
, read_only
)))
20711 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20716 /* This differs from %* only for a modified read-only buffer. */
20717 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20719 if (!NILP (BVAR (b
, read_only
)))
20724 /* This differs from %* in ignoring read-only-ness. */
20725 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20737 if (command_loop_level
> 5)
20739 p
= decode_mode_spec_buf
;
20740 for (i
= 0; i
< command_loop_level
; i
++)
20743 return decode_mode_spec_buf
;
20751 if (command_loop_level
> 5)
20753 p
= decode_mode_spec_buf
;
20754 for (i
= 0; i
< command_loop_level
; i
++)
20757 return decode_mode_spec_buf
;
20764 /* Let lots_of_dashes be a string of infinite length. */
20765 if (mode_line_target
== MODE_LINE_NOPROP
||
20766 mode_line_target
== MODE_LINE_STRING
)
20768 if (field_width
<= 0
20769 || field_width
> sizeof (lots_of_dashes
))
20771 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20772 decode_mode_spec_buf
[i
] = '-';
20773 decode_mode_spec_buf
[i
] = '\0';
20774 return decode_mode_spec_buf
;
20777 return lots_of_dashes
;
20781 obj
= BVAR (b
, name
);
20785 /* %c and %l are ignored in `frame-title-format'.
20786 (In redisplay_internal, the frame title is drawn _before_ the
20787 windows are updated, so the stuff which depends on actual
20788 window contents (such as %l) may fail to render properly, or
20789 even crash emacs.) */
20790 if (mode_line_target
== MODE_LINE_TITLE
)
20794 EMACS_INT col
= current_column ();
20795 w
->column_number_displayed
= make_number (col
);
20796 pint2str (decode_mode_spec_buf
, field_width
, col
);
20797 return decode_mode_spec_buf
;
20801 #ifndef SYSTEM_MALLOC
20803 if (NILP (Vmemory_full
))
20806 return "!MEM FULL! ";
20813 /* %F displays the frame name. */
20814 if (!NILP (f
->title
))
20815 return SSDATA (f
->title
);
20816 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20817 return SSDATA (f
->name
);
20821 obj
= BVAR (b
, filename
);
20826 EMACS_INT size
= ZV
- BEGV
;
20827 pint2str (decode_mode_spec_buf
, field_width
, size
);
20828 return decode_mode_spec_buf
;
20833 EMACS_INT size
= ZV
- BEGV
;
20834 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20835 return decode_mode_spec_buf
;
20840 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20841 EMACS_INT topline
, nlines
, height
;
20844 /* %c and %l are ignored in `frame-title-format'. */
20845 if (mode_line_target
== MODE_LINE_TITLE
)
20848 startpos
= XMARKER (w
->start
)->charpos
;
20849 startpos_byte
= marker_byte_position (w
->start
);
20850 height
= WINDOW_TOTAL_LINES (w
);
20852 /* If we decided that this buffer isn't suitable for line numbers,
20853 don't forget that too fast. */
20854 if (EQ (w
->base_line_pos
, w
->buffer
))
20856 /* But do forget it, if the window shows a different buffer now. */
20857 else if (BUFFERP (w
->base_line_pos
))
20858 w
->base_line_pos
= Qnil
;
20860 /* If the buffer is very big, don't waste time. */
20861 if (INTEGERP (Vline_number_display_limit
)
20862 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20864 w
->base_line_pos
= Qnil
;
20865 w
->base_line_number
= Qnil
;
20869 if (INTEGERP (w
->base_line_number
)
20870 && INTEGERP (w
->base_line_pos
)
20871 && XFASTINT (w
->base_line_pos
) <= startpos
)
20873 line
= XFASTINT (w
->base_line_number
);
20874 linepos
= XFASTINT (w
->base_line_pos
);
20875 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20880 linepos
= BUF_BEGV (b
);
20881 linepos_byte
= BUF_BEGV_BYTE (b
);
20884 /* Count lines from base line to window start position. */
20885 nlines
= display_count_lines (linepos_byte
,
20889 topline
= nlines
+ line
;
20891 /* Determine a new base line, if the old one is too close
20892 or too far away, or if we did not have one.
20893 "Too close" means it's plausible a scroll-down would
20894 go back past it. */
20895 if (startpos
== BUF_BEGV (b
))
20897 w
->base_line_number
= make_number (topline
);
20898 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20900 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20901 || linepos
== BUF_BEGV (b
))
20903 EMACS_INT limit
= BUF_BEGV (b
);
20904 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20905 EMACS_INT position
;
20906 EMACS_INT distance
=
20907 (height
* 2 + 30) * line_number_display_limit_width
;
20909 if (startpos
- distance
> limit
)
20911 limit
= startpos
- distance
;
20912 limit_byte
= CHAR_TO_BYTE (limit
);
20915 nlines
= display_count_lines (startpos_byte
,
20917 - (height
* 2 + 30),
20919 /* If we couldn't find the lines we wanted within
20920 line_number_display_limit_width chars per line,
20921 give up on line numbers for this window. */
20922 if (position
== limit_byte
&& limit
== startpos
- distance
)
20924 w
->base_line_pos
= w
->buffer
;
20925 w
->base_line_number
= Qnil
;
20929 w
->base_line_number
= make_number (topline
- nlines
);
20930 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20933 /* Now count lines from the start pos to point. */
20934 nlines
= display_count_lines (startpos_byte
,
20935 PT_BYTE
, PT
, &junk
);
20937 /* Record that we did display the line number. */
20938 line_number_displayed
= 1;
20940 /* Make the string to show. */
20941 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20942 return decode_mode_spec_buf
;
20945 char* p
= decode_mode_spec_buf
;
20946 int pad
= field_width
- 2;
20952 return decode_mode_spec_buf
;
20958 obj
= BVAR (b
, mode_name
);
20962 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20968 EMACS_INT pos
= marker_position (w
->start
);
20969 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20971 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20973 if (pos
<= BUF_BEGV (b
))
20978 else if (pos
<= BUF_BEGV (b
))
20982 if (total
> 1000000)
20983 /* Do it differently for a large value, to avoid overflow. */
20984 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20986 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20987 /* We can't normally display a 3-digit number,
20988 so get us a 2-digit number that is close. */
20991 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20992 return decode_mode_spec_buf
;
20996 /* Display percentage of size above the bottom of the screen. */
20999 EMACS_INT toppos
= marker_position (w
->start
);
21000 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21001 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21003 if (botpos
>= BUF_ZV (b
))
21005 if (toppos
<= BUF_BEGV (b
))
21012 if (total
> 1000000)
21013 /* Do it differently for a large value, to avoid overflow. */
21014 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21016 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21017 /* We can't normally display a 3-digit number,
21018 so get us a 2-digit number that is close. */
21021 if (toppos
<= BUF_BEGV (b
))
21022 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21024 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21025 return decode_mode_spec_buf
;
21030 /* status of process */
21031 obj
= Fget_buffer_process (Fcurrent_buffer ());
21033 return "no process";
21035 obj
= Fsymbol_name (Fprocess_status (obj
));
21041 int count
= inhibit_garbage_collection ();
21042 Lisp_Object val
= call1 (intern ("file-remote-p"),
21043 BVAR (current_buffer
, directory
));
21044 unbind_to (count
, Qnil
);
21052 case 't': /* indicate TEXT or BINARY */
21056 /* coding-system (not including end-of-line format) */
21058 /* coding-system (including end-of-line type) */
21060 int eol_flag
= (c
== 'Z');
21061 char *p
= decode_mode_spec_buf
;
21063 if (! FRAME_WINDOW_P (f
))
21065 /* No need to mention EOL here--the terminal never needs
21066 to do EOL conversion. */
21067 p
= decode_mode_spec_coding (CODING_ID_NAME
21068 (FRAME_KEYBOARD_CODING (f
)->id
),
21070 p
= decode_mode_spec_coding (CODING_ID_NAME
21071 (FRAME_TERMINAL_CODING (f
)->id
),
21074 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21077 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21078 #ifdef subprocesses
21079 obj
= Fget_buffer_process (Fcurrent_buffer ());
21080 if (PROCESSP (obj
))
21082 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21084 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21087 #endif /* subprocesses */
21090 return decode_mode_spec_buf
;
21097 return SSDATA (obj
);
21104 /* Count up to COUNT lines starting from START_BYTE.
21105 But don't go beyond LIMIT_BYTE.
21106 Return the number of lines thus found (always nonnegative).
21108 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21111 display_count_lines (EMACS_INT start_byte
,
21112 EMACS_INT limit_byte
, EMACS_INT count
,
21113 EMACS_INT
*byte_pos_ptr
)
21115 register unsigned char *cursor
;
21116 unsigned char *base
;
21118 register EMACS_INT ceiling
;
21119 register unsigned char *ceiling_addr
;
21120 EMACS_INT orig_count
= count
;
21122 /* If we are not in selective display mode,
21123 check only for newlines. */
21124 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21125 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21129 while (start_byte
< limit_byte
)
21131 ceiling
= BUFFER_CEILING_OF (start_byte
);
21132 ceiling
= min (limit_byte
- 1, ceiling
);
21133 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21134 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21137 if (selective_display
)
21138 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21141 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21144 if (cursor
!= ceiling_addr
)
21148 start_byte
+= cursor
- base
+ 1;
21149 *byte_pos_ptr
= start_byte
;
21153 if (++cursor
== ceiling_addr
)
21159 start_byte
+= cursor
- base
;
21164 while (start_byte
> limit_byte
)
21166 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21167 ceiling
= max (limit_byte
, ceiling
);
21168 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21169 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21172 if (selective_display
)
21173 while (--cursor
!= ceiling_addr
21174 && *cursor
!= '\n' && *cursor
!= 015)
21177 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21180 if (cursor
!= ceiling_addr
)
21184 start_byte
+= cursor
- base
+ 1;
21185 *byte_pos_ptr
= start_byte
;
21186 /* When scanning backwards, we should
21187 not count the newline posterior to which we stop. */
21188 return - orig_count
- 1;
21194 /* Here we add 1 to compensate for the last decrement
21195 of CURSOR, which took it past the valid range. */
21196 start_byte
+= cursor
- base
+ 1;
21200 *byte_pos_ptr
= limit_byte
;
21203 return - orig_count
+ count
;
21204 return orig_count
- count
;
21210 /***********************************************************************
21212 ***********************************************************************/
21214 /* Display a NUL-terminated string, starting with index START.
21216 If STRING is non-null, display that C string. Otherwise, the Lisp
21217 string LISP_STRING is displayed. There's a case that STRING is
21218 non-null and LISP_STRING is not nil. It means STRING is a string
21219 data of LISP_STRING. In that case, we display LISP_STRING while
21220 ignoring its text properties.
21222 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21223 FACE_STRING. Display STRING or LISP_STRING with the face at
21224 FACE_STRING_POS in FACE_STRING:
21226 Display the string in the environment given by IT, but use the
21227 standard display table, temporarily.
21229 FIELD_WIDTH is the minimum number of output glyphs to produce.
21230 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21231 with spaces. If STRING has more characters, more than FIELD_WIDTH
21232 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21234 PRECISION is the maximum number of characters to output from
21235 STRING. PRECISION < 0 means don't truncate the string.
21237 This is roughly equivalent to printf format specifiers:
21239 FIELD_WIDTH PRECISION PRINTF
21240 ----------------------------------------
21246 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21247 display them, and < 0 means obey the current buffer's value of
21248 enable_multibyte_characters.
21250 Value is the number of columns displayed. */
21253 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21254 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21255 int field_width
, int precision
, int max_x
, int multibyte
)
21257 int hpos_at_start
= it
->hpos
;
21258 int saved_face_id
= it
->face_id
;
21259 struct glyph_row
*row
= it
->glyph_row
;
21260 EMACS_INT it_charpos
;
21262 /* Initialize the iterator IT for iteration over STRING beginning
21263 with index START. */
21264 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21265 precision
, field_width
, multibyte
);
21266 if (string
&& STRINGP (lisp_string
))
21267 /* LISP_STRING is the one returned by decode_mode_spec. We should
21268 ignore its text properties. */
21269 it
->stop_charpos
= it
->end_charpos
;
21271 /* If displaying STRING, set up the face of the iterator from
21272 FACE_STRING, if that's given. */
21273 if (STRINGP (face_string
))
21279 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21280 0, it
->region_beg_charpos
,
21281 it
->region_end_charpos
,
21282 &endptr
, it
->base_face_id
, 0);
21283 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21284 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21287 /* Set max_x to the maximum allowed X position. Don't let it go
21288 beyond the right edge of the window. */
21290 max_x
= it
->last_visible_x
;
21292 max_x
= min (max_x
, it
->last_visible_x
);
21294 /* Skip over display elements that are not visible. because IT->w is
21296 if (it
->current_x
< it
->first_visible_x
)
21297 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21298 MOVE_TO_POS
| MOVE_TO_X
);
21300 row
->ascent
= it
->max_ascent
;
21301 row
->height
= it
->max_ascent
+ it
->max_descent
;
21302 row
->phys_ascent
= it
->max_phys_ascent
;
21303 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21304 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21306 if (STRINGP (it
->string
))
21307 it_charpos
= IT_STRING_CHARPOS (*it
);
21309 it_charpos
= IT_CHARPOS (*it
);
21311 /* This condition is for the case that we are called with current_x
21312 past last_visible_x. */
21313 while (it
->current_x
< max_x
)
21315 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21317 /* Get the next display element. */
21318 if (!get_next_display_element (it
))
21321 /* Produce glyphs. */
21322 x_before
= it
->current_x
;
21323 n_glyphs_before
= row
->used
[TEXT_AREA
];
21324 PRODUCE_GLYPHS (it
);
21326 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21329 while (i
< nglyphs
)
21331 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21333 if (it
->line_wrap
!= TRUNCATE
21334 && x
+ glyph
->pixel_width
> max_x
)
21336 /* End of continued line or max_x reached. */
21337 if (CHAR_GLYPH_PADDING_P (*glyph
))
21339 /* A wide character is unbreakable. */
21340 if (row
->reversed_p
)
21341 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21342 - n_glyphs_before
);
21343 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21344 it
->current_x
= x_before
;
21348 if (row
->reversed_p
)
21349 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21350 - (n_glyphs_before
+ i
));
21351 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21356 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21358 /* Glyph is at least partially visible. */
21360 if (x
< it
->first_visible_x
)
21361 row
->x
= x
- it
->first_visible_x
;
21365 /* Glyph is off the left margin of the display area.
21366 Should not happen. */
21370 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21371 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21372 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21373 row
->phys_height
= max (row
->phys_height
,
21374 it
->max_phys_ascent
+ it
->max_phys_descent
);
21375 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21376 it
->max_extra_line_spacing
);
21377 x
+= glyph
->pixel_width
;
21381 /* Stop if max_x reached. */
21385 /* Stop at line ends. */
21386 if (ITERATOR_AT_END_OF_LINE_P (it
))
21388 it
->continuation_lines_width
= 0;
21392 set_iterator_to_next (it
, 1);
21393 if (STRINGP (it
->string
))
21394 it_charpos
= IT_STRING_CHARPOS (*it
);
21396 it_charpos
= IT_CHARPOS (*it
);
21398 /* Stop if truncating at the right edge. */
21399 if (it
->line_wrap
== TRUNCATE
21400 && it
->current_x
>= it
->last_visible_x
)
21402 /* Add truncation mark, but don't do it if the line is
21403 truncated at a padding space. */
21404 if (it_charpos
< it
->string_nchars
)
21406 if (!FRAME_WINDOW_P (it
->f
))
21410 if (it
->current_x
> it
->last_visible_x
)
21412 if (!row
->reversed_p
)
21414 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21415 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21420 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21421 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21423 unproduce_glyphs (it
, ii
+ 1);
21424 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21426 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21428 row
->used
[TEXT_AREA
] = ii
;
21429 produce_special_glyphs (it
, IT_TRUNCATION
);
21432 produce_special_glyphs (it
, IT_TRUNCATION
);
21434 row
->truncated_on_right_p
= 1;
21440 /* Maybe insert a truncation at the left. */
21441 if (it
->first_visible_x
21444 if (!FRAME_WINDOW_P (it
->f
))
21445 insert_left_trunc_glyphs (it
);
21446 row
->truncated_on_left_p
= 1;
21449 it
->face_id
= saved_face_id
;
21451 /* Value is number of columns displayed. */
21452 return it
->hpos
- hpos_at_start
;
21457 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21458 appears as an element of LIST or as the car of an element of LIST.
21459 If PROPVAL is a list, compare each element against LIST in that
21460 way, and return 1/2 if any element of PROPVAL is found in LIST.
21461 Otherwise return 0. This function cannot quit.
21462 The return value is 2 if the text is invisible but with an ellipsis
21463 and 1 if it's invisible and without an ellipsis. */
21466 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21468 register Lisp_Object tail
, proptail
;
21470 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21472 register Lisp_Object tem
;
21474 if (EQ (propval
, tem
))
21476 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21477 return NILP (XCDR (tem
)) ? 1 : 2;
21480 if (CONSP (propval
))
21482 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21484 Lisp_Object propelt
;
21485 propelt
= XCAR (proptail
);
21486 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21488 register Lisp_Object tem
;
21490 if (EQ (propelt
, tem
))
21492 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21493 return NILP (XCDR (tem
)) ? 1 : 2;
21501 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21502 doc
: /* Non-nil if the property makes the text invisible.
21503 POS-OR-PROP can be a marker or number, in which case it is taken to be
21504 a position in the current buffer and the value of the `invisible' property
21505 is checked; or it can be some other value, which is then presumed to be the
21506 value of the `invisible' property of the text of interest.
21507 The non-nil value returned can be t for truly invisible text or something
21508 else if the text is replaced by an ellipsis. */)
21509 (Lisp_Object pos_or_prop
)
21512 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21513 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21515 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21516 return (invis
== 0 ? Qnil
21518 : make_number (invis
));
21521 /* Calculate a width or height in pixels from a specification using
21522 the following elements:
21525 NUM - a (fractional) multiple of the default font width/height
21526 (NUM) - specifies exactly NUM pixels
21527 UNIT - a fixed number of pixels, see below.
21528 ELEMENT - size of a display element in pixels, see below.
21529 (NUM . SPEC) - equals NUM * SPEC
21530 (+ SPEC SPEC ...) - add pixel values
21531 (- SPEC SPEC ...) - subtract pixel values
21532 (- SPEC) - negate pixel value
21535 INT or FLOAT - a number constant
21536 SYMBOL - use symbol's (buffer local) variable binding.
21539 in - pixels per inch *)
21540 mm - pixels per 1/1000 meter *)
21541 cm - pixels per 1/100 meter *)
21542 width - width of current font in pixels.
21543 height - height of current font in pixels.
21545 *) using the ratio(s) defined in display-pixels-per-inch.
21549 left-fringe - left fringe width in pixels
21550 right-fringe - right fringe width in pixels
21552 left-margin - left margin width in pixels
21553 right-margin - right margin width in pixels
21555 scroll-bar - scroll-bar area width in pixels
21559 Pixels corresponding to 5 inches:
21562 Total width of non-text areas on left side of window (if scroll-bar is on left):
21563 '(space :width (+ left-fringe left-margin scroll-bar))
21565 Align to first text column (in header line):
21566 '(space :align-to 0)
21568 Align to middle of text area minus half the width of variable `my-image'
21569 containing a loaded image:
21570 '(space :align-to (0.5 . (- text my-image)))
21572 Width of left margin minus width of 1 character in the default font:
21573 '(space :width (- left-margin 1))
21575 Width of left margin minus width of 2 characters in the current font:
21576 '(space :width (- left-margin (2 . width)))
21578 Center 1 character over left-margin (in header line):
21579 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21581 Different ways to express width of left fringe plus left margin minus one pixel:
21582 '(space :width (- (+ left-fringe left-margin) (1)))
21583 '(space :width (+ left-fringe left-margin (- (1))))
21584 '(space :width (+ left-fringe left-margin (-1)))
21588 #define NUMVAL(X) \
21589 ((INTEGERP (X) || FLOATP (X)) \
21594 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21595 struct font
*font
, int width_p
, int *align_to
)
21599 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21600 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21603 return OK_PIXELS (0);
21605 xassert (FRAME_LIVE_P (it
->f
));
21607 if (SYMBOLP (prop
))
21609 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21611 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21613 if (unit
[0] == 'i' && unit
[1] == 'n')
21615 else if (unit
[0] == 'm' && unit
[1] == 'm')
21617 else if (unit
[0] == 'c' && unit
[1] == 'm')
21624 #ifdef HAVE_WINDOW_SYSTEM
21625 if (FRAME_WINDOW_P (it
->f
)
21627 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21628 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21630 return OK_PIXELS (ppi
/ pixels
);
21633 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21634 || (CONSP (Vdisplay_pixels_per_inch
)
21636 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21637 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21639 return OK_PIXELS (ppi
/ pixels
);
21645 #ifdef HAVE_WINDOW_SYSTEM
21646 if (EQ (prop
, Qheight
))
21647 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21648 if (EQ (prop
, Qwidth
))
21649 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21651 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21652 return OK_PIXELS (1);
21655 if (EQ (prop
, Qtext
))
21656 return OK_PIXELS (width_p
21657 ? window_box_width (it
->w
, TEXT_AREA
)
21658 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21660 if (align_to
&& *align_to
< 0)
21663 if (EQ (prop
, Qleft
))
21664 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21665 if (EQ (prop
, Qright
))
21666 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21667 if (EQ (prop
, Qcenter
))
21668 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21669 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21670 if (EQ (prop
, Qleft_fringe
))
21671 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21672 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21673 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21674 if (EQ (prop
, Qright_fringe
))
21675 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21676 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21677 : window_box_right_offset (it
->w
, TEXT_AREA
));
21678 if (EQ (prop
, Qleft_margin
))
21679 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21680 if (EQ (prop
, Qright_margin
))
21681 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21682 if (EQ (prop
, Qscroll_bar
))
21683 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21685 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21686 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21687 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21692 if (EQ (prop
, Qleft_fringe
))
21693 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21694 if (EQ (prop
, Qright_fringe
))
21695 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21696 if (EQ (prop
, Qleft_margin
))
21697 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21698 if (EQ (prop
, Qright_margin
))
21699 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21700 if (EQ (prop
, Qscroll_bar
))
21701 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21704 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21707 if (INTEGERP (prop
) || FLOATP (prop
))
21709 int base_unit
= (width_p
21710 ? FRAME_COLUMN_WIDTH (it
->f
)
21711 : FRAME_LINE_HEIGHT (it
->f
));
21712 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21717 Lisp_Object car
= XCAR (prop
);
21718 Lisp_Object cdr
= XCDR (prop
);
21722 #ifdef HAVE_WINDOW_SYSTEM
21723 if (FRAME_WINDOW_P (it
->f
)
21724 && valid_image_p (prop
))
21726 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21727 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21729 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21732 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21738 while (CONSP (cdr
))
21740 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21741 font
, width_p
, align_to
))
21744 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21749 if (EQ (car
, Qminus
))
21751 return OK_PIXELS (pixels
);
21754 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21757 if (INTEGERP (car
) || FLOATP (car
))
21760 pixels
= XFLOATINT (car
);
21762 return OK_PIXELS (pixels
);
21763 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21764 font
, width_p
, align_to
))
21765 return OK_PIXELS (pixels
* fact
);
21776 /***********************************************************************
21778 ***********************************************************************/
21780 #ifdef HAVE_WINDOW_SYSTEM
21785 dump_glyph_string (struct glyph_string
*s
)
21787 fprintf (stderr
, "glyph string\n");
21788 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21789 s
->x
, s
->y
, s
->width
, s
->height
);
21790 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21791 fprintf (stderr
, " hl = %d\n", s
->hl
);
21792 fprintf (stderr
, " left overhang = %d, right = %d\n",
21793 s
->left_overhang
, s
->right_overhang
);
21794 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21795 fprintf (stderr
, " extends to end of line = %d\n",
21796 s
->extends_to_end_of_line_p
);
21797 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21798 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21801 #endif /* GLYPH_DEBUG */
21803 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21804 of XChar2b structures for S; it can't be allocated in
21805 init_glyph_string because it must be allocated via `alloca'. W
21806 is the window on which S is drawn. ROW and AREA are the glyph row
21807 and area within the row from which S is constructed. START is the
21808 index of the first glyph structure covered by S. HL is a
21809 face-override for drawing S. */
21812 #define OPTIONAL_HDC(hdc) HDC hdc,
21813 #define DECLARE_HDC(hdc) HDC hdc;
21814 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21815 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21818 #ifndef OPTIONAL_HDC
21819 #define OPTIONAL_HDC(hdc)
21820 #define DECLARE_HDC(hdc)
21821 #define ALLOCATE_HDC(hdc, f)
21822 #define RELEASE_HDC(hdc, f)
21826 init_glyph_string (struct glyph_string
*s
,
21828 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21829 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21831 memset (s
, 0, sizeof *s
);
21833 s
->f
= XFRAME (w
->frame
);
21837 s
->display
= FRAME_X_DISPLAY (s
->f
);
21838 s
->window
= FRAME_X_WINDOW (s
->f
);
21839 s
->char2b
= char2b
;
21843 s
->first_glyph
= row
->glyphs
[area
] + start
;
21844 s
->height
= row
->height
;
21845 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21846 s
->ybase
= s
->y
+ row
->ascent
;
21850 /* Append the list of glyph strings with head H and tail T to the list
21851 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21854 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21855 struct glyph_string
*h
, struct glyph_string
*t
)
21869 /* Prepend the list of glyph strings with head H and tail T to the
21870 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21874 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21875 struct glyph_string
*h
, struct glyph_string
*t
)
21889 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21890 Set *HEAD and *TAIL to the resulting list. */
21893 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21894 struct glyph_string
*s
)
21896 s
->next
= s
->prev
= NULL
;
21897 append_glyph_string_lists (head
, tail
, s
, s
);
21901 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21902 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21903 make sure that X resources for the face returned are allocated.
21904 Value is a pointer to a realized face that is ready for display if
21905 DISPLAY_P is non-zero. */
21907 static inline struct face
*
21908 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21909 XChar2b
*char2b
, int display_p
)
21911 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21915 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21917 if (code
!= FONT_INVALID_CODE
)
21918 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21920 STORE_XCHAR2B (char2b
, 0, 0);
21923 /* Make sure X resources of the face are allocated. */
21924 #ifdef HAVE_X_WINDOWS
21928 xassert (face
!= NULL
);
21929 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21936 /* Get face and two-byte form of character glyph GLYPH on frame F.
21937 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21938 a pointer to a realized face that is ready for display. */
21940 static inline struct face
*
21941 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21942 XChar2b
*char2b
, int *two_byte_p
)
21946 xassert (glyph
->type
== CHAR_GLYPH
);
21947 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21956 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21957 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21959 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21961 if (code
!= FONT_INVALID_CODE
)
21962 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21964 STORE_XCHAR2B (char2b
, 0, 0);
21967 /* Make sure X resources of the face are allocated. */
21968 xassert (face
!= NULL
);
21969 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21974 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21975 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21978 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21982 if (CHAR_BYTE8_P (c
))
21983 code
= CHAR_TO_BYTE8 (c
);
21985 code
= font
->driver
->encode_char (font
, c
);
21987 if (code
== FONT_INVALID_CODE
)
21989 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21994 /* Fill glyph string S with composition components specified by S->cmp.
21996 BASE_FACE is the base face of the composition.
21997 S->cmp_from is the index of the first component for S.
21999 OVERLAPS non-zero means S should draw the foreground only, and use
22000 its physical height for clipping. See also draw_glyphs.
22002 Value is the index of a component not in S. */
22005 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22009 /* For all glyphs of this composition, starting at the offset
22010 S->cmp_from, until we reach the end of the definition or encounter a
22011 glyph that requires the different face, add it to S. */
22016 s
->for_overlaps
= overlaps
;
22019 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22021 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22023 /* TAB in a composition means display glyphs with padding space
22024 on the left or right. */
22027 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22030 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22037 s
->font
= s
->face
->font
;
22039 else if (s
->face
!= face
)
22047 /* All glyph strings for the same composition has the same width,
22048 i.e. the width set for the first component of the composition. */
22049 s
->width
= s
->first_glyph
->pixel_width
;
22051 /* If the specified font could not be loaded, use the frame's
22052 default font, but record the fact that we couldn't load it in
22053 the glyph string so that we can draw rectangles for the
22054 characters of the glyph string. */
22055 if (s
->font
== NULL
)
22057 s
->font_not_found_p
= 1;
22058 s
->font
= FRAME_FONT (s
->f
);
22061 /* Adjust base line for subscript/superscript text. */
22062 s
->ybase
+= s
->first_glyph
->voffset
;
22064 /* This glyph string must always be drawn with 16-bit functions. */
22071 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22072 int start
, int end
, int overlaps
)
22074 struct glyph
*glyph
, *last
;
22075 Lisp_Object lgstring
;
22078 s
->for_overlaps
= overlaps
;
22079 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22080 last
= s
->row
->glyphs
[s
->area
] + end
;
22081 s
->cmp_id
= glyph
->u
.cmp
.id
;
22082 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22083 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22084 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22085 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22086 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22088 while (glyph
< last
22089 && glyph
->u
.cmp
.automatic
22090 && glyph
->u
.cmp
.id
== s
->cmp_id
22091 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22092 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22094 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22096 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22097 unsigned code
= LGLYPH_CODE (lglyph
);
22099 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22101 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22102 return glyph
- s
->row
->glyphs
[s
->area
];
22106 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22107 See the comment of fill_glyph_string for arguments.
22108 Value is the index of the first glyph not in S. */
22112 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22113 int start
, int end
, int overlaps
)
22115 struct glyph
*glyph
, *last
;
22118 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22119 s
->for_overlaps
= overlaps
;
22120 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22121 last
= s
->row
->glyphs
[s
->area
] + end
;
22122 voffset
= glyph
->voffset
;
22123 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22124 s
->font
= s
->face
->font
;
22126 s
->width
= glyph
->pixel_width
;
22128 while (glyph
< last
22129 && glyph
->type
== GLYPHLESS_GLYPH
22130 && glyph
->voffset
== voffset
22131 && glyph
->face_id
== face_id
)
22134 s
->width
+= glyph
->pixel_width
;
22137 s
->ybase
+= voffset
;
22138 return glyph
- s
->row
->glyphs
[s
->area
];
22142 /* Fill glyph string S from a sequence of character glyphs.
22144 FACE_ID is the face id of the string. START is the index of the
22145 first glyph to consider, END is the index of the last + 1.
22146 OVERLAPS non-zero means S should draw the foreground only, and use
22147 its physical height for clipping. See also draw_glyphs.
22149 Value is the index of the first glyph not in S. */
22152 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22153 int start
, int end
, int overlaps
)
22155 struct glyph
*glyph
, *last
;
22157 int glyph_not_available_p
;
22159 xassert (s
->f
== XFRAME (s
->w
->frame
));
22160 xassert (s
->nchars
== 0);
22161 xassert (start
>= 0 && end
> start
);
22163 s
->for_overlaps
= overlaps
;
22164 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22165 last
= s
->row
->glyphs
[s
->area
] + end
;
22166 voffset
= glyph
->voffset
;
22167 s
->padding_p
= glyph
->padding_p
;
22168 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22170 while (glyph
< last
22171 && glyph
->type
== CHAR_GLYPH
22172 && glyph
->voffset
== voffset
22173 /* Same face id implies same font, nowadays. */
22174 && glyph
->face_id
== face_id
22175 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22179 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22180 s
->char2b
+ s
->nchars
,
22182 s
->two_byte_p
= two_byte_p
;
22184 xassert (s
->nchars
<= end
- start
);
22185 s
->width
+= glyph
->pixel_width
;
22186 if (glyph
++->padding_p
!= s
->padding_p
)
22190 s
->font
= s
->face
->font
;
22192 /* If the specified font could not be loaded, use the frame's font,
22193 but record the fact that we couldn't load it in
22194 S->font_not_found_p so that we can draw rectangles for the
22195 characters of the glyph string. */
22196 if (s
->font
== NULL
|| glyph_not_available_p
)
22198 s
->font_not_found_p
= 1;
22199 s
->font
= FRAME_FONT (s
->f
);
22202 /* Adjust base line for subscript/superscript text. */
22203 s
->ybase
+= voffset
;
22205 xassert (s
->face
&& s
->face
->gc
);
22206 return glyph
- s
->row
->glyphs
[s
->area
];
22210 /* Fill glyph string S from image glyph S->first_glyph. */
22213 fill_image_glyph_string (struct glyph_string
*s
)
22215 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22216 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22218 s
->slice
= s
->first_glyph
->slice
.img
;
22219 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22220 s
->font
= s
->face
->font
;
22221 s
->width
= s
->first_glyph
->pixel_width
;
22223 /* Adjust base line for subscript/superscript text. */
22224 s
->ybase
+= s
->first_glyph
->voffset
;
22228 /* Fill glyph string S from a sequence of stretch glyphs.
22230 START is the index of the first glyph to consider,
22231 END is the index of the last + 1.
22233 Value is the index of the first glyph not in S. */
22236 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22238 struct glyph
*glyph
, *last
;
22239 int voffset
, face_id
;
22241 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22243 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22244 last
= s
->row
->glyphs
[s
->area
] + end
;
22245 face_id
= glyph
->face_id
;
22246 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22247 s
->font
= s
->face
->font
;
22248 s
->width
= glyph
->pixel_width
;
22250 voffset
= glyph
->voffset
;
22254 && glyph
->type
== STRETCH_GLYPH
22255 && glyph
->voffset
== voffset
22256 && glyph
->face_id
== face_id
);
22258 s
->width
+= glyph
->pixel_width
;
22260 /* Adjust base line for subscript/superscript text. */
22261 s
->ybase
+= voffset
;
22263 /* The case that face->gc == 0 is handled when drawing the glyph
22264 string by calling PREPARE_FACE_FOR_DISPLAY. */
22266 return glyph
- s
->row
->glyphs
[s
->area
];
22269 static struct font_metrics
*
22270 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22272 static struct font_metrics metrics
;
22273 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22275 if (! font
|| code
== FONT_INVALID_CODE
)
22277 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22282 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22283 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22284 assumed to be zero. */
22287 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22289 *left
= *right
= 0;
22291 if (glyph
->type
== CHAR_GLYPH
)
22295 struct font_metrics
*pcm
;
22297 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22298 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22300 if (pcm
->rbearing
> pcm
->width
)
22301 *right
= pcm
->rbearing
- pcm
->width
;
22302 if (pcm
->lbearing
< 0)
22303 *left
= -pcm
->lbearing
;
22306 else if (glyph
->type
== COMPOSITE_GLYPH
)
22308 if (! glyph
->u
.cmp
.automatic
)
22310 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22312 if (cmp
->rbearing
> cmp
->pixel_width
)
22313 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22314 if (cmp
->lbearing
< 0)
22315 *left
= - cmp
->lbearing
;
22319 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22320 struct font_metrics metrics
;
22322 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22323 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22324 if (metrics
.rbearing
> metrics
.width
)
22325 *right
= metrics
.rbearing
- metrics
.width
;
22326 if (metrics
.lbearing
< 0)
22327 *left
= - metrics
.lbearing
;
22333 /* Return the index of the first glyph preceding glyph string S that
22334 is overwritten by S because of S's left overhang. Value is -1
22335 if no glyphs are overwritten. */
22338 left_overwritten (struct glyph_string
*s
)
22342 if (s
->left_overhang
)
22345 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22346 int first
= s
->first_glyph
- glyphs
;
22348 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22349 x
-= glyphs
[i
].pixel_width
;
22360 /* Return the index of the first glyph preceding glyph string S that
22361 is overwriting S because of its right overhang. Value is -1 if no
22362 glyph in front of S overwrites S. */
22365 left_overwriting (struct glyph_string
*s
)
22368 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22369 int first
= s
->first_glyph
- glyphs
;
22373 for (i
= first
- 1; i
>= 0; --i
)
22376 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22379 x
-= glyphs
[i
].pixel_width
;
22386 /* Return the index of the last glyph following glyph string S that is
22387 overwritten by S because of S's right overhang. Value is -1 if
22388 no such glyph is found. */
22391 right_overwritten (struct glyph_string
*s
)
22395 if (s
->right_overhang
)
22398 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22399 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22400 int end
= s
->row
->used
[s
->area
];
22402 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22403 x
+= glyphs
[i
].pixel_width
;
22412 /* Return the index of the last glyph following glyph string S that
22413 overwrites S because of its left overhang. Value is negative
22414 if no such glyph is found. */
22417 right_overwriting (struct glyph_string
*s
)
22420 int end
= s
->row
->used
[s
->area
];
22421 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22422 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22426 for (i
= first
; i
< end
; ++i
)
22429 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22432 x
+= glyphs
[i
].pixel_width
;
22439 /* Set background width of glyph string S. START is the index of the
22440 first glyph following S. LAST_X is the right-most x-position + 1
22441 in the drawing area. */
22444 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22446 /* If the face of this glyph string has to be drawn to the end of
22447 the drawing area, set S->extends_to_end_of_line_p. */
22449 if (start
== s
->row
->used
[s
->area
]
22450 && s
->area
== TEXT_AREA
22451 && ((s
->row
->fill_line_p
22452 && (s
->hl
== DRAW_NORMAL_TEXT
22453 || s
->hl
== DRAW_IMAGE_RAISED
22454 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22455 || s
->hl
== DRAW_MOUSE_FACE
))
22456 s
->extends_to_end_of_line_p
= 1;
22458 /* If S extends its face to the end of the line, set its
22459 background_width to the distance to the right edge of the drawing
22461 if (s
->extends_to_end_of_line_p
)
22462 s
->background_width
= last_x
- s
->x
+ 1;
22464 s
->background_width
= s
->width
;
22468 /* Compute overhangs and x-positions for glyph string S and its
22469 predecessors, or successors. X is the starting x-position for S.
22470 BACKWARD_P non-zero means process predecessors. */
22473 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22479 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22480 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22490 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22491 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22501 /* The following macros are only called from draw_glyphs below.
22502 They reference the following parameters of that function directly:
22503 `w', `row', `area', and `overlap_p'
22504 as well as the following local variables:
22505 `s', `f', and `hdc' (in W32) */
22508 /* On W32, silently add local `hdc' variable to argument list of
22509 init_glyph_string. */
22510 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22511 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22513 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22514 init_glyph_string (s, char2b, w, row, area, start, hl)
22517 /* Add a glyph string for a stretch glyph to the list of strings
22518 between HEAD and TAIL. START is the index of the stretch glyph in
22519 row area AREA of glyph row ROW. END is the index of the last glyph
22520 in that glyph row area. X is the current output position assigned
22521 to the new glyph string constructed. HL overrides that face of the
22522 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22523 is the right-most x-position of the drawing area. */
22525 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22526 and below -- keep them on one line. */
22527 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22530 s = (struct glyph_string *) alloca (sizeof *s); \
22531 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22532 START = fill_stretch_glyph_string (s, START, END); \
22533 append_glyph_string (&HEAD, &TAIL, s); \
22539 /* Add a glyph string for an image glyph to the list of strings
22540 between HEAD and TAIL. START is the index of the image glyph in
22541 row area AREA of glyph row ROW. END is the index of the last glyph
22542 in that glyph row area. X is the current output position assigned
22543 to the new glyph string constructed. HL overrides that face of the
22544 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22545 is the right-most x-position of the drawing area. */
22547 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22550 s = (struct glyph_string *) alloca (sizeof *s); \
22551 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22552 fill_image_glyph_string (s); \
22553 append_glyph_string (&HEAD, &TAIL, s); \
22560 /* Add a glyph string for a sequence of character glyphs to the list
22561 of strings between HEAD and TAIL. START is the index of the first
22562 glyph in row area AREA of glyph row ROW that is part of the new
22563 glyph string. END is the index of the last glyph in that glyph row
22564 area. X is the current output position assigned to the new glyph
22565 string constructed. HL overrides that face of the glyph; e.g. it
22566 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22567 right-most x-position of the drawing area. */
22569 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22575 face_id = (row)->glyphs[area][START].face_id; \
22577 s = (struct glyph_string *) alloca (sizeof *s); \
22578 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22579 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22580 append_glyph_string (&HEAD, &TAIL, s); \
22582 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22587 /* Add a glyph string for a composite sequence to the list of strings
22588 between HEAD and TAIL. START is the index of the first glyph in
22589 row area AREA of glyph row ROW that is part of the new glyph
22590 string. END is the index of the last glyph in that glyph row area.
22591 X is the current output position assigned to the new glyph string
22592 constructed. HL overrides that face of the glyph; e.g. it is
22593 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22594 x-position of the drawing area. */
22596 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22598 int face_id = (row)->glyphs[area][START].face_id; \
22599 struct face *base_face = FACE_FROM_ID (f, face_id); \
22600 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22601 struct composition *cmp = composition_table[cmp_id]; \
22603 struct glyph_string *first_s IF_LINT (= NULL); \
22606 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22608 /* Make glyph_strings for each glyph sequence that is drawable by \
22609 the same face, and append them to HEAD/TAIL. */ \
22610 for (n = 0; n < cmp->glyph_len;) \
22612 s = (struct glyph_string *) alloca (sizeof *s); \
22613 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22614 append_glyph_string (&(HEAD), &(TAIL), s); \
22620 n = fill_composite_glyph_string (s, base_face, overlaps); \
22628 /* Add a glyph string for a glyph-string sequence to the list of strings
22629 between HEAD and TAIL. */
22631 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22635 Lisp_Object gstring; \
22637 face_id = (row)->glyphs[area][START].face_id; \
22638 gstring = (composition_gstring_from_id \
22639 ((row)->glyphs[area][START].u.cmp.id)); \
22640 s = (struct glyph_string *) alloca (sizeof *s); \
22641 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22642 * LGSTRING_GLYPH_LEN (gstring)); \
22643 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22644 append_glyph_string (&(HEAD), &(TAIL), s); \
22646 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22650 /* Add a glyph string for a sequence of glyphless character's glyphs
22651 to the list of strings between HEAD and TAIL. The meanings of
22652 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22654 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22659 face_id = (row)->glyphs[area][START].face_id; \
22661 s = (struct glyph_string *) alloca (sizeof *s); \
22662 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22663 append_glyph_string (&HEAD, &TAIL, s); \
22665 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22671 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22672 of AREA of glyph row ROW on window W between indices START and END.
22673 HL overrides the face for drawing glyph strings, e.g. it is
22674 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22675 x-positions of the drawing area.
22677 This is an ugly monster macro construct because we must use alloca
22678 to allocate glyph strings (because draw_glyphs can be called
22679 asynchronously). */
22681 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22684 HEAD = TAIL = NULL; \
22685 while (START < END) \
22687 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22688 switch (first_glyph->type) \
22691 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22695 case COMPOSITE_GLYPH: \
22696 if (first_glyph->u.cmp.automatic) \
22697 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22700 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22704 case STRETCH_GLYPH: \
22705 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22709 case IMAGE_GLYPH: \
22710 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22714 case GLYPHLESS_GLYPH: \
22715 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22725 set_glyph_string_background_width (s, START, LAST_X); \
22732 /* Draw glyphs between START and END in AREA of ROW on window W,
22733 starting at x-position X. X is relative to AREA in W. HL is a
22734 face-override with the following meaning:
22736 DRAW_NORMAL_TEXT draw normally
22737 DRAW_CURSOR draw in cursor face
22738 DRAW_MOUSE_FACE draw in mouse face.
22739 DRAW_INVERSE_VIDEO draw in mode line face
22740 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22741 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22743 If OVERLAPS is non-zero, draw only the foreground of characters and
22744 clip to the physical height of ROW. Non-zero value also defines
22745 the overlapping part to be drawn:
22747 OVERLAPS_PRED overlap with preceding rows
22748 OVERLAPS_SUCC overlap with succeeding rows
22749 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22750 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22752 Value is the x-position reached, relative to AREA of W. */
22755 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22756 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22757 enum draw_glyphs_face hl
, int overlaps
)
22759 struct glyph_string
*head
, *tail
;
22760 struct glyph_string
*s
;
22761 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22762 int i
, j
, x_reached
, last_x
, area_left
= 0;
22763 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22766 ALLOCATE_HDC (hdc
, f
);
22768 /* Let's rather be paranoid than getting a SEGV. */
22769 end
= min (end
, row
->used
[area
]);
22770 start
= max (0, start
);
22771 start
= min (end
, start
);
22773 /* Translate X to frame coordinates. Set last_x to the right
22774 end of the drawing area. */
22775 if (row
->full_width_p
)
22777 /* X is relative to the left edge of W, without scroll bars
22779 area_left
= WINDOW_LEFT_EDGE_X (w
);
22780 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22784 area_left
= window_box_left (w
, area
);
22785 last_x
= area_left
+ window_box_width (w
, area
);
22789 /* Build a doubly-linked list of glyph_string structures between
22790 head and tail from what we have to draw. Note that the macro
22791 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22792 the reason we use a separate variable `i'. */
22794 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22796 x_reached
= tail
->x
+ tail
->background_width
;
22800 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22801 the row, redraw some glyphs in front or following the glyph
22802 strings built above. */
22803 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22805 struct glyph_string
*h
, *t
;
22806 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22807 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22808 int check_mouse_face
= 0;
22811 /* If mouse highlighting is on, we may need to draw adjacent
22812 glyphs using mouse-face highlighting. */
22813 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22815 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22817 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22818 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22820 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22822 check_mouse_face
= 1;
22823 mouse_beg_col
= (row
== mouse_beg_row
)
22824 ? hlinfo
->mouse_face_beg_col
: 0;
22825 mouse_end_col
= (row
== mouse_end_row
)
22826 ? hlinfo
->mouse_face_end_col
22827 : row
->used
[TEXT_AREA
];
22831 /* Compute overhangs for all glyph strings. */
22832 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22833 for (s
= head
; s
; s
= s
->next
)
22834 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22836 /* Prepend glyph strings for glyphs in front of the first glyph
22837 string that are overwritten because of the first glyph
22838 string's left overhang. The background of all strings
22839 prepended must be drawn because the first glyph string
22841 i
= left_overwritten (head
);
22844 enum draw_glyphs_face overlap_hl
;
22846 /* If this row contains mouse highlighting, attempt to draw
22847 the overlapped glyphs with the correct highlight. This
22848 code fails if the overlap encompasses more than one glyph
22849 and mouse-highlight spans only some of these glyphs.
22850 However, making it work perfectly involves a lot more
22851 code, and I don't know if the pathological case occurs in
22852 practice, so we'll stick to this for now. --- cyd */
22853 if (check_mouse_face
22854 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22855 overlap_hl
= DRAW_MOUSE_FACE
;
22857 overlap_hl
= DRAW_NORMAL_TEXT
;
22860 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22861 overlap_hl
, dummy_x
, last_x
);
22863 compute_overhangs_and_x (t
, head
->x
, 1);
22864 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22868 /* Prepend glyph strings for glyphs in front of the first glyph
22869 string that overwrite that glyph string because of their
22870 right overhang. For these strings, only the foreground must
22871 be drawn, because it draws over the glyph string at `head'.
22872 The background must not be drawn because this would overwrite
22873 right overhangs of preceding glyphs for which no glyph
22875 i
= left_overwriting (head
);
22878 enum draw_glyphs_face overlap_hl
;
22880 if (check_mouse_face
22881 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22882 overlap_hl
= DRAW_MOUSE_FACE
;
22884 overlap_hl
= DRAW_NORMAL_TEXT
;
22887 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22888 overlap_hl
, dummy_x
, last_x
);
22889 for (s
= h
; s
; s
= s
->next
)
22890 s
->background_filled_p
= 1;
22891 compute_overhangs_and_x (t
, head
->x
, 1);
22892 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22895 /* Append glyphs strings for glyphs following the last glyph
22896 string tail that are overwritten by tail. The background of
22897 these strings has to be drawn because tail's foreground draws
22899 i
= right_overwritten (tail
);
22902 enum draw_glyphs_face overlap_hl
;
22904 if (check_mouse_face
22905 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22906 overlap_hl
= DRAW_MOUSE_FACE
;
22908 overlap_hl
= DRAW_NORMAL_TEXT
;
22910 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22911 overlap_hl
, x
, last_x
);
22912 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22913 we don't have `end = i;' here. */
22914 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22915 append_glyph_string_lists (&head
, &tail
, h
, t
);
22919 /* Append glyph strings for glyphs following the last glyph
22920 string tail that overwrite tail. The foreground of such
22921 glyphs has to be drawn because it writes into the background
22922 of tail. The background must not be drawn because it could
22923 paint over the foreground of following glyphs. */
22924 i
= right_overwriting (tail
);
22927 enum draw_glyphs_face overlap_hl
;
22928 if (check_mouse_face
22929 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22930 overlap_hl
= DRAW_MOUSE_FACE
;
22932 overlap_hl
= DRAW_NORMAL_TEXT
;
22935 i
++; /* We must include the Ith glyph. */
22936 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22937 overlap_hl
, x
, last_x
);
22938 for (s
= h
; s
; s
= s
->next
)
22939 s
->background_filled_p
= 1;
22940 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22941 append_glyph_string_lists (&head
, &tail
, h
, t
);
22943 if (clip_head
|| clip_tail
)
22944 for (s
= head
; s
; s
= s
->next
)
22946 s
->clip_head
= clip_head
;
22947 s
->clip_tail
= clip_tail
;
22951 /* Draw all strings. */
22952 for (s
= head
; s
; s
= s
->next
)
22953 FRAME_RIF (f
)->draw_glyph_string (s
);
22956 /* When focus a sole frame and move horizontally, this sets on_p to 0
22957 causing a failure to erase prev cursor position. */
22958 if (area
== TEXT_AREA
22959 && !row
->full_width_p
22960 /* When drawing overlapping rows, only the glyph strings'
22961 foreground is drawn, which doesn't erase a cursor
22965 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22966 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22967 : (tail
? tail
->x
+ tail
->background_width
: x
));
22971 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22972 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22976 /* Value is the x-position up to which drawn, relative to AREA of W.
22977 This doesn't include parts drawn because of overhangs. */
22978 if (row
->full_width_p
)
22979 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22981 x_reached
-= area_left
;
22983 RELEASE_HDC (hdc
, f
);
22988 /* Expand row matrix if too narrow. Don't expand if area
22991 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22993 if (!fonts_changed_p \
22994 && (it->glyph_row->glyphs[area] \
22995 < it->glyph_row->glyphs[area + 1])) \
22997 it->w->ncols_scale_factor++; \
22998 fonts_changed_p = 1; \
23002 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23003 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23006 append_glyph (struct it
*it
)
23008 struct glyph
*glyph
;
23009 enum glyph_row_area area
= it
->area
;
23011 xassert (it
->glyph_row
);
23012 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23014 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23015 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23017 /* If the glyph row is reversed, we need to prepend the glyph
23018 rather than append it. */
23019 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23023 /* Make room for the additional glyph. */
23024 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23026 glyph
= it
->glyph_row
->glyphs
[area
];
23028 glyph
->charpos
= CHARPOS (it
->position
);
23029 glyph
->object
= it
->object
;
23030 if (it
->pixel_width
> 0)
23032 glyph
->pixel_width
= it
->pixel_width
;
23033 glyph
->padding_p
= 0;
23037 /* Assure at least 1-pixel width. Otherwise, cursor can't
23038 be displayed correctly. */
23039 glyph
->pixel_width
= 1;
23040 glyph
->padding_p
= 1;
23042 glyph
->ascent
= it
->ascent
;
23043 glyph
->descent
= it
->descent
;
23044 glyph
->voffset
= it
->voffset
;
23045 glyph
->type
= CHAR_GLYPH
;
23046 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23047 glyph
->multibyte_p
= it
->multibyte_p
;
23048 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23049 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23050 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23051 || it
->phys_descent
> it
->descent
);
23052 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23053 glyph
->face_id
= it
->face_id
;
23054 glyph
->u
.ch
= it
->char_to_display
;
23055 glyph
->slice
.img
= null_glyph_slice
;
23056 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23059 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23060 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23062 glyph
->bidi_type
= it
->bidi_it
.type
;
23066 glyph
->resolved_level
= 0;
23067 glyph
->bidi_type
= UNKNOWN_BT
;
23069 ++it
->glyph_row
->used
[area
];
23072 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23075 /* Store one glyph for the composition IT->cmp_it.id in
23076 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23080 append_composite_glyph (struct it
*it
)
23082 struct glyph
*glyph
;
23083 enum glyph_row_area area
= it
->area
;
23085 xassert (it
->glyph_row
);
23087 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23088 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23090 /* If the glyph row is reversed, we need to prepend the glyph
23091 rather than append it. */
23092 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23096 /* Make room for the new glyph. */
23097 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23099 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23101 glyph
->charpos
= it
->cmp_it
.charpos
;
23102 glyph
->object
= it
->object
;
23103 glyph
->pixel_width
= it
->pixel_width
;
23104 glyph
->ascent
= it
->ascent
;
23105 glyph
->descent
= it
->descent
;
23106 glyph
->voffset
= it
->voffset
;
23107 glyph
->type
= COMPOSITE_GLYPH
;
23108 if (it
->cmp_it
.ch
< 0)
23110 glyph
->u
.cmp
.automatic
= 0;
23111 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23112 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23116 glyph
->u
.cmp
.automatic
= 1;
23117 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23118 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23119 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23121 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23122 glyph
->multibyte_p
= it
->multibyte_p
;
23123 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23124 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23125 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23126 || it
->phys_descent
> it
->descent
);
23127 glyph
->padding_p
= 0;
23128 glyph
->glyph_not_available_p
= 0;
23129 glyph
->face_id
= it
->face_id
;
23130 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23133 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23134 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23136 glyph
->bidi_type
= it
->bidi_it
.type
;
23138 ++it
->glyph_row
->used
[area
];
23141 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23145 /* Change IT->ascent and IT->height according to the setting of
23149 take_vertical_position_into_account (struct it
*it
)
23153 if (it
->voffset
< 0)
23154 /* Increase the ascent so that we can display the text higher
23156 it
->ascent
-= it
->voffset
;
23158 /* Increase the descent so that we can display the text lower
23160 it
->descent
+= it
->voffset
;
23165 /* Produce glyphs/get display metrics for the image IT is loaded with.
23166 See the description of struct display_iterator in dispextern.h for
23167 an overview of struct display_iterator. */
23170 produce_image_glyph (struct it
*it
)
23174 int glyph_ascent
, crop
;
23175 struct glyph_slice slice
;
23177 xassert (it
->what
== IT_IMAGE
);
23179 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23181 /* Make sure X resources of the face is loaded. */
23182 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23184 if (it
->image_id
< 0)
23186 /* Fringe bitmap. */
23187 it
->ascent
= it
->phys_ascent
= 0;
23188 it
->descent
= it
->phys_descent
= 0;
23189 it
->pixel_width
= 0;
23194 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23196 /* Make sure X resources of the image is loaded. */
23197 prepare_image_for_display (it
->f
, img
);
23199 slice
.x
= slice
.y
= 0;
23200 slice
.width
= img
->width
;
23201 slice
.height
= img
->height
;
23203 if (INTEGERP (it
->slice
.x
))
23204 slice
.x
= XINT (it
->slice
.x
);
23205 else if (FLOATP (it
->slice
.x
))
23206 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23208 if (INTEGERP (it
->slice
.y
))
23209 slice
.y
= XINT (it
->slice
.y
);
23210 else if (FLOATP (it
->slice
.y
))
23211 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23213 if (INTEGERP (it
->slice
.width
))
23214 slice
.width
= XINT (it
->slice
.width
);
23215 else if (FLOATP (it
->slice
.width
))
23216 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23218 if (INTEGERP (it
->slice
.height
))
23219 slice
.height
= XINT (it
->slice
.height
);
23220 else if (FLOATP (it
->slice
.height
))
23221 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23223 if (slice
.x
>= img
->width
)
23224 slice
.x
= img
->width
;
23225 if (slice
.y
>= img
->height
)
23226 slice
.y
= img
->height
;
23227 if (slice
.x
+ slice
.width
>= img
->width
)
23228 slice
.width
= img
->width
- slice
.x
;
23229 if (slice
.y
+ slice
.height
> img
->height
)
23230 slice
.height
= img
->height
- slice
.y
;
23232 if (slice
.width
== 0 || slice
.height
== 0)
23235 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23237 it
->descent
= slice
.height
- glyph_ascent
;
23239 it
->descent
+= img
->vmargin
;
23240 if (slice
.y
+ slice
.height
== img
->height
)
23241 it
->descent
+= img
->vmargin
;
23242 it
->phys_descent
= it
->descent
;
23244 it
->pixel_width
= slice
.width
;
23246 it
->pixel_width
+= img
->hmargin
;
23247 if (slice
.x
+ slice
.width
== img
->width
)
23248 it
->pixel_width
+= img
->hmargin
;
23250 /* It's quite possible for images to have an ascent greater than
23251 their height, so don't get confused in that case. */
23252 if (it
->descent
< 0)
23257 if (face
->box
!= FACE_NO_BOX
)
23259 if (face
->box_line_width
> 0)
23262 it
->ascent
+= face
->box_line_width
;
23263 if (slice
.y
+ slice
.height
== img
->height
)
23264 it
->descent
+= face
->box_line_width
;
23267 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23268 it
->pixel_width
+= eabs (face
->box_line_width
);
23269 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23270 it
->pixel_width
+= eabs (face
->box_line_width
);
23273 take_vertical_position_into_account (it
);
23275 /* Automatically crop wide image glyphs at right edge so we can
23276 draw the cursor on same display row. */
23277 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23278 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23280 it
->pixel_width
-= crop
;
23281 slice
.width
-= crop
;
23286 struct glyph
*glyph
;
23287 enum glyph_row_area area
= it
->area
;
23289 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23290 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23292 glyph
->charpos
= CHARPOS (it
->position
);
23293 glyph
->object
= it
->object
;
23294 glyph
->pixel_width
= it
->pixel_width
;
23295 glyph
->ascent
= glyph_ascent
;
23296 glyph
->descent
= it
->descent
;
23297 glyph
->voffset
= it
->voffset
;
23298 glyph
->type
= IMAGE_GLYPH
;
23299 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23300 glyph
->multibyte_p
= it
->multibyte_p
;
23301 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23302 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23303 glyph
->overlaps_vertically_p
= 0;
23304 glyph
->padding_p
= 0;
23305 glyph
->glyph_not_available_p
= 0;
23306 glyph
->face_id
= it
->face_id
;
23307 glyph
->u
.img_id
= img
->id
;
23308 glyph
->slice
.img
= slice
;
23309 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23312 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23313 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23315 glyph
->bidi_type
= it
->bidi_it
.type
;
23317 ++it
->glyph_row
->used
[area
];
23320 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23325 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23326 of the glyph, WIDTH and HEIGHT are the width and height of the
23327 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23330 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23331 int width
, int height
, int ascent
)
23333 struct glyph
*glyph
;
23334 enum glyph_row_area area
= it
->area
;
23336 xassert (ascent
>= 0 && ascent
<= height
);
23338 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23339 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23341 /* If the glyph row is reversed, we need to prepend the glyph
23342 rather than append it. */
23343 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23347 /* Make room for the additional glyph. */
23348 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23350 glyph
= it
->glyph_row
->glyphs
[area
];
23352 glyph
->charpos
= CHARPOS (it
->position
);
23353 glyph
->object
= object
;
23354 glyph
->pixel_width
= width
;
23355 glyph
->ascent
= ascent
;
23356 glyph
->descent
= height
- ascent
;
23357 glyph
->voffset
= it
->voffset
;
23358 glyph
->type
= STRETCH_GLYPH
;
23359 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23360 glyph
->multibyte_p
= it
->multibyte_p
;
23361 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23362 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23363 glyph
->overlaps_vertically_p
= 0;
23364 glyph
->padding_p
= 0;
23365 glyph
->glyph_not_available_p
= 0;
23366 glyph
->face_id
= it
->face_id
;
23367 glyph
->u
.stretch
.ascent
= ascent
;
23368 glyph
->u
.stretch
.height
= height
;
23369 glyph
->slice
.img
= null_glyph_slice
;
23370 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23373 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23374 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23376 glyph
->bidi_type
= it
->bidi_it
.type
;
23380 glyph
->resolved_level
= 0;
23381 glyph
->bidi_type
= UNKNOWN_BT
;
23383 ++it
->glyph_row
->used
[area
];
23386 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23389 #endif /* HAVE_WINDOW_SYSTEM */
23391 /* Produce a stretch glyph for iterator IT. IT->object is the value
23392 of the glyph property displayed. The value must be a list
23393 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23396 1. `:width WIDTH' specifies that the space should be WIDTH *
23397 canonical char width wide. WIDTH may be an integer or floating
23400 2. `:relative-width FACTOR' specifies that the width of the stretch
23401 should be computed from the width of the first character having the
23402 `glyph' property, and should be FACTOR times that width.
23404 3. `:align-to HPOS' specifies that the space should be wide enough
23405 to reach HPOS, a value in canonical character units.
23407 Exactly one of the above pairs must be present.
23409 4. `:height HEIGHT' specifies that the height of the stretch produced
23410 should be HEIGHT, measured in canonical character units.
23412 5. `:relative-height FACTOR' specifies that the height of the
23413 stretch should be FACTOR times the height of the characters having
23414 the glyph property.
23416 Either none or exactly one of 4 or 5 must be present.
23418 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23419 of the stretch should be used for the ascent of the stretch.
23420 ASCENT must be in the range 0 <= ASCENT <= 100. */
23423 produce_stretch_glyph (struct it
*it
)
23425 /* (space :width WIDTH :height HEIGHT ...) */
23426 Lisp_Object prop
, plist
;
23427 int width
= 0, height
= 0, align_to
= -1;
23428 int zero_width_ok_p
= 0;
23431 struct face
*face
= NULL
;
23432 struct font
*font
= NULL
;
23434 #ifdef HAVE_WINDOW_SYSTEM
23435 int zero_height_ok_p
= 0;
23437 if (FRAME_WINDOW_P (it
->f
))
23439 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23440 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23441 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23445 /* List should start with `space'. */
23446 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23447 plist
= XCDR (it
->object
);
23449 /* Compute the width of the stretch. */
23450 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23451 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23453 /* Absolute width `:width WIDTH' specified and valid. */
23454 zero_width_ok_p
= 1;
23457 #ifdef HAVE_WINDOW_SYSTEM
23458 else if (FRAME_WINDOW_P (it
->f
)
23459 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23461 /* Relative width `:relative-width FACTOR' specified and valid.
23462 Compute the width of the characters having the `glyph'
23465 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23468 if (it
->multibyte_p
)
23469 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23472 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23473 if (! ASCII_CHAR_P (it2
.c
))
23474 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23477 it2
.glyph_row
= NULL
;
23478 it2
.what
= IT_CHARACTER
;
23479 x_produce_glyphs (&it2
);
23480 width
= NUMVAL (prop
) * it2
.pixel_width
;
23482 #endif /* HAVE_WINDOW_SYSTEM */
23483 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23484 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23486 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23487 align_to
= (align_to
< 0
23489 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23490 else if (align_to
< 0)
23491 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23492 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23493 zero_width_ok_p
= 1;
23496 /* Nothing specified -> width defaults to canonical char width. */
23497 width
= FRAME_COLUMN_WIDTH (it
->f
);
23499 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23502 #ifdef HAVE_WINDOW_SYSTEM
23503 /* Compute height. */
23504 if (FRAME_WINDOW_P (it
->f
))
23506 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23507 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23510 zero_height_ok_p
= 1;
23512 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23514 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23516 height
= FONT_HEIGHT (font
);
23518 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23521 /* Compute percentage of height used for ascent. If
23522 `:ascent ASCENT' is present and valid, use that. Otherwise,
23523 derive the ascent from the font in use. */
23524 if (prop
= Fplist_get (plist
, QCascent
),
23525 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23526 ascent
= height
* NUMVAL (prop
) / 100.0;
23527 else if (!NILP (prop
)
23528 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23529 ascent
= min (max (0, (int)tem
), height
);
23531 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23534 #endif /* HAVE_WINDOW_SYSTEM */
23537 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23538 && it
->current_x
+ width
> it
->last_visible_x
)
23540 width
= it
->last_visible_x
- it
->current_x
;
23541 #ifdef HAVE_WINDOW_SYSTEM
23542 /* Subtact one more pixel from the stretch width, but only on
23543 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23544 width
-= FRAME_WINDOW_P (it
->f
);
23548 if (width
> 0 && height
> 0 && it
->glyph_row
)
23550 Lisp_Object o_object
= it
->object
;
23551 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23554 if (!STRINGP (object
))
23555 object
= it
->w
->buffer
;
23556 #ifdef HAVE_WINDOW_SYSTEM
23557 if (FRAME_WINDOW_P (it
->f
))
23558 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23562 it
->object
= object
;
23563 it
->char_to_display
= ' ';
23564 it
->pixel_width
= it
->len
= 1;
23566 tty_append_glyph (it
);
23567 it
->object
= o_object
;
23571 it
->pixel_width
= width
;
23572 #ifdef HAVE_WINDOW_SYSTEM
23573 if (FRAME_WINDOW_P (it
->f
))
23575 it
->ascent
= it
->phys_ascent
= ascent
;
23576 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23577 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23578 take_vertical_position_into_account (it
);
23582 it
->nglyphs
= width
;
23585 #ifdef HAVE_WINDOW_SYSTEM
23587 /* Calculate line-height and line-spacing properties.
23588 An integer value specifies explicit pixel value.
23589 A float value specifies relative value to current face height.
23590 A cons (float . face-name) specifies relative value to
23591 height of specified face font.
23593 Returns height in pixels, or nil. */
23597 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23598 int boff
, int override
)
23600 Lisp_Object face_name
= Qnil
;
23601 int ascent
, descent
, height
;
23603 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23608 face_name
= XCAR (val
);
23610 if (!NUMBERP (val
))
23611 val
= make_number (1);
23612 if (NILP (face_name
))
23614 height
= it
->ascent
+ it
->descent
;
23619 if (NILP (face_name
))
23621 font
= FRAME_FONT (it
->f
);
23622 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23624 else if (EQ (face_name
, Qt
))
23633 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23635 return make_number (-1);
23637 face
= FACE_FROM_ID (it
->f
, face_id
);
23640 return make_number (-1);
23641 boff
= font
->baseline_offset
;
23642 if (font
->vertical_centering
)
23643 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23646 ascent
= FONT_BASE (font
) + boff
;
23647 descent
= FONT_DESCENT (font
) - boff
;
23651 it
->override_ascent
= ascent
;
23652 it
->override_descent
= descent
;
23653 it
->override_boff
= boff
;
23656 height
= ascent
+ descent
;
23660 height
= (int)(XFLOAT_DATA (val
) * height
);
23661 else if (INTEGERP (val
))
23662 height
*= XINT (val
);
23664 return make_number (height
);
23668 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23669 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23670 and only if this is for a character for which no font was found.
23672 If the display method (it->glyphless_method) is
23673 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23674 length of the acronym or the hexadecimal string, UPPER_XOFF and
23675 UPPER_YOFF are pixel offsets for the upper part of the string,
23676 LOWER_XOFF and LOWER_YOFF are for the lower part.
23678 For the other display methods, LEN through LOWER_YOFF are zero. */
23681 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23682 short upper_xoff
, short upper_yoff
,
23683 short lower_xoff
, short lower_yoff
)
23685 struct glyph
*glyph
;
23686 enum glyph_row_area area
= it
->area
;
23688 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23689 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23691 /* If the glyph row is reversed, we need to prepend the glyph
23692 rather than append it. */
23693 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23697 /* Make room for the additional glyph. */
23698 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23700 glyph
= it
->glyph_row
->glyphs
[area
];
23702 glyph
->charpos
= CHARPOS (it
->position
);
23703 glyph
->object
= it
->object
;
23704 glyph
->pixel_width
= it
->pixel_width
;
23705 glyph
->ascent
= it
->ascent
;
23706 glyph
->descent
= it
->descent
;
23707 glyph
->voffset
= it
->voffset
;
23708 glyph
->type
= GLYPHLESS_GLYPH
;
23709 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23710 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23711 glyph
->u
.glyphless
.len
= len
;
23712 glyph
->u
.glyphless
.ch
= it
->c
;
23713 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23714 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23715 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23716 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23717 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23718 glyph
->multibyte_p
= it
->multibyte_p
;
23719 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23720 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23721 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23722 || it
->phys_descent
> it
->descent
);
23723 glyph
->padding_p
= 0;
23724 glyph
->glyph_not_available_p
= 0;
23725 glyph
->face_id
= face_id
;
23726 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23729 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23730 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23732 glyph
->bidi_type
= it
->bidi_it
.type
;
23734 ++it
->glyph_row
->used
[area
];
23737 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23741 /* Produce a glyph for a glyphless character for iterator IT.
23742 IT->glyphless_method specifies which method to use for displaying
23743 the character. See the description of enum
23744 glyphless_display_method in dispextern.h for the detail.
23746 FOR_NO_FONT is nonzero if and only if this is for a character for
23747 which no font was found. ACRONYM, if non-nil, is an acronym string
23748 for the character. */
23751 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23756 int base_width
, base_height
, width
, height
;
23757 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23760 /* Get the metrics of the base font. We always refer to the current
23762 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23763 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23764 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23765 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23766 base_height
= it
->ascent
+ it
->descent
;
23767 base_width
= font
->average_width
;
23769 /* Get a face ID for the glyph by utilizing a cache (the same way as
23770 done for `escape-glyph' in get_next_display_element). */
23771 if (it
->f
== last_glyphless_glyph_frame
23772 && it
->face_id
== last_glyphless_glyph_face_id
)
23774 face_id
= last_glyphless_glyph_merged_face_id
;
23778 /* Merge the `glyphless-char' face into the current face. */
23779 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23780 last_glyphless_glyph_frame
= it
->f
;
23781 last_glyphless_glyph_face_id
= it
->face_id
;
23782 last_glyphless_glyph_merged_face_id
= face_id
;
23785 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23787 it
->pixel_width
= THIN_SPACE_WIDTH
;
23789 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23791 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23793 width
= CHAR_WIDTH (it
->c
);
23796 else if (width
> 4)
23798 it
->pixel_width
= base_width
* width
;
23800 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23806 unsigned int code
[6];
23808 int ascent
, descent
;
23809 struct font_metrics metrics_upper
, metrics_lower
;
23811 face
= FACE_FROM_ID (it
->f
, face_id
);
23812 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23813 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23815 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23817 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23818 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23819 if (CONSP (acronym
))
23820 acronym
= XCAR (acronym
);
23821 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23825 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23826 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23829 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23830 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23831 upper_len
= (len
+ 1) / 2;
23832 font
->driver
->text_extents (font
, code
, upper_len
,
23834 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23839 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23840 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23841 upper_xoff
= upper_yoff
= 2; /* the typical case */
23842 if (base_width
>= width
)
23844 /* Align the upper to the left, the lower to the right. */
23845 it
->pixel_width
= base_width
;
23846 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23850 /* Center the shorter one. */
23851 it
->pixel_width
= width
;
23852 if (metrics_upper
.width
>= metrics_lower
.width
)
23853 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23856 /* FIXME: This code doesn't look right. It formerly was
23857 missing the "lower_xoff = 0;", which couldn't have
23858 been right since it left lower_xoff uninitialized. */
23860 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23864 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23865 top, bottom, and between upper and lower strings. */
23866 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23867 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23868 /* Center vertically.
23869 H:base_height, D:base_descent
23870 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23872 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23873 descent = D - H/2 + h/2;
23874 lower_yoff = descent - 2 - ld;
23875 upper_yoff = lower_yoff - la - 1 - ud; */
23876 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23877 descent
= it
->descent
- (base_height
- height
) / 2;
23878 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23879 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23880 - metrics_upper
.descent
);
23881 /* Don't make the height shorter than the base height. */
23882 if (height
> base_height
)
23884 it
->ascent
= ascent
;
23885 it
->descent
= descent
;
23889 it
->phys_ascent
= it
->ascent
;
23890 it
->phys_descent
= it
->descent
;
23892 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23893 upper_xoff
, upper_yoff
,
23894 lower_xoff
, lower_yoff
);
23896 take_vertical_position_into_account (it
);
23901 Produce glyphs/get display metrics for the display element IT is
23902 loaded with. See the description of struct it in dispextern.h
23903 for an overview of struct it. */
23906 x_produce_glyphs (struct it
*it
)
23908 int extra_line_spacing
= it
->extra_line_spacing
;
23910 it
->glyph_not_available_p
= 0;
23912 if (it
->what
== IT_CHARACTER
)
23915 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23916 struct font
*font
= face
->font
;
23917 struct font_metrics
*pcm
= NULL
;
23918 int boff
; /* baseline offset */
23922 /* When no suitable font is found, display this character by
23923 the method specified in the first extra slot of
23924 Vglyphless_char_display. */
23925 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23927 xassert (it
->what
== IT_GLYPHLESS
);
23928 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23932 boff
= font
->baseline_offset
;
23933 if (font
->vertical_centering
)
23934 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23936 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23942 if (it
->override_ascent
>= 0)
23944 it
->ascent
= it
->override_ascent
;
23945 it
->descent
= it
->override_descent
;
23946 boff
= it
->override_boff
;
23950 it
->ascent
= FONT_BASE (font
) + boff
;
23951 it
->descent
= FONT_DESCENT (font
) - boff
;
23954 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23956 pcm
= get_per_char_metric (font
, &char2b
);
23957 if (pcm
->width
== 0
23958 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23964 it
->phys_ascent
= pcm
->ascent
+ boff
;
23965 it
->phys_descent
= pcm
->descent
- boff
;
23966 it
->pixel_width
= pcm
->width
;
23970 it
->glyph_not_available_p
= 1;
23971 it
->phys_ascent
= it
->ascent
;
23972 it
->phys_descent
= it
->descent
;
23973 it
->pixel_width
= font
->space_width
;
23976 if (it
->constrain_row_ascent_descent_p
)
23978 if (it
->descent
> it
->max_descent
)
23980 it
->ascent
+= it
->descent
- it
->max_descent
;
23981 it
->descent
= it
->max_descent
;
23983 if (it
->ascent
> it
->max_ascent
)
23985 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23986 it
->ascent
= it
->max_ascent
;
23988 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23989 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23990 extra_line_spacing
= 0;
23993 /* If this is a space inside a region of text with
23994 `space-width' property, change its width. */
23995 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23997 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23999 /* If face has a box, add the box thickness to the character
24000 height. If character has a box line to the left and/or
24001 right, add the box line width to the character's width. */
24002 if (face
->box
!= FACE_NO_BOX
)
24004 int thick
= face
->box_line_width
;
24008 it
->ascent
+= thick
;
24009 it
->descent
+= thick
;
24014 if (it
->start_of_box_run_p
)
24015 it
->pixel_width
+= thick
;
24016 if (it
->end_of_box_run_p
)
24017 it
->pixel_width
+= thick
;
24020 /* If face has an overline, add the height of the overline
24021 (1 pixel) and a 1 pixel margin to the character height. */
24022 if (face
->overline_p
)
24023 it
->ascent
+= overline_margin
;
24025 if (it
->constrain_row_ascent_descent_p
)
24027 if (it
->ascent
> it
->max_ascent
)
24028 it
->ascent
= it
->max_ascent
;
24029 if (it
->descent
> it
->max_descent
)
24030 it
->descent
= it
->max_descent
;
24033 take_vertical_position_into_account (it
);
24035 /* If we have to actually produce glyphs, do it. */
24040 /* Translate a space with a `space-width' property
24041 into a stretch glyph. */
24042 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24043 / FONT_HEIGHT (font
));
24044 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24045 it
->ascent
+ it
->descent
, ascent
);
24050 /* If characters with lbearing or rbearing are displayed
24051 in this line, record that fact in a flag of the
24052 glyph row. This is used to optimize X output code. */
24053 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24054 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24056 if (! stretched_p
&& it
->pixel_width
== 0)
24057 /* We assure that all visible glyphs have at least 1-pixel
24059 it
->pixel_width
= 1;
24061 else if (it
->char_to_display
== '\n')
24063 /* A newline has no width, but we need the height of the
24064 line. But if previous part of the line sets a height,
24065 don't increase that height */
24067 Lisp_Object height
;
24068 Lisp_Object total_height
= Qnil
;
24070 it
->override_ascent
= -1;
24071 it
->pixel_width
= 0;
24074 height
= get_it_property (it
, Qline_height
);
24075 /* Split (line-height total-height) list */
24077 && CONSP (XCDR (height
))
24078 && NILP (XCDR (XCDR (height
))))
24080 total_height
= XCAR (XCDR (height
));
24081 height
= XCAR (height
);
24083 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24085 if (it
->override_ascent
>= 0)
24087 it
->ascent
= it
->override_ascent
;
24088 it
->descent
= it
->override_descent
;
24089 boff
= it
->override_boff
;
24093 it
->ascent
= FONT_BASE (font
) + boff
;
24094 it
->descent
= FONT_DESCENT (font
) - boff
;
24097 if (EQ (height
, Qt
))
24099 if (it
->descent
> it
->max_descent
)
24101 it
->ascent
+= it
->descent
- it
->max_descent
;
24102 it
->descent
= it
->max_descent
;
24104 if (it
->ascent
> it
->max_ascent
)
24106 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24107 it
->ascent
= it
->max_ascent
;
24109 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24110 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24111 it
->constrain_row_ascent_descent_p
= 1;
24112 extra_line_spacing
= 0;
24116 Lisp_Object spacing
;
24118 it
->phys_ascent
= it
->ascent
;
24119 it
->phys_descent
= it
->descent
;
24121 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24122 && face
->box
!= FACE_NO_BOX
24123 && face
->box_line_width
> 0)
24125 it
->ascent
+= face
->box_line_width
;
24126 it
->descent
+= face
->box_line_width
;
24129 && XINT (height
) > it
->ascent
+ it
->descent
)
24130 it
->ascent
= XINT (height
) - it
->descent
;
24132 if (!NILP (total_height
))
24133 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24136 spacing
= get_it_property (it
, Qline_spacing
);
24137 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24139 if (INTEGERP (spacing
))
24141 extra_line_spacing
= XINT (spacing
);
24142 if (!NILP (total_height
))
24143 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24147 else /* i.e. (it->char_to_display == '\t') */
24149 if (font
->space_width
> 0)
24151 int tab_width
= it
->tab_width
* font
->space_width
;
24152 int x
= it
->current_x
+ it
->continuation_lines_width
;
24153 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24155 /* If the distance from the current position to the next tab
24156 stop is less than a space character width, use the
24157 tab stop after that. */
24158 if (next_tab_x
- x
< font
->space_width
)
24159 next_tab_x
+= tab_width
;
24161 it
->pixel_width
= next_tab_x
- x
;
24163 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24164 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24168 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24169 it
->ascent
+ it
->descent
, it
->ascent
);
24174 it
->pixel_width
= 0;
24179 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24181 /* A static composition.
24183 Note: A composition is represented as one glyph in the
24184 glyph matrix. There are no padding glyphs.
24186 Important note: pixel_width, ascent, and descent are the
24187 values of what is drawn by draw_glyphs (i.e. the values of
24188 the overall glyphs composed). */
24189 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24190 int boff
; /* baseline offset */
24191 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24192 int glyph_len
= cmp
->glyph_len
;
24193 struct font
*font
= face
->font
;
24197 /* If we have not yet calculated pixel size data of glyphs of
24198 the composition for the current face font, calculate them
24199 now. Theoretically, we have to check all fonts for the
24200 glyphs, but that requires much time and memory space. So,
24201 here we check only the font of the first glyph. This may
24202 lead to incorrect display, but it's very rare, and C-l
24203 (recenter-top-bottom) can correct the display anyway. */
24204 if (! cmp
->font
|| cmp
->font
!= font
)
24206 /* Ascent and descent of the font of the first character
24207 of this composition (adjusted by baseline offset).
24208 Ascent and descent of overall glyphs should not be less
24209 than these, respectively. */
24210 int font_ascent
, font_descent
, font_height
;
24211 /* Bounding box of the overall glyphs. */
24212 int leftmost
, rightmost
, lowest
, highest
;
24213 int lbearing
, rbearing
;
24214 int i
, width
, ascent
, descent
;
24215 int left_padded
= 0, right_padded
= 0;
24216 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24218 struct font_metrics
*pcm
;
24219 int font_not_found_p
;
24222 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24223 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24225 if (glyph_len
< cmp
->glyph_len
)
24227 for (i
= 0; i
< glyph_len
; i
++)
24229 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24231 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24236 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24237 : IT_CHARPOS (*it
));
24238 /* If no suitable font is found, use the default font. */
24239 font_not_found_p
= font
== NULL
;
24240 if (font_not_found_p
)
24242 face
= face
->ascii_face
;
24245 boff
= font
->baseline_offset
;
24246 if (font
->vertical_centering
)
24247 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24248 font_ascent
= FONT_BASE (font
) + boff
;
24249 font_descent
= FONT_DESCENT (font
) - boff
;
24250 font_height
= FONT_HEIGHT (font
);
24252 cmp
->font
= (void *) font
;
24255 if (! font_not_found_p
)
24257 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24259 pcm
= get_per_char_metric (font
, &char2b
);
24262 /* Initialize the bounding box. */
24265 width
= pcm
->width
;
24266 ascent
= pcm
->ascent
;
24267 descent
= pcm
->descent
;
24268 lbearing
= pcm
->lbearing
;
24269 rbearing
= pcm
->rbearing
;
24273 width
= font
->space_width
;
24274 ascent
= FONT_BASE (font
);
24275 descent
= FONT_DESCENT (font
);
24282 lowest
= - descent
+ boff
;
24283 highest
= ascent
+ boff
;
24285 if (! font_not_found_p
24286 && font
->default_ascent
24287 && CHAR_TABLE_P (Vuse_default_ascent
)
24288 && !NILP (Faref (Vuse_default_ascent
,
24289 make_number (it
->char_to_display
))))
24290 highest
= font
->default_ascent
+ boff
;
24292 /* Draw the first glyph at the normal position. It may be
24293 shifted to right later if some other glyphs are drawn
24295 cmp
->offsets
[i
* 2] = 0;
24296 cmp
->offsets
[i
* 2 + 1] = boff
;
24297 cmp
->lbearing
= lbearing
;
24298 cmp
->rbearing
= rbearing
;
24300 /* Set cmp->offsets for the remaining glyphs. */
24301 for (i
++; i
< glyph_len
; i
++)
24303 int left
, right
, btm
, top
;
24304 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24306 struct face
*this_face
;
24310 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24311 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24312 font
= this_face
->font
;
24318 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24320 pcm
= get_per_char_metric (font
, &char2b
);
24323 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24326 width
= pcm
->width
;
24327 ascent
= pcm
->ascent
;
24328 descent
= pcm
->descent
;
24329 lbearing
= pcm
->lbearing
;
24330 rbearing
= pcm
->rbearing
;
24331 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24333 /* Relative composition with or without
24334 alternate chars. */
24335 left
= (leftmost
+ rightmost
- width
) / 2;
24336 btm
= - descent
+ boff
;
24337 if (font
->relative_compose
24338 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24339 || NILP (Faref (Vignore_relative_composition
,
24340 make_number (ch
)))))
24343 if (- descent
>= font
->relative_compose
)
24344 /* One extra pixel between two glyphs. */
24346 else if (ascent
<= 0)
24347 /* One extra pixel between two glyphs. */
24348 btm
= lowest
- 1 - ascent
- descent
;
24353 /* A composition rule is specified by an integer
24354 value that encodes global and new reference
24355 points (GREF and NREF). GREF and NREF are
24356 specified by numbers as below:
24358 0---1---2 -- ascent
24362 9--10--11 -- center
24364 ---3---4---5--- baseline
24366 6---7---8 -- descent
24368 int rule
= COMPOSITION_RULE (cmp
, i
);
24369 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24371 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24372 grefx
= gref
% 3, nrefx
= nref
% 3;
24373 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24375 xoff
= font_height
* (xoff
- 128) / 256;
24377 yoff
= font_height
* (yoff
- 128) / 256;
24380 + grefx
* (rightmost
- leftmost
) / 2
24381 - nrefx
* width
/ 2
24384 btm
= ((grefy
== 0 ? highest
24386 : grefy
== 2 ? lowest
24387 : (highest
+ lowest
) / 2)
24388 - (nrefy
== 0 ? ascent
+ descent
24389 : nrefy
== 1 ? descent
- boff
24391 : (ascent
+ descent
) / 2)
24395 cmp
->offsets
[i
* 2] = left
;
24396 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24398 /* Update the bounding box of the overall glyphs. */
24401 right
= left
+ width
;
24402 if (left
< leftmost
)
24404 if (right
> rightmost
)
24407 top
= btm
+ descent
+ ascent
;
24413 if (cmp
->lbearing
> left
+ lbearing
)
24414 cmp
->lbearing
= left
+ lbearing
;
24415 if (cmp
->rbearing
< left
+ rbearing
)
24416 cmp
->rbearing
= left
+ rbearing
;
24420 /* If there are glyphs whose x-offsets are negative,
24421 shift all glyphs to the right and make all x-offsets
24425 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24426 cmp
->offsets
[i
* 2] -= leftmost
;
24427 rightmost
-= leftmost
;
24428 cmp
->lbearing
-= leftmost
;
24429 cmp
->rbearing
-= leftmost
;
24432 if (left_padded
&& cmp
->lbearing
< 0)
24434 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24435 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24436 rightmost
-= cmp
->lbearing
;
24437 cmp
->rbearing
-= cmp
->lbearing
;
24440 if (right_padded
&& rightmost
< cmp
->rbearing
)
24442 rightmost
= cmp
->rbearing
;
24445 cmp
->pixel_width
= rightmost
;
24446 cmp
->ascent
= highest
;
24447 cmp
->descent
= - lowest
;
24448 if (cmp
->ascent
< font_ascent
)
24449 cmp
->ascent
= font_ascent
;
24450 if (cmp
->descent
< font_descent
)
24451 cmp
->descent
= font_descent
;
24455 && (cmp
->lbearing
< 0
24456 || cmp
->rbearing
> cmp
->pixel_width
))
24457 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24459 it
->pixel_width
= cmp
->pixel_width
;
24460 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24461 it
->descent
= it
->phys_descent
= cmp
->descent
;
24462 if (face
->box
!= FACE_NO_BOX
)
24464 int thick
= face
->box_line_width
;
24468 it
->ascent
+= thick
;
24469 it
->descent
+= thick
;
24474 if (it
->start_of_box_run_p
)
24475 it
->pixel_width
+= thick
;
24476 if (it
->end_of_box_run_p
)
24477 it
->pixel_width
+= thick
;
24480 /* If face has an overline, add the height of the overline
24481 (1 pixel) and a 1 pixel margin to the character height. */
24482 if (face
->overline_p
)
24483 it
->ascent
+= overline_margin
;
24485 take_vertical_position_into_account (it
);
24486 if (it
->ascent
< 0)
24488 if (it
->descent
< 0)
24492 append_composite_glyph (it
);
24494 else if (it
->what
== IT_COMPOSITION
)
24496 /* A dynamic (automatic) composition. */
24497 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24498 Lisp_Object gstring
;
24499 struct font_metrics metrics
;
24503 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24505 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24508 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24509 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24510 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24511 it
->descent
= it
->phys_descent
= metrics
.descent
;
24512 if (face
->box
!= FACE_NO_BOX
)
24514 int thick
= face
->box_line_width
;
24518 it
->ascent
+= thick
;
24519 it
->descent
+= thick
;
24524 if (it
->start_of_box_run_p
)
24525 it
->pixel_width
+= thick
;
24526 if (it
->end_of_box_run_p
)
24527 it
->pixel_width
+= thick
;
24529 /* If face has an overline, add the height of the overline
24530 (1 pixel) and a 1 pixel margin to the character height. */
24531 if (face
->overline_p
)
24532 it
->ascent
+= overline_margin
;
24533 take_vertical_position_into_account (it
);
24534 if (it
->ascent
< 0)
24536 if (it
->descent
< 0)
24540 append_composite_glyph (it
);
24542 else if (it
->what
== IT_GLYPHLESS
)
24543 produce_glyphless_glyph (it
, 0, Qnil
);
24544 else if (it
->what
== IT_IMAGE
)
24545 produce_image_glyph (it
);
24546 else if (it
->what
== IT_STRETCH
)
24547 produce_stretch_glyph (it
);
24550 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24551 because this isn't true for images with `:ascent 100'. */
24552 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24553 if (it
->area
== TEXT_AREA
)
24554 it
->current_x
+= it
->pixel_width
;
24556 if (extra_line_spacing
> 0)
24558 it
->descent
+= extra_line_spacing
;
24559 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24560 it
->max_extra_line_spacing
= extra_line_spacing
;
24563 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24564 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24565 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24566 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24570 Output LEN glyphs starting at START at the nominal cursor position.
24571 Advance the nominal cursor over the text. The global variable
24572 updated_window contains the window being updated, updated_row is
24573 the glyph row being updated, and updated_area is the area of that
24574 row being updated. */
24577 x_write_glyphs (struct glyph
*start
, int len
)
24581 xassert (updated_window
&& updated_row
);
24584 /* Write glyphs. */
24586 hpos
= start
- updated_row
->glyphs
[updated_area
];
24587 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24588 updated_row
, updated_area
,
24590 DRAW_NORMAL_TEXT
, 0);
24592 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24593 if (updated_area
== TEXT_AREA
24594 && updated_window
->phys_cursor_on_p
24595 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24596 && updated_window
->phys_cursor
.hpos
>= hpos
24597 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24598 updated_window
->phys_cursor_on_p
= 0;
24602 /* Advance the output cursor. */
24603 output_cursor
.hpos
+= len
;
24604 output_cursor
.x
= x
;
24609 Insert LEN glyphs from START at the nominal cursor position. */
24612 x_insert_glyphs (struct glyph
*start
, int len
)
24616 int line_height
, shift_by_width
, shifted_region_width
;
24617 struct glyph_row
*row
;
24618 struct glyph
*glyph
;
24619 int frame_x
, frame_y
;
24622 xassert (updated_window
&& updated_row
);
24624 w
= updated_window
;
24625 f
= XFRAME (WINDOW_FRAME (w
));
24627 /* Get the height of the line we are in. */
24629 line_height
= row
->height
;
24631 /* Get the width of the glyphs to insert. */
24632 shift_by_width
= 0;
24633 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24634 shift_by_width
+= glyph
->pixel_width
;
24636 /* Get the width of the region to shift right. */
24637 shifted_region_width
= (window_box_width (w
, updated_area
)
24642 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24643 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24645 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24646 line_height
, shift_by_width
);
24648 /* Write the glyphs. */
24649 hpos
= start
- row
->glyphs
[updated_area
];
24650 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24652 DRAW_NORMAL_TEXT
, 0);
24654 /* Advance the output cursor. */
24655 output_cursor
.hpos
+= len
;
24656 output_cursor
.x
+= shift_by_width
;
24662 Erase the current text line from the nominal cursor position
24663 (inclusive) to pixel column TO_X (exclusive). The idea is that
24664 everything from TO_X onward is already erased.
24666 TO_X is a pixel position relative to updated_area of
24667 updated_window. TO_X == -1 means clear to the end of this area. */
24670 x_clear_end_of_line (int to_x
)
24673 struct window
*w
= updated_window
;
24674 int max_x
, min_y
, max_y
;
24675 int from_x
, from_y
, to_y
;
24677 xassert (updated_window
&& updated_row
);
24678 f
= XFRAME (w
->frame
);
24680 if (updated_row
->full_width_p
)
24681 max_x
= WINDOW_TOTAL_WIDTH (w
);
24683 max_x
= window_box_width (w
, updated_area
);
24684 max_y
= window_text_bottom_y (w
);
24686 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24687 of window. For TO_X > 0, truncate to end of drawing area. */
24693 to_x
= min (to_x
, max_x
);
24695 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24697 /* Notice if the cursor will be cleared by this operation. */
24698 if (!updated_row
->full_width_p
)
24699 notice_overwritten_cursor (w
, updated_area
,
24700 output_cursor
.x
, -1,
24702 MATRIX_ROW_BOTTOM_Y (updated_row
));
24704 from_x
= output_cursor
.x
;
24706 /* Translate to frame coordinates. */
24707 if (updated_row
->full_width_p
)
24709 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24710 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24714 int area_left
= window_box_left (w
, updated_area
);
24715 from_x
+= area_left
;
24719 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24720 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24721 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24723 /* Prevent inadvertently clearing to end of the X window. */
24724 if (to_x
> from_x
&& to_y
> from_y
)
24727 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24728 to_x
- from_x
, to_y
- from_y
);
24733 #endif /* HAVE_WINDOW_SYSTEM */
24737 /***********************************************************************
24739 ***********************************************************************/
24741 /* Value is the internal representation of the specified cursor type
24742 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24743 of the bar cursor. */
24745 static enum text_cursor_kinds
24746 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24748 enum text_cursor_kinds type
;
24753 if (EQ (arg
, Qbox
))
24754 return FILLED_BOX_CURSOR
;
24756 if (EQ (arg
, Qhollow
))
24757 return HOLLOW_BOX_CURSOR
;
24759 if (EQ (arg
, Qbar
))
24766 && EQ (XCAR (arg
), Qbar
)
24767 && INTEGERP (XCDR (arg
))
24768 && XINT (XCDR (arg
)) >= 0)
24770 *width
= XINT (XCDR (arg
));
24774 if (EQ (arg
, Qhbar
))
24777 return HBAR_CURSOR
;
24781 && EQ (XCAR (arg
), Qhbar
)
24782 && INTEGERP (XCDR (arg
))
24783 && XINT (XCDR (arg
)) >= 0)
24785 *width
= XINT (XCDR (arg
));
24786 return HBAR_CURSOR
;
24789 /* Treat anything unknown as "hollow box cursor".
24790 It was bad to signal an error; people have trouble fixing
24791 .Xdefaults with Emacs, when it has something bad in it. */
24792 type
= HOLLOW_BOX_CURSOR
;
24797 /* Set the default cursor types for specified frame. */
24799 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24804 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24805 FRAME_CURSOR_WIDTH (f
) = width
;
24807 /* By default, set up the blink-off state depending on the on-state. */
24809 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24812 FRAME_BLINK_OFF_CURSOR (f
)
24813 = get_specified_cursor_type (XCDR (tem
), &width
);
24814 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24817 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24821 #ifdef HAVE_WINDOW_SYSTEM
24823 /* Return the cursor we want to be displayed in window W. Return
24824 width of bar/hbar cursor through WIDTH arg. Return with
24825 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24826 (i.e. if the `system caret' should track this cursor).
24828 In a mini-buffer window, we want the cursor only to appear if we
24829 are reading input from this window. For the selected window, we
24830 want the cursor type given by the frame parameter or buffer local
24831 setting of cursor-type. If explicitly marked off, draw no cursor.
24832 In all other cases, we want a hollow box cursor. */
24834 static enum text_cursor_kinds
24835 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24836 int *active_cursor
)
24838 struct frame
*f
= XFRAME (w
->frame
);
24839 struct buffer
*b
= XBUFFER (w
->buffer
);
24840 int cursor_type
= DEFAULT_CURSOR
;
24841 Lisp_Object alt_cursor
;
24842 int non_selected
= 0;
24844 *active_cursor
= 1;
24847 if (cursor_in_echo_area
24848 && FRAME_HAS_MINIBUF_P (f
)
24849 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24851 if (w
== XWINDOW (echo_area_window
))
24853 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24855 *width
= FRAME_CURSOR_WIDTH (f
);
24856 return FRAME_DESIRED_CURSOR (f
);
24859 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24862 *active_cursor
= 0;
24866 /* Detect a nonselected window or nonselected frame. */
24867 else if (w
!= XWINDOW (f
->selected_window
)
24868 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24870 *active_cursor
= 0;
24872 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24878 /* Never display a cursor in a window in which cursor-type is nil. */
24879 if (NILP (BVAR (b
, cursor_type
)))
24882 /* Get the normal cursor type for this window. */
24883 if (EQ (BVAR (b
, cursor_type
), Qt
))
24885 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24886 *width
= FRAME_CURSOR_WIDTH (f
);
24889 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24891 /* Use cursor-in-non-selected-windows instead
24892 for non-selected window or frame. */
24895 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24896 if (!EQ (Qt
, alt_cursor
))
24897 return get_specified_cursor_type (alt_cursor
, width
);
24898 /* t means modify the normal cursor type. */
24899 if (cursor_type
== FILLED_BOX_CURSOR
)
24900 cursor_type
= HOLLOW_BOX_CURSOR
;
24901 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24903 return cursor_type
;
24906 /* Use normal cursor if not blinked off. */
24907 if (!w
->cursor_off_p
)
24909 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24911 if (cursor_type
== FILLED_BOX_CURSOR
)
24913 /* Using a block cursor on large images can be very annoying.
24914 So use a hollow cursor for "large" images.
24915 If image is not transparent (no mask), also use hollow cursor. */
24916 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24917 if (img
!= NULL
&& IMAGEP (img
->spec
))
24919 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24920 where N = size of default frame font size.
24921 This should cover most of the "tiny" icons people may use. */
24923 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24924 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24925 cursor_type
= HOLLOW_BOX_CURSOR
;
24928 else if (cursor_type
!= NO_CURSOR
)
24930 /* Display current only supports BOX and HOLLOW cursors for images.
24931 So for now, unconditionally use a HOLLOW cursor when cursor is
24932 not a solid box cursor. */
24933 cursor_type
= HOLLOW_BOX_CURSOR
;
24936 return cursor_type
;
24939 /* Cursor is blinked off, so determine how to "toggle" it. */
24941 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24942 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24943 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24945 /* Then see if frame has specified a specific blink off cursor type. */
24946 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24948 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24949 return FRAME_BLINK_OFF_CURSOR (f
);
24953 /* Some people liked having a permanently visible blinking cursor,
24954 while others had very strong opinions against it. So it was
24955 decided to remove it. KFS 2003-09-03 */
24957 /* Finally perform built-in cursor blinking:
24958 filled box <-> hollow box
24959 wide [h]bar <-> narrow [h]bar
24960 narrow [h]bar <-> no cursor
24961 other type <-> no cursor */
24963 if (cursor_type
== FILLED_BOX_CURSOR
)
24964 return HOLLOW_BOX_CURSOR
;
24966 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24969 return cursor_type
;
24977 /* Notice when the text cursor of window W has been completely
24978 overwritten by a drawing operation that outputs glyphs in AREA
24979 starting at X0 and ending at X1 in the line starting at Y0 and
24980 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24981 the rest of the line after X0 has been written. Y coordinates
24982 are window-relative. */
24985 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24986 int x0
, int x1
, int y0
, int y1
)
24988 int cx0
, cx1
, cy0
, cy1
;
24989 struct glyph_row
*row
;
24991 if (!w
->phys_cursor_on_p
)
24993 if (area
!= TEXT_AREA
)
24996 if (w
->phys_cursor
.vpos
< 0
24997 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24998 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24999 !(row
->enabled_p
&& row
->displays_text_p
)))
25002 if (row
->cursor_in_fringe_p
)
25004 row
->cursor_in_fringe_p
= 0;
25005 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25006 w
->phys_cursor_on_p
= 0;
25010 cx0
= w
->phys_cursor
.x
;
25011 cx1
= cx0
+ w
->phys_cursor_width
;
25012 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25015 /* The cursor image will be completely removed from the
25016 screen if the output area intersects the cursor area in
25017 y-direction. When we draw in [y0 y1[, and some part of
25018 the cursor is at y < y0, that part must have been drawn
25019 before. When scrolling, the cursor is erased before
25020 actually scrolling, so we don't come here. When not
25021 scrolling, the rows above the old cursor row must have
25022 changed, and in this case these rows must have written
25023 over the cursor image.
25025 Likewise if part of the cursor is below y1, with the
25026 exception of the cursor being in the first blank row at
25027 the buffer and window end because update_text_area
25028 doesn't draw that row. (Except when it does, but
25029 that's handled in update_text_area.) */
25031 cy0
= w
->phys_cursor
.y
;
25032 cy1
= cy0
+ w
->phys_cursor_height
;
25033 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25036 w
->phys_cursor_on_p
= 0;
25039 #endif /* HAVE_WINDOW_SYSTEM */
25042 /************************************************************************
25044 ************************************************************************/
25046 #ifdef HAVE_WINDOW_SYSTEM
25049 Fix the display of area AREA of overlapping row ROW in window W
25050 with respect to the overlapping part OVERLAPS. */
25053 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25054 enum glyph_row_area area
, int overlaps
)
25061 for (i
= 0; i
< row
->used
[area
];)
25063 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25065 int start
= i
, start_x
= x
;
25069 x
+= row
->glyphs
[area
][i
].pixel_width
;
25072 while (i
< row
->used
[area
]
25073 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25075 draw_glyphs (w
, start_x
, row
, area
,
25077 DRAW_NORMAL_TEXT
, overlaps
);
25081 x
+= row
->glyphs
[area
][i
].pixel_width
;
25091 Draw the cursor glyph of window W in glyph row ROW. See the
25092 comment of draw_glyphs for the meaning of HL. */
25095 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25096 enum draw_glyphs_face hl
)
25098 /* If cursor hpos is out of bounds, don't draw garbage. This can
25099 happen in mini-buffer windows when switching between echo area
25100 glyphs and mini-buffer. */
25101 if ((row
->reversed_p
25102 ? (w
->phys_cursor
.hpos
>= 0)
25103 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25105 int on_p
= w
->phys_cursor_on_p
;
25107 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25108 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25110 w
->phys_cursor_on_p
= on_p
;
25112 if (hl
== DRAW_CURSOR
)
25113 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25114 /* When we erase the cursor, and ROW is overlapped by other
25115 rows, make sure that these overlapping parts of other rows
25117 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25119 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25121 if (row
> w
->current_matrix
->rows
25122 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25123 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25124 OVERLAPS_ERASED_CURSOR
);
25126 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25127 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25128 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25129 OVERLAPS_ERASED_CURSOR
);
25136 Erase the image of a cursor of window W from the screen. */
25139 erase_phys_cursor (struct window
*w
)
25141 struct frame
*f
= XFRAME (w
->frame
);
25142 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25143 int hpos
= w
->phys_cursor
.hpos
;
25144 int vpos
= w
->phys_cursor
.vpos
;
25145 int mouse_face_here_p
= 0;
25146 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25147 struct glyph_row
*cursor_row
;
25148 struct glyph
*cursor_glyph
;
25149 enum draw_glyphs_face hl
;
25151 /* No cursor displayed or row invalidated => nothing to do on the
25153 if (w
->phys_cursor_type
== NO_CURSOR
)
25154 goto mark_cursor_off
;
25156 /* VPOS >= active_glyphs->nrows means that window has been resized.
25157 Don't bother to erase the cursor. */
25158 if (vpos
>= active_glyphs
->nrows
)
25159 goto mark_cursor_off
;
25161 /* If row containing cursor is marked invalid, there is nothing we
25163 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25164 if (!cursor_row
->enabled_p
)
25165 goto mark_cursor_off
;
25167 /* If line spacing is > 0, old cursor may only be partially visible in
25168 window after split-window. So adjust visible height. */
25169 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25170 window_text_bottom_y (w
) - cursor_row
->y
);
25172 /* If row is completely invisible, don't attempt to delete a cursor which
25173 isn't there. This can happen if cursor is at top of a window, and
25174 we switch to a buffer with a header line in that window. */
25175 if (cursor_row
->visible_height
<= 0)
25176 goto mark_cursor_off
;
25178 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25179 if (cursor_row
->cursor_in_fringe_p
)
25181 cursor_row
->cursor_in_fringe_p
= 0;
25182 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25183 goto mark_cursor_off
;
25186 /* This can happen when the new row is shorter than the old one.
25187 In this case, either draw_glyphs or clear_end_of_line
25188 should have cleared the cursor. Note that we wouldn't be
25189 able to erase the cursor in this case because we don't have a
25190 cursor glyph at hand. */
25191 if ((cursor_row
->reversed_p
25192 ? (w
->phys_cursor
.hpos
< 0)
25193 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25194 goto mark_cursor_off
;
25196 /* If the cursor is in the mouse face area, redisplay that when
25197 we clear the cursor. */
25198 if (! NILP (hlinfo
->mouse_face_window
)
25199 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25200 /* Don't redraw the cursor's spot in mouse face if it is at the
25201 end of a line (on a newline). The cursor appears there, but
25202 mouse highlighting does not. */
25203 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25204 mouse_face_here_p
= 1;
25206 /* Maybe clear the display under the cursor. */
25207 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25210 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25213 cursor_glyph
= get_phys_cursor_glyph (w
);
25214 if (cursor_glyph
== NULL
)
25215 goto mark_cursor_off
;
25217 width
= cursor_glyph
->pixel_width
;
25218 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25219 x
= w
->phys_cursor
.x
;
25221 width
-= left_x
- x
;
25222 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25223 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25224 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25227 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25230 /* Erase the cursor by redrawing the character underneath it. */
25231 if (mouse_face_here_p
)
25232 hl
= DRAW_MOUSE_FACE
;
25234 hl
= DRAW_NORMAL_TEXT
;
25235 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25238 w
->phys_cursor_on_p
= 0;
25239 w
->phys_cursor_type
= NO_CURSOR
;
25244 Display or clear cursor of window W. If ON is zero, clear the
25245 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25246 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25249 display_and_set_cursor (struct window
*w
, int on
,
25250 int hpos
, int vpos
, int x
, int y
)
25252 struct frame
*f
= XFRAME (w
->frame
);
25253 int new_cursor_type
;
25254 int new_cursor_width
;
25256 struct glyph_row
*glyph_row
;
25257 struct glyph
*glyph
;
25259 /* This is pointless on invisible frames, and dangerous on garbaged
25260 windows and frames; in the latter case, the frame or window may
25261 be in the midst of changing its size, and x and y may be off the
25263 if (! FRAME_VISIBLE_P (f
)
25264 || FRAME_GARBAGED_P (f
)
25265 || vpos
>= w
->current_matrix
->nrows
25266 || hpos
>= w
->current_matrix
->matrix_w
)
25269 /* If cursor is off and we want it off, return quickly. */
25270 if (!on
&& !w
->phys_cursor_on_p
)
25273 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25274 /* If cursor row is not enabled, we don't really know where to
25275 display the cursor. */
25276 if (!glyph_row
->enabled_p
)
25278 w
->phys_cursor_on_p
= 0;
25283 if (!glyph_row
->exact_window_width_line_p
25284 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25285 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25287 xassert (interrupt_input_blocked
);
25289 /* Set new_cursor_type to the cursor we want to be displayed. */
25290 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25291 &new_cursor_width
, &active_cursor
);
25293 /* If cursor is currently being shown and we don't want it to be or
25294 it is in the wrong place, or the cursor type is not what we want,
25296 if (w
->phys_cursor_on_p
25298 || w
->phys_cursor
.x
!= x
25299 || w
->phys_cursor
.y
!= y
25300 || new_cursor_type
!= w
->phys_cursor_type
25301 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25302 && new_cursor_width
!= w
->phys_cursor_width
)))
25303 erase_phys_cursor (w
);
25305 /* Don't check phys_cursor_on_p here because that flag is only set
25306 to zero in some cases where we know that the cursor has been
25307 completely erased, to avoid the extra work of erasing the cursor
25308 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25309 still not be visible, or it has only been partly erased. */
25312 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25313 w
->phys_cursor_height
= glyph_row
->height
;
25315 /* Set phys_cursor_.* before x_draw_.* is called because some
25316 of them may need the information. */
25317 w
->phys_cursor
.x
= x
;
25318 w
->phys_cursor
.y
= glyph_row
->y
;
25319 w
->phys_cursor
.hpos
= hpos
;
25320 w
->phys_cursor
.vpos
= vpos
;
25323 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25324 new_cursor_type
, new_cursor_width
,
25325 on
, active_cursor
);
25329 /* Switch the display of W's cursor on or off, according to the value
25333 update_window_cursor (struct window
*w
, int on
)
25335 /* Don't update cursor in windows whose frame is in the process
25336 of being deleted. */
25337 if (w
->current_matrix
)
25340 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25341 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25347 /* Call update_window_cursor with parameter ON_P on all leaf windows
25348 in the window tree rooted at W. */
25351 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25355 if (!NILP (w
->hchild
))
25356 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25357 else if (!NILP (w
->vchild
))
25358 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25360 update_window_cursor (w
, on_p
);
25362 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25368 Display the cursor on window W, or clear it, according to ON_P.
25369 Don't change the cursor's position. */
25372 x_update_cursor (struct frame
*f
, int on_p
)
25374 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25379 Clear the cursor of window W to background color, and mark the
25380 cursor as not shown. This is used when the text where the cursor
25381 is about to be rewritten. */
25384 x_clear_cursor (struct window
*w
)
25386 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25387 update_window_cursor (w
, 0);
25390 #endif /* HAVE_WINDOW_SYSTEM */
25392 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25395 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25396 int start_hpos
, int end_hpos
,
25397 enum draw_glyphs_face draw
)
25399 #ifdef HAVE_WINDOW_SYSTEM
25400 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25402 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25406 #if defined (HAVE_GPM) || defined (MSDOS)
25407 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25411 /* Display the active region described by mouse_face_* according to DRAW. */
25414 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25416 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25417 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25419 if (/* If window is in the process of being destroyed, don't bother
25421 w
->current_matrix
!= NULL
25422 /* Don't update mouse highlight if hidden */
25423 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25424 /* Recognize when we are called to operate on rows that don't exist
25425 anymore. This can happen when a window is split. */
25426 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25428 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25429 struct glyph_row
*row
, *first
, *last
;
25431 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25432 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25434 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25436 int start_hpos
, end_hpos
, start_x
;
25438 /* For all but the first row, the highlight starts at column 0. */
25441 /* R2L rows have BEG and END in reversed order, but the
25442 screen drawing geometry is always left to right. So
25443 we need to mirror the beginning and end of the
25444 highlighted area in R2L rows. */
25445 if (!row
->reversed_p
)
25447 start_hpos
= hlinfo
->mouse_face_beg_col
;
25448 start_x
= hlinfo
->mouse_face_beg_x
;
25450 else if (row
== last
)
25452 start_hpos
= hlinfo
->mouse_face_end_col
;
25453 start_x
= hlinfo
->mouse_face_end_x
;
25461 else if (row
->reversed_p
&& row
== last
)
25463 start_hpos
= hlinfo
->mouse_face_end_col
;
25464 start_x
= hlinfo
->mouse_face_end_x
;
25474 if (!row
->reversed_p
)
25475 end_hpos
= hlinfo
->mouse_face_end_col
;
25476 else if (row
== first
)
25477 end_hpos
= hlinfo
->mouse_face_beg_col
;
25480 end_hpos
= row
->used
[TEXT_AREA
];
25481 if (draw
== DRAW_NORMAL_TEXT
)
25482 row
->fill_line_p
= 1; /* Clear to end of line */
25485 else if (row
->reversed_p
&& row
== first
)
25486 end_hpos
= hlinfo
->mouse_face_beg_col
;
25489 end_hpos
= row
->used
[TEXT_AREA
];
25490 if (draw
== DRAW_NORMAL_TEXT
)
25491 row
->fill_line_p
= 1; /* Clear to end of line */
25494 if (end_hpos
> start_hpos
)
25496 draw_row_with_mouse_face (w
, start_x
, row
,
25497 start_hpos
, end_hpos
, draw
);
25500 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25504 #ifdef HAVE_WINDOW_SYSTEM
25505 /* When we've written over the cursor, arrange for it to
25506 be displayed again. */
25507 if (FRAME_WINDOW_P (f
)
25508 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25511 display_and_set_cursor (w
, 1,
25512 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25513 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25516 #endif /* HAVE_WINDOW_SYSTEM */
25519 #ifdef HAVE_WINDOW_SYSTEM
25520 /* Change the mouse cursor. */
25521 if (FRAME_WINDOW_P (f
))
25523 if (draw
== DRAW_NORMAL_TEXT
25524 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25525 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25526 else if (draw
== DRAW_MOUSE_FACE
)
25527 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25529 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25531 #endif /* HAVE_WINDOW_SYSTEM */
25535 Clear out the mouse-highlighted active region.
25536 Redraw it un-highlighted first. Value is non-zero if mouse
25537 face was actually drawn unhighlighted. */
25540 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25544 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25546 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25550 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25551 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25552 hlinfo
->mouse_face_window
= Qnil
;
25553 hlinfo
->mouse_face_overlay
= Qnil
;
25557 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25558 within the mouse face on that window. */
25560 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25562 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25564 /* Quickly resolve the easy cases. */
25565 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25566 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25568 if (vpos
< hlinfo
->mouse_face_beg_row
25569 || vpos
> hlinfo
->mouse_face_end_row
)
25571 if (vpos
> hlinfo
->mouse_face_beg_row
25572 && vpos
< hlinfo
->mouse_face_end_row
)
25575 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25577 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25579 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25582 else if ((vpos
== hlinfo
->mouse_face_beg_row
25583 && hpos
>= hlinfo
->mouse_face_beg_col
)
25584 || (vpos
== hlinfo
->mouse_face_end_row
25585 && hpos
< hlinfo
->mouse_face_end_col
))
25590 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25592 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25595 else if ((vpos
== hlinfo
->mouse_face_beg_row
25596 && hpos
<= hlinfo
->mouse_face_beg_col
)
25597 || (vpos
== hlinfo
->mouse_face_end_row
25598 && hpos
> hlinfo
->mouse_face_end_col
))
25606 Non-zero if physical cursor of window W is within mouse face. */
25609 cursor_in_mouse_face_p (struct window
*w
)
25611 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25616 /* Find the glyph rows START_ROW and END_ROW of window W that display
25617 characters between buffer positions START_CHARPOS and END_CHARPOS
25618 (excluding END_CHARPOS). This is similar to row_containing_pos,
25619 but is more accurate when bidi reordering makes buffer positions
25620 change non-linearly with glyph rows. */
25622 rows_from_pos_range (struct window
*w
,
25623 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25624 struct glyph_row
**start
, struct glyph_row
**end
)
25626 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25627 int last_y
= window_text_bottom_y (w
);
25628 struct glyph_row
*row
;
25633 while (!first
->enabled_p
25634 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25637 /* Find the START row. */
25639 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25642 /* A row can potentially be the START row if the range of the
25643 characters it displays intersects the range
25644 [START_CHARPOS..END_CHARPOS). */
25645 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25646 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25647 /* See the commentary in row_containing_pos, for the
25648 explanation of the complicated way to check whether
25649 some position is beyond the end of the characters
25650 displayed by a row. */
25651 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25652 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25653 && !row
->ends_at_zv_p
25654 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25655 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25656 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25657 && !row
->ends_at_zv_p
25658 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25660 /* Found a candidate row. Now make sure at least one of the
25661 glyphs it displays has a charpos from the range
25662 [START_CHARPOS..END_CHARPOS).
25664 This is not obvious because bidi reordering could make
25665 buffer positions of a row be 1,2,3,102,101,100, and if we
25666 want to highlight characters in [50..60), we don't want
25667 this row, even though [50..60) does intersect [1..103),
25668 the range of character positions given by the row's start
25669 and end positions. */
25670 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25671 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25675 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25676 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25685 /* Find the END row. */
25687 /* If the last row is partially visible, start looking for END
25688 from that row, instead of starting from FIRST. */
25689 && !(row
->enabled_p
25690 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25692 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25694 struct glyph_row
*next
= row
+ 1;
25696 if (!next
->enabled_p
25697 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25698 /* The first row >= START whose range of displayed characters
25699 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25700 is the row END + 1. */
25701 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25702 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25703 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25704 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25705 && !next
->ends_at_zv_p
25706 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25707 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25708 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25709 && !next
->ends_at_zv_p
25710 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25717 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25718 but none of the characters it displays are in the range, it is
25720 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25721 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25725 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25726 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25739 /* This function sets the mouse_face_* elements of HLINFO, assuming
25740 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25741 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25742 for the overlay or run of text properties specifying the mouse
25743 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25744 before-string and after-string that must also be highlighted.
25745 COVER_STRING, if non-nil, is a display string that may cover some
25746 or all of the highlighted text. */
25749 mouse_face_from_buffer_pos (Lisp_Object window
,
25750 Mouse_HLInfo
*hlinfo
,
25751 EMACS_INT mouse_charpos
,
25752 EMACS_INT start_charpos
,
25753 EMACS_INT end_charpos
,
25754 Lisp_Object before_string
,
25755 Lisp_Object after_string
,
25756 Lisp_Object cover_string
)
25758 struct window
*w
= XWINDOW (window
);
25759 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25760 struct glyph_row
*r1
, *r2
;
25761 struct glyph
*glyph
, *end
;
25762 EMACS_INT ignore
, pos
;
25765 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25766 xassert (NILP (before_string
) || STRINGP (before_string
));
25767 xassert (NILP (after_string
) || STRINGP (after_string
));
25769 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25770 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25772 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25773 /* If the before-string or display-string contains newlines,
25774 rows_from_pos_range skips to its last row. Move back. */
25775 if (!NILP (before_string
) || !NILP (cover_string
))
25777 struct glyph_row
*prev
;
25778 while ((prev
= r1
- 1, prev
>= first
)
25779 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25780 && prev
->used
[TEXT_AREA
] > 0)
25782 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25783 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25784 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25786 || !(EQ (glyph
->object
, before_string
)
25787 || EQ (glyph
->object
, cover_string
)))
25794 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25795 hlinfo
->mouse_face_past_end
= 1;
25797 else if (!NILP (after_string
))
25799 /* If the after-string has newlines, advance to its last row. */
25800 struct glyph_row
*next
;
25801 struct glyph_row
*last
25802 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25804 for (next
= r2
+ 1;
25806 && next
->used
[TEXT_AREA
] > 0
25807 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25811 /* The rest of the display engine assumes that mouse_face_beg_row is
25812 either above below mouse_face_end_row or identical to it. But
25813 with bidi-reordered continued lines, the row for START_CHARPOS
25814 could be below the row for END_CHARPOS. If so, swap the rows and
25815 store them in correct order. */
25818 struct glyph_row
*tem
= r2
;
25824 hlinfo
->mouse_face_beg_y
= r1
->y
;
25825 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25826 hlinfo
->mouse_face_end_y
= r2
->y
;
25827 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25829 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25830 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25831 could be anywhere in the row and in any order. The strategy
25832 below is to find the leftmost and the rightmost glyph that
25833 belongs to either of these 3 strings, or whose position is
25834 between START_CHARPOS and END_CHARPOS, and highlight all the
25835 glyphs between those two. This may cover more than just the text
25836 between START_CHARPOS and END_CHARPOS if the range of characters
25837 strides the bidi level boundary, e.g. if the beginning is in R2L
25838 text while the end is in L2R text or vice versa. */
25839 if (!r1
->reversed_p
)
25841 /* This row is in a left to right paragraph. Scan it left to
25843 glyph
= r1
->glyphs
[TEXT_AREA
];
25844 end
= glyph
+ r1
->used
[TEXT_AREA
];
25847 /* Skip truncation glyphs at the start of the glyph row. */
25848 if (r1
->displays_text_p
)
25850 && INTEGERP (glyph
->object
)
25851 && glyph
->charpos
< 0;
25853 x
+= glyph
->pixel_width
;
25855 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25856 or COVER_STRING, and the first glyph from buffer whose
25857 position is between START_CHARPOS and END_CHARPOS. */
25859 && !INTEGERP (glyph
->object
)
25860 && !EQ (glyph
->object
, cover_string
)
25861 && !(BUFFERP (glyph
->object
)
25862 && (glyph
->charpos
>= start_charpos
25863 && glyph
->charpos
< end_charpos
));
25866 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25867 are present at buffer positions between START_CHARPOS and
25868 END_CHARPOS, or if they come from an overlay. */
25869 if (EQ (glyph
->object
, before_string
))
25871 pos
= string_buffer_position (before_string
,
25873 /* If pos == 0, it means before_string came from an
25874 overlay, not from a buffer position. */
25875 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25878 else if (EQ (glyph
->object
, after_string
))
25880 pos
= string_buffer_position (after_string
, end_charpos
);
25881 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25884 x
+= glyph
->pixel_width
;
25886 hlinfo
->mouse_face_beg_x
= x
;
25887 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25891 /* This row is in a right to left paragraph. Scan it right to
25895 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25896 glyph
= end
+ r1
->used
[TEXT_AREA
];
25898 /* Skip truncation glyphs at the start of the glyph row. */
25899 if (r1
->displays_text_p
)
25901 && INTEGERP (glyph
->object
)
25902 && glyph
->charpos
< 0;
25906 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25907 or COVER_STRING, and the first glyph from buffer whose
25908 position is between START_CHARPOS and END_CHARPOS. */
25910 && !INTEGERP (glyph
->object
)
25911 && !EQ (glyph
->object
, cover_string
)
25912 && !(BUFFERP (glyph
->object
)
25913 && (glyph
->charpos
>= start_charpos
25914 && glyph
->charpos
< end_charpos
));
25917 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25918 are present at buffer positions between START_CHARPOS and
25919 END_CHARPOS, or if they come from an overlay. */
25920 if (EQ (glyph
->object
, before_string
))
25922 pos
= string_buffer_position (before_string
, start_charpos
);
25923 /* If pos == 0, it means before_string came from an
25924 overlay, not from a buffer position. */
25925 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25928 else if (EQ (glyph
->object
, after_string
))
25930 pos
= string_buffer_position (after_string
, end_charpos
);
25931 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25936 glyph
++; /* first glyph to the right of the highlighted area */
25937 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25938 x
+= g
->pixel_width
;
25939 hlinfo
->mouse_face_beg_x
= x
;
25940 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25943 /* If the highlight ends in a different row, compute GLYPH and END
25944 for the end row. Otherwise, reuse the values computed above for
25945 the row where the highlight begins. */
25948 if (!r2
->reversed_p
)
25950 glyph
= r2
->glyphs
[TEXT_AREA
];
25951 end
= glyph
+ r2
->used
[TEXT_AREA
];
25956 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25957 glyph
= end
+ r2
->used
[TEXT_AREA
];
25961 if (!r2
->reversed_p
)
25963 /* Skip truncation and continuation glyphs near the end of the
25964 row, and also blanks and stretch glyphs inserted by
25965 extend_face_to_end_of_line. */
25967 && INTEGERP ((end
- 1)->object
)
25968 && (end
- 1)->charpos
<= 0)
25970 /* Scan the rest of the glyph row from the end, looking for the
25971 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25972 COVER_STRING, or whose position is between START_CHARPOS
25976 && !INTEGERP (end
->object
)
25977 && !EQ (end
->object
, cover_string
)
25978 && !(BUFFERP (end
->object
)
25979 && (end
->charpos
>= start_charpos
25980 && end
->charpos
< end_charpos
));
25983 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25984 are present at buffer positions between START_CHARPOS and
25985 END_CHARPOS, or if they come from an overlay. */
25986 if (EQ (end
->object
, before_string
))
25988 pos
= string_buffer_position (before_string
, start_charpos
);
25989 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25992 else if (EQ (end
->object
, after_string
))
25994 pos
= string_buffer_position (after_string
, end_charpos
);
25995 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25999 /* Find the X coordinate of the last glyph to be highlighted. */
26000 for (; glyph
<= end
; ++glyph
)
26001 x
+= glyph
->pixel_width
;
26003 hlinfo
->mouse_face_end_x
= x
;
26004 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26008 /* Skip truncation and continuation glyphs near the end of the
26009 row, and also blanks and stretch glyphs inserted by
26010 extend_face_to_end_of_line. */
26014 && INTEGERP (end
->object
)
26015 && end
->charpos
<= 0)
26017 x
+= end
->pixel_width
;
26020 /* Scan the rest of the glyph row from the end, looking for the
26021 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26022 COVER_STRING, or whose position is between START_CHARPOS
26026 && !INTEGERP (end
->object
)
26027 && !EQ (end
->object
, cover_string
)
26028 && !(BUFFERP (end
->object
)
26029 && (end
->charpos
>= start_charpos
26030 && end
->charpos
< end_charpos
));
26033 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26034 are present at buffer positions between START_CHARPOS and
26035 END_CHARPOS, or if they come from an overlay. */
26036 if (EQ (end
->object
, before_string
))
26038 pos
= string_buffer_position (before_string
, start_charpos
);
26039 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26042 else if (EQ (end
->object
, after_string
))
26044 pos
= string_buffer_position (after_string
, end_charpos
);
26045 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26048 x
+= end
->pixel_width
;
26050 hlinfo
->mouse_face_end_x
= x
;
26051 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26054 hlinfo
->mouse_face_window
= window
;
26055 hlinfo
->mouse_face_face_id
26056 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26058 !hlinfo
->mouse_face_hidden
, -1);
26059 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26062 /* The following function is not used anymore (replaced with
26063 mouse_face_from_string_pos), but I leave it here for the time
26064 being, in case someone would. */
26066 #if 0 /* not used */
26068 /* Find the position of the glyph for position POS in OBJECT in
26069 window W's current matrix, and return in *X, *Y the pixel
26070 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26072 RIGHT_P non-zero means return the position of the right edge of the
26073 glyph, RIGHT_P zero means return the left edge position.
26075 If no glyph for POS exists in the matrix, return the position of
26076 the glyph with the next smaller position that is in the matrix, if
26077 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26078 exists in the matrix, return the position of the glyph with the
26079 next larger position in OBJECT.
26081 Value is non-zero if a glyph was found. */
26084 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26085 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26087 int yb
= window_text_bottom_y (w
);
26088 struct glyph_row
*r
;
26089 struct glyph
*best_glyph
= NULL
;
26090 struct glyph_row
*best_row
= NULL
;
26093 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26094 r
->enabled_p
&& r
->y
< yb
;
26097 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26098 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26101 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26102 if (EQ (g
->object
, object
))
26104 if (g
->charpos
== pos
)
26111 else if (best_glyph
== NULL
26112 || ((eabs (g
->charpos
- pos
)
26113 < eabs (best_glyph
->charpos
- pos
))
26116 : g
->charpos
> pos
)))
26130 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26134 *x
+= best_glyph
->pixel_width
;
26139 *vpos
= best_row
- w
->current_matrix
->rows
;
26142 return best_glyph
!= NULL
;
26144 #endif /* not used */
26146 /* Find the positions of the first and the last glyphs in window W's
26147 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26148 (assumed to be a string), and return in HLINFO's mouse_face_*
26149 members the pixel and column/row coordinates of those glyphs. */
26152 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26153 Lisp_Object object
,
26154 EMACS_INT startpos
, EMACS_INT endpos
)
26156 int yb
= window_text_bottom_y (w
);
26157 struct glyph_row
*r
;
26158 struct glyph
*g
, *e
;
26162 /* Find the glyph row with at least one position in the range
26163 [STARTPOS..ENDPOS], and the first glyph in that row whose
26164 position belongs to that range. */
26165 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26166 r
->enabled_p
&& r
->y
< yb
;
26169 if (!r
->reversed_p
)
26171 g
= r
->glyphs
[TEXT_AREA
];
26172 e
= g
+ r
->used
[TEXT_AREA
];
26173 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26174 if (EQ (g
->object
, object
)
26175 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26177 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26178 hlinfo
->mouse_face_beg_y
= r
->y
;
26179 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26180 hlinfo
->mouse_face_beg_x
= gx
;
26189 e
= r
->glyphs
[TEXT_AREA
];
26190 g
= e
+ r
->used
[TEXT_AREA
];
26191 for ( ; g
> e
; --g
)
26192 if (EQ ((g
-1)->object
, object
)
26193 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26195 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26196 hlinfo
->mouse_face_beg_y
= r
->y
;
26197 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26198 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26199 gx
+= g1
->pixel_width
;
26200 hlinfo
->mouse_face_beg_x
= gx
;
26212 /* Starting with the next row, look for the first row which does NOT
26213 include any glyphs whose positions are in the range. */
26214 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26216 g
= r
->glyphs
[TEXT_AREA
];
26217 e
= g
+ r
->used
[TEXT_AREA
];
26219 for ( ; g
< e
; ++g
)
26220 if (EQ (g
->object
, object
)
26221 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26230 /* The highlighted region ends on the previous row. */
26233 /* Set the end row and its vertical pixel coordinate. */
26234 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26235 hlinfo
->mouse_face_end_y
= r
->y
;
26237 /* Compute and set the end column and the end column's horizontal
26238 pixel coordinate. */
26239 if (!r
->reversed_p
)
26241 g
= r
->glyphs
[TEXT_AREA
];
26242 e
= g
+ r
->used
[TEXT_AREA
];
26243 for ( ; e
> g
; --e
)
26244 if (EQ ((e
-1)->object
, object
)
26245 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26247 hlinfo
->mouse_face_end_col
= e
- g
;
26249 for (gx
= r
->x
; g
< e
; ++g
)
26250 gx
+= g
->pixel_width
;
26251 hlinfo
->mouse_face_end_x
= gx
;
26255 e
= r
->glyphs
[TEXT_AREA
];
26256 g
= e
+ r
->used
[TEXT_AREA
];
26257 for (gx
= r
->x
; e
< g
; ++e
)
26259 if (EQ (e
->object
, object
)
26260 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26262 gx
+= e
->pixel_width
;
26264 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26265 hlinfo
->mouse_face_end_x
= gx
;
26269 #ifdef HAVE_WINDOW_SYSTEM
26271 /* See if position X, Y is within a hot-spot of an image. */
26274 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26276 if (!CONSP (hot_spot
))
26279 if (EQ (XCAR (hot_spot
), Qrect
))
26281 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26282 Lisp_Object rect
= XCDR (hot_spot
);
26286 if (!CONSP (XCAR (rect
)))
26288 if (!CONSP (XCDR (rect
)))
26290 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26292 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26294 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26296 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26300 else if (EQ (XCAR (hot_spot
), Qcircle
))
26302 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26303 Lisp_Object circ
= XCDR (hot_spot
);
26304 Lisp_Object lr
, lx0
, ly0
;
26306 && CONSP (XCAR (circ
))
26307 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26308 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26309 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26311 double r
= XFLOATINT (lr
);
26312 double dx
= XINT (lx0
) - x
;
26313 double dy
= XINT (ly0
) - y
;
26314 return (dx
* dx
+ dy
* dy
<= r
* r
);
26317 else if (EQ (XCAR (hot_spot
), Qpoly
))
26319 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26320 if (VECTORP (XCDR (hot_spot
)))
26322 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26323 Lisp_Object
*poly
= v
->contents
;
26324 int n
= v
->header
.size
;
26327 Lisp_Object lx
, ly
;
26330 /* Need an even number of coordinates, and at least 3 edges. */
26331 if (n
< 6 || n
& 1)
26334 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26335 If count is odd, we are inside polygon. Pixels on edges
26336 may or may not be included depending on actual geometry of the
26338 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26339 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26341 x0
= XINT (lx
), y0
= XINT (ly
);
26342 for (i
= 0; i
< n
; i
+= 2)
26344 int x1
= x0
, y1
= y0
;
26345 if ((lx
= poly
[i
], !INTEGERP (lx
))
26346 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26348 x0
= XINT (lx
), y0
= XINT (ly
);
26350 /* Does this segment cross the X line? */
26358 if (y
> y0
&& y
> y1
)
26360 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26370 find_hot_spot (Lisp_Object map
, int x
, int y
)
26372 while (CONSP (map
))
26374 if (CONSP (XCAR (map
))
26375 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26383 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26385 doc
: /* Lookup in image map MAP coordinates X and Y.
26386 An image map is an alist where each element has the format (AREA ID PLIST).
26387 An AREA is specified as either a rectangle, a circle, or a polygon:
26388 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26389 pixel coordinates of the upper left and bottom right corners.
26390 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26391 and the radius of the circle; r may be a float or integer.
26392 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26393 vector describes one corner in the polygon.
26394 Returns the alist element for the first matching AREA in MAP. */)
26395 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26403 return find_hot_spot (map
, XINT (x
), XINT (y
));
26407 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26409 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26411 /* Do not change cursor shape while dragging mouse. */
26412 if (!NILP (do_mouse_tracking
))
26415 if (!NILP (pointer
))
26417 if (EQ (pointer
, Qarrow
))
26418 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26419 else if (EQ (pointer
, Qhand
))
26420 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26421 else if (EQ (pointer
, Qtext
))
26422 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26423 else if (EQ (pointer
, intern ("hdrag")))
26424 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26425 #ifdef HAVE_X_WINDOWS
26426 else if (EQ (pointer
, intern ("vdrag")))
26427 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26429 else if (EQ (pointer
, intern ("hourglass")))
26430 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26431 else if (EQ (pointer
, Qmodeline
))
26432 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26434 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26437 if (cursor
!= No_Cursor
)
26438 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26441 #endif /* HAVE_WINDOW_SYSTEM */
26443 /* Take proper action when mouse has moved to the mode or header line
26444 or marginal area AREA of window W, x-position X and y-position Y.
26445 X is relative to the start of the text display area of W, so the
26446 width of bitmap areas and scroll bars must be subtracted to get a
26447 position relative to the start of the mode line. */
26450 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26451 enum window_part area
)
26453 struct window
*w
= XWINDOW (window
);
26454 struct frame
*f
= XFRAME (w
->frame
);
26455 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26456 #ifdef HAVE_WINDOW_SYSTEM
26457 Display_Info
*dpyinfo
;
26459 Cursor cursor
= No_Cursor
;
26460 Lisp_Object pointer
= Qnil
;
26461 int dx
, dy
, width
, height
;
26463 Lisp_Object string
, object
= Qnil
;
26464 Lisp_Object pos
, help
;
26466 Lisp_Object mouse_face
;
26467 int original_x_pixel
= x
;
26468 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26469 struct glyph_row
*row
;
26471 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26476 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26477 returns them in row/column units! */
26478 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26479 &object
, &dx
, &dy
, &width
, &height
);
26481 row
= (area
== ON_MODE_LINE
26482 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26483 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26485 /* Find the glyph under the mouse pointer. */
26486 if (row
->mode_line_p
&& row
->enabled_p
)
26488 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26489 end
= glyph
+ row
->used
[TEXT_AREA
];
26491 for (x0
= original_x_pixel
;
26492 glyph
< end
&& x0
>= glyph
->pixel_width
;
26494 x0
-= glyph
->pixel_width
;
26502 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26503 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26504 returns them in row/column units! */
26505 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26506 &object
, &dx
, &dy
, &width
, &height
);
26511 #ifdef HAVE_WINDOW_SYSTEM
26512 if (IMAGEP (object
))
26514 Lisp_Object image_map
, hotspot
;
26515 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26517 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26519 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26523 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26524 If so, we could look for mouse-enter, mouse-leave
26525 properties in PLIST (and do something...). */
26526 hotspot
= XCDR (hotspot
);
26527 if (CONSP (hotspot
)
26528 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26530 pointer
= Fplist_get (plist
, Qpointer
);
26531 if (NILP (pointer
))
26533 help
= Fplist_get (plist
, Qhelp_echo
);
26536 help_echo_string
= help
;
26537 /* Is this correct? ++kfs */
26538 XSETWINDOW (help_echo_window
, w
);
26539 help_echo_object
= w
->buffer
;
26540 help_echo_pos
= charpos
;
26544 if (NILP (pointer
))
26545 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26547 #endif /* HAVE_WINDOW_SYSTEM */
26549 if (STRINGP (string
))
26551 pos
= make_number (charpos
);
26552 /* If we're on a string with `help-echo' text property, arrange
26553 for the help to be displayed. This is done by setting the
26554 global variable help_echo_string to the help string. */
26557 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26560 help_echo_string
= help
;
26561 XSETWINDOW (help_echo_window
, w
);
26562 help_echo_object
= string
;
26563 help_echo_pos
= charpos
;
26567 #ifdef HAVE_WINDOW_SYSTEM
26568 if (FRAME_WINDOW_P (f
))
26570 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26571 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26572 if (NILP (pointer
))
26573 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26575 /* Change the mouse pointer according to what is under X/Y. */
26577 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26580 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26581 if (!KEYMAPP (map
))
26582 map
= Fget_text_property (pos
, Qkeymap
, string
);
26583 if (!KEYMAPP (map
))
26584 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26589 /* Change the mouse face according to what is under X/Y. */
26590 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26591 if (!NILP (mouse_face
)
26592 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26597 struct glyph
* tmp_glyph
;
26601 int total_pixel_width
;
26602 EMACS_INT begpos
, endpos
, ignore
;
26606 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26607 Qmouse_face
, string
, Qnil
);
26613 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26615 endpos
= SCHARS (string
);
26619 /* Calculate the glyph position GPOS of GLYPH in the
26620 displayed string, relative to the beginning of the
26621 highlighted part of the string.
26623 Note: GPOS is different from CHARPOS. CHARPOS is the
26624 position of GLYPH in the internal string object. A mode
26625 line string format has structures which are converted to
26626 a flattened string by the Emacs Lisp interpreter. The
26627 internal string is an element of those structures. The
26628 displayed string is the flattened string. */
26629 tmp_glyph
= row_start_glyph
;
26630 while (tmp_glyph
< glyph
26631 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26632 && begpos
<= tmp_glyph
->charpos
26633 && tmp_glyph
->charpos
< endpos
)))
26635 gpos
= glyph
- tmp_glyph
;
26637 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26638 the highlighted part of the displayed string to which
26639 GLYPH belongs. Note: GSEQ_LENGTH is different from
26640 SCHARS (STRING), because the latter returns the length of
26641 the internal string. */
26642 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26644 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26645 && begpos
<= tmp_glyph
->charpos
26646 && tmp_glyph
->charpos
< endpos
));
26649 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26651 /* Calculate the total pixel width of all the glyphs between
26652 the beginning of the highlighted area and GLYPH. */
26653 total_pixel_width
= 0;
26654 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26655 total_pixel_width
+= tmp_glyph
->pixel_width
;
26657 /* Pre calculation of re-rendering position. Note: X is in
26658 column units here, after the call to mode_line_string or
26659 marginal_area_string. */
26661 vpos
= (area
== ON_MODE_LINE
26662 ? (w
->current_matrix
)->nrows
- 1
26665 /* If GLYPH's position is included in the region that is
26666 already drawn in mouse face, we have nothing to do. */
26667 if ( EQ (window
, hlinfo
->mouse_face_window
)
26668 && (!row
->reversed_p
26669 ? (hlinfo
->mouse_face_beg_col
<= hpos
26670 && hpos
< hlinfo
->mouse_face_end_col
)
26671 /* In R2L rows we swap BEG and END, see below. */
26672 : (hlinfo
->mouse_face_end_col
<= hpos
26673 && hpos
< hlinfo
->mouse_face_beg_col
))
26674 && hlinfo
->mouse_face_beg_row
== vpos
)
26677 if (clear_mouse_face (hlinfo
))
26678 cursor
= No_Cursor
;
26680 if (!row
->reversed_p
)
26682 hlinfo
->mouse_face_beg_col
= hpos
;
26683 hlinfo
->mouse_face_beg_x
= original_x_pixel
26684 - (total_pixel_width
+ dx
);
26685 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26686 hlinfo
->mouse_face_end_x
= 0;
26690 /* In R2L rows, show_mouse_face expects BEG and END
26691 coordinates to be swapped. */
26692 hlinfo
->mouse_face_end_col
= hpos
;
26693 hlinfo
->mouse_face_end_x
= original_x_pixel
26694 - (total_pixel_width
+ dx
);
26695 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26696 hlinfo
->mouse_face_beg_x
= 0;
26699 hlinfo
->mouse_face_beg_row
= vpos
;
26700 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26701 hlinfo
->mouse_face_beg_y
= 0;
26702 hlinfo
->mouse_face_end_y
= 0;
26703 hlinfo
->mouse_face_past_end
= 0;
26704 hlinfo
->mouse_face_window
= window
;
26706 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26712 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26714 if (NILP (pointer
))
26717 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26718 clear_mouse_face (hlinfo
);
26720 #ifdef HAVE_WINDOW_SYSTEM
26721 if (FRAME_WINDOW_P (f
))
26722 define_frame_cursor1 (f
, cursor
, pointer
);
26728 Take proper action when the mouse has moved to position X, Y on
26729 frame F as regards highlighting characters that have mouse-face
26730 properties. Also de-highlighting chars where the mouse was before.
26731 X and Y can be negative or out of range. */
26734 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26736 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26737 enum window_part part
;
26738 Lisp_Object window
;
26740 Cursor cursor
= No_Cursor
;
26741 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26744 /* When a menu is active, don't highlight because this looks odd. */
26745 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26746 if (popup_activated ())
26750 if (NILP (Vmouse_highlight
)
26751 || !f
->glyphs_initialized_p
26752 || f
->pointer_invisible
)
26755 hlinfo
->mouse_face_mouse_x
= x
;
26756 hlinfo
->mouse_face_mouse_y
= y
;
26757 hlinfo
->mouse_face_mouse_frame
= f
;
26759 if (hlinfo
->mouse_face_defer
)
26762 if (gc_in_progress
)
26764 hlinfo
->mouse_face_deferred_gc
= 1;
26768 /* Which window is that in? */
26769 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26771 /* If we were displaying active text in another window, clear that.
26772 Also clear if we move out of text area in same window. */
26773 if (! EQ (window
, hlinfo
->mouse_face_window
)
26774 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26775 && !NILP (hlinfo
->mouse_face_window
)))
26776 clear_mouse_face (hlinfo
);
26778 /* Not on a window -> return. */
26779 if (!WINDOWP (window
))
26782 /* Reset help_echo_string. It will get recomputed below. */
26783 help_echo_string
= Qnil
;
26785 /* Convert to window-relative pixel coordinates. */
26786 w
= XWINDOW (window
);
26787 frame_to_window_pixel_xy (w
, &x
, &y
);
26789 #ifdef HAVE_WINDOW_SYSTEM
26790 /* Handle tool-bar window differently since it doesn't display a
26792 if (EQ (window
, f
->tool_bar_window
))
26794 note_tool_bar_highlight (f
, x
, y
);
26799 /* Mouse is on the mode, header line or margin? */
26800 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26801 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26803 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26807 #ifdef HAVE_WINDOW_SYSTEM
26808 if (part
== ON_VERTICAL_BORDER
)
26810 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26811 help_echo_string
= build_string ("drag-mouse-1: resize");
26813 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26814 || part
== ON_SCROLL_BAR
)
26815 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26817 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26820 /* Are we in a window whose display is up to date?
26821 And verify the buffer's text has not changed. */
26822 b
= XBUFFER (w
->buffer
);
26823 if (part
== ON_TEXT
26824 && EQ (w
->window_end_valid
, w
->buffer
)
26825 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26826 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26828 int hpos
, vpos
, dx
, dy
, area
;
26830 struct glyph
*glyph
;
26831 Lisp_Object object
;
26832 Lisp_Object mouse_face
= Qnil
, position
;
26833 Lisp_Object
*overlay_vec
= NULL
;
26834 ptrdiff_t i
, noverlays
;
26835 struct buffer
*obuf
;
26836 EMACS_INT obegv
, ozv
;
26839 /* Find the glyph under X/Y. */
26840 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26842 #ifdef HAVE_WINDOW_SYSTEM
26843 /* Look for :pointer property on image. */
26844 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26846 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26847 if (img
!= NULL
&& IMAGEP (img
->spec
))
26849 Lisp_Object image_map
, hotspot
;
26850 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26852 && (hotspot
= find_hot_spot (image_map
,
26853 glyph
->slice
.img
.x
+ dx
,
26854 glyph
->slice
.img
.y
+ dy
),
26856 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26860 /* Could check XCAR (hotspot) to see if we enter/leave
26862 If so, we could look for mouse-enter, mouse-leave
26863 properties in PLIST (and do something...). */
26864 hotspot
= XCDR (hotspot
);
26865 if (CONSP (hotspot
)
26866 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26868 pointer
= Fplist_get (plist
, Qpointer
);
26869 if (NILP (pointer
))
26871 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26872 if (!NILP (help_echo_string
))
26874 help_echo_window
= window
;
26875 help_echo_object
= glyph
->object
;
26876 help_echo_pos
= glyph
->charpos
;
26880 if (NILP (pointer
))
26881 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26884 #endif /* HAVE_WINDOW_SYSTEM */
26886 /* Clear mouse face if X/Y not over text. */
26888 || area
!= TEXT_AREA
26889 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26890 /* Glyph's OBJECT is an integer for glyphs inserted by the
26891 display engine for its internal purposes, like truncation
26892 and continuation glyphs and blanks beyond the end of
26893 line's text on text terminals. If we are over such a
26894 glyph, we are not over any text. */
26895 || INTEGERP (glyph
->object
)
26896 /* R2L rows have a stretch glyph at their front, which
26897 stands for no text, whereas L2R rows have no glyphs at
26898 all beyond the end of text. Treat such stretch glyphs
26899 like we do with NULL glyphs in L2R rows. */
26900 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26901 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26902 && glyph
->type
== STRETCH_GLYPH
26903 && glyph
->avoid_cursor_p
))
26905 if (clear_mouse_face (hlinfo
))
26906 cursor
= No_Cursor
;
26907 #ifdef HAVE_WINDOW_SYSTEM
26908 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26910 if (area
!= TEXT_AREA
)
26911 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26913 pointer
= Vvoid_text_area_pointer
;
26919 pos
= glyph
->charpos
;
26920 object
= glyph
->object
;
26921 if (!STRINGP (object
) && !BUFFERP (object
))
26924 /* If we get an out-of-range value, return now; avoid an error. */
26925 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26928 /* Make the window's buffer temporarily current for
26929 overlays_at and compute_char_face. */
26930 obuf
= current_buffer
;
26931 current_buffer
= b
;
26937 /* Is this char mouse-active or does it have help-echo? */
26938 position
= make_number (pos
);
26940 if (BUFFERP (object
))
26942 /* Put all the overlays we want in a vector in overlay_vec. */
26943 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26944 /* Sort overlays into increasing priority order. */
26945 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26950 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26953 cursor
= No_Cursor
;
26955 /* Check mouse-face highlighting. */
26957 /* If there exists an overlay with mouse-face overlapping
26958 the one we are currently highlighting, we have to
26959 check if we enter the overlapping overlay, and then
26960 highlight only that. */
26961 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26962 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26964 /* Find the highest priority overlay with a mouse-face. */
26965 Lisp_Object overlay
= Qnil
;
26966 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26968 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26969 if (!NILP (mouse_face
))
26970 overlay
= overlay_vec
[i
];
26973 /* If we're highlighting the same overlay as before, there's
26974 no need to do that again. */
26975 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26976 goto check_help_echo
;
26977 hlinfo
->mouse_face_overlay
= overlay
;
26979 /* Clear the display of the old active region, if any. */
26980 if (clear_mouse_face (hlinfo
))
26981 cursor
= No_Cursor
;
26983 /* If no overlay applies, get a text property. */
26984 if (NILP (overlay
))
26985 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26987 /* Next, compute the bounds of the mouse highlighting and
26989 if (!NILP (mouse_face
) && STRINGP (object
))
26991 /* The mouse-highlighting comes from a display string
26992 with a mouse-face. */
26996 s
= Fprevious_single_property_change
26997 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26998 e
= Fnext_single_property_change
26999 (position
, Qmouse_face
, object
, Qnil
);
27001 s
= make_number (0);
27003 e
= make_number (SCHARS (object
) - 1);
27004 mouse_face_from_string_pos (w
, hlinfo
, object
,
27005 XINT (s
), XINT (e
));
27006 hlinfo
->mouse_face_past_end
= 0;
27007 hlinfo
->mouse_face_window
= window
;
27008 hlinfo
->mouse_face_face_id
27009 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27010 glyph
->face_id
, 1);
27011 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27012 cursor
= No_Cursor
;
27016 /* The mouse-highlighting, if any, comes from an overlay
27017 or text property in the buffer. */
27018 Lisp_Object buffer
IF_LINT (= Qnil
);
27019 Lisp_Object cover_string
IF_LINT (= Qnil
);
27021 if (STRINGP (object
))
27023 /* If we are on a display string with no mouse-face,
27024 check if the text under it has one. */
27025 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27026 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27027 pos
= string_buffer_position (object
, start
);
27030 mouse_face
= get_char_property_and_overlay
27031 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27032 buffer
= w
->buffer
;
27033 cover_string
= object
;
27039 cover_string
= Qnil
;
27042 if (!NILP (mouse_face
))
27044 Lisp_Object before
, after
;
27045 Lisp_Object before_string
, after_string
;
27046 /* To correctly find the limits of mouse highlight
27047 in a bidi-reordered buffer, we must not use the
27048 optimization of limiting the search in
27049 previous-single-property-change and
27050 next-single-property-change, because
27051 rows_from_pos_range needs the real start and end
27052 positions to DTRT in this case. That's because
27053 the first row visible in a window does not
27054 necessarily display the character whose position
27055 is the smallest. */
27057 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27058 ? Fmarker_position (w
->start
)
27061 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27062 ? make_number (BUF_Z (XBUFFER (buffer
))
27063 - XFASTINT (w
->window_end_pos
))
27066 if (NILP (overlay
))
27068 /* Handle the text property case. */
27069 before
= Fprevious_single_property_change
27070 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27071 after
= Fnext_single_property_change
27072 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27073 before_string
= after_string
= Qnil
;
27077 /* Handle the overlay case. */
27078 before
= Foverlay_start (overlay
);
27079 after
= Foverlay_end (overlay
);
27080 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27081 after_string
= Foverlay_get (overlay
, Qafter_string
);
27083 if (!STRINGP (before_string
)) before_string
= Qnil
;
27084 if (!STRINGP (after_string
)) after_string
= Qnil
;
27087 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27090 before_string
, after_string
,
27092 cursor
= No_Cursor
;
27099 /* Look for a `help-echo' property. */
27100 if (NILP (help_echo_string
)) {
27101 Lisp_Object help
, overlay
;
27103 /* Check overlays first. */
27104 help
= overlay
= Qnil
;
27105 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27107 overlay
= overlay_vec
[i
];
27108 help
= Foverlay_get (overlay
, Qhelp_echo
);
27113 help_echo_string
= help
;
27114 help_echo_window
= window
;
27115 help_echo_object
= overlay
;
27116 help_echo_pos
= pos
;
27120 Lisp_Object obj
= glyph
->object
;
27121 EMACS_INT charpos
= glyph
->charpos
;
27123 /* Try text properties. */
27126 && charpos
< SCHARS (obj
))
27128 help
= Fget_text_property (make_number (charpos
),
27132 /* If the string itself doesn't specify a help-echo,
27133 see if the buffer text ``under'' it does. */
27134 struct glyph_row
*r
27135 = MATRIX_ROW (w
->current_matrix
, vpos
);
27136 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27137 EMACS_INT p
= string_buffer_position (obj
, start
);
27140 help
= Fget_char_property (make_number (p
),
27141 Qhelp_echo
, w
->buffer
);
27150 else if (BUFFERP (obj
)
27153 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27158 help_echo_string
= help
;
27159 help_echo_window
= window
;
27160 help_echo_object
= obj
;
27161 help_echo_pos
= charpos
;
27166 #ifdef HAVE_WINDOW_SYSTEM
27167 /* Look for a `pointer' property. */
27168 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27170 /* Check overlays first. */
27171 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27172 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27174 if (NILP (pointer
))
27176 Lisp_Object obj
= glyph
->object
;
27177 EMACS_INT charpos
= glyph
->charpos
;
27179 /* Try text properties. */
27182 && charpos
< SCHARS (obj
))
27184 pointer
= Fget_text_property (make_number (charpos
),
27186 if (NILP (pointer
))
27188 /* If the string itself doesn't specify a pointer,
27189 see if the buffer text ``under'' it does. */
27190 struct glyph_row
*r
27191 = MATRIX_ROW (w
->current_matrix
, vpos
);
27192 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27193 EMACS_INT p
= string_buffer_position (obj
, start
);
27195 pointer
= Fget_char_property (make_number (p
),
27196 Qpointer
, w
->buffer
);
27199 else if (BUFFERP (obj
)
27202 pointer
= Fget_text_property (make_number (charpos
),
27206 #endif /* HAVE_WINDOW_SYSTEM */
27210 current_buffer
= obuf
;
27215 #ifdef HAVE_WINDOW_SYSTEM
27216 if (FRAME_WINDOW_P (f
))
27217 define_frame_cursor1 (f
, cursor
, pointer
);
27219 /* This is here to prevent a compiler error, about "label at end of
27220 compound statement". */
27227 Clear any mouse-face on window W. This function is part of the
27228 redisplay interface, and is called from try_window_id and similar
27229 functions to ensure the mouse-highlight is off. */
27232 x_clear_window_mouse_face (struct window
*w
)
27234 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27235 Lisp_Object window
;
27238 XSETWINDOW (window
, w
);
27239 if (EQ (window
, hlinfo
->mouse_face_window
))
27240 clear_mouse_face (hlinfo
);
27246 Just discard the mouse face information for frame F, if any.
27247 This is used when the size of F is changed. */
27250 cancel_mouse_face (struct frame
*f
)
27252 Lisp_Object window
;
27253 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27255 window
= hlinfo
->mouse_face_window
;
27256 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27258 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27259 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27260 hlinfo
->mouse_face_window
= Qnil
;
27266 /***********************************************************************
27268 ***********************************************************************/
27270 #ifdef HAVE_WINDOW_SYSTEM
27272 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27273 which intersects rectangle R. R is in window-relative coordinates. */
27276 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27277 enum glyph_row_area area
)
27279 struct glyph
*first
= row
->glyphs
[area
];
27280 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27281 struct glyph
*last
;
27282 int first_x
, start_x
, x
;
27284 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27285 /* If row extends face to end of line write the whole line. */
27286 draw_glyphs (w
, 0, row
, area
,
27287 0, row
->used
[area
],
27288 DRAW_NORMAL_TEXT
, 0);
27291 /* Set START_X to the window-relative start position for drawing glyphs of
27292 AREA. The first glyph of the text area can be partially visible.
27293 The first glyphs of other areas cannot. */
27294 start_x
= window_box_left_offset (w
, area
);
27296 if (area
== TEXT_AREA
)
27299 /* Find the first glyph that must be redrawn. */
27301 && x
+ first
->pixel_width
< r
->x
)
27303 x
+= first
->pixel_width
;
27307 /* Find the last one. */
27311 && x
< r
->x
+ r
->width
)
27313 x
+= last
->pixel_width
;
27319 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27320 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27321 DRAW_NORMAL_TEXT
, 0);
27326 /* Redraw the parts of the glyph row ROW on window W intersecting
27327 rectangle R. R is in window-relative coordinates. Value is
27328 non-zero if mouse-face was overwritten. */
27331 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27333 xassert (row
->enabled_p
);
27335 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27336 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27337 0, row
->used
[TEXT_AREA
],
27338 DRAW_NORMAL_TEXT
, 0);
27341 if (row
->used
[LEFT_MARGIN_AREA
])
27342 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27343 if (row
->used
[TEXT_AREA
])
27344 expose_area (w
, row
, r
, TEXT_AREA
);
27345 if (row
->used
[RIGHT_MARGIN_AREA
])
27346 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27347 draw_row_fringe_bitmaps (w
, row
);
27350 return row
->mouse_face_p
;
27354 /* Redraw those parts of glyphs rows during expose event handling that
27355 overlap other rows. Redrawing of an exposed line writes over parts
27356 of lines overlapping that exposed line; this function fixes that.
27358 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27359 row in W's current matrix that is exposed and overlaps other rows.
27360 LAST_OVERLAPPING_ROW is the last such row. */
27363 expose_overlaps (struct window
*w
,
27364 struct glyph_row
*first_overlapping_row
,
27365 struct glyph_row
*last_overlapping_row
,
27368 struct glyph_row
*row
;
27370 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27371 if (row
->overlapping_p
)
27373 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27376 if (row
->used
[LEFT_MARGIN_AREA
])
27377 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27379 if (row
->used
[TEXT_AREA
])
27380 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27382 if (row
->used
[RIGHT_MARGIN_AREA
])
27383 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27389 /* Return non-zero if W's cursor intersects rectangle R. */
27392 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27394 XRectangle cr
, result
;
27395 struct glyph
*cursor_glyph
;
27396 struct glyph_row
*row
;
27398 if (w
->phys_cursor
.vpos
>= 0
27399 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27400 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27402 && row
->cursor_in_fringe_p
)
27404 /* Cursor is in the fringe. */
27405 cr
.x
= window_box_right_offset (w
,
27406 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27407 ? RIGHT_MARGIN_AREA
27410 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27411 cr
.height
= row
->height
;
27412 return x_intersect_rectangles (&cr
, r
, &result
);
27415 cursor_glyph
= get_phys_cursor_glyph (w
);
27418 /* r is relative to W's box, but w->phys_cursor.x is relative
27419 to left edge of W's TEXT area. Adjust it. */
27420 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27421 cr
.y
= w
->phys_cursor
.y
;
27422 cr
.width
= cursor_glyph
->pixel_width
;
27423 cr
.height
= w
->phys_cursor_height
;
27424 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27425 I assume the effect is the same -- and this is portable. */
27426 return x_intersect_rectangles (&cr
, r
, &result
);
27428 /* If we don't understand the format, pretend we're not in the hot-spot. */
27434 Draw a vertical window border to the right of window W if W doesn't
27435 have vertical scroll bars. */
27438 x_draw_vertical_border (struct window
*w
)
27440 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27442 /* We could do better, if we knew what type of scroll-bar the adjacent
27443 windows (on either side) have... But we don't :-(
27444 However, I think this works ok. ++KFS 2003-04-25 */
27446 /* Redraw borders between horizontally adjacent windows. Don't
27447 do it for frames with vertical scroll bars because either the
27448 right scroll bar of a window, or the left scroll bar of its
27449 neighbor will suffice as a border. */
27450 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27453 if (!WINDOW_RIGHTMOST_P (w
)
27454 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27456 int x0
, x1
, y0
, y1
;
27458 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27461 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27464 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27466 else if (!WINDOW_LEFTMOST_P (w
)
27467 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27469 int x0
, x1
, y0
, y1
;
27471 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27474 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27477 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27482 /* Redraw the part of window W intersection rectangle FR. Pixel
27483 coordinates in FR are frame-relative. Call this function with
27484 input blocked. Value is non-zero if the exposure overwrites
27488 expose_window (struct window
*w
, XRectangle
*fr
)
27490 struct frame
*f
= XFRAME (w
->frame
);
27492 int mouse_face_overwritten_p
= 0;
27494 /* If window is not yet fully initialized, do nothing. This can
27495 happen when toolkit scroll bars are used and a window is split.
27496 Reconfiguring the scroll bar will generate an expose for a newly
27498 if (w
->current_matrix
== NULL
)
27501 /* When we're currently updating the window, display and current
27502 matrix usually don't agree. Arrange for a thorough display
27504 if (w
== updated_window
)
27506 SET_FRAME_GARBAGED (f
);
27510 /* Frame-relative pixel rectangle of W. */
27511 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27512 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27513 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27514 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27516 if (x_intersect_rectangles (fr
, &wr
, &r
))
27518 int yb
= window_text_bottom_y (w
);
27519 struct glyph_row
*row
;
27520 int cursor_cleared_p
, phys_cursor_on_p
;
27521 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27523 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27524 r
.x
, r
.y
, r
.width
, r
.height
));
27526 /* Convert to window coordinates. */
27527 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27528 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27530 /* Turn off the cursor. */
27531 if (!w
->pseudo_window_p
27532 && phys_cursor_in_rect_p (w
, &r
))
27534 x_clear_cursor (w
);
27535 cursor_cleared_p
= 1;
27538 cursor_cleared_p
= 0;
27540 /* If the row containing the cursor extends face to end of line,
27541 then expose_area might overwrite the cursor outside the
27542 rectangle and thus notice_overwritten_cursor might clear
27543 w->phys_cursor_on_p. We remember the original value and
27544 check later if it is changed. */
27545 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27547 /* Update lines intersecting rectangle R. */
27548 first_overlapping_row
= last_overlapping_row
= NULL
;
27549 for (row
= w
->current_matrix
->rows
;
27554 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27556 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27557 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27558 || (r
.y
>= y0
&& r
.y
< y1
)
27559 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27561 /* A header line may be overlapping, but there is no need
27562 to fix overlapping areas for them. KFS 2005-02-12 */
27563 if (row
->overlapping_p
&& !row
->mode_line_p
)
27565 if (first_overlapping_row
== NULL
)
27566 first_overlapping_row
= row
;
27567 last_overlapping_row
= row
;
27571 if (expose_line (w
, row
, &r
))
27572 mouse_face_overwritten_p
= 1;
27575 else if (row
->overlapping_p
)
27577 /* We must redraw a row overlapping the exposed area. */
27579 ? y0
+ row
->phys_height
> r
.y
27580 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27582 if (first_overlapping_row
== NULL
)
27583 first_overlapping_row
= row
;
27584 last_overlapping_row
= row
;
27592 /* Display the mode line if there is one. */
27593 if (WINDOW_WANTS_MODELINE_P (w
)
27594 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27596 && row
->y
< r
.y
+ r
.height
)
27598 if (expose_line (w
, row
, &r
))
27599 mouse_face_overwritten_p
= 1;
27602 if (!w
->pseudo_window_p
)
27604 /* Fix the display of overlapping rows. */
27605 if (first_overlapping_row
)
27606 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27609 /* Draw border between windows. */
27610 x_draw_vertical_border (w
);
27612 /* Turn the cursor on again. */
27613 if (cursor_cleared_p
27614 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27615 update_window_cursor (w
, 1);
27619 return mouse_face_overwritten_p
;
27624 /* Redraw (parts) of all windows in the window tree rooted at W that
27625 intersect R. R contains frame pixel coordinates. Value is
27626 non-zero if the exposure overwrites mouse-face. */
27629 expose_window_tree (struct window
*w
, XRectangle
*r
)
27631 struct frame
*f
= XFRAME (w
->frame
);
27632 int mouse_face_overwritten_p
= 0;
27634 while (w
&& !FRAME_GARBAGED_P (f
))
27636 if (!NILP (w
->hchild
))
27637 mouse_face_overwritten_p
27638 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27639 else if (!NILP (w
->vchild
))
27640 mouse_face_overwritten_p
27641 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27643 mouse_face_overwritten_p
|= expose_window (w
, r
);
27645 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27648 return mouse_face_overwritten_p
;
27653 Redisplay an exposed area of frame F. X and Y are the upper-left
27654 corner of the exposed rectangle. W and H are width and height of
27655 the exposed area. All are pixel values. W or H zero means redraw
27656 the entire frame. */
27659 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27662 int mouse_face_overwritten_p
= 0;
27664 TRACE ((stderr
, "expose_frame "));
27666 /* No need to redraw if frame will be redrawn soon. */
27667 if (FRAME_GARBAGED_P (f
))
27669 TRACE ((stderr
, " garbaged\n"));
27673 /* If basic faces haven't been realized yet, there is no point in
27674 trying to redraw anything. This can happen when we get an expose
27675 event while Emacs is starting, e.g. by moving another window. */
27676 if (FRAME_FACE_CACHE (f
) == NULL
27677 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27679 TRACE ((stderr
, " no faces\n"));
27683 if (w
== 0 || h
== 0)
27686 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27687 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27697 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27698 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27700 if (WINDOWP (f
->tool_bar_window
))
27701 mouse_face_overwritten_p
27702 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27704 #ifdef HAVE_X_WINDOWS
27706 #ifndef USE_X_TOOLKIT
27707 if (WINDOWP (f
->menu_bar_window
))
27708 mouse_face_overwritten_p
27709 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27710 #endif /* not USE_X_TOOLKIT */
27714 /* Some window managers support a focus-follows-mouse style with
27715 delayed raising of frames. Imagine a partially obscured frame,
27716 and moving the mouse into partially obscured mouse-face on that
27717 frame. The visible part of the mouse-face will be highlighted,
27718 then the WM raises the obscured frame. With at least one WM, KDE
27719 2.1, Emacs is not getting any event for the raising of the frame
27720 (even tried with SubstructureRedirectMask), only Expose events.
27721 These expose events will draw text normally, i.e. not
27722 highlighted. Which means we must redo the highlight here.
27723 Subsume it under ``we love X''. --gerd 2001-08-15 */
27724 /* Included in Windows version because Windows most likely does not
27725 do the right thing if any third party tool offers
27726 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27727 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27729 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27730 if (f
== hlinfo
->mouse_face_mouse_frame
)
27732 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27733 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27734 clear_mouse_face (hlinfo
);
27735 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27742 Determine the intersection of two rectangles R1 and R2. Return
27743 the intersection in *RESULT. Value is non-zero if RESULT is not
27747 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27749 XRectangle
*left
, *right
;
27750 XRectangle
*upper
, *lower
;
27751 int intersection_p
= 0;
27753 /* Rearrange so that R1 is the left-most rectangle. */
27755 left
= r1
, right
= r2
;
27757 left
= r2
, right
= r1
;
27759 /* X0 of the intersection is right.x0, if this is inside R1,
27760 otherwise there is no intersection. */
27761 if (right
->x
<= left
->x
+ left
->width
)
27763 result
->x
= right
->x
;
27765 /* The right end of the intersection is the minimum of
27766 the right ends of left and right. */
27767 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27770 /* Same game for Y. */
27772 upper
= r1
, lower
= r2
;
27774 upper
= r2
, lower
= r1
;
27776 /* The upper end of the intersection is lower.y0, if this is inside
27777 of upper. Otherwise, there is no intersection. */
27778 if (lower
->y
<= upper
->y
+ upper
->height
)
27780 result
->y
= lower
->y
;
27782 /* The lower end of the intersection is the minimum of the lower
27783 ends of upper and lower. */
27784 result
->height
= (min (lower
->y
+ lower
->height
,
27785 upper
->y
+ upper
->height
)
27787 intersection_p
= 1;
27791 return intersection_p
;
27794 #endif /* HAVE_WINDOW_SYSTEM */
27797 /***********************************************************************
27799 ***********************************************************************/
27802 syms_of_xdisp (void)
27804 Vwith_echo_area_save_vector
= Qnil
;
27805 staticpro (&Vwith_echo_area_save_vector
);
27807 Vmessage_stack
= Qnil
;
27808 staticpro (&Vmessage_stack
);
27810 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27812 message_dolog_marker1
= Fmake_marker ();
27813 staticpro (&message_dolog_marker1
);
27814 message_dolog_marker2
= Fmake_marker ();
27815 staticpro (&message_dolog_marker2
);
27816 message_dolog_marker3
= Fmake_marker ();
27817 staticpro (&message_dolog_marker3
);
27820 defsubr (&Sdump_frame_glyph_matrix
);
27821 defsubr (&Sdump_glyph_matrix
);
27822 defsubr (&Sdump_glyph_row
);
27823 defsubr (&Sdump_tool_bar_row
);
27824 defsubr (&Strace_redisplay
);
27825 defsubr (&Strace_to_stderr
);
27827 #ifdef HAVE_WINDOW_SYSTEM
27828 defsubr (&Stool_bar_lines_needed
);
27829 defsubr (&Slookup_image_map
);
27831 defsubr (&Sformat_mode_line
);
27832 defsubr (&Sinvisible_p
);
27833 defsubr (&Scurrent_bidi_paragraph_direction
);
27835 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27836 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27837 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27838 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27839 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27840 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27841 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27842 DEFSYM (Qeval
, "eval");
27843 DEFSYM (QCdata
, ":data");
27844 DEFSYM (Qdisplay
, "display");
27845 DEFSYM (Qspace_width
, "space-width");
27846 DEFSYM (Qraise
, "raise");
27847 DEFSYM (Qslice
, "slice");
27848 DEFSYM (Qspace
, "space");
27849 DEFSYM (Qmargin
, "margin");
27850 DEFSYM (Qpointer
, "pointer");
27851 DEFSYM (Qleft_margin
, "left-margin");
27852 DEFSYM (Qright_margin
, "right-margin");
27853 DEFSYM (Qcenter
, "center");
27854 DEFSYM (Qline_height
, "line-height");
27855 DEFSYM (QCalign_to
, ":align-to");
27856 DEFSYM (QCrelative_width
, ":relative-width");
27857 DEFSYM (QCrelative_height
, ":relative-height");
27858 DEFSYM (QCeval
, ":eval");
27859 DEFSYM (QCpropertize
, ":propertize");
27860 DEFSYM (QCfile
, ":file");
27861 DEFSYM (Qfontified
, "fontified");
27862 DEFSYM (Qfontification_functions
, "fontification-functions");
27863 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27864 DEFSYM (Qescape_glyph
, "escape-glyph");
27865 DEFSYM (Qnobreak_space
, "nobreak-space");
27866 DEFSYM (Qimage
, "image");
27867 DEFSYM (Qtext
, "text");
27868 DEFSYM (Qboth
, "both");
27869 DEFSYM (Qboth_horiz
, "both-horiz");
27870 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27871 DEFSYM (QCmap
, ":map");
27872 DEFSYM (QCpointer
, ":pointer");
27873 DEFSYM (Qrect
, "rect");
27874 DEFSYM (Qcircle
, "circle");
27875 DEFSYM (Qpoly
, "poly");
27876 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27877 DEFSYM (Qgrow_only
, "grow-only");
27878 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27879 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27880 DEFSYM (Qposition
, "position");
27881 DEFSYM (Qbuffer_position
, "buffer-position");
27882 DEFSYM (Qobject
, "object");
27883 DEFSYM (Qbar
, "bar");
27884 DEFSYM (Qhbar
, "hbar");
27885 DEFSYM (Qbox
, "box");
27886 DEFSYM (Qhollow
, "hollow");
27887 DEFSYM (Qhand
, "hand");
27888 DEFSYM (Qarrow
, "arrow");
27889 DEFSYM (Qtext
, "text");
27890 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27892 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27893 Fcons (intern_c_string ("void-variable"), Qnil
)),
27895 staticpro (&list_of_error
);
27897 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27898 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27899 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27900 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27902 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27903 staticpro (&echo_buffer
[0]);
27904 staticpro (&echo_buffer
[1]);
27906 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27907 staticpro (&echo_area_buffer
[0]);
27908 staticpro (&echo_area_buffer
[1]);
27910 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27911 staticpro (&Vmessages_buffer_name
);
27913 mode_line_proptrans_alist
= Qnil
;
27914 staticpro (&mode_line_proptrans_alist
);
27915 mode_line_string_list
= Qnil
;
27916 staticpro (&mode_line_string_list
);
27917 mode_line_string_face
= Qnil
;
27918 staticpro (&mode_line_string_face
);
27919 mode_line_string_face_prop
= Qnil
;
27920 staticpro (&mode_line_string_face_prop
);
27921 Vmode_line_unwind_vector
= Qnil
;
27922 staticpro (&Vmode_line_unwind_vector
);
27924 help_echo_string
= Qnil
;
27925 staticpro (&help_echo_string
);
27926 help_echo_object
= Qnil
;
27927 staticpro (&help_echo_object
);
27928 help_echo_window
= Qnil
;
27929 staticpro (&help_echo_window
);
27930 previous_help_echo_string
= Qnil
;
27931 staticpro (&previous_help_echo_string
);
27932 help_echo_pos
= -1;
27934 DEFSYM (Qright_to_left
, "right-to-left");
27935 DEFSYM (Qleft_to_right
, "left-to-right");
27937 #ifdef HAVE_WINDOW_SYSTEM
27938 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27939 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27940 For example, if a block cursor is over a tab, it will be drawn as
27941 wide as that tab on the display. */);
27942 x_stretch_cursor_p
= 0;
27945 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27946 doc
: /* *Non-nil means highlight trailing whitespace.
27947 The face used for trailing whitespace is `trailing-whitespace'. */);
27948 Vshow_trailing_whitespace
= Qnil
;
27950 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27951 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27952 A value of t means highlight the character itself (for nobreak space,
27953 use face `nobreak-space').
27954 A value of nil means no highlighting.
27955 Other values mean display the escape glyph followed by an ordinary
27956 space or ordinary hyphen. */);
27957 Vnobreak_char_display
= Qt
;
27959 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27960 doc
: /* *The pointer shape to show in void text areas.
27961 A value of nil means to show the text pointer. Other options are `arrow',
27962 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27963 Vvoid_text_area_pointer
= Qarrow
;
27965 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27966 doc
: /* Non-nil means don't actually do any redisplay.
27967 This is used for internal purposes. */);
27968 Vinhibit_redisplay
= Qnil
;
27970 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27971 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27972 Vglobal_mode_string
= Qnil
;
27974 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27975 doc
: /* Marker for where to display an arrow on top of the buffer text.
27976 This must be the beginning of a line in order to work.
27977 See also `overlay-arrow-string'. */);
27978 Voverlay_arrow_position
= Qnil
;
27980 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27981 doc
: /* String to display as an arrow in non-window frames.
27982 See also `overlay-arrow-position'. */);
27983 Voverlay_arrow_string
= make_pure_c_string ("=>");
27985 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27986 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27987 The symbols on this list are examined during redisplay to determine
27988 where to display overlay arrows. */);
27989 Voverlay_arrow_variable_list
27990 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27992 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27993 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27994 If that fails to bring point back on frame, point is centered instead.
27995 If this is zero, point is always centered after it moves off frame.
27996 If you want scrolling to always be a line at a time, you should set
27997 `scroll-conservatively' to a large value rather than set this to 1. */);
27999 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28000 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28001 If point moves off-screen, redisplay will scroll by up to
28002 `scroll-conservatively' lines in order to bring point just barely
28003 onto the screen again. If that cannot be done, then redisplay
28004 recenters point as usual.
28006 If the value is greater than 100, redisplay will never recenter point,
28007 but will always scroll just enough text to bring point into view, even
28008 if you move far away.
28010 A value of zero means always recenter point if it moves off screen. */);
28011 scroll_conservatively
= 0;
28013 DEFVAR_INT ("scroll-margin", scroll_margin
,
28014 doc
: /* *Number of lines of margin at the top and bottom of a window.
28015 Recenter the window whenever point gets within this many lines
28016 of the top or bottom of the window. */);
28019 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28020 doc
: /* Pixels per inch value for non-window system displays.
28021 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28022 Vdisplay_pixels_per_inch
= make_float (72.0);
28025 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28028 DEFVAR_LISP ("truncate-partial-width-windows",
28029 Vtruncate_partial_width_windows
,
28030 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28031 For an integer value, truncate lines in each window narrower than the
28032 full frame width, provided the window width is less than that integer;
28033 otherwise, respect the value of `truncate-lines'.
28035 For any other non-nil value, truncate lines in all windows that do
28036 not span the full frame width.
28038 A value of nil means to respect the value of `truncate-lines'.
28040 If `word-wrap' is enabled, you might want to reduce this. */);
28041 Vtruncate_partial_width_windows
= make_number (50);
28043 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28044 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28045 Any other value means to use the appropriate face, `mode-line',
28046 `header-line', or `menu' respectively. */);
28047 mode_line_inverse_video
= 1;
28049 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28050 doc
: /* *Maximum buffer size for which line number should be displayed.
28051 If the buffer is bigger than this, the line number does not appear
28052 in the mode line. A value of nil means no limit. */);
28053 Vline_number_display_limit
= Qnil
;
28055 DEFVAR_INT ("line-number-display-limit-width",
28056 line_number_display_limit_width
,
28057 doc
: /* *Maximum line width (in characters) for line number display.
28058 If the average length of the lines near point is bigger than this, then the
28059 line number may be omitted from the mode line. */);
28060 line_number_display_limit_width
= 200;
28062 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28063 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28064 highlight_nonselected_windows
= 0;
28066 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28067 doc
: /* Non-nil if more than one frame is visible on this display.
28068 Minibuffer-only frames don't count, but iconified frames do.
28069 This variable is not guaranteed to be accurate except while processing
28070 `frame-title-format' and `icon-title-format'. */);
28072 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28073 doc
: /* Template for displaying the title bar of visible frames.
28074 \(Assuming the window manager supports this feature.)
28076 This variable has the same structure as `mode-line-format', except that
28077 the %c and %l constructs are ignored. It is used only on frames for
28078 which no explicit name has been set \(see `modify-frame-parameters'). */);
28080 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28081 doc
: /* Template for displaying the title bar of an iconified frame.
28082 \(Assuming the window manager supports this feature.)
28083 This variable has the same structure as `mode-line-format' (which see),
28084 and is used only on frames for which no explicit name has been set
28085 \(see `modify-frame-parameters'). */);
28087 = Vframe_title_format
28088 = pure_cons (intern_c_string ("multiple-frames"),
28089 pure_cons (make_pure_c_string ("%b"),
28090 pure_cons (pure_cons (empty_unibyte_string
,
28091 pure_cons (intern_c_string ("invocation-name"),
28092 pure_cons (make_pure_c_string ("@"),
28093 pure_cons (intern_c_string ("system-name"),
28097 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28098 doc
: /* Maximum number of lines to keep in the message log buffer.
28099 If nil, disable message logging. If t, log messages but don't truncate
28100 the buffer when it becomes large. */);
28101 Vmessage_log_max
= make_number (100);
28103 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28104 doc
: /* Functions called before redisplay, if window sizes have changed.
28105 The value should be a list of functions that take one argument.
28106 Just before redisplay, for each frame, if any of its windows have changed
28107 size since the last redisplay, or have been split or deleted,
28108 all the functions in the list are called, with the frame as argument. */);
28109 Vwindow_size_change_functions
= Qnil
;
28111 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28112 doc
: /* List of functions to call before redisplaying a window with scrolling.
28113 Each function is called with two arguments, the window and its new
28114 display-start position. Note that these functions are also called by
28115 `set-window-buffer'. Also note that the value of `window-end' is not
28116 valid when these functions are called. */);
28117 Vwindow_scroll_functions
= Qnil
;
28119 DEFVAR_LISP ("window-text-change-functions",
28120 Vwindow_text_change_functions
,
28121 doc
: /* Functions to call in redisplay when text in the window might change. */);
28122 Vwindow_text_change_functions
= Qnil
;
28124 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28125 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28126 Each function is called with two arguments, the window and the end trigger value.
28127 See `set-window-redisplay-end-trigger'. */);
28128 Vredisplay_end_trigger_functions
= Qnil
;
28130 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28131 doc
: /* *Non-nil means autoselect window with mouse pointer.
28132 If nil, do not autoselect windows.
28133 A positive number means delay autoselection by that many seconds: a
28134 window is autoselected only after the mouse has remained in that
28135 window for the duration of the delay.
28136 A negative number has a similar effect, but causes windows to be
28137 autoselected only after the mouse has stopped moving. \(Because of
28138 the way Emacs compares mouse events, you will occasionally wait twice
28139 that time before the window gets selected.\)
28140 Any other value means to autoselect window instantaneously when the
28141 mouse pointer enters it.
28143 Autoselection selects the minibuffer only if it is active, and never
28144 unselects the minibuffer if it is active.
28146 When customizing this variable make sure that the actual value of
28147 `focus-follows-mouse' matches the behavior of your window manager. */);
28148 Vmouse_autoselect_window
= Qnil
;
28150 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28151 doc
: /* *Non-nil means automatically resize tool-bars.
28152 This dynamically changes the tool-bar's height to the minimum height
28153 that is needed to make all tool-bar items visible.
28154 If value is `grow-only', the tool-bar's height is only increased
28155 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28156 Vauto_resize_tool_bars
= Qt
;
28158 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28159 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28160 auto_raise_tool_bar_buttons_p
= 1;
28162 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28163 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28164 make_cursor_line_fully_visible_p
= 1;
28166 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28167 doc
: /* *Border below tool-bar in pixels.
28168 If an integer, use it as the height of the border.
28169 If it is one of `internal-border-width' or `border-width', use the
28170 value of the corresponding frame parameter.
28171 Otherwise, no border is added below the tool-bar. */);
28172 Vtool_bar_border
= Qinternal_border_width
;
28174 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28175 doc
: /* *Margin around tool-bar buttons in pixels.
28176 If an integer, use that for both horizontal and vertical margins.
28177 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28178 HORZ specifying the horizontal margin, and VERT specifying the
28179 vertical margin. */);
28180 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28182 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28183 doc
: /* *Relief thickness of tool-bar buttons. */);
28184 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28186 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28187 doc
: /* Tool bar style to use.
28189 image - show images only
28190 text - show text only
28191 both - show both, text below image
28192 both-horiz - show text to the right of the image
28193 text-image-horiz - show text to the left of the image
28194 any other - use system default or image if no system default. */);
28195 Vtool_bar_style
= Qnil
;
28197 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28198 doc
: /* *Maximum number of characters a label can have to be shown.
28199 The tool bar style must also show labels for this to have any effect, see
28200 `tool-bar-style'. */);
28201 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28203 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28204 doc
: /* List of functions to call to fontify regions of text.
28205 Each function is called with one argument POS. Functions must
28206 fontify a region starting at POS in the current buffer, and give
28207 fontified regions the property `fontified'. */);
28208 Vfontification_functions
= Qnil
;
28209 Fmake_variable_buffer_local (Qfontification_functions
);
28211 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28212 unibyte_display_via_language_environment
,
28213 doc
: /* *Non-nil means display unibyte text according to language environment.
28214 Specifically, this means that raw bytes in the range 160-255 decimal
28215 are displayed by converting them to the equivalent multibyte characters
28216 according to the current language environment. As a result, they are
28217 displayed according to the current fontset.
28219 Note that this variable affects only how these bytes are displayed,
28220 but does not change the fact they are interpreted as raw bytes. */);
28221 unibyte_display_via_language_environment
= 0;
28223 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28224 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28225 If a float, it specifies a fraction of the mini-window frame's height.
28226 If an integer, it specifies a number of lines. */);
28227 Vmax_mini_window_height
= make_float (0.25);
28229 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28230 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28231 A value of nil means don't automatically resize mini-windows.
28232 A value of t means resize them to fit the text displayed in them.
28233 A value of `grow-only', the default, means let mini-windows grow only;
28234 they return to their normal size when the minibuffer is closed, or the
28235 echo area becomes empty. */);
28236 Vresize_mini_windows
= Qgrow_only
;
28238 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28239 doc
: /* Alist specifying how to blink the cursor off.
28240 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28241 `cursor-type' frame-parameter or variable equals ON-STATE,
28242 comparing using `equal', Emacs uses OFF-STATE to specify
28243 how to blink it off. ON-STATE and OFF-STATE are values for
28244 the `cursor-type' frame parameter.
28246 If a frame's ON-STATE has no entry in this list,
28247 the frame's other specifications determine how to blink the cursor off. */);
28248 Vblink_cursor_alist
= Qnil
;
28250 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28251 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28252 If non-nil, windows are automatically scrolled horizontally to make
28253 point visible. */);
28254 automatic_hscrolling_p
= 1;
28255 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28257 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28258 doc
: /* *How many columns away from the window edge point is allowed to get
28259 before automatic hscrolling will horizontally scroll the window. */);
28260 hscroll_margin
= 5;
28262 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28263 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28264 When point is less than `hscroll-margin' columns from the window
28265 edge, automatic hscrolling will scroll the window by the amount of columns
28266 determined by this variable. If its value is a positive integer, scroll that
28267 many columns. If it's a positive floating-point number, it specifies the
28268 fraction of the window's width to scroll. If it's nil or zero, point will be
28269 centered horizontally after the scroll. Any other value, including negative
28270 numbers, are treated as if the value were zero.
28272 Automatic hscrolling always moves point outside the scroll margin, so if
28273 point was more than scroll step columns inside the margin, the window will
28274 scroll more than the value given by the scroll step.
28276 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28277 and `scroll-right' overrides this variable's effect. */);
28278 Vhscroll_step
= make_number (0);
28280 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28281 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28282 Bind this around calls to `message' to let it take effect. */);
28283 message_truncate_lines
= 0;
28285 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28286 doc
: /* Normal hook run to update the menu bar definitions.
28287 Redisplay runs this hook before it redisplays the menu bar.
28288 This is used to update submenus such as Buffers,
28289 whose contents depend on various data. */);
28290 Vmenu_bar_update_hook
= Qnil
;
28292 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28293 doc
: /* Frame for which we are updating a menu.
28294 The enable predicate for a menu binding should check this variable. */);
28295 Vmenu_updating_frame
= Qnil
;
28297 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28298 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28299 inhibit_menubar_update
= 0;
28301 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28302 doc
: /* Prefix prepended to all continuation lines at display time.
28303 The value may be a string, an image, or a stretch-glyph; it is
28304 interpreted in the same way as the value of a `display' text property.
28306 This variable is overridden by any `wrap-prefix' text or overlay
28309 To add a prefix to non-continuation lines, use `line-prefix'. */);
28310 Vwrap_prefix
= Qnil
;
28311 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28312 Fmake_variable_buffer_local (Qwrap_prefix
);
28314 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28315 doc
: /* Prefix prepended to all non-continuation lines at display time.
28316 The value may be a string, an image, or a stretch-glyph; it is
28317 interpreted in the same way as the value of a `display' text property.
28319 This variable is overridden by any `line-prefix' text or overlay
28322 To add a prefix to continuation lines, use `wrap-prefix'. */);
28323 Vline_prefix
= Qnil
;
28324 DEFSYM (Qline_prefix
, "line-prefix");
28325 Fmake_variable_buffer_local (Qline_prefix
);
28327 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28328 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28329 inhibit_eval_during_redisplay
= 0;
28331 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28332 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28333 inhibit_free_realized_faces
= 0;
28336 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28337 doc
: /* Inhibit try_window_id display optimization. */);
28338 inhibit_try_window_id
= 0;
28340 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28341 doc
: /* Inhibit try_window_reusing display optimization. */);
28342 inhibit_try_window_reusing
= 0;
28344 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28345 doc
: /* Inhibit try_cursor_movement display optimization. */);
28346 inhibit_try_cursor_movement
= 0;
28347 #endif /* GLYPH_DEBUG */
28349 DEFVAR_INT ("overline-margin", overline_margin
,
28350 doc
: /* *Space between overline and text, in pixels.
28351 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28352 margin to the caracter height. */);
28353 overline_margin
= 2;
28355 DEFVAR_INT ("underline-minimum-offset",
28356 underline_minimum_offset
,
28357 doc
: /* Minimum distance between baseline and underline.
28358 This can improve legibility of underlined text at small font sizes,
28359 particularly when using variable `x-use-underline-position-properties'
28360 with fonts that specify an UNDERLINE_POSITION relatively close to the
28361 baseline. The default value is 1. */);
28362 underline_minimum_offset
= 1;
28364 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28365 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28366 This feature only works when on a window system that can change
28367 cursor shapes. */);
28368 display_hourglass_p
= 1;
28370 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28371 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28372 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28374 hourglass_atimer
= NULL
;
28375 hourglass_shown_p
= 0;
28377 DEFSYM (Qglyphless_char
, "glyphless-char");
28378 DEFSYM (Qhex_code
, "hex-code");
28379 DEFSYM (Qempty_box
, "empty-box");
28380 DEFSYM (Qthin_space
, "thin-space");
28381 DEFSYM (Qzero_width
, "zero-width");
28383 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28384 /* Intern this now in case it isn't already done.
28385 Setting this variable twice is harmless.
28386 But don't staticpro it here--that is done in alloc.c. */
28387 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28388 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28390 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28391 doc
: /* Char-table defining glyphless characters.
28392 Each element, if non-nil, should be one of the following:
28393 an ASCII acronym string: display this string in a box
28394 `hex-code': display the hexadecimal code of a character in a box
28395 `empty-box': display as an empty box
28396 `thin-space': display as 1-pixel width space
28397 `zero-width': don't display
28398 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28399 display method for graphical terminals and text terminals respectively.
28400 GRAPHICAL and TEXT should each have one of the values listed above.
28402 The char-table has one extra slot to control the display of a character for
28403 which no font is found. This slot only takes effect on graphical terminals.
28404 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28405 `thin-space'. The default is `empty-box'. */);
28406 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28407 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28412 /* Initialize this module when Emacs starts. */
28417 current_header_line_height
= current_mode_line_height
= -1;
28419 CHARPOS (this_line_start_pos
) = 0;
28421 if (!noninteractive
)
28423 struct window
*m
= XWINDOW (minibuf_window
);
28424 Lisp_Object frame
= m
->frame
;
28425 struct frame
*f
= XFRAME (frame
);
28426 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28427 struct window
*r
= XWINDOW (root
);
28430 echo_area_window
= minibuf_window
;
28432 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28433 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28434 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28435 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28436 XSETFASTINT (m
->total_lines
, 1);
28437 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28439 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28440 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28441 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28443 /* The default ellipsis glyphs `...'. */
28444 for (i
= 0; i
< 3; ++i
)
28445 default_invis_vector
[i
] = make_number ('.');
28449 /* Allocate the buffer for frame titles.
28450 Also used for `format-mode-line'. */
28452 mode_line_noprop_buf
= (char *) xmalloc (size
);
28453 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28454 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28455 mode_line_target
= MODE_LINE_DISPLAY
;
28458 help_echo_showing_p
= 0;
28461 /* Since w32 does not support atimers, it defines its own implementation of
28462 the following three functions in w32fns.c. */
28465 /* Platform-independent portion of hourglass implementation. */
28467 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28469 hourglass_started (void)
28471 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28474 /* Cancel a currently active hourglass timer, and start a new one. */
28476 start_hourglass (void)
28478 #if defined (HAVE_WINDOW_SYSTEM)
28480 int secs
, usecs
= 0;
28482 cancel_hourglass ();
28484 if (INTEGERP (Vhourglass_delay
)
28485 && XINT (Vhourglass_delay
) > 0)
28486 secs
= XFASTINT (Vhourglass_delay
);
28487 else if (FLOATP (Vhourglass_delay
)
28488 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28491 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28492 secs
= XFASTINT (tem
);
28493 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28496 secs
= DEFAULT_HOURGLASS_DELAY
;
28498 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28499 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28500 show_hourglass
, NULL
);
28505 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28508 cancel_hourglass (void)
28510 #if defined (HAVE_WINDOW_SYSTEM)
28511 if (hourglass_atimer
)
28513 cancel_atimer (hourglass_atimer
);
28514 hourglass_atimer
= NULL
;
28517 if (hourglass_shown_p
)
28521 #endif /* ! WINDOWSNT */