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) \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE); \
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 *);
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
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1346 bidi_unshelve_cache (itdata
);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 /* Correct bogus values of tab_width. */
2482 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2483 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2486 /* Are lines in the display truncated? */
2487 if (base_face_id
!= DEFAULT_FACE_ID
2488 || XINT (it
->w
->hscroll
)
2489 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2490 && ((!NILP (Vtruncate_partial_width_windows
)
2491 && !INTEGERP (Vtruncate_partial_width_windows
))
2492 || (INTEGERP (Vtruncate_partial_width_windows
)
2493 && (WINDOW_TOTAL_COLS (it
->w
)
2494 < XINT (Vtruncate_partial_width_windows
))))))
2495 it
->line_wrap
= TRUNCATE
;
2496 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2497 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2498 ? WINDOW_WRAP
: WORD_WRAP
;
2500 it
->line_wrap
= TRUNCATE
;
2502 /* Get dimensions of truncation and continuation glyphs. These are
2503 displayed as fringe bitmaps under X, so we don't need them for such
2505 if (!FRAME_WINDOW_P (it
->f
))
2507 if (it
->line_wrap
== TRUNCATE
)
2509 /* We will need the truncation glyph. */
2510 xassert (it
->glyph_row
== NULL
);
2511 produce_special_glyphs (it
, IT_TRUNCATION
);
2512 it
->truncation_pixel_width
= it
->pixel_width
;
2516 /* We will need the continuation glyph. */
2517 xassert (it
->glyph_row
== NULL
);
2518 produce_special_glyphs (it
, IT_CONTINUATION
);
2519 it
->continuation_pixel_width
= it
->pixel_width
;
2522 /* Reset these values to zero because the produce_special_glyphs
2523 above has changed them. */
2524 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2525 it
->phys_ascent
= it
->phys_descent
= 0;
2528 /* Set this after getting the dimensions of truncation and
2529 continuation glyphs, so that we don't produce glyphs when calling
2530 produce_special_glyphs, above. */
2531 it
->glyph_row
= row
;
2532 it
->area
= TEXT_AREA
;
2534 /* Forget any previous info about this row being reversed. */
2536 it
->glyph_row
->reversed_p
= 0;
2538 /* Get the dimensions of the display area. The display area
2539 consists of the visible window area plus a horizontally scrolled
2540 part to the left of the window. All x-values are relative to the
2541 start of this total display area. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2544 /* Mode lines, menu bar in terminal frames. */
2545 it
->first_visible_x
= 0;
2546 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2551 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2552 it
->last_visible_x
= (it
->first_visible_x
2553 + window_box_width (w
, TEXT_AREA
));
2555 /* If we truncate lines, leave room for the truncator glyph(s) at
2556 the right margin. Otherwise, leave room for the continuation
2557 glyph(s). Truncation and continuation glyphs are not inserted
2558 for window-based redisplay. */
2559 if (!FRAME_WINDOW_P (it
->f
))
2561 if (it
->line_wrap
== TRUNCATE
)
2562 it
->last_visible_x
-= it
->truncation_pixel_width
;
2564 it
->last_visible_x
-= it
->continuation_pixel_width
;
2567 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2568 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2571 /* Leave room for a border glyph. */
2572 if (!FRAME_WINDOW_P (it
->f
)
2573 && !WINDOW_RIGHTMOST_P (it
->w
))
2574 it
->last_visible_x
-= 1;
2576 it
->last_visible_y
= window_text_bottom_y (w
);
2578 /* For mode lines and alike, arrange for the first glyph having a
2579 left box line if the face specifies a box. */
2580 if (base_face_id
!= DEFAULT_FACE_ID
)
2584 it
->face_id
= remapped_base_face_id
;
2586 /* If we have a boxed mode line, make the first character appear
2587 with a left box line. */
2588 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2589 if (face
->box
!= FACE_NO_BOX
)
2590 it
->start_of_box_run_p
= 1;
2593 /* If a buffer position was specified, set the iterator there,
2594 getting overlays and face properties from that position. */
2595 if (charpos
>= BUF_BEG (current_buffer
))
2597 it
->end_charpos
= ZV
;
2599 IT_CHARPOS (*it
) = charpos
;
2601 /* Compute byte position if not specified. */
2602 if (bytepos
< charpos
)
2603 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2605 IT_BYTEPOS (*it
) = bytepos
;
2607 it
->start
= it
->current
;
2608 /* Do we need to reorder bidirectional text? Not if this is a
2609 unibyte buffer: by definition, none of the single-byte
2610 characters are strong R2L, so no reordering is needed. And
2611 bidi.c doesn't support unibyte buffers anyway. */
2613 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2616 /* If we are to reorder bidirectional text, init the bidi
2620 /* Note the paragraph direction that this buffer wants to
2622 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= L2R
;
2625 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2627 it
->paragraph_embedding
= R2L
;
2629 it
->paragraph_embedding
= NEUTRAL_DIR
;
2630 bidi_unshelve_cache (NULL
);
2631 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 it
->from_disp_prop_p
= 0;
2956 handle_overlay_change_p
= 0;
2958 handled
= HANDLED_RECOMPUTE_PROPS
;
2961 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2962 handle_overlay_change_p
= 0;
2965 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2967 /* Don't check for overlay strings below when set to deliver
2968 characters from a display vector. */
2969 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2970 handle_overlay_change_p
= 0;
2972 /* Handle overlay changes.
2973 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2974 if it finds overlays. */
2975 if (handle_overlay_change_p
)
2976 handled
= handle_overlay_change (it
);
2981 setup_for_ellipsis (it
, 0);
2985 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2987 /* Determine where to stop next. */
2988 if (handled
== HANDLED_NORMALLY
)
2989 compute_stop_pos (it
);
2993 /* Compute IT->stop_charpos from text property and overlay change
2994 information for IT's current position. */
2997 compute_stop_pos (struct it
*it
)
2999 register INTERVAL iv
, next_iv
;
3000 Lisp_Object object
, limit
, position
;
3001 EMACS_INT charpos
, bytepos
;
3003 /* If nowhere else, stop at the end. */
3004 it
->stop_charpos
= it
->end_charpos
;
3006 if (STRINGP (it
->string
))
3008 /* Strings are usually short, so don't limit the search for
3010 object
= it
->string
;
3012 charpos
= IT_STRING_CHARPOS (*it
);
3013 bytepos
= IT_STRING_BYTEPOS (*it
);
3019 /* If next overlay change is in front of the current stop pos
3020 (which is IT->end_charpos), stop there. Note: value of
3021 next_overlay_change is point-max if no overlay change
3023 charpos
= IT_CHARPOS (*it
);
3024 bytepos
= IT_BYTEPOS (*it
);
3025 pos
= next_overlay_change (charpos
);
3026 if (pos
< it
->stop_charpos
)
3027 it
->stop_charpos
= pos
;
3029 /* If showing the region, we have to stop at the region
3030 start or end because the face might change there. */
3031 if (it
->region_beg_charpos
> 0)
3033 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3035 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3039 /* Set up variables for computing the stop position from text
3040 property changes. */
3041 XSETBUFFER (object
, current_buffer
);
3042 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3045 /* Get the interval containing IT's position. Value is a null
3046 interval if there isn't such an interval. */
3047 position
= make_number (charpos
);
3048 iv
= validate_interval_range (object
, &position
, &position
, 0);
3049 if (!NULL_INTERVAL_P (iv
))
3051 Lisp_Object values_here
[LAST_PROP_IDX
];
3054 /* Get properties here. */
3055 for (p
= it_props
; p
->handler
; ++p
)
3056 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3058 /* Look for an interval following iv that has different
3060 for (next_iv
= next_interval (iv
);
3061 (!NULL_INTERVAL_P (next_iv
)
3063 || XFASTINT (limit
) > next_iv
->position
));
3064 next_iv
= next_interval (next_iv
))
3066 for (p
= it_props
; p
->handler
; ++p
)
3068 Lisp_Object new_value
;
3070 new_value
= textget (next_iv
->plist
, *p
->name
);
3071 if (!EQ (values_here
[p
->idx
], new_value
))
3079 if (!NULL_INTERVAL_P (next_iv
))
3081 if (INTEGERP (limit
)
3082 && next_iv
->position
>= XFASTINT (limit
))
3083 /* No text property change up to limit. */
3084 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3086 /* Text properties change in next_iv. */
3087 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3091 if (it
->cmp_it
.id
< 0)
3093 EMACS_INT stoppos
= it
->end_charpos
;
3095 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3097 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3098 stoppos
, it
->string
);
3101 xassert (STRINGP (it
->string
)
3102 || (it
->stop_charpos
>= BEGV
3103 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3107 /* Return the position of the next overlay change after POS in
3108 current_buffer. Value is point-max if no overlay change
3109 follows. This is like `next-overlay-change' but doesn't use
3113 next_overlay_change (EMACS_INT pos
)
3115 ptrdiff_t i
, noverlays
;
3117 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3137 /* Return the character position of a display string at or after
3138 position specified by POSITION. If no display string exists at or
3139 after POSITION, return ZV. A display string is either an overlay
3140 with `display' property whose value is a string, or a `display'
3141 text property whose value is a string. STRING is data about the
3142 string to iterate; if STRING->lstring is nil, we are iterating a
3143 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3146 compute_display_string_pos (struct text_pos
*position
,
3147 struct bidi_string_data
*string
, int frame_window_p
)
3149 /* OBJECT = nil means current buffer. */
3150 Lisp_Object object
=
3151 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3152 Lisp_Object pos
, spec
;
3153 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3154 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3155 EMACS_INT begb
= string_p
? 0 : BEGV
;
3156 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3157 struct text_pos tpos
;
3160 /* We don't support display properties whose values are strings
3161 that have display string properties. */
3162 || string
->from_disp_str
3163 /* C strings cannot have display properties. */
3164 || (string
->s
&& !STRINGP (object
)))
3167 /* If the character at CHARPOS is where the display string begins,
3169 pos
= make_number (charpos
);
3170 if (STRINGP (object
))
3171 bufpos
= string
->bufpos
;
3175 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3177 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3180 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3184 /* Look forward for the first character with a `display' property
3185 that will replace the underlying text when displayed. */
3187 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3188 CHARPOS (tpos
) = XFASTINT (pos
);
3189 if (STRINGP (object
))
3190 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3192 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3193 if (CHARPOS (tpos
) >= eob
)
3195 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3196 if (!STRINGP (object
))
3197 bufpos
= CHARPOS (tpos
);
3198 } while (NILP (spec
)
3199 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3202 return CHARPOS (tpos
);
3205 /* Return the character position of the end of the display string that
3206 started at CHARPOS. A display string is either an overlay with
3207 `display' property whose value is a string or a `display' text
3208 property whose value is a string. */
3210 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3212 /* OBJECT = nil means current buffer. */
3213 Lisp_Object object
=
3214 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3215 Lisp_Object pos
= make_number (charpos
);
3217 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3219 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3222 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3225 /* Look forward for the first character where the `display' property
3227 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3229 return XFASTINT (pos
);
3234 /***********************************************************************
3236 ***********************************************************************/
3238 /* Handle changes in the `fontified' property of the current buffer by
3239 calling hook functions from Qfontification_functions to fontify
3242 static enum prop_handled
3243 handle_fontified_prop (struct it
*it
)
3245 Lisp_Object prop
, pos
;
3246 enum prop_handled handled
= HANDLED_NORMALLY
;
3248 if (!NILP (Vmemory_full
))
3251 /* Get the value of the `fontified' property at IT's current buffer
3252 position. (The `fontified' property doesn't have a special
3253 meaning in strings.) If the value is nil, call functions from
3254 Qfontification_functions. */
3255 if (!STRINGP (it
->string
)
3257 && !NILP (Vfontification_functions
)
3258 && !NILP (Vrun_hooks
)
3259 && (pos
= make_number (IT_CHARPOS (*it
)),
3260 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3261 /* Ignore the special cased nil value always present at EOB since
3262 no amount of fontifying will be able to change it. */
3263 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3265 int count
= SPECPDL_INDEX ();
3267 struct buffer
*obuf
= current_buffer
;
3268 int begv
= BEGV
, zv
= ZV
;
3269 int old_clip_changed
= current_buffer
->clip_changed
;
3271 val
= Vfontification_functions
;
3272 specbind (Qfontification_functions
, Qnil
);
3274 xassert (it
->end_charpos
== ZV
);
3276 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3277 safe_call1 (val
, pos
);
3280 Lisp_Object fns
, fn
;
3281 struct gcpro gcpro1
, gcpro2
;
3286 for (; CONSP (val
); val
= XCDR (val
))
3292 /* A value of t indicates this hook has a local
3293 binding; it means to run the global binding too.
3294 In a global value, t should not occur. If it
3295 does, we must ignore it to avoid an endless
3297 for (fns
= Fdefault_value (Qfontification_functions
);
3303 safe_call1 (fn
, pos
);
3307 safe_call1 (fn
, pos
);
3313 unbind_to (count
, Qnil
);
3315 /* Fontification functions routinely call `save-restriction'.
3316 Normally, this tags clip_changed, which can confuse redisplay
3317 (see discussion in Bug#6671). Since we don't perform any
3318 special handling of fontification changes in the case where
3319 `save-restriction' isn't called, there's no point doing so in
3320 this case either. So, if the buffer's restrictions are
3321 actually left unchanged, reset clip_changed. */
3322 if (obuf
== current_buffer
)
3324 if (begv
== BEGV
&& zv
== ZV
)
3325 current_buffer
->clip_changed
= old_clip_changed
;
3327 /* There isn't much we can reasonably do to protect against
3328 misbehaving fontification, but here's a fig leaf. */
3329 else if (!NILP (BVAR (obuf
, name
)))
3330 set_buffer_internal_1 (obuf
);
3332 /* The fontification code may have added/removed text.
3333 It could do even a lot worse, but let's at least protect against
3334 the most obvious case where only the text past `pos' gets changed',
3335 as is/was done in grep.el where some escapes sequences are turned
3336 into face properties (bug#7876). */
3337 it
->end_charpos
= ZV
;
3339 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3340 something. This avoids an endless loop if they failed to
3341 fontify the text for which reason ever. */
3342 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3343 handled
= HANDLED_RECOMPUTE_PROPS
;
3351 /***********************************************************************
3353 ***********************************************************************/
3355 /* Set up iterator IT from face properties at its current position.
3356 Called from handle_stop. */
3358 static enum prop_handled
3359 handle_face_prop (struct it
*it
)
3362 EMACS_INT next_stop
;
3364 if (!STRINGP (it
->string
))
3367 = face_at_buffer_position (it
->w
,
3369 it
->region_beg_charpos
,
3370 it
->region_end_charpos
,
3373 + TEXT_PROP_DISTANCE_LIMIT
),
3374 0, it
->base_face_id
);
3376 /* Is this a start of a run of characters with box face?
3377 Caveat: this can be called for a freshly initialized
3378 iterator; face_id is -1 in this case. We know that the new
3379 face will not change until limit, i.e. if the new face has a
3380 box, all characters up to limit will have one. But, as
3381 usual, we don't know whether limit is really the end. */
3382 if (new_face_id
!= it
->face_id
)
3384 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3386 /* If new face has a box but old face has not, this is
3387 the start of a run of characters with box, i.e. it has
3388 a shadow on the left side. The value of face_id of the
3389 iterator will be -1 if this is the initial call that gets
3390 the face. In this case, we have to look in front of IT's
3391 position and see whether there is a face != new_face_id. */
3392 it
->start_of_box_run_p
3393 = (new_face
->box
!= FACE_NO_BOX
3394 && (it
->face_id
>= 0
3395 || IT_CHARPOS (*it
) == BEG
3396 || new_face_id
!= face_before_it_pos (it
)));
3397 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3405 Lisp_Object from_overlay
3406 = (it
->current
.overlay_string_index
>= 0
3407 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3410 /* See if we got to this string directly or indirectly from
3411 an overlay property. That includes the before-string or
3412 after-string of an overlay, strings in display properties
3413 provided by an overlay, their text properties, etc.
3415 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3416 if (! NILP (from_overlay
))
3417 for (i
= it
->sp
- 1; i
>= 0; i
--)
3419 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3421 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3422 else if (! NILP (it
->stack
[i
].from_overlay
))
3423 from_overlay
= it
->stack
[i
].from_overlay
;
3425 if (!NILP (from_overlay
))
3429 if (! NILP (from_overlay
))
3431 bufpos
= IT_CHARPOS (*it
);
3432 /* For a string from an overlay, the base face depends
3433 only on text properties and ignores overlays. */
3435 = face_for_overlay_string (it
->w
,
3437 it
->region_beg_charpos
,
3438 it
->region_end_charpos
,
3441 + TEXT_PROP_DISTANCE_LIMIT
),
3449 /* For strings from a `display' property, use the face at
3450 IT's current buffer position as the base face to merge
3451 with, so that overlay strings appear in the same face as
3452 surrounding text, unless they specify their own
3454 base_face_id
= underlying_face_id (it
);
3457 new_face_id
= face_at_string_position (it
->w
,
3459 IT_STRING_CHARPOS (*it
),
3461 it
->region_beg_charpos
,
3462 it
->region_end_charpos
,
3466 /* Is this a start of a run of characters with box? Caveat:
3467 this can be called for a freshly allocated iterator; face_id
3468 is -1 is this case. We know that the new face will not
3469 change until the next check pos, i.e. if the new face has a
3470 box, all characters up to that position will have a
3471 box. But, as usual, we don't know whether that position
3472 is really the end. */
3473 if (new_face_id
!= it
->face_id
)
3475 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3476 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3478 /* If new face has a box but old face hasn't, this is the
3479 start of a run of characters with box, i.e. it has a
3480 shadow on the left side. */
3481 it
->start_of_box_run_p
3482 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3483 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3487 it
->face_id
= new_face_id
;
3488 return HANDLED_NORMALLY
;
3492 /* Return the ID of the face ``underlying'' IT's current position,
3493 which is in a string. If the iterator is associated with a
3494 buffer, return the face at IT's current buffer position.
3495 Otherwise, use the iterator's base_face_id. */
3498 underlying_face_id (struct it
*it
)
3500 int face_id
= it
->base_face_id
, i
;
3502 xassert (STRINGP (it
->string
));
3504 for (i
= it
->sp
- 1; i
>= 0; --i
)
3505 if (NILP (it
->stack
[i
].string
))
3506 face_id
= it
->stack
[i
].face_id
;
3512 /* Compute the face one character before or after the current position
3513 of IT, in the visual order. BEFORE_P non-zero means get the face
3514 in front (to the left in L2R paragraphs, to the right in R2L
3515 paragraphs) of IT's screen position. Value is the ID of the face. */
3518 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3521 EMACS_INT next_check_charpos
;
3523 void *it_copy_data
= NULL
;
3525 xassert (it
->s
== NULL
);
3527 if (STRINGP (it
->string
))
3529 EMACS_INT bufpos
, charpos
;
3532 /* No face change past the end of the string (for the case
3533 we are padding with spaces). No face change before the
3535 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3536 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3541 /* Set charpos to the position before or after IT's current
3542 position, in the logical order, which in the non-bidi
3543 case is the same as the visual order. */
3545 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3546 else if (it
->what
== IT_COMPOSITION
)
3547 /* For composition, we must check the character after the
3549 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3551 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3557 /* With bidi iteration, the character before the current
3558 in the visual order cannot be found by simple
3559 iteration, because "reverse" reordering is not
3560 supported. Instead, we need to use the move_it_*
3561 family of functions. */
3562 /* Ignore face changes before the first visible
3563 character on this display line. */
3564 if (it
->current_x
<= it
->first_visible_x
)
3566 SAVE_IT (it_copy
, *it
, it_copy_data
);
3567 /* Implementation note: Since move_it_in_display_line
3568 works in the iterator geometry, and thinks the first
3569 character is always the leftmost, even in R2L lines,
3570 we don't need to distinguish between the R2L and L2R
3572 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3573 it_copy
.current_x
- 1, MOVE_TO_X
);
3574 charpos
= IT_STRING_CHARPOS (it_copy
);
3575 RESTORE_IT (it
, it
, it_copy_data
);
3579 /* Set charpos to the string position of the character
3580 that comes after IT's current position in the visual
3582 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3586 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3588 charpos
= it_copy
.bidi_it
.charpos
;
3591 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3593 if (it
->current
.overlay_string_index
>= 0)
3594 bufpos
= IT_CHARPOS (*it
);
3598 base_face_id
= underlying_face_id (it
);
3600 /* Get the face for ASCII, or unibyte. */
3601 face_id
= face_at_string_position (it
->w
,
3605 it
->region_beg_charpos
,
3606 it
->region_end_charpos
,
3607 &next_check_charpos
,
3610 /* Correct the face for charsets different from ASCII. Do it
3611 for the multibyte case only. The face returned above is
3612 suitable for unibyte text if IT->string is unibyte. */
3613 if (STRING_MULTIBYTE (it
->string
))
3615 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3616 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3618 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3620 c
= string_char_and_length (p
, &len
);
3621 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3626 struct text_pos pos
;
3628 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3629 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3632 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3633 pos
= it
->current
.pos
;
3638 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3641 if (it
->what
== IT_COMPOSITION
)
3643 /* For composition, we must check the position after
3645 pos
.charpos
+= it
->cmp_it
.nchars
;
3646 pos
.bytepos
+= it
->len
;
3649 INC_TEXT_POS (pos
, it
->multibyte_p
);
3656 /* With bidi iteration, the character before the current
3657 in the visual order cannot be found by simple
3658 iteration, because "reverse" reordering is not
3659 supported. Instead, we need to use the move_it_*
3660 family of functions. */
3661 /* Ignore face changes before the first visible
3662 character on this display line. */
3663 if (it
->current_x
<= it
->first_visible_x
)
3665 SAVE_IT (it_copy
, *it
, it_copy_data
);
3666 /* Implementation note: Since move_it_in_display_line
3667 works in the iterator geometry, and thinks the first
3668 character is always the leftmost, even in R2L lines,
3669 we don't need to distinguish between the R2L and L2R
3671 move_it_in_display_line (&it_copy
, ZV
,
3672 it_copy
.current_x
- 1, MOVE_TO_X
);
3673 pos
= it_copy
.current
.pos
;
3674 RESTORE_IT (it
, it
, it_copy_data
);
3678 /* Set charpos to the buffer position of the character
3679 that comes after IT's current position in the visual
3681 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3685 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3688 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3691 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3693 /* Determine face for CHARSET_ASCII, or unibyte. */
3694 face_id
= face_at_buffer_position (it
->w
,
3696 it
->region_beg_charpos
,
3697 it
->region_end_charpos
,
3698 &next_check_charpos
,
3701 /* Correct the face for charsets different from ASCII. Do it
3702 for the multibyte case only. The face returned above is
3703 suitable for unibyte text if current_buffer is unibyte. */
3704 if (it
->multibyte_p
)
3706 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3707 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3708 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3717 /***********************************************************************
3719 ***********************************************************************/
3721 /* Set up iterator IT from invisible properties at its current
3722 position. Called from handle_stop. */
3724 static enum prop_handled
3725 handle_invisible_prop (struct it
*it
)
3727 enum prop_handled handled
= HANDLED_NORMALLY
;
3729 if (STRINGP (it
->string
))
3731 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3733 /* Get the value of the invisible text property at the
3734 current position. Value will be nil if there is no such
3736 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3737 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3740 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3744 handled
= HANDLED_RECOMPUTE_PROPS
;
3746 /* Get the position at which the next change of the
3747 invisible text property can be found in IT->string.
3748 Value will be nil if the property value is the same for
3749 all the rest of IT->string. */
3750 XSETINT (limit
, SCHARS (it
->string
));
3751 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3754 /* Text at current position is invisible. The next
3755 change in the property is at position end_charpos.
3756 Move IT's current position to that position. */
3757 if (INTEGERP (end_charpos
)
3758 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3760 struct text_pos old
;
3763 old
= it
->current
.string_pos
;
3764 oldpos
= CHARPOS (old
);
3767 if (it
->bidi_it
.first_elt
3768 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3769 bidi_paragraph_init (it
->paragraph_embedding
,
3771 /* Bidi-iterate out of the invisible text. */
3774 bidi_move_to_visually_next (&it
->bidi_it
);
3776 while (oldpos
<= it
->bidi_it
.charpos
3777 && it
->bidi_it
.charpos
< endpos
);
3779 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3780 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3781 if (IT_CHARPOS (*it
) >= endpos
)
3782 it
->prev_stop
= endpos
;
3786 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3787 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3792 /* The rest of the string is invisible. If this is an
3793 overlay string, proceed with the next overlay string
3794 or whatever comes and return a character from there. */
3795 if (it
->current
.overlay_string_index
>= 0)
3797 next_overlay_string (it
);
3798 /* Don't check for overlay strings when we just
3799 finished processing them. */
3800 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3804 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3805 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3813 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3814 Lisp_Object pos
, prop
, overlay
;
3816 /* First of all, is there invisible text at this position? */
3817 tem
= start_charpos
= IT_CHARPOS (*it
);
3818 pos
= make_number (tem
);
3819 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3821 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3823 /* If we are on invisible text, skip over it. */
3824 if (invis_p
&& start_charpos
< it
->end_charpos
)
3826 /* Record whether we have to display an ellipsis for the
3828 int display_ellipsis_p
= invis_p
== 2;
3830 handled
= HANDLED_RECOMPUTE_PROPS
;
3832 /* Loop skipping over invisible text. The loop is left at
3833 ZV or with IT on the first char being visible again. */
3836 /* Try to skip some invisible text. Return value is the
3837 position reached which can be equal to where we start
3838 if there is nothing invisible there. This skips both
3839 over invisible text properties and overlays with
3840 invisible property. */
3841 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3843 /* If we skipped nothing at all we weren't at invisible
3844 text in the first place. If everything to the end of
3845 the buffer was skipped, end the loop. */
3846 if (newpos
== tem
|| newpos
>= ZV
)
3850 /* We skipped some characters but not necessarily
3851 all there are. Check if we ended up on visible
3852 text. Fget_char_property returns the property of
3853 the char before the given position, i.e. if we
3854 get invis_p = 0, this means that the char at
3855 newpos is visible. */
3856 pos
= make_number (newpos
);
3857 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3858 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3861 /* If we ended up on invisible text, proceed to
3862 skip starting with next_stop. */
3866 /* If there are adjacent invisible texts, don't lose the
3867 second one's ellipsis. */
3869 display_ellipsis_p
= 1;
3873 /* The position newpos is now either ZV or on visible text. */
3874 if (it
->bidi_p
&& newpos
< ZV
)
3876 /* With bidi iteration, the region of invisible text
3877 could start and/or end in the middle of a non-base
3878 embedding level. Therefore, we need to skip
3879 invisible text using the bidi iterator, starting at
3880 IT's current position, until we find ourselves
3881 outside the invisible text. Skipping invisible text
3882 _after_ bidi iteration avoids affecting the visual
3883 order of the displayed text when invisible properties
3884 are added or removed. */
3885 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3887 /* If we were `reseat'ed to a new paragraph,
3888 determine the paragraph base direction. We need
3889 to do it now because next_element_from_buffer may
3890 not have a chance to do it, if we are going to
3891 skip any text at the beginning, which resets the
3893 bidi_paragraph_init (it
->paragraph_embedding
,
3898 bidi_move_to_visually_next (&it
->bidi_it
);
3900 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3901 && it
->bidi_it
.charpos
< newpos
);
3902 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3903 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3904 /* If we overstepped NEWPOS, record its position in the
3905 iterator, so that we skip invisible text if later the
3906 bidi iteration lands us in the invisible region
3908 if (IT_CHARPOS (*it
) >= newpos
)
3909 it
->prev_stop
= newpos
;
3913 IT_CHARPOS (*it
) = newpos
;
3914 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3917 /* If there are before-strings at the start of invisible
3918 text, and the text is invisible because of a text
3919 property, arrange to show before-strings because 20.x did
3920 it that way. (If the text is invisible because of an
3921 overlay property instead of a text property, this is
3922 already handled in the overlay code.) */
3924 && get_overlay_strings (it
, it
->stop_charpos
))
3926 handled
= HANDLED_RECOMPUTE_PROPS
;
3927 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3929 else if (display_ellipsis_p
)
3931 /* Make sure that the glyphs of the ellipsis will get
3932 correct `charpos' values. If we would not update
3933 it->position here, the glyphs would belong to the
3934 last visible character _before_ the invisible
3935 text, which confuses `set_cursor_from_row'.
3937 We use the last invisible position instead of the
3938 first because this way the cursor is always drawn on
3939 the first "." of the ellipsis, whenever PT is inside
3940 the invisible text. Otherwise the cursor would be
3941 placed _after_ the ellipsis when the point is after the
3942 first invisible character. */
3943 if (!STRINGP (it
->object
))
3945 it
->position
.charpos
= newpos
- 1;
3946 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3949 /* Let the ellipsis display before
3950 considering any properties of the following char.
3951 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3952 handled
= HANDLED_RETURN
;
3961 /* Make iterator IT return `...' next.
3962 Replaces LEN characters from buffer. */
3965 setup_for_ellipsis (struct it
*it
, int len
)
3967 /* Use the display table definition for `...'. Invalid glyphs
3968 will be handled by the method returning elements from dpvec. */
3969 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3971 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3972 it
->dpvec
= v
->contents
;
3973 it
->dpend
= v
->contents
+ v
->header
.size
;
3977 /* Default `...'. */
3978 it
->dpvec
= default_invis_vector
;
3979 it
->dpend
= default_invis_vector
+ 3;
3982 it
->dpvec_char_len
= len
;
3983 it
->current
.dpvec_index
= 0;
3984 it
->dpvec_face_id
= -1;
3986 /* Remember the current face id in case glyphs specify faces.
3987 IT's face is restored in set_iterator_to_next.
3988 saved_face_id was set to preceding char's face in handle_stop. */
3989 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3990 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3992 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3998 /***********************************************************************
4000 ***********************************************************************/
4002 /* Set up iterator IT from `display' property at its current position.
4003 Called from handle_stop.
4004 We return HANDLED_RETURN if some part of the display property
4005 overrides the display of the buffer text itself.
4006 Otherwise we return HANDLED_NORMALLY. */
4008 static enum prop_handled
4009 handle_display_prop (struct it
*it
)
4011 Lisp_Object propval
, object
, overlay
;
4012 struct text_pos
*position
;
4014 /* Nonzero if some property replaces the display of the text itself. */
4015 int display_replaced_p
= 0;
4017 if (STRINGP (it
->string
))
4019 object
= it
->string
;
4020 position
= &it
->current
.string_pos
;
4021 bufpos
= CHARPOS (it
->current
.pos
);
4025 XSETWINDOW (object
, it
->w
);
4026 position
= &it
->current
.pos
;
4027 bufpos
= CHARPOS (*position
);
4030 /* Reset those iterator values set from display property values. */
4031 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4032 it
->space_width
= Qnil
;
4033 it
->font_height
= Qnil
;
4036 /* We don't support recursive `display' properties, i.e. string
4037 values that have a string `display' property, that have a string
4038 `display' property etc. */
4039 if (!it
->string_from_display_prop_p
)
4040 it
->area
= TEXT_AREA
;
4042 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4043 Qdisplay
, object
, &overlay
);
4045 return HANDLED_NORMALLY
;
4046 /* Now OVERLAY is the overlay that gave us this property, or nil
4047 if it was a text property. */
4049 if (!STRINGP (it
->string
))
4050 object
= it
->w
->buffer
;
4052 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4054 FRAME_WINDOW_P (it
->f
));
4056 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4059 /* Subroutine of handle_display_prop. Returns non-zero if the display
4060 specification in SPEC is a replacing specification, i.e. it would
4061 replace the text covered by `display' property with something else,
4062 such as an image or a display string.
4064 See handle_single_display_spec for documentation of arguments.
4065 frame_window_p is non-zero if the window being redisplayed is on a
4066 GUI frame; this argument is used only if IT is NULL, see below.
4068 IT can be NULL, if this is called by the bidi reordering code
4069 through compute_display_string_pos, which see. In that case, this
4070 function only examines SPEC, but does not otherwise "handle" it, in
4071 the sense that it doesn't set up members of IT from the display
4074 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4075 Lisp_Object overlay
, struct text_pos
*position
,
4076 EMACS_INT bufpos
, int frame_window_p
)
4078 int replacing_p
= 0;
4081 /* Simple specerties. */
4082 && !EQ (XCAR (spec
), Qimage
)
4083 && !EQ (XCAR (spec
), Qspace
)
4084 && !EQ (XCAR (spec
), Qwhen
)
4085 && !EQ (XCAR (spec
), Qslice
)
4086 && !EQ (XCAR (spec
), Qspace_width
)
4087 && !EQ (XCAR (spec
), Qheight
)
4088 && !EQ (XCAR (spec
), Qraise
)
4089 /* Marginal area specifications. */
4090 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4091 && !EQ (XCAR (spec
), Qleft_fringe
)
4092 && !EQ (XCAR (spec
), Qright_fringe
)
4093 && !NILP (XCAR (spec
)))
4095 for (; CONSP (spec
); spec
= XCDR (spec
))
4097 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4098 position
, bufpos
, replacing_p
,
4102 /* If some text in a string is replaced, `position' no
4103 longer points to the position of `object'. */
4104 if (!it
|| STRINGP (object
))
4109 else if (VECTORP (spec
))
4112 for (i
= 0; i
< ASIZE (spec
); ++i
)
4113 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4114 position
, bufpos
, replacing_p
,
4118 /* If some text in a string is replaced, `position' no
4119 longer points to the position of `object'. */
4120 if (!it
|| STRINGP (object
))
4126 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4127 position
, bufpos
, 0, frame_window_p
))
4134 /* Value is the position of the end of the `display' property starting
4135 at START_POS in OBJECT. */
4137 static struct text_pos
4138 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4141 struct text_pos end_pos
;
4143 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4144 Qdisplay
, object
, Qnil
);
4145 CHARPOS (end_pos
) = XFASTINT (end
);
4146 if (STRINGP (object
))
4147 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4149 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4155 /* Set up IT from a single `display' property specification SPEC. OBJECT
4156 is the object in which the `display' property was found. *POSITION
4157 is the position in OBJECT at which the `display' property was found.
4158 BUFPOS is the buffer position of OBJECT (different from POSITION if
4159 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4160 previously saw a display specification which already replaced text
4161 display with something else, for example an image; we ignore such
4162 properties after the first one has been processed.
4164 OVERLAY is the overlay this `display' property came from,
4165 or nil if it was a text property.
4167 If SPEC is a `space' or `image' specification, and in some other
4168 cases too, set *POSITION to the position where the `display'
4171 If IT is NULL, only examine the property specification in SPEC, but
4172 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4173 is intended to be displayed in a window on a GUI frame.
4175 Value is non-zero if something was found which replaces the display
4176 of buffer or string text. */
4179 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4180 Lisp_Object overlay
, struct text_pos
*position
,
4181 EMACS_INT bufpos
, int display_replaced_p
,
4185 Lisp_Object location
, value
;
4186 struct text_pos start_pos
= *position
;
4189 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4190 If the result is non-nil, use VALUE instead of SPEC. */
4192 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4201 if (!NILP (form
) && !EQ (form
, Qt
))
4203 int count
= SPECPDL_INDEX ();
4204 struct gcpro gcpro1
;
4206 /* Bind `object' to the object having the `display' property, a
4207 buffer or string. Bind `position' to the position in the
4208 object where the property was found, and `buffer-position'
4209 to the current position in the buffer. */
4212 XSETBUFFER (object
, current_buffer
);
4213 specbind (Qobject
, object
);
4214 specbind (Qposition
, make_number (CHARPOS (*position
)));
4215 specbind (Qbuffer_position
, make_number (bufpos
));
4217 form
= safe_eval (form
);
4219 unbind_to (count
, Qnil
);
4225 /* Handle `(height HEIGHT)' specifications. */
4227 && EQ (XCAR (spec
), Qheight
)
4228 && CONSP (XCDR (spec
)))
4232 if (!FRAME_WINDOW_P (it
->f
))
4235 it
->font_height
= XCAR (XCDR (spec
));
4236 if (!NILP (it
->font_height
))
4238 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4239 int new_height
= -1;
4241 if (CONSP (it
->font_height
)
4242 && (EQ (XCAR (it
->font_height
), Qplus
)
4243 || EQ (XCAR (it
->font_height
), Qminus
))
4244 && CONSP (XCDR (it
->font_height
))
4245 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4247 /* `(+ N)' or `(- N)' where N is an integer. */
4248 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4249 if (EQ (XCAR (it
->font_height
), Qplus
))
4251 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4253 else if (FUNCTIONP (it
->font_height
))
4255 /* Call function with current height as argument.
4256 Value is the new height. */
4258 height
= safe_call1 (it
->font_height
,
4259 face
->lface
[LFACE_HEIGHT_INDEX
]);
4260 if (NUMBERP (height
))
4261 new_height
= XFLOATINT (height
);
4263 else if (NUMBERP (it
->font_height
))
4265 /* Value is a multiple of the canonical char height. */
4268 f
= FACE_FROM_ID (it
->f
,
4269 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4270 new_height
= (XFLOATINT (it
->font_height
)
4271 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4275 /* Evaluate IT->font_height with `height' bound to the
4276 current specified height to get the new height. */
4277 int count
= SPECPDL_INDEX ();
4279 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4280 value
= safe_eval (it
->font_height
);
4281 unbind_to (count
, Qnil
);
4283 if (NUMBERP (value
))
4284 new_height
= XFLOATINT (value
);
4288 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4295 /* Handle `(space-width WIDTH)'. */
4297 && EQ (XCAR (spec
), Qspace_width
)
4298 && CONSP (XCDR (spec
)))
4302 if (!FRAME_WINDOW_P (it
->f
))
4305 value
= XCAR (XCDR (spec
));
4306 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4307 it
->space_width
= value
;
4313 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4315 && EQ (XCAR (spec
), Qslice
))
4321 if (!FRAME_WINDOW_P (it
->f
))
4324 if (tem
= XCDR (spec
), CONSP (tem
))
4326 it
->slice
.x
= XCAR (tem
);
4327 if (tem
= XCDR (tem
), CONSP (tem
))
4329 it
->slice
.y
= XCAR (tem
);
4330 if (tem
= XCDR (tem
), CONSP (tem
))
4332 it
->slice
.width
= XCAR (tem
);
4333 if (tem
= XCDR (tem
), CONSP (tem
))
4334 it
->slice
.height
= XCAR (tem
);
4343 /* Handle `(raise FACTOR)'. */
4345 && EQ (XCAR (spec
), Qraise
)
4346 && CONSP (XCDR (spec
)))
4350 if (!FRAME_WINDOW_P (it
->f
))
4353 #ifdef HAVE_WINDOW_SYSTEM
4354 value
= XCAR (XCDR (spec
));
4355 if (NUMBERP (value
))
4357 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4358 it
->voffset
= - (XFLOATINT (value
)
4359 * (FONT_HEIGHT (face
->font
)));
4361 #endif /* HAVE_WINDOW_SYSTEM */
4367 /* Don't handle the other kinds of display specifications
4368 inside a string that we got from a `display' property. */
4369 if (it
&& it
->string_from_display_prop_p
)
4372 /* Characters having this form of property are not displayed, so
4373 we have to find the end of the property. */
4376 start_pos
= *position
;
4377 *position
= display_prop_end (it
, object
, start_pos
);
4381 /* Stop the scan at that end position--we assume that all
4382 text properties change there. */
4384 it
->stop_charpos
= position
->charpos
;
4386 /* Handle `(left-fringe BITMAP [FACE])'
4387 and `(right-fringe BITMAP [FACE])'. */
4389 && (EQ (XCAR (spec
), Qleft_fringe
)
4390 || EQ (XCAR (spec
), Qright_fringe
))
4391 && CONSP (XCDR (spec
)))
4397 if (!FRAME_WINDOW_P (it
->f
))
4398 /* If we return here, POSITION has been advanced
4399 across the text with this property. */
4402 else if (!frame_window_p
)
4405 #ifdef HAVE_WINDOW_SYSTEM
4406 value
= XCAR (XCDR (spec
));
4407 if (!SYMBOLP (value
)
4408 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4409 /* If we return here, POSITION has been advanced
4410 across the text with this property. */
4415 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4417 if (CONSP (XCDR (XCDR (spec
))))
4419 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4420 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4426 /* Save current settings of IT so that we can restore them
4427 when we are finished with the glyph property value. */
4428 push_it (it
, position
);
4430 it
->area
= TEXT_AREA
;
4431 it
->what
= IT_IMAGE
;
4432 it
->image_id
= -1; /* no image */
4433 it
->position
= start_pos
;
4434 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4435 it
->method
= GET_FROM_IMAGE
;
4436 it
->from_overlay
= Qnil
;
4437 it
->face_id
= face_id
;
4438 it
->from_disp_prop_p
= 1;
4440 /* Say that we haven't consumed the characters with
4441 `display' property yet. The call to pop_it in
4442 set_iterator_to_next will clean this up. */
4443 *position
= start_pos
;
4445 if (EQ (XCAR (spec
), Qleft_fringe
))
4447 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4448 it
->left_user_fringe_face_id
= face_id
;
4452 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4453 it
->right_user_fringe_face_id
= face_id
;
4456 #endif /* HAVE_WINDOW_SYSTEM */
4460 /* Prepare to handle `((margin left-margin) ...)',
4461 `((margin right-margin) ...)' and `((margin nil) ...)'
4462 prefixes for display specifications. */
4463 location
= Qunbound
;
4464 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4468 value
= XCDR (spec
);
4470 value
= XCAR (value
);
4473 if (EQ (XCAR (tem
), Qmargin
)
4474 && (tem
= XCDR (tem
),
4475 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4477 || EQ (tem
, Qleft_margin
)
4478 || EQ (tem
, Qright_margin
))))
4482 if (EQ (location
, Qunbound
))
4488 /* After this point, VALUE is the property after any
4489 margin prefix has been stripped. It must be a string,
4490 an image specification, or `(space ...)'.
4492 LOCATION specifies where to display: `left-margin',
4493 `right-margin' or nil. */
4495 valid_p
= (STRINGP (value
)
4496 #ifdef HAVE_WINDOW_SYSTEM
4497 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4498 && valid_image_p (value
))
4499 #endif /* not HAVE_WINDOW_SYSTEM */
4500 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4502 if (valid_p
&& !display_replaced_p
)
4507 /* Save current settings of IT so that we can restore them
4508 when we are finished with the glyph property value. */
4509 push_it (it
, position
);
4510 it
->from_overlay
= overlay
;
4511 it
->from_disp_prop_p
= 1;
4513 if (NILP (location
))
4514 it
->area
= TEXT_AREA
;
4515 else if (EQ (location
, Qleft_margin
))
4516 it
->area
= LEFT_MARGIN_AREA
;
4518 it
->area
= RIGHT_MARGIN_AREA
;
4520 if (STRINGP (value
))
4523 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4524 it
->current
.overlay_string_index
= -1;
4525 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4526 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4527 it
->method
= GET_FROM_STRING
;
4528 it
->stop_charpos
= 0;
4530 it
->base_level_stop
= 0;
4531 it
->string_from_display_prop_p
= 1;
4532 /* Say that we haven't consumed the characters with
4533 `display' property yet. The call to pop_it in
4534 set_iterator_to_next will clean this up. */
4535 if (BUFFERP (object
))
4536 *position
= start_pos
;
4538 /* Force paragraph direction to be that of the parent
4539 object. If the parent object's paragraph direction is
4540 not yet determined, default to L2R. */
4541 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4542 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4544 it
->paragraph_embedding
= L2R
;
4546 /* Set up the bidi iterator for this display string. */
4549 it
->bidi_it
.string
.lstring
= it
->string
;
4550 it
->bidi_it
.string
.s
= NULL
;
4551 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4552 it
->bidi_it
.string
.bufpos
= bufpos
;
4553 it
->bidi_it
.string
.from_disp_str
= 1;
4554 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4555 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4558 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4560 it
->method
= GET_FROM_STRETCH
;
4562 *position
= it
->position
= start_pos
;
4564 #ifdef HAVE_WINDOW_SYSTEM
4567 it
->what
= IT_IMAGE
;
4568 it
->image_id
= lookup_image (it
->f
, value
);
4569 it
->position
= start_pos
;
4570 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4571 it
->method
= GET_FROM_IMAGE
;
4573 /* Say that we haven't consumed the characters with
4574 `display' property yet. The call to pop_it in
4575 set_iterator_to_next will clean this up. */
4576 *position
= start_pos
;
4578 #endif /* HAVE_WINDOW_SYSTEM */
4583 /* Invalid property or property not supported. Restore
4584 POSITION to what it was before. */
4585 *position
= start_pos
;
4589 /* Check if PROP is a display property value whose text should be
4590 treated as intangible. OVERLAY is the overlay from which PROP
4591 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4592 specify the buffer position covered by PROP. */
4595 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4596 EMACS_INT charpos
, EMACS_INT bytepos
)
4598 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4599 struct text_pos position
;
4601 SET_TEXT_POS (position
, charpos
, bytepos
);
4602 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4603 &position
, charpos
, frame_window_p
);
4607 /* Return 1 if PROP is a display sub-property value containing STRING.
4609 Implementation note: this and the following function are really
4610 special cases of handle_display_spec and
4611 handle_single_display_spec, and should ideally use the same code.
4612 Until they do, these two pairs must be consistent and must be
4613 modified in sync. */
4616 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4618 if (EQ (string
, prop
))
4621 /* Skip over `when FORM'. */
4622 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4627 /* Actually, the condition following `when' should be eval'ed,
4628 like handle_single_display_spec does, and we should return
4629 zero if it evaluates to nil. However, this function is
4630 called only when the buffer was already displayed and some
4631 glyph in the glyph matrix was found to come from a display
4632 string. Therefore, the condition was already evaluated, and
4633 the result was non-nil, otherwise the display string wouldn't
4634 have been displayed and we would have never been called for
4635 this property. Thus, we can skip the evaluation and assume
4636 its result is non-nil. */
4641 /* Skip over `margin LOCATION'. */
4642 if (EQ (XCAR (prop
), Qmargin
))
4653 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4657 /* Return 1 if STRING appears in the `display' property PROP. */
4660 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4663 && !EQ (XCAR (prop
), Qwhen
)
4664 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4666 /* A list of sub-properties. */
4667 while (CONSP (prop
))
4669 if (single_display_spec_string_p (XCAR (prop
), string
))
4674 else if (VECTORP (prop
))
4676 /* A vector of sub-properties. */
4678 for (i
= 0; i
< ASIZE (prop
); ++i
)
4679 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4683 return single_display_spec_string_p (prop
, string
);
4688 /* Look for STRING in overlays and text properties in the current
4689 buffer, between character positions FROM and TO (excluding TO).
4690 BACK_P non-zero means look back (in this case, TO is supposed to be
4692 Value is the first character position where STRING was found, or
4693 zero if it wasn't found before hitting TO.
4695 This function may only use code that doesn't eval because it is
4696 called asynchronously from note_mouse_highlight. */
4699 string_buffer_position_lim (Lisp_Object string
,
4700 EMACS_INT from
, EMACS_INT to
, int back_p
)
4702 Lisp_Object limit
, prop
, pos
;
4705 pos
= make_number (from
);
4707 if (!back_p
) /* looking forward */
4709 limit
= make_number (min (to
, ZV
));
4710 while (!found
&& !EQ (pos
, limit
))
4712 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4713 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4716 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4720 else /* looking back */
4722 limit
= make_number (max (to
, BEGV
));
4723 while (!found
&& !EQ (pos
, limit
))
4725 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4726 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4729 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4734 return found
? XINT (pos
) : 0;
4737 /* Determine which buffer position in current buffer STRING comes from.
4738 AROUND_CHARPOS is an approximate position where it could come from.
4739 Value is the buffer position or 0 if it couldn't be determined.
4741 This function is necessary because we don't record buffer positions
4742 in glyphs generated from strings (to keep struct glyph small).
4743 This function may only use code that doesn't eval because it is
4744 called asynchronously from note_mouse_highlight. */
4747 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4749 const int MAX_DISTANCE
= 1000;
4750 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4751 around_charpos
+ MAX_DISTANCE
,
4755 found
= string_buffer_position_lim (string
, around_charpos
,
4756 around_charpos
- MAX_DISTANCE
, 1);
4762 /***********************************************************************
4763 `composition' property
4764 ***********************************************************************/
4766 /* Set up iterator IT from `composition' property at its current
4767 position. Called from handle_stop. */
4769 static enum prop_handled
4770 handle_composition_prop (struct it
*it
)
4772 Lisp_Object prop
, string
;
4773 EMACS_INT pos
, pos_byte
, start
, end
;
4775 if (STRINGP (it
->string
))
4779 pos
= IT_STRING_CHARPOS (*it
);
4780 pos_byte
= IT_STRING_BYTEPOS (*it
);
4781 string
= it
->string
;
4782 s
= SDATA (string
) + pos_byte
;
4783 it
->c
= STRING_CHAR (s
);
4787 pos
= IT_CHARPOS (*it
);
4788 pos_byte
= IT_BYTEPOS (*it
);
4790 it
->c
= FETCH_CHAR (pos_byte
);
4793 /* If there's a valid composition and point is not inside of the
4794 composition (in the case that the composition is from the current
4795 buffer), draw a glyph composed from the composition components. */
4796 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4797 && COMPOSITION_VALID_P (start
, end
, prop
)
4798 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4801 /* As we can't handle this situation (perhaps font-lock added
4802 a new composition), we just return here hoping that next
4803 redisplay will detect this composition much earlier. */
4804 return HANDLED_NORMALLY
;
4807 if (STRINGP (it
->string
))
4808 pos_byte
= string_char_to_byte (it
->string
, start
);
4810 pos_byte
= CHAR_TO_BYTE (start
);
4812 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4815 if (it
->cmp_it
.id
>= 0)
4818 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4819 it
->cmp_it
.nglyphs
= -1;
4823 return HANDLED_NORMALLY
;
4828 /***********************************************************************
4830 ***********************************************************************/
4832 /* The following structure is used to record overlay strings for
4833 later sorting in load_overlay_strings. */
4835 struct overlay_entry
4837 Lisp_Object overlay
;
4844 /* Set up iterator IT from overlay strings at its current position.
4845 Called from handle_stop. */
4847 static enum prop_handled
4848 handle_overlay_change (struct it
*it
)
4850 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4851 return HANDLED_RECOMPUTE_PROPS
;
4853 return HANDLED_NORMALLY
;
4857 /* Set up the next overlay string for delivery by IT, if there is an
4858 overlay string to deliver. Called by set_iterator_to_next when the
4859 end of the current overlay string is reached. If there are more
4860 overlay strings to display, IT->string and
4861 IT->current.overlay_string_index are set appropriately here.
4862 Otherwise IT->string is set to nil. */
4865 next_overlay_string (struct it
*it
)
4867 ++it
->current
.overlay_string_index
;
4868 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4870 /* No more overlay strings. Restore IT's settings to what
4871 they were before overlay strings were processed, and
4872 continue to deliver from current_buffer. */
4874 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4877 || (NILP (it
->string
)
4878 && it
->method
== GET_FROM_BUFFER
4879 && it
->stop_charpos
>= BEGV
4880 && it
->stop_charpos
<= it
->end_charpos
));
4881 it
->current
.overlay_string_index
= -1;
4882 it
->n_overlay_strings
= 0;
4883 it
->overlay_strings_charpos
= -1;
4885 /* If we're at the end of the buffer, record that we have
4886 processed the overlay strings there already, so that
4887 next_element_from_buffer doesn't try it again. */
4888 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4889 it
->overlay_strings_at_end_processed_p
= 1;
4893 /* There are more overlay strings to process. If
4894 IT->current.overlay_string_index has advanced to a position
4895 where we must load IT->overlay_strings with more strings, do
4896 it. We must load at the IT->overlay_strings_charpos where
4897 IT->n_overlay_strings was originally computed; when invisible
4898 text is present, this might not be IT_CHARPOS (Bug#7016). */
4899 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4901 if (it
->current
.overlay_string_index
&& i
== 0)
4902 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4904 /* Initialize IT to deliver display elements from the overlay
4906 it
->string
= it
->overlay_strings
[i
];
4907 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4908 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4909 it
->method
= GET_FROM_STRING
;
4910 it
->stop_charpos
= 0;
4911 if (it
->cmp_it
.stop_pos
>= 0)
4912 it
->cmp_it
.stop_pos
= 0;
4914 it
->base_level_stop
= 0;
4916 /* Set up the bidi iterator for this overlay string. */
4919 it
->bidi_it
.string
.lstring
= it
->string
;
4920 it
->bidi_it
.string
.s
= NULL
;
4921 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4922 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4923 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4924 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4925 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4933 /* Compare two overlay_entry structures E1 and E2. Used as a
4934 comparison function for qsort in load_overlay_strings. Overlay
4935 strings for the same position are sorted so that
4937 1. All after-strings come in front of before-strings, except
4938 when they come from the same overlay.
4940 2. Within after-strings, strings are sorted so that overlay strings
4941 from overlays with higher priorities come first.
4943 2. Within before-strings, strings are sorted so that overlay
4944 strings from overlays with higher priorities come last.
4946 Value is analogous to strcmp. */
4950 compare_overlay_entries (const void *e1
, const void *e2
)
4952 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4953 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4956 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4958 /* Let after-strings appear in front of before-strings if
4959 they come from different overlays. */
4960 if (EQ (entry1
->overlay
, entry2
->overlay
))
4961 result
= entry1
->after_string_p
? 1 : -1;
4963 result
= entry1
->after_string_p
? -1 : 1;
4965 else if (entry1
->after_string_p
)
4966 /* After-strings sorted in order of decreasing priority. */
4967 result
= entry2
->priority
- entry1
->priority
;
4969 /* Before-strings sorted in order of increasing priority. */
4970 result
= entry1
->priority
- entry2
->priority
;
4976 /* Load the vector IT->overlay_strings with overlay strings from IT's
4977 current buffer position, or from CHARPOS if that is > 0. Set
4978 IT->n_overlays to the total number of overlay strings found.
4980 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4981 a time. On entry into load_overlay_strings,
4982 IT->current.overlay_string_index gives the number of overlay
4983 strings that have already been loaded by previous calls to this
4986 IT->add_overlay_start contains an additional overlay start
4987 position to consider for taking overlay strings from, if non-zero.
4988 This position comes into play when the overlay has an `invisible'
4989 property, and both before and after-strings. When we've skipped to
4990 the end of the overlay, because of its `invisible' property, we
4991 nevertheless want its before-string to appear.
4992 IT->add_overlay_start will contain the overlay start position
4995 Overlay strings are sorted so that after-string strings come in
4996 front of before-string strings. Within before and after-strings,
4997 strings are sorted by overlay priority. See also function
4998 compare_overlay_entries. */
5001 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5003 Lisp_Object overlay
, window
, str
, invisible
;
5004 struct Lisp_Overlay
*ov
;
5005 EMACS_INT start
, end
;
5007 int n
= 0, i
, j
, invis_p
;
5008 struct overlay_entry
*entries
5009 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5012 charpos
= IT_CHARPOS (*it
);
5014 /* Append the overlay string STRING of overlay OVERLAY to vector
5015 `entries' which has size `size' and currently contains `n'
5016 elements. AFTER_P non-zero means STRING is an after-string of
5018 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5021 Lisp_Object priority; \
5025 int new_size = 2 * size; \
5026 struct overlay_entry *old = entries; \
5028 (struct overlay_entry *) alloca (new_size \
5029 * sizeof *entries); \
5030 memcpy (entries, old, size * sizeof *entries); \
5034 entries[n].string = (STRING); \
5035 entries[n].overlay = (OVERLAY); \
5036 priority = Foverlay_get ((OVERLAY), Qpriority); \
5037 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5038 entries[n].after_string_p = (AFTER_P); \
5043 /* Process overlay before the overlay center. */
5044 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5046 XSETMISC (overlay
, ov
);
5047 xassert (OVERLAYP (overlay
));
5048 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5049 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5054 /* Skip this overlay if it doesn't start or end at IT's current
5056 if (end
!= charpos
&& start
!= charpos
)
5059 /* Skip this overlay if it doesn't apply to IT->w. */
5060 window
= Foverlay_get (overlay
, Qwindow
);
5061 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5064 /* If the text ``under'' the overlay is invisible, both before-
5065 and after-strings from this overlay are visible; start and
5066 end position are indistinguishable. */
5067 invisible
= Foverlay_get (overlay
, Qinvisible
);
5068 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5070 /* If overlay has a non-empty before-string, record it. */
5071 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5072 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5074 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5076 /* If overlay has a non-empty after-string, record it. */
5077 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5078 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5080 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5083 /* Process overlays after the overlay center. */
5084 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5086 XSETMISC (overlay
, ov
);
5087 xassert (OVERLAYP (overlay
));
5088 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5089 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5091 if (start
> charpos
)
5094 /* Skip this overlay if it doesn't start or end at IT's current
5096 if (end
!= charpos
&& start
!= charpos
)
5099 /* Skip this overlay if it doesn't apply to IT->w. */
5100 window
= Foverlay_get (overlay
, Qwindow
);
5101 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5104 /* If the text ``under'' the overlay is invisible, it has a zero
5105 dimension, and both before- and after-strings apply. */
5106 invisible
= Foverlay_get (overlay
, Qinvisible
);
5107 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5109 /* If overlay has a non-empty before-string, record it. */
5110 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5111 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5113 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5115 /* If overlay has a non-empty after-string, record it. */
5116 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5117 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5119 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5122 #undef RECORD_OVERLAY_STRING
5126 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5128 /* Record number of overlay strings, and where we computed it. */
5129 it
->n_overlay_strings
= n
;
5130 it
->overlay_strings_charpos
= charpos
;
5132 /* IT->current.overlay_string_index is the number of overlay strings
5133 that have already been consumed by IT. Copy some of the
5134 remaining overlay strings to IT->overlay_strings. */
5136 j
= it
->current
.overlay_string_index
;
5137 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5139 it
->overlay_strings
[i
] = entries
[j
].string
;
5140 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5147 /* Get the first chunk of overlay strings at IT's current buffer
5148 position, or at CHARPOS if that is > 0. Value is non-zero if at
5149 least one overlay string was found. */
5152 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5154 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5155 process. This fills IT->overlay_strings with strings, and sets
5156 IT->n_overlay_strings to the total number of strings to process.
5157 IT->pos.overlay_string_index has to be set temporarily to zero
5158 because load_overlay_strings needs this; it must be set to -1
5159 when no overlay strings are found because a zero value would
5160 indicate a position in the first overlay string. */
5161 it
->current
.overlay_string_index
= 0;
5162 load_overlay_strings (it
, charpos
);
5164 /* If we found overlay strings, set up IT to deliver display
5165 elements from the first one. Otherwise set up IT to deliver
5166 from current_buffer. */
5167 if (it
->n_overlay_strings
)
5169 /* Make sure we know settings in current_buffer, so that we can
5170 restore meaningful values when we're done with the overlay
5173 compute_stop_pos (it
);
5174 xassert (it
->face_id
>= 0);
5176 /* Save IT's settings. They are restored after all overlay
5177 strings have been processed. */
5178 xassert (!compute_stop_p
|| it
->sp
== 0);
5180 /* When called from handle_stop, there might be an empty display
5181 string loaded. In that case, don't bother saving it. */
5182 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5185 /* Set up IT to deliver display elements from the first overlay
5187 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5188 it
->string
= it
->overlay_strings
[0];
5189 it
->from_overlay
= Qnil
;
5190 it
->stop_charpos
= 0;
5191 xassert (STRINGP (it
->string
));
5192 it
->end_charpos
= SCHARS (it
->string
);
5194 it
->base_level_stop
= 0;
5195 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5196 it
->method
= GET_FROM_STRING
;
5197 it
->from_disp_prop_p
= 0;
5199 /* Force paragraph direction to be that of the parent
5201 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5202 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5204 it
->paragraph_embedding
= L2R
;
5206 /* Set up the bidi iterator for this overlay string. */
5209 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5211 it
->bidi_it
.string
.lstring
= it
->string
;
5212 it
->bidi_it
.string
.s
= NULL
;
5213 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5214 it
->bidi_it
.string
.bufpos
= pos
;
5215 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5216 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5217 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5222 it
->current
.overlay_string_index
= -1;
5227 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5230 it
->method
= GET_FROM_BUFFER
;
5232 (void) get_overlay_strings_1 (it
, charpos
, 1);
5236 /* Value is non-zero if we found at least one overlay string. */
5237 return STRINGP (it
->string
);
5242 /***********************************************************************
5243 Saving and restoring state
5244 ***********************************************************************/
5246 /* Save current settings of IT on IT->stack. Called, for example,
5247 before setting up IT for an overlay string, to be able to restore
5248 IT's settings to what they were after the overlay string has been
5249 processed. If POSITION is non-NULL, it is the position to save on
5250 the stack instead of IT->position. */
5253 push_it (struct it
*it
, struct text_pos
*position
)
5255 struct iterator_stack_entry
*p
;
5257 xassert (it
->sp
< IT_STACK_SIZE
);
5258 p
= it
->stack
+ it
->sp
;
5260 p
->stop_charpos
= it
->stop_charpos
;
5261 p
->prev_stop
= it
->prev_stop
;
5262 p
->base_level_stop
= it
->base_level_stop
;
5263 p
->cmp_it
= it
->cmp_it
;
5264 xassert (it
->face_id
>= 0);
5265 p
->face_id
= it
->face_id
;
5266 p
->string
= it
->string
;
5267 p
->method
= it
->method
;
5268 p
->from_overlay
= it
->from_overlay
;
5271 case GET_FROM_IMAGE
:
5272 p
->u
.image
.object
= it
->object
;
5273 p
->u
.image
.image_id
= it
->image_id
;
5274 p
->u
.image
.slice
= it
->slice
;
5276 case GET_FROM_STRETCH
:
5277 p
->u
.stretch
.object
= it
->object
;
5280 p
->position
= position
? *position
: it
->position
;
5281 p
->current
= it
->current
;
5282 p
->end_charpos
= it
->end_charpos
;
5283 p
->string_nchars
= it
->string_nchars
;
5285 p
->multibyte_p
= it
->multibyte_p
;
5286 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5287 p
->space_width
= it
->space_width
;
5288 p
->font_height
= it
->font_height
;
5289 p
->voffset
= it
->voffset
;
5290 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5291 p
->display_ellipsis_p
= 0;
5292 p
->line_wrap
= it
->line_wrap
;
5293 p
->bidi_p
= it
->bidi_p
;
5294 p
->paragraph_embedding
= it
->paragraph_embedding
;
5295 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5298 /* Save the state of the bidi iterator as well. */
5300 bidi_push_it (&it
->bidi_it
);
5304 iterate_out_of_display_property (struct it
*it
)
5306 int buffer_p
= BUFFERP (it
->object
);
5307 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5308 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5310 /* Maybe initialize paragraph direction. If we are at the beginning
5311 of a new paragraph, next_element_from_buffer may not have a
5312 chance to do that. */
5313 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5314 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5315 /* prev_stop can be zero, so check against BEGV as well. */
5316 while (it
->bidi_it
.charpos
>= bob
5317 && it
->prev_stop
<= it
->bidi_it
.charpos
5318 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5319 bidi_move_to_visually_next (&it
->bidi_it
);
5320 /* Record the stop_pos we just crossed, for when we cross it
5322 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5323 it
->prev_stop
= CHARPOS (it
->position
);
5324 /* If we ended up not where pop_it put us, resync IT's
5325 positional members with the bidi iterator. */
5326 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5328 SET_TEXT_POS (it
->position
,
5329 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5331 it
->current
.pos
= it
->position
;
5333 it
->current
.string_pos
= it
->position
;
5337 /* Restore IT's settings from IT->stack. Called, for example, when no
5338 more overlay strings must be processed, and we return to delivering
5339 display elements from a buffer, or when the end of a string from a
5340 `display' property is reached and we return to delivering display
5341 elements from an overlay string, or from a buffer. */
5344 pop_it (struct it
*it
)
5346 struct iterator_stack_entry
*p
;
5347 int from_display_prop
= it
->from_disp_prop_p
;
5349 xassert (it
->sp
> 0);
5351 p
= it
->stack
+ it
->sp
;
5352 it
->stop_charpos
= p
->stop_charpos
;
5353 it
->prev_stop
= p
->prev_stop
;
5354 it
->base_level_stop
= p
->base_level_stop
;
5355 it
->cmp_it
= p
->cmp_it
;
5356 it
->face_id
= p
->face_id
;
5357 it
->current
= p
->current
;
5358 it
->position
= p
->position
;
5359 it
->string
= p
->string
;
5360 it
->from_overlay
= p
->from_overlay
;
5361 if (NILP (it
->string
))
5362 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5363 it
->method
= p
->method
;
5366 case GET_FROM_IMAGE
:
5367 it
->image_id
= p
->u
.image
.image_id
;
5368 it
->object
= p
->u
.image
.object
;
5369 it
->slice
= p
->u
.image
.slice
;
5371 case GET_FROM_STRETCH
:
5372 it
->object
= p
->u
.stretch
.object
;
5374 case GET_FROM_BUFFER
:
5375 it
->object
= it
->w
->buffer
;
5377 case GET_FROM_STRING
:
5378 it
->object
= it
->string
;
5380 case GET_FROM_DISPLAY_VECTOR
:
5382 it
->method
= GET_FROM_C_STRING
;
5383 else if (STRINGP (it
->string
))
5384 it
->method
= GET_FROM_STRING
;
5387 it
->method
= GET_FROM_BUFFER
;
5388 it
->object
= it
->w
->buffer
;
5391 it
->end_charpos
= p
->end_charpos
;
5392 it
->string_nchars
= p
->string_nchars
;
5394 it
->multibyte_p
= p
->multibyte_p
;
5395 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5396 it
->space_width
= p
->space_width
;
5397 it
->font_height
= p
->font_height
;
5398 it
->voffset
= p
->voffset
;
5399 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5400 it
->line_wrap
= p
->line_wrap
;
5401 it
->bidi_p
= p
->bidi_p
;
5402 it
->paragraph_embedding
= p
->paragraph_embedding
;
5403 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5406 bidi_pop_it (&it
->bidi_it
);
5407 /* Bidi-iterate until we get out of the portion of text, if any,
5408 covered by a `display' text property or by an overlay with
5409 `display' property. (We cannot just jump there, because the
5410 internal coherency of the bidi iterator state can not be
5411 preserved across such jumps.) We also must determine the
5412 paragraph base direction if the overlay we just processed is
5413 at the beginning of a new paragraph. */
5414 if (from_display_prop
5415 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5416 iterate_out_of_display_property (it
);
5418 xassert ((BUFFERP (it
->object
)
5419 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5420 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5421 || (STRINGP (it
->object
)
5422 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5423 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5429 /***********************************************************************
5431 ***********************************************************************/
5433 /* Set IT's current position to the previous line start. */
5436 back_to_previous_line_start (struct it
*it
)
5438 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5439 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5443 /* Move IT to the next line start.
5445 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5446 we skipped over part of the text (as opposed to moving the iterator
5447 continuously over the text). Otherwise, don't change the value
5450 Newlines may come from buffer text, overlay strings, or strings
5451 displayed via the `display' property. That's the reason we can't
5452 simply use find_next_newline_no_quit.
5454 Note that this function may not skip over invisible text that is so
5455 because of text properties and immediately follows a newline. If
5456 it would, function reseat_at_next_visible_line_start, when called
5457 from set_iterator_to_next, would effectively make invisible
5458 characters following a newline part of the wrong glyph row, which
5459 leads to wrong cursor motion. */
5462 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5464 EMACS_INT old_selective
;
5465 int newline_found_p
, n
;
5466 const int MAX_NEWLINE_DISTANCE
= 500;
5468 /* If already on a newline, just consume it to avoid unintended
5469 skipping over invisible text below. */
5470 if (it
->what
== IT_CHARACTER
5472 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5474 set_iterator_to_next (it
, 0);
5479 /* Don't handle selective display in the following. It's (a)
5480 unnecessary because it's done by the caller, and (b) leads to an
5481 infinite recursion because next_element_from_ellipsis indirectly
5482 calls this function. */
5483 old_selective
= it
->selective
;
5486 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5487 from buffer text. */
5488 for (n
= newline_found_p
= 0;
5489 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5490 n
+= STRINGP (it
->string
) ? 0 : 1)
5492 if (!get_next_display_element (it
))
5494 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5495 set_iterator_to_next (it
, 0);
5498 /* If we didn't find a newline near enough, see if we can use a
5500 if (!newline_found_p
)
5502 EMACS_INT start
= IT_CHARPOS (*it
);
5503 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5506 xassert (!STRINGP (it
->string
));
5508 /* If we are not bidi-reordering, and there isn't any `display'
5509 property in sight, and no overlays, we can just use the
5510 position of the newline in buffer text. */
5512 && (it
->stop_charpos
>= limit
5513 || ((pos
= Fnext_single_property_change (make_number (start
),
5515 make_number (limit
)),
5517 && next_overlay_change (start
) == ZV
)))
5519 IT_CHARPOS (*it
) = limit
;
5520 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5521 *skipped_p
= newline_found_p
= 1;
5525 while (get_next_display_element (it
)
5526 && !newline_found_p
)
5528 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5529 set_iterator_to_next (it
, 0);
5534 it
->selective
= old_selective
;
5535 return newline_found_p
;
5539 /* Set IT's current position to the previous visible line start. Skip
5540 invisible text that is so either due to text properties or due to
5541 selective display. Caution: this does not change IT->current_x and
5545 back_to_previous_visible_line_start (struct it
*it
)
5547 while (IT_CHARPOS (*it
) > BEGV
)
5549 back_to_previous_line_start (it
);
5551 if (IT_CHARPOS (*it
) <= BEGV
)
5554 /* If selective > 0, then lines indented more than its value are
5556 if (it
->selective
> 0
5557 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5561 /* Check the newline before point for invisibility. */
5564 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5565 Qinvisible
, it
->window
);
5566 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5570 if (IT_CHARPOS (*it
) <= BEGV
)
5575 void *it2data
= NULL
;
5578 Lisp_Object val
, overlay
;
5580 SAVE_IT (it2
, *it
, it2data
);
5582 /* If newline is part of a composition, continue from start of composition */
5583 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5584 && beg
< IT_CHARPOS (*it
))
5587 /* If newline is replaced by a display property, find start of overlay
5588 or interval and continue search from that point. */
5589 pos
= --IT_CHARPOS (it2
);
5592 bidi_unshelve_cache (NULL
);
5593 it2
.string_from_display_prop_p
= 0;
5594 it2
.from_disp_prop_p
= 0;
5595 if (handle_display_prop (&it2
) == HANDLED_RETURN
5596 && !NILP (val
= get_char_property_and_overlay
5597 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5598 && (OVERLAYP (overlay
)
5599 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5600 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5602 RESTORE_IT (it
, it
, it2data
);
5606 /* Newline is not replaced by anything -- so we are done. */
5607 RESTORE_IT (it
, it
, it2data
);
5613 IT_CHARPOS (*it
) = beg
;
5614 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5618 it
->continuation_lines_width
= 0;
5620 xassert (IT_CHARPOS (*it
) >= BEGV
);
5621 xassert (IT_CHARPOS (*it
) == BEGV
5622 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5627 /* Reseat iterator IT at the previous visible line start. Skip
5628 invisible text that is so either due to text properties or due to
5629 selective display. At the end, update IT's overlay information,
5630 face information etc. */
5633 reseat_at_previous_visible_line_start (struct it
*it
)
5635 back_to_previous_visible_line_start (it
);
5636 reseat (it
, it
->current
.pos
, 1);
5641 /* Reseat iterator IT on the next visible line start in the current
5642 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5643 preceding the line start. Skip over invisible text that is so
5644 because of selective display. Compute faces, overlays etc at the
5645 new position. Note that this function does not skip over text that
5646 is invisible because of text properties. */
5649 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5651 int newline_found_p
, skipped_p
= 0;
5653 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5655 /* Skip over lines that are invisible because they are indented
5656 more than the value of IT->selective. */
5657 if (it
->selective
> 0)
5658 while (IT_CHARPOS (*it
) < ZV
5659 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5662 xassert (IT_BYTEPOS (*it
) == BEGV
5663 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5664 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5667 /* Position on the newline if that's what's requested. */
5668 if (on_newline_p
&& newline_found_p
)
5670 if (STRINGP (it
->string
))
5672 if (IT_STRING_CHARPOS (*it
) > 0)
5676 --IT_STRING_CHARPOS (*it
);
5677 --IT_STRING_BYTEPOS (*it
);
5680 /* Setting this flag will cause
5681 bidi_move_to_visually_next not to advance, but
5682 instead deliver the current character (newline),
5683 which is what the ON_NEWLINE_P flag wants. */
5684 it
->bidi_it
.first_elt
= 1;
5687 else if (IT_CHARPOS (*it
) > BEGV
)
5694 /* With bidi iteration, the call to `reseat' will cause
5695 bidi_move_to_visually_next deliver the current character,
5696 the newline, instead of advancing. */
5697 reseat (it
, it
->current
.pos
, 0);
5701 reseat (it
, it
->current
.pos
, 0);
5708 /***********************************************************************
5709 Changing an iterator's position
5710 ***********************************************************************/
5712 /* Change IT's current position to POS in current_buffer. If FORCE_P
5713 is non-zero, always check for text properties at the new position.
5714 Otherwise, text properties are only looked up if POS >=
5715 IT->check_charpos of a property. */
5718 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5720 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5722 reseat_1 (it
, pos
, 0);
5724 /* Determine where to check text properties. Avoid doing it
5725 where possible because text property lookup is very expensive. */
5727 || CHARPOS (pos
) > it
->stop_charpos
5728 || CHARPOS (pos
) < original_pos
)
5732 /* For bidi iteration, we need to prime prev_stop and
5733 base_level_stop with our best estimations. */
5734 if (CHARPOS (pos
) < it
->prev_stop
)
5736 handle_stop_backwards (it
, BEGV
);
5737 if (CHARPOS (pos
) < it
->base_level_stop
)
5738 it
->base_level_stop
= 0;
5740 else if (CHARPOS (pos
) > it
->stop_charpos
5741 && it
->stop_charpos
>= BEGV
)
5742 handle_stop_backwards (it
, it
->stop_charpos
);
5749 it
->prev_stop
= it
->base_level_stop
= 0;
5758 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5759 IT->stop_pos to POS, also. */
5762 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5764 /* Don't call this function when scanning a C string. */
5765 xassert (it
->s
== NULL
);
5767 /* POS must be a reasonable value. */
5768 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5770 it
->current
.pos
= it
->position
= pos
;
5771 it
->end_charpos
= ZV
;
5773 it
->current
.dpvec_index
= -1;
5774 it
->current
.overlay_string_index
= -1;
5775 IT_STRING_CHARPOS (*it
) = -1;
5776 IT_STRING_BYTEPOS (*it
) = -1;
5778 it
->method
= GET_FROM_BUFFER
;
5779 it
->object
= it
->w
->buffer
;
5780 it
->area
= TEXT_AREA
;
5781 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5783 it
->string_from_display_prop_p
= 0;
5784 it
->from_disp_prop_p
= 0;
5785 it
->face_before_selective_p
= 0;
5788 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5790 bidi_unshelve_cache (NULL
);
5791 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5792 it
->bidi_it
.string
.s
= NULL
;
5793 it
->bidi_it
.string
.lstring
= Qnil
;
5794 it
->bidi_it
.string
.bufpos
= 0;
5795 it
->bidi_it
.string
.unibyte
= 0;
5800 it
->stop_charpos
= CHARPOS (pos
);
5801 it
->base_level_stop
= CHARPOS (pos
);
5806 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5807 If S is non-null, it is a C string to iterate over. Otherwise,
5808 STRING gives a Lisp string to iterate over.
5810 If PRECISION > 0, don't return more then PRECISION number of
5811 characters from the string.
5813 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5814 characters have been returned. FIELD_WIDTH < 0 means an infinite
5817 MULTIBYTE = 0 means disable processing of multibyte characters,
5818 MULTIBYTE > 0 means enable it,
5819 MULTIBYTE < 0 means use IT->multibyte_p.
5821 IT must be initialized via a prior call to init_iterator before
5822 calling this function. */
5825 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5826 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5829 /* No region in strings. */
5830 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5832 /* No text property checks performed by default, but see below. */
5833 it
->stop_charpos
= -1;
5835 /* Set iterator position and end position. */
5836 memset (&it
->current
, 0, sizeof it
->current
);
5837 it
->current
.overlay_string_index
= -1;
5838 it
->current
.dpvec_index
= -1;
5839 xassert (charpos
>= 0);
5841 /* If STRING is specified, use its multibyteness, otherwise use the
5842 setting of MULTIBYTE, if specified. */
5844 it
->multibyte_p
= multibyte
> 0;
5846 /* Bidirectional reordering of strings is controlled by the default
5847 value of bidi-display-reordering. */
5848 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5852 xassert (STRINGP (string
));
5853 it
->string
= string
;
5855 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5856 it
->method
= GET_FROM_STRING
;
5857 it
->current
.string_pos
= string_pos (charpos
, string
);
5861 it
->bidi_it
.string
.lstring
= string
;
5862 it
->bidi_it
.string
.s
= NULL
;
5863 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5864 it
->bidi_it
.string
.bufpos
= 0;
5865 it
->bidi_it
.string
.from_disp_str
= 0;
5866 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5867 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5868 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5873 it
->s
= (const unsigned char *) s
;
5876 /* Note that we use IT->current.pos, not it->current.string_pos,
5877 for displaying C strings. */
5878 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5879 if (it
->multibyte_p
)
5881 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5882 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5886 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5887 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5892 it
->bidi_it
.string
.lstring
= Qnil
;
5893 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5894 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5895 it
->bidi_it
.string
.bufpos
= 0;
5896 it
->bidi_it
.string
.from_disp_str
= 0;
5897 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5898 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5901 it
->method
= GET_FROM_C_STRING
;
5904 /* PRECISION > 0 means don't return more than PRECISION characters
5906 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5908 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5910 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5913 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5914 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5915 FIELD_WIDTH < 0 means infinite field width. This is useful for
5916 padding with `-' at the end of a mode line. */
5917 if (field_width
< 0)
5918 field_width
= INFINITY
;
5919 /* Implementation note: We deliberately don't enlarge
5920 it->bidi_it.string.schars here to fit it->end_charpos, because
5921 the bidi iterator cannot produce characters out of thin air. */
5922 if (field_width
> it
->end_charpos
- charpos
)
5923 it
->end_charpos
= charpos
+ field_width
;
5925 /* Use the standard display table for displaying strings. */
5926 if (DISP_TABLE_P (Vstandard_display_table
))
5927 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5929 it
->stop_charpos
= charpos
;
5930 it
->prev_stop
= charpos
;
5931 it
->base_level_stop
= 0;
5934 it
->bidi_it
.first_elt
= 1;
5935 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5936 it
->bidi_it
.disp_pos
= -1;
5938 if (s
== NULL
&& it
->multibyte_p
)
5940 EMACS_INT endpos
= SCHARS (it
->string
);
5941 if (endpos
> it
->end_charpos
)
5942 endpos
= it
->end_charpos
;
5943 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5951 /***********************************************************************
5953 ***********************************************************************/
5955 /* Map enum it_method value to corresponding next_element_from_* function. */
5957 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5959 next_element_from_buffer
,
5960 next_element_from_display_vector
,
5961 next_element_from_string
,
5962 next_element_from_c_string
,
5963 next_element_from_image
,
5964 next_element_from_stretch
5967 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5970 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5971 (possibly with the following characters). */
5973 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5974 ((IT)->cmp_it.id >= 0 \
5975 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5976 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5977 END_CHARPOS, (IT)->w, \
5978 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5982 /* Lookup the char-table Vglyphless_char_display for character C (-1
5983 if we want information for no-font case), and return the display
5984 method symbol. By side-effect, update it->what and
5985 it->glyphless_method. This function is called from
5986 get_next_display_element for each character element, and from
5987 x_produce_glyphs when no suitable font was found. */
5990 lookup_glyphless_char_display (int c
, struct it
*it
)
5992 Lisp_Object glyphless_method
= Qnil
;
5994 if (CHAR_TABLE_P (Vglyphless_char_display
)
5995 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5999 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6000 if (CONSP (glyphless_method
))
6001 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6002 ? XCAR (glyphless_method
)
6003 : XCDR (glyphless_method
);
6006 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6010 if (NILP (glyphless_method
))
6013 /* The default is to display the character by a proper font. */
6015 /* The default for the no-font case is to display an empty box. */
6016 glyphless_method
= Qempty_box
;
6018 if (EQ (glyphless_method
, Qzero_width
))
6021 return glyphless_method
;
6022 /* This method can't be used for the no-font case. */
6023 glyphless_method
= Qempty_box
;
6025 if (EQ (glyphless_method
, Qthin_space
))
6026 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6027 else if (EQ (glyphless_method
, Qempty_box
))
6028 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6029 else if (EQ (glyphless_method
, Qhex_code
))
6030 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6031 else if (STRINGP (glyphless_method
))
6032 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6035 /* Invalid value. We use the default method. */
6036 glyphless_method
= Qnil
;
6039 it
->what
= IT_GLYPHLESS
;
6040 return glyphless_method
;
6043 /* Load IT's display element fields with information about the next
6044 display element from the current position of IT. Value is zero if
6045 end of buffer (or C string) is reached. */
6047 static struct frame
*last_escape_glyph_frame
= NULL
;
6048 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6049 static int last_escape_glyph_merged_face_id
= 0;
6051 struct frame
*last_glyphless_glyph_frame
= NULL
;
6052 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6053 int last_glyphless_glyph_merged_face_id
= 0;
6056 get_next_display_element (struct it
*it
)
6058 /* Non-zero means that we found a display element. Zero means that
6059 we hit the end of what we iterate over. Performance note: the
6060 function pointer `method' used here turns out to be faster than
6061 using a sequence of if-statements. */
6065 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6067 if (it
->what
== IT_CHARACTER
)
6069 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6070 and only if (a) the resolved directionality of that character
6072 /* FIXME: Do we need an exception for characters from display
6074 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6075 it
->c
= bidi_mirror_char (it
->c
);
6076 /* Map via display table or translate control characters.
6077 IT->c, IT->len etc. have been set to the next character by
6078 the function call above. If we have a display table, and it
6079 contains an entry for IT->c, translate it. Don't do this if
6080 IT->c itself comes from a display table, otherwise we could
6081 end up in an infinite recursion. (An alternative could be to
6082 count the recursion depth of this function and signal an
6083 error when a certain maximum depth is reached.) Is it worth
6085 if (success_p
&& it
->dpvec
== NULL
)
6088 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6089 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6090 nbsp_or_shy
= char_is_other
;
6091 int c
= it
->c
; /* This is the character to display. */
6093 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6095 xassert (SINGLE_BYTE_CHAR_P (c
));
6096 if (unibyte_display_via_language_environment
)
6098 c
= DECODE_CHAR (unibyte
, c
);
6100 c
= BYTE8_TO_CHAR (it
->c
);
6103 c
= BYTE8_TO_CHAR (it
->c
);
6107 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6110 struct Lisp_Vector
*v
= XVECTOR (dv
);
6112 /* Return the first character from the display table
6113 entry, if not empty. If empty, don't display the
6114 current character. */
6117 it
->dpvec_char_len
= it
->len
;
6118 it
->dpvec
= v
->contents
;
6119 it
->dpend
= v
->contents
+ v
->header
.size
;
6120 it
->current
.dpvec_index
= 0;
6121 it
->dpvec_face_id
= -1;
6122 it
->saved_face_id
= it
->face_id
;
6123 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6128 set_iterator_to_next (it
, 0);
6133 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6135 if (it
->what
== IT_GLYPHLESS
)
6137 /* Don't display this character. */
6138 set_iterator_to_next (it
, 0);
6142 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6143 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6144 : c
== 0xAD ? char_is_soft_hyphen
6147 /* Translate control characters into `\003' or `^C' form.
6148 Control characters coming from a display table entry are
6149 currently not translated because we use IT->dpvec to hold
6150 the translation. This could easily be changed but I
6151 don't believe that it is worth doing.
6153 NBSP and SOFT-HYPEN are property translated too.
6155 Non-printable characters and raw-byte characters are also
6156 translated to octal form. */
6157 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6158 ? (it
->area
!= TEXT_AREA
6159 /* In mode line, treat \n, \t like other crl chars. */
6162 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6163 || (c
!= '\n' && c
!= '\t'))
6166 || ! CHAR_PRINTABLE_P (c
))))
6168 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6169 or a non-printable character which must be displayed
6170 either as '\003' or as `^C' where the '\\' and '^'
6171 can be defined in the display table. Fill
6172 IT->ctl_chars with glyphs for what we have to
6173 display. Then, set IT->dpvec to these glyphs. */
6177 EMACS_INT lface_id
= 0;
6180 /* Handle control characters with ^. */
6182 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6186 g
= '^'; /* default glyph for Control */
6187 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6189 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6190 && GLYPH_CODE_CHAR_VALID_P (gc
))
6192 g
= GLYPH_CODE_CHAR (gc
);
6193 lface_id
= GLYPH_CODE_FACE (gc
);
6197 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6199 else if (it
->f
== last_escape_glyph_frame
6200 && it
->face_id
== last_escape_glyph_face_id
)
6202 face_id
= last_escape_glyph_merged_face_id
;
6206 /* Merge the escape-glyph face into the current face. */
6207 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6209 last_escape_glyph_frame
= it
->f
;
6210 last_escape_glyph_face_id
= it
->face_id
;
6211 last_escape_glyph_merged_face_id
= face_id
;
6214 XSETINT (it
->ctl_chars
[0], g
);
6215 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6217 goto display_control
;
6220 /* Handle non-break space in the mode where it only gets
6223 if (EQ (Vnobreak_char_display
, Qt
)
6224 && nbsp_or_shy
== char_is_nbsp
)
6226 /* Merge the no-break-space face into the current face. */
6227 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6231 XSETINT (it
->ctl_chars
[0], ' ');
6233 goto display_control
;
6236 /* Handle sequences that start with the "escape glyph". */
6238 /* the default escape glyph is \. */
6239 escape_glyph
= '\\';
6242 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6243 && GLYPH_CODE_CHAR_VALID_P (gc
))
6245 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6246 lface_id
= GLYPH_CODE_FACE (gc
);
6250 /* The display table specified a face.
6251 Merge it into face_id and also into escape_glyph. */
6252 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6255 else if (it
->f
== last_escape_glyph_frame
6256 && it
->face_id
== last_escape_glyph_face_id
)
6258 face_id
= last_escape_glyph_merged_face_id
;
6262 /* Merge the escape-glyph face into the current face. */
6263 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6265 last_escape_glyph_frame
= it
->f
;
6266 last_escape_glyph_face_id
= it
->face_id
;
6267 last_escape_glyph_merged_face_id
= face_id
;
6270 /* Handle soft hyphens in the mode where they only get
6273 if (EQ (Vnobreak_char_display
, Qt
)
6274 && nbsp_or_shy
== char_is_soft_hyphen
)
6276 XSETINT (it
->ctl_chars
[0], '-');
6278 goto display_control
;
6281 /* Handle non-break space and soft hyphen
6282 with the escape glyph. */
6286 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6287 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6288 XSETINT (it
->ctl_chars
[1], c
);
6290 goto display_control
;
6297 if (CHAR_BYTE8_P (c
))
6298 /* Display \200 instead of \17777600. */
6299 c
= CHAR_TO_BYTE8 (c
);
6300 len
= sprintf (str
, "%03o", c
);
6302 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6303 for (i
= 0; i
< len
; i
++)
6304 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6309 /* Set up IT->dpvec and return first character from it. */
6310 it
->dpvec_char_len
= it
->len
;
6311 it
->dpvec
= it
->ctl_chars
;
6312 it
->dpend
= it
->dpvec
+ ctl_len
;
6313 it
->current
.dpvec_index
= 0;
6314 it
->dpvec_face_id
= face_id
;
6315 it
->saved_face_id
= it
->face_id
;
6316 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6320 it
->char_to_display
= c
;
6324 it
->char_to_display
= it
->c
;
6328 /* Adjust face id for a multibyte character. There are no multibyte
6329 character in unibyte text. */
6330 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6333 && FRAME_WINDOW_P (it
->f
))
6335 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6337 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6339 /* Automatic composition with glyph-string. */
6340 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6342 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6346 EMACS_INT pos
= (it
->s
? -1
6347 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6348 : IT_CHARPOS (*it
));
6351 if (it
->what
== IT_CHARACTER
)
6352 c
= it
->char_to_display
;
6355 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6359 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6360 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6363 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6368 /* Is this character the last one of a run of characters with
6369 box? If yes, set IT->end_of_box_run_p to 1. */
6373 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6375 int face_id
= underlying_face_id (it
);
6376 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6380 if (face
->box
== FACE_NO_BOX
)
6382 /* If the box comes from face properties in a
6383 display string, check faces in that string. */
6384 int string_face_id
= face_after_it_pos (it
);
6385 it
->end_of_box_run_p
6386 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6389 /* Otherwise, the box comes from the underlying face.
6390 If this is the last string character displayed, check
6391 the next buffer location. */
6392 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6393 && (it
->current
.overlay_string_index
6394 == it
->n_overlay_strings
- 1))
6398 struct text_pos pos
= it
->current
.pos
;
6399 INC_TEXT_POS (pos
, it
->multibyte_p
);
6401 next_face_id
= face_at_buffer_position
6402 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6403 it
->region_end_charpos
, &ignore
,
6404 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6406 it
->end_of_box_run_p
6407 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6414 int face_id
= face_after_it_pos (it
);
6415 it
->end_of_box_run_p
6416 = (face_id
!= it
->face_id
6417 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6421 /* Value is 0 if end of buffer or string reached. */
6426 /* Move IT to the next display element.
6428 RESEAT_P non-zero means if called on a newline in buffer text,
6429 skip to the next visible line start.
6431 Functions get_next_display_element and set_iterator_to_next are
6432 separate because I find this arrangement easier to handle than a
6433 get_next_display_element function that also increments IT's
6434 position. The way it is we can first look at an iterator's current
6435 display element, decide whether it fits on a line, and if it does,
6436 increment the iterator position. The other way around we probably
6437 would either need a flag indicating whether the iterator has to be
6438 incremented the next time, or we would have to implement a
6439 decrement position function which would not be easy to write. */
6442 set_iterator_to_next (struct it
*it
, int reseat_p
)
6444 /* Reset flags indicating start and end of a sequence of characters
6445 with box. Reset them at the start of this function because
6446 moving the iterator to a new position might set them. */
6447 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6451 case GET_FROM_BUFFER
:
6452 /* The current display element of IT is a character from
6453 current_buffer. Advance in the buffer, and maybe skip over
6454 invisible lines that are so because of selective display. */
6455 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6456 reseat_at_next_visible_line_start (it
, 0);
6457 else if (it
->cmp_it
.id
>= 0)
6459 /* We are currently getting glyphs from a composition. */
6464 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6465 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6466 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6468 it
->cmp_it
.from
= it
->cmp_it
.to
;
6473 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6475 it
->end_charpos
, Qnil
);
6478 else if (! it
->cmp_it
.reversed_p
)
6480 /* Composition created while scanning forward. */
6481 /* Update IT's char/byte positions to point to the first
6482 character of the next grapheme cluster, or to the
6483 character visually after the current composition. */
6484 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6485 bidi_move_to_visually_next (&it
->bidi_it
);
6486 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6487 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6489 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6491 /* Proceed to the next grapheme cluster. */
6492 it
->cmp_it
.from
= it
->cmp_it
.to
;
6496 /* No more grapheme clusters in this composition.
6497 Find the next stop position. */
6498 EMACS_INT stop
= it
->end_charpos
;
6499 if (it
->bidi_it
.scan_dir
< 0)
6500 /* Now we are scanning backward and don't know
6503 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6504 IT_BYTEPOS (*it
), stop
, Qnil
);
6509 /* Composition created while scanning backward. */
6510 /* Update IT's char/byte positions to point to the last
6511 character of the previous grapheme cluster, or the
6512 character visually after the current composition. */
6513 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6514 bidi_move_to_visually_next (&it
->bidi_it
);
6515 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6516 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6517 if (it
->cmp_it
.from
> 0)
6519 /* Proceed to the previous grapheme cluster. */
6520 it
->cmp_it
.to
= it
->cmp_it
.from
;
6524 /* No more grapheme clusters in this composition.
6525 Find the next stop position. */
6526 EMACS_INT stop
= it
->end_charpos
;
6527 if (it
->bidi_it
.scan_dir
< 0)
6528 /* Now we are scanning backward and don't know
6531 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6532 IT_BYTEPOS (*it
), stop
, Qnil
);
6538 xassert (it
->len
!= 0);
6542 IT_BYTEPOS (*it
) += it
->len
;
6543 IT_CHARPOS (*it
) += 1;
6547 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6548 /* If this is a new paragraph, determine its base
6549 direction (a.k.a. its base embedding level). */
6550 if (it
->bidi_it
.new_paragraph
)
6551 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6552 bidi_move_to_visually_next (&it
->bidi_it
);
6553 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6554 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6555 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6557 /* As the scan direction was changed, we must
6558 re-compute the stop position for composition. */
6559 EMACS_INT stop
= it
->end_charpos
;
6560 if (it
->bidi_it
.scan_dir
< 0)
6562 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6563 IT_BYTEPOS (*it
), stop
, Qnil
);
6566 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6570 case GET_FROM_C_STRING
:
6571 /* Current display element of IT is from a C string. */
6573 /* If the string position is beyond string's end, it means
6574 next_element_from_c_string is padding the string with
6575 blanks, in which case we bypass the bidi iterator,
6576 because it cannot deal with such virtual characters. */
6577 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6579 IT_BYTEPOS (*it
) += it
->len
;
6580 IT_CHARPOS (*it
) += 1;
6584 bidi_move_to_visually_next (&it
->bidi_it
);
6585 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6586 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6590 case GET_FROM_DISPLAY_VECTOR
:
6591 /* Current display element of IT is from a display table entry.
6592 Advance in the display table definition. Reset it to null if
6593 end reached, and continue with characters from buffers/
6595 ++it
->current
.dpvec_index
;
6597 /* Restore face of the iterator to what they were before the
6598 display vector entry (these entries may contain faces). */
6599 it
->face_id
= it
->saved_face_id
;
6601 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6603 int recheck_faces
= it
->ellipsis_p
;
6606 it
->method
= GET_FROM_C_STRING
;
6607 else if (STRINGP (it
->string
))
6608 it
->method
= GET_FROM_STRING
;
6611 it
->method
= GET_FROM_BUFFER
;
6612 it
->object
= it
->w
->buffer
;
6616 it
->current
.dpvec_index
= -1;
6618 /* Skip over characters which were displayed via IT->dpvec. */
6619 if (it
->dpvec_char_len
< 0)
6620 reseat_at_next_visible_line_start (it
, 1);
6621 else if (it
->dpvec_char_len
> 0)
6623 if (it
->method
== GET_FROM_STRING
6624 && it
->n_overlay_strings
> 0)
6625 it
->ignore_overlay_strings_at_pos_p
= 1;
6626 it
->len
= it
->dpvec_char_len
;
6627 set_iterator_to_next (it
, reseat_p
);
6630 /* Maybe recheck faces after display vector */
6632 it
->stop_charpos
= IT_CHARPOS (*it
);
6636 case GET_FROM_STRING
:
6637 /* Current display element is a character from a Lisp string. */
6638 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6639 if (it
->cmp_it
.id
>= 0)
6645 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6646 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6647 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6648 it
->cmp_it
.from
= it
->cmp_it
.to
;
6652 composition_compute_stop_pos (&it
->cmp_it
,
6653 IT_STRING_CHARPOS (*it
),
6654 IT_STRING_BYTEPOS (*it
),
6655 it
->end_charpos
, it
->string
);
6658 else if (! it
->cmp_it
.reversed_p
)
6660 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6661 bidi_move_to_visually_next (&it
->bidi_it
);
6662 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6663 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6665 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6666 it
->cmp_it
.from
= it
->cmp_it
.to
;
6669 EMACS_INT stop
= it
->end_charpos
;
6670 if (it
->bidi_it
.scan_dir
< 0)
6672 composition_compute_stop_pos (&it
->cmp_it
,
6673 IT_STRING_CHARPOS (*it
),
6674 IT_STRING_BYTEPOS (*it
), stop
,
6680 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6681 bidi_move_to_visually_next (&it
->bidi_it
);
6682 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6683 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6684 if (it
->cmp_it
.from
> 0)
6685 it
->cmp_it
.to
= it
->cmp_it
.from
;
6688 EMACS_INT stop
= it
->end_charpos
;
6689 if (it
->bidi_it
.scan_dir
< 0)
6691 composition_compute_stop_pos (&it
->cmp_it
,
6692 IT_STRING_CHARPOS (*it
),
6693 IT_STRING_BYTEPOS (*it
), stop
,
6701 /* If the string position is beyond string's end, it
6702 means next_element_from_string is padding the string
6703 with blanks, in which case we bypass the bidi
6704 iterator, because it cannot deal with such virtual
6706 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6708 IT_STRING_BYTEPOS (*it
) += it
->len
;
6709 IT_STRING_CHARPOS (*it
) += 1;
6713 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6715 bidi_move_to_visually_next (&it
->bidi_it
);
6716 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6717 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6718 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6720 EMACS_INT stop
= it
->end_charpos
;
6722 if (it
->bidi_it
.scan_dir
< 0)
6724 composition_compute_stop_pos (&it
->cmp_it
,
6725 IT_STRING_CHARPOS (*it
),
6726 IT_STRING_BYTEPOS (*it
), stop
,
6732 consider_string_end
:
6734 if (it
->current
.overlay_string_index
>= 0)
6736 /* IT->string is an overlay string. Advance to the
6737 next, if there is one. */
6738 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6741 next_overlay_string (it
);
6743 setup_for_ellipsis (it
, 0);
6748 /* IT->string is not an overlay string. If we reached
6749 its end, and there is something on IT->stack, proceed
6750 with what is on the stack. This can be either another
6751 string, this time an overlay string, or a buffer. */
6752 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6756 if (it
->method
== GET_FROM_STRING
)
6757 goto consider_string_end
;
6762 case GET_FROM_IMAGE
:
6763 case GET_FROM_STRETCH
:
6764 /* The position etc with which we have to proceed are on
6765 the stack. The position may be at the end of a string,
6766 if the `display' property takes up the whole string. */
6767 xassert (it
->sp
> 0);
6769 if (it
->method
== GET_FROM_STRING
)
6770 goto consider_string_end
;
6774 /* There are no other methods defined, so this should be a bug. */
6778 xassert (it
->method
!= GET_FROM_STRING
6779 || (STRINGP (it
->string
)
6780 && IT_STRING_CHARPOS (*it
) >= 0));
6783 /* Load IT's display element fields with information about the next
6784 display element which comes from a display table entry or from the
6785 result of translating a control character to one of the forms `^C'
6788 IT->dpvec holds the glyphs to return as characters.
6789 IT->saved_face_id holds the face id before the display vector--it
6790 is restored into IT->face_id in set_iterator_to_next. */
6793 next_element_from_display_vector (struct it
*it
)
6798 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6800 it
->face_id
= it
->saved_face_id
;
6802 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6803 That seemed totally bogus - so I changed it... */
6804 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6806 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6808 it
->c
= GLYPH_CODE_CHAR (gc
);
6809 it
->len
= CHAR_BYTES (it
->c
);
6811 /* The entry may contain a face id to use. Such a face id is
6812 the id of a Lisp face, not a realized face. A face id of
6813 zero means no face is specified. */
6814 if (it
->dpvec_face_id
>= 0)
6815 it
->face_id
= it
->dpvec_face_id
;
6818 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6820 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6825 /* Display table entry is invalid. Return a space. */
6826 it
->c
= ' ', it
->len
= 1;
6828 /* Don't change position and object of the iterator here. They are
6829 still the values of the character that had this display table
6830 entry or was translated, and that's what we want. */
6831 it
->what
= IT_CHARACTER
;
6835 /* Get the first element of string/buffer in the visual order, after
6836 being reseated to a new position in a string or a buffer. */
6838 get_visually_first_element (struct it
*it
)
6840 int string_p
= STRINGP (it
->string
) || it
->s
;
6841 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6842 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6844 if (STRINGP (it
->string
))
6846 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6847 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6851 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6852 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6855 if (it
->bidi_it
.charpos
== eob
)
6857 /* Nothing to do, but reset the FIRST_ELT flag, like
6858 bidi_paragraph_init does, because we are not going to
6860 it
->bidi_it
.first_elt
= 0;
6862 else if (it
->bidi_it
.charpos
== bob
6864 /* FIXME: Should support all Unicode line separators. */
6865 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6866 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6868 /* If we are at the beginning of a line/string, we can produce
6869 the next element right away. */
6870 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6871 bidi_move_to_visually_next (&it
->bidi_it
);
6875 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6877 /* We need to prime the bidi iterator starting at the line's or
6878 string's beginning, before we will be able to produce the
6881 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6884 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6886 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6888 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6891 /* Now return to buffer/string position where we were asked
6892 to get the next display element, and produce that. */
6893 bidi_move_to_visually_next (&it
->bidi_it
);
6895 while (it
->bidi_it
.bytepos
!= orig_bytepos
6896 && it
->bidi_it
.charpos
< eob
);
6899 /* Adjust IT's position information to where we ended up. */
6900 if (STRINGP (it
->string
))
6902 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6903 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6907 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6908 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6911 if (STRINGP (it
->string
) || !it
->s
)
6913 EMACS_INT stop
, charpos
, bytepos
;
6915 if (STRINGP (it
->string
))
6918 stop
= SCHARS (it
->string
);
6919 if (stop
> it
->end_charpos
)
6920 stop
= it
->end_charpos
;
6921 charpos
= IT_STRING_CHARPOS (*it
);
6922 bytepos
= IT_STRING_BYTEPOS (*it
);
6926 stop
= it
->end_charpos
;
6927 charpos
= IT_CHARPOS (*it
);
6928 bytepos
= IT_BYTEPOS (*it
);
6930 if (it
->bidi_it
.scan_dir
< 0)
6932 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6937 /* Load IT with the next display element from Lisp string IT->string.
6938 IT->current.string_pos is the current position within the string.
6939 If IT->current.overlay_string_index >= 0, the Lisp string is an
6943 next_element_from_string (struct it
*it
)
6945 struct text_pos position
;
6947 xassert (STRINGP (it
->string
));
6948 xassert (!it
->bidi_p
|| it
->string
== it
->bidi_it
.string
.lstring
);
6949 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6950 position
= it
->current
.string_pos
;
6952 /* With bidi reordering, the character to display might not be the
6953 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6954 that we were reseat()ed to a new string, whose paragraph
6955 direction is not known. */
6956 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6958 get_visually_first_element (it
);
6959 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
6962 /* Time to check for invisible text? */
6963 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
6965 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
6968 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6969 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
6971 /* With bidi non-linear iteration, we could find
6972 ourselves far beyond the last computed stop_charpos,
6973 with several other stop positions in between that we
6974 missed. Scan them all now, in buffer's logical
6975 order, until we find and handle the last stop_charpos
6976 that precedes our current position. */
6977 handle_stop_backwards (it
, it
->stop_charpos
);
6978 return GET_NEXT_DISPLAY_ELEMENT (it
);
6984 /* Take note of the stop position we just moved
6985 across, for when we will move back across it. */
6986 it
->prev_stop
= it
->stop_charpos
;
6987 /* If we are at base paragraph embedding level, take
6988 note of the last stop position seen at this
6990 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6991 it
->base_level_stop
= it
->stop_charpos
;
6995 /* Since a handler may have changed IT->method, we must
6997 return GET_NEXT_DISPLAY_ELEMENT (it
);
7001 /* If we are before prev_stop, we may have overstepped
7002 on our way backwards a stop_pos, and if so, we need
7003 to handle that stop_pos. */
7004 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7005 /* We can sometimes back up for reasons that have nothing
7006 to do with bidi reordering. E.g., compositions. The
7007 code below is only needed when we are above the base
7008 embedding level, so test for that explicitly. */
7009 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7011 /* If we lost track of base_level_stop, we have no better place
7012 for handle_stop_backwards to start from than BEGV. This
7013 happens, e.g., when we were reseated to the previous
7014 screenful of text by vertical-motion. */
7015 if (it
->base_level_stop
<= 0
7016 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7017 it
->base_level_stop
= 0;
7018 handle_stop_backwards (it
, it
->base_level_stop
);
7019 return GET_NEXT_DISPLAY_ELEMENT (it
);
7023 if (it
->current
.overlay_string_index
>= 0)
7025 /* Get the next character from an overlay string. In overlay
7026 strings, There is no field width or padding with spaces to
7028 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7033 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7034 IT_STRING_BYTEPOS (*it
),
7035 it
->bidi_it
.scan_dir
< 0
7037 : SCHARS (it
->string
))
7038 && next_element_from_composition (it
))
7042 else if (STRING_MULTIBYTE (it
->string
))
7044 const unsigned char *s
= (SDATA (it
->string
)
7045 + IT_STRING_BYTEPOS (*it
));
7046 it
->c
= string_char_and_length (s
, &it
->len
);
7050 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7056 /* Get the next character from a Lisp string that is not an
7057 overlay string. Such strings come from the mode line, for
7058 example. We may have to pad with spaces, or truncate the
7059 string. See also next_element_from_c_string. */
7060 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7065 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7067 /* Pad with spaces. */
7068 it
->c
= ' ', it
->len
= 1;
7069 CHARPOS (position
) = BYTEPOS (position
) = -1;
7071 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7072 IT_STRING_BYTEPOS (*it
),
7073 it
->bidi_it
.scan_dir
< 0
7075 : it
->string_nchars
)
7076 && next_element_from_composition (it
))
7080 else if (STRING_MULTIBYTE (it
->string
))
7082 const unsigned char *s
= (SDATA (it
->string
)
7083 + IT_STRING_BYTEPOS (*it
));
7084 it
->c
= string_char_and_length (s
, &it
->len
);
7088 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7093 /* Record what we have and where it came from. */
7094 it
->what
= IT_CHARACTER
;
7095 it
->object
= it
->string
;
7096 it
->position
= position
;
7101 /* Load IT with next display element from C string IT->s.
7102 IT->string_nchars is the maximum number of characters to return
7103 from the string. IT->end_charpos may be greater than
7104 IT->string_nchars when this function is called, in which case we
7105 may have to return padding spaces. Value is zero if end of string
7106 reached, including padding spaces. */
7109 next_element_from_c_string (struct it
*it
)
7114 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7115 it
->what
= IT_CHARACTER
;
7116 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7119 /* With bidi reordering, the character to display might not be the
7120 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7121 we were reseated to a new string, whose paragraph direction is
7123 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7124 get_visually_first_element (it
);
7126 /* IT's position can be greater than IT->string_nchars in case a
7127 field width or precision has been specified when the iterator was
7129 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7131 /* End of the game. */
7135 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7137 /* Pad with spaces. */
7138 it
->c
= ' ', it
->len
= 1;
7139 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7141 else if (it
->multibyte_p
)
7142 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7144 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7150 /* Set up IT to return characters from an ellipsis, if appropriate.
7151 The definition of the ellipsis glyphs may come from a display table
7152 entry. This function fills IT with the first glyph from the
7153 ellipsis if an ellipsis is to be displayed. */
7156 next_element_from_ellipsis (struct it
*it
)
7158 if (it
->selective_display_ellipsis_p
)
7159 setup_for_ellipsis (it
, it
->len
);
7162 /* The face at the current position may be different from the
7163 face we find after the invisible text. Remember what it
7164 was in IT->saved_face_id, and signal that it's there by
7165 setting face_before_selective_p. */
7166 it
->saved_face_id
= it
->face_id
;
7167 it
->method
= GET_FROM_BUFFER
;
7168 it
->object
= it
->w
->buffer
;
7169 reseat_at_next_visible_line_start (it
, 1);
7170 it
->face_before_selective_p
= 1;
7173 return GET_NEXT_DISPLAY_ELEMENT (it
);
7177 /* Deliver an image display element. The iterator IT is already
7178 filled with image information (done in handle_display_prop). Value
7183 next_element_from_image (struct it
*it
)
7185 it
->what
= IT_IMAGE
;
7186 it
->ignore_overlay_strings_at_pos_p
= 0;
7191 /* Fill iterator IT with next display element from a stretch glyph
7192 property. IT->object is the value of the text property. Value is
7196 next_element_from_stretch (struct it
*it
)
7198 it
->what
= IT_STRETCH
;
7202 /* Scan forward from CHARPOS in the current buffer/string, until we
7203 find a stop position > current IT's position. Then handle the stop
7204 position before that. This is called when we bump into a stop
7205 position while reordering bidirectional text. CHARPOS should be
7206 the last previously processed stop_pos (or BEGV/0, if none were
7207 processed yet) whose position is less that IT's current
7211 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7213 int bufp
= !STRINGP (it
->string
);
7214 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7215 struct display_pos save_current
= it
->current
;
7216 struct text_pos save_position
= it
->position
;
7217 struct text_pos pos1
;
7218 EMACS_INT next_stop
;
7220 /* Scan in strict logical order. */
7224 it
->prev_stop
= charpos
;
7227 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7228 reseat_1 (it
, pos1
, 0);
7231 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7232 compute_stop_pos (it
);
7233 /* We must advance forward, right? */
7234 if (it
->stop_charpos
<= it
->prev_stop
)
7236 charpos
= it
->stop_charpos
;
7238 while (charpos
<= where_we_are
);
7240 next_stop
= it
->stop_charpos
;
7241 it
->stop_charpos
= it
->prev_stop
;
7243 it
->current
= save_current
;
7244 it
->position
= save_position
;
7246 it
->stop_charpos
= next_stop
;
7249 /* Load IT with the next display element from current_buffer. Value
7250 is zero if end of buffer reached. IT->stop_charpos is the next
7251 position at which to stop and check for text properties or buffer
7255 next_element_from_buffer (struct it
*it
)
7259 xassert (IT_CHARPOS (*it
) >= BEGV
);
7260 xassert (NILP (it
->string
) && !it
->s
);
7261 xassert (!it
->bidi_p
7262 || (it
->bidi_it
.string
.lstring
== Qnil
7263 && it
->bidi_it
.string
.s
== NULL
));
7265 /* With bidi reordering, the character to display might not be the
7266 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7267 we were reseat()ed to a new buffer position, which is potentially
7268 a different paragraph. */
7269 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7271 get_visually_first_element (it
);
7272 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7275 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7277 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7279 int overlay_strings_follow_p
;
7281 /* End of the game, except when overlay strings follow that
7282 haven't been returned yet. */
7283 if (it
->overlay_strings_at_end_processed_p
)
7284 overlay_strings_follow_p
= 0;
7287 it
->overlay_strings_at_end_processed_p
= 1;
7288 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7291 if (overlay_strings_follow_p
)
7292 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7296 it
->position
= it
->current
.pos
;
7300 else if (!(!it
->bidi_p
7301 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7302 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7304 /* With bidi non-linear iteration, we could find ourselves
7305 far beyond the last computed stop_charpos, with several
7306 other stop positions in between that we missed. Scan
7307 them all now, in buffer's logical order, until we find
7308 and handle the last stop_charpos that precedes our
7309 current position. */
7310 handle_stop_backwards (it
, it
->stop_charpos
);
7311 return GET_NEXT_DISPLAY_ELEMENT (it
);
7317 /* Take note of the stop position we just moved across,
7318 for when we will move back across it. */
7319 it
->prev_stop
= it
->stop_charpos
;
7320 /* If we are at base paragraph embedding level, take
7321 note of the last stop position seen at this
7323 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7324 it
->base_level_stop
= it
->stop_charpos
;
7327 return GET_NEXT_DISPLAY_ELEMENT (it
);
7331 /* If we are before prev_stop, we may have overstepped on
7332 our way backwards a stop_pos, and if so, we need to
7333 handle that stop_pos. */
7334 && IT_CHARPOS (*it
) < it
->prev_stop
7335 /* We can sometimes back up for reasons that have nothing
7336 to do with bidi reordering. E.g., compositions. The
7337 code below is only needed when we are above the base
7338 embedding level, so test for that explicitly. */
7339 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7341 /* If we lost track of base_level_stop, we have no better place
7342 for handle_stop_backwards to start from than BEGV. This
7343 happens, e.g., when we were reseated to the previous
7344 screenful of text by vertical-motion. */
7345 if (it
->base_level_stop
<= 0
7346 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7347 it
->base_level_stop
= BEGV
;
7348 handle_stop_backwards (it
, it
->base_level_stop
);
7349 return GET_NEXT_DISPLAY_ELEMENT (it
);
7353 /* No face changes, overlays etc. in sight, so just return a
7354 character from current_buffer. */
7358 /* Maybe run the redisplay end trigger hook. Performance note:
7359 This doesn't seem to cost measurable time. */
7360 if (it
->redisplay_end_trigger_charpos
7362 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7363 run_redisplay_end_trigger_hook (it
);
7365 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7366 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7368 && next_element_from_composition (it
))
7373 /* Get the next character, maybe multibyte. */
7374 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7375 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7376 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7378 it
->c
= *p
, it
->len
= 1;
7380 /* Record what we have and where it came from. */
7381 it
->what
= IT_CHARACTER
;
7382 it
->object
= it
->w
->buffer
;
7383 it
->position
= it
->current
.pos
;
7385 /* Normally we return the character found above, except when we
7386 really want to return an ellipsis for selective display. */
7391 /* A value of selective > 0 means hide lines indented more
7392 than that number of columns. */
7393 if (it
->selective
> 0
7394 && IT_CHARPOS (*it
) + 1 < ZV
7395 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7396 IT_BYTEPOS (*it
) + 1,
7399 success_p
= next_element_from_ellipsis (it
);
7400 it
->dpvec_char_len
= -1;
7403 else if (it
->c
== '\r' && it
->selective
== -1)
7405 /* A value of selective == -1 means that everything from the
7406 CR to the end of the line is invisible, with maybe an
7407 ellipsis displayed for it. */
7408 success_p
= next_element_from_ellipsis (it
);
7409 it
->dpvec_char_len
= -1;
7414 /* Value is zero if end of buffer reached. */
7415 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7420 /* Run the redisplay end trigger hook for IT. */
7423 run_redisplay_end_trigger_hook (struct it
*it
)
7425 Lisp_Object args
[3];
7427 /* IT->glyph_row should be non-null, i.e. we should be actually
7428 displaying something, or otherwise we should not run the hook. */
7429 xassert (it
->glyph_row
);
7431 /* Set up hook arguments. */
7432 args
[0] = Qredisplay_end_trigger_functions
;
7433 args
[1] = it
->window
;
7434 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7435 it
->redisplay_end_trigger_charpos
= 0;
7437 /* Since we are *trying* to run these functions, don't try to run
7438 them again, even if they get an error. */
7439 it
->w
->redisplay_end_trigger
= Qnil
;
7440 Frun_hook_with_args (3, args
);
7442 /* Notice if it changed the face of the character we are on. */
7443 handle_face_prop (it
);
7447 /* Deliver a composition display element. Unlike the other
7448 next_element_from_XXX, this function is not registered in the array
7449 get_next_element[]. It is called from next_element_from_buffer and
7450 next_element_from_string when necessary. */
7453 next_element_from_composition (struct it
*it
)
7455 it
->what
= IT_COMPOSITION
;
7456 it
->len
= it
->cmp_it
.nbytes
;
7457 if (STRINGP (it
->string
))
7461 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7462 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7465 it
->position
= it
->current
.string_pos
;
7466 it
->object
= it
->string
;
7467 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7468 IT_STRING_BYTEPOS (*it
), it
->string
);
7474 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7475 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7478 if (it
->bidi_it
.new_paragraph
)
7479 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7480 /* Resync the bidi iterator with IT's new position.
7481 FIXME: this doesn't support bidirectional text. */
7482 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7483 bidi_move_to_visually_next (&it
->bidi_it
);
7487 it
->position
= it
->current
.pos
;
7488 it
->object
= it
->w
->buffer
;
7489 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7490 IT_BYTEPOS (*it
), Qnil
);
7497 /***********************************************************************
7498 Moving an iterator without producing glyphs
7499 ***********************************************************************/
7501 /* Check if iterator is at a position corresponding to a valid buffer
7502 position after some move_it_ call. */
7504 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7505 ((it)->method == GET_FROM_STRING \
7506 ? IT_STRING_CHARPOS (*it) == 0 \
7510 /* Move iterator IT to a specified buffer or X position within one
7511 line on the display without producing glyphs.
7513 OP should be a bit mask including some or all of these bits:
7514 MOVE_TO_X: Stop upon reaching x-position TO_X.
7515 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7516 Regardless of OP's value, stop upon reaching the end of the display line.
7518 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7519 This means, in particular, that TO_X includes window's horizontal
7522 The return value has several possible values that
7523 say what condition caused the scan to stop:
7525 MOVE_POS_MATCH_OR_ZV
7526 - when TO_POS or ZV was reached.
7529 -when TO_X was reached before TO_POS or ZV were reached.
7532 - when we reached the end of the display area and the line must
7536 - when we reached the end of the display area and the line is
7540 - when we stopped at a line end, i.e. a newline or a CR and selective
7543 static enum move_it_result
7544 move_it_in_display_line_to (struct it
*it
,
7545 EMACS_INT to_charpos
, int to_x
,
7546 enum move_operation_enum op
)
7548 enum move_it_result result
= MOVE_UNDEFINED
;
7549 struct glyph_row
*saved_glyph_row
;
7550 struct it wrap_it
, atpos_it
, atx_it
;
7551 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7553 enum it_method prev_method
= it
->method
;
7554 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7555 int saw_smaller_pos
= prev_pos
< to_charpos
;
7557 /* Don't produce glyphs in produce_glyphs. */
7558 saved_glyph_row
= it
->glyph_row
;
7559 it
->glyph_row
= NULL
;
7561 /* Use wrap_it to save a copy of IT wherever a word wrap could
7562 occur. Use atpos_it to save a copy of IT at the desired buffer
7563 position, if found, so that we can scan ahead and check if the
7564 word later overshoots the window edge. Use atx_it similarly, for
7570 #define BUFFER_POS_REACHED_P() \
7571 ((op & MOVE_TO_POS) != 0 \
7572 && BUFFERP (it->object) \
7573 && (IT_CHARPOS (*it) == to_charpos \
7574 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7575 && (it->method == GET_FROM_BUFFER \
7576 || (it->method == GET_FROM_DISPLAY_VECTOR \
7577 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7579 /* If there's a line-/wrap-prefix, handle it. */
7580 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7581 && it
->current_y
< it
->last_visible_y
)
7582 handle_line_prefix (it
);
7584 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7585 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7589 int x
, i
, ascent
= 0, descent
= 0;
7591 /* Utility macro to reset an iterator with x, ascent, and descent. */
7592 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7593 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7594 (IT)->max_descent = descent)
7596 /* Stop if we move beyond TO_CHARPOS (after an image or a
7597 display string or stretch glyph). */
7598 if ((op
& MOVE_TO_POS
) != 0
7599 && BUFFERP (it
->object
)
7600 && it
->method
== GET_FROM_BUFFER
7601 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7603 && (prev_method
== GET_FROM_IMAGE
7604 || prev_method
== GET_FROM_STRETCH
7605 || prev_method
== GET_FROM_STRING
)
7606 /* Passed TO_CHARPOS from left to right. */
7607 && ((prev_pos
< to_charpos
7608 && IT_CHARPOS (*it
) > to_charpos
)
7609 /* Passed TO_CHARPOS from right to left. */
7610 || (prev_pos
> to_charpos
7611 && IT_CHARPOS (*it
) < to_charpos
)))))
7613 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7615 result
= MOVE_POS_MATCH_OR_ZV
;
7618 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7619 /* If wrap_it is valid, the current position might be in a
7620 word that is wrapped. So, save the iterator in
7621 atpos_it and continue to see if wrapping happens. */
7622 SAVE_IT (atpos_it
, *it
, atpos_data
);
7625 /* Stop when ZV reached.
7626 We used to stop here when TO_CHARPOS reached as well, but that is
7627 too soon if this glyph does not fit on this line. So we handle it
7628 explicitly below. */
7629 if (!get_next_display_element (it
))
7631 result
= MOVE_POS_MATCH_OR_ZV
;
7635 if (it
->line_wrap
== TRUNCATE
)
7637 if (BUFFER_POS_REACHED_P ())
7639 result
= MOVE_POS_MATCH_OR_ZV
;
7645 if (it
->line_wrap
== WORD_WRAP
)
7647 if (IT_DISPLAYING_WHITESPACE (it
))
7651 /* We have reached a glyph that follows one or more
7652 whitespace characters. If the position is
7653 already found, we are done. */
7654 if (atpos_it
.sp
>= 0)
7656 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7657 result
= MOVE_POS_MATCH_OR_ZV
;
7662 RESTORE_IT (it
, &atx_it
, atx_data
);
7663 result
= MOVE_X_REACHED
;
7666 /* Otherwise, we can wrap here. */
7667 SAVE_IT (wrap_it
, *it
, wrap_data
);
7673 /* Remember the line height for the current line, in case
7674 the next element doesn't fit on the line. */
7675 ascent
= it
->max_ascent
;
7676 descent
= it
->max_descent
;
7678 /* The call to produce_glyphs will get the metrics of the
7679 display element IT is loaded with. Record the x-position
7680 before this display element, in case it doesn't fit on the
7684 PRODUCE_GLYPHS (it
);
7686 if (it
->area
!= TEXT_AREA
)
7688 prev_method
= it
->method
;
7689 if (it
->method
== GET_FROM_BUFFER
)
7690 prev_pos
= IT_CHARPOS (*it
);
7691 set_iterator_to_next (it
, 1);
7692 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7693 SET_TEXT_POS (this_line_min_pos
,
7694 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7698 /* The number of glyphs we get back in IT->nglyphs will normally
7699 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7700 character on a terminal frame, or (iii) a line end. For the
7701 second case, IT->nglyphs - 1 padding glyphs will be present.
7702 (On X frames, there is only one glyph produced for a
7703 composite character.)
7705 The behavior implemented below means, for continuation lines,
7706 that as many spaces of a TAB as fit on the current line are
7707 displayed there. For terminal frames, as many glyphs of a
7708 multi-glyph character are displayed in the current line, too.
7709 This is what the old redisplay code did, and we keep it that
7710 way. Under X, the whole shape of a complex character must
7711 fit on the line or it will be completely displayed in the
7714 Note that both for tabs and padding glyphs, all glyphs have
7718 /* More than one glyph or glyph doesn't fit on line. All
7719 glyphs have the same width. */
7720 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7722 int x_before_this_char
= x
;
7723 int hpos_before_this_char
= it
->hpos
;
7725 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7727 new_x
= x
+ single_glyph_width
;
7729 /* We want to leave anything reaching TO_X to the caller. */
7730 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7732 if (BUFFER_POS_REACHED_P ())
7734 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7735 goto buffer_pos_reached
;
7736 if (atpos_it
.sp
< 0)
7738 SAVE_IT (atpos_it
, *it
, atpos_data
);
7739 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7744 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7747 result
= MOVE_X_REACHED
;
7752 SAVE_IT (atx_it
, *it
, atx_data
);
7753 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7758 if (/* Lines are continued. */
7759 it
->line_wrap
!= TRUNCATE
7760 && (/* And glyph doesn't fit on the line. */
7761 new_x
> it
->last_visible_x
7762 /* Or it fits exactly and we're on a window
7764 || (new_x
== it
->last_visible_x
7765 && FRAME_WINDOW_P (it
->f
))))
7767 if (/* IT->hpos == 0 means the very first glyph
7768 doesn't fit on the line, e.g. a wide image. */
7770 || (new_x
== it
->last_visible_x
7771 && FRAME_WINDOW_P (it
->f
)))
7774 it
->current_x
= new_x
;
7776 /* The character's last glyph just barely fits
7778 if (i
== it
->nglyphs
- 1)
7780 /* If this is the destination position,
7781 return a position *before* it in this row,
7782 now that we know it fits in this row. */
7783 if (BUFFER_POS_REACHED_P ())
7785 if (it
->line_wrap
!= WORD_WRAP
7788 it
->hpos
= hpos_before_this_char
;
7789 it
->current_x
= x_before_this_char
;
7790 result
= MOVE_POS_MATCH_OR_ZV
;
7793 if (it
->line_wrap
== WORD_WRAP
7796 SAVE_IT (atpos_it
, *it
, atpos_data
);
7797 atpos_it
.current_x
= x_before_this_char
;
7798 atpos_it
.hpos
= hpos_before_this_char
;
7802 prev_method
= it
->method
;
7803 if (it
->method
== GET_FROM_BUFFER
)
7804 prev_pos
= IT_CHARPOS (*it
);
7805 set_iterator_to_next (it
, 1);
7806 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7807 SET_TEXT_POS (this_line_min_pos
,
7808 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7809 /* On graphical terminals, newlines may
7810 "overflow" into the fringe if
7811 overflow-newline-into-fringe is non-nil.
7812 On text-only terminals, newlines may
7813 overflow into the last glyph on the
7815 if (!FRAME_WINDOW_P (it
->f
)
7816 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7818 if (!get_next_display_element (it
))
7820 result
= MOVE_POS_MATCH_OR_ZV
;
7823 if (BUFFER_POS_REACHED_P ())
7825 if (ITERATOR_AT_END_OF_LINE_P (it
))
7826 result
= MOVE_POS_MATCH_OR_ZV
;
7828 result
= MOVE_LINE_CONTINUED
;
7831 if (ITERATOR_AT_END_OF_LINE_P (it
))
7833 result
= MOVE_NEWLINE_OR_CR
;
7840 IT_RESET_X_ASCENT_DESCENT (it
);
7842 if (wrap_it
.sp
>= 0)
7844 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7849 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7851 result
= MOVE_LINE_CONTINUED
;
7855 if (BUFFER_POS_REACHED_P ())
7857 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7858 goto buffer_pos_reached
;
7859 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7861 SAVE_IT (atpos_it
, *it
, atpos_data
);
7862 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7866 if (new_x
> it
->first_visible_x
)
7868 /* Glyph is visible. Increment number of glyphs that
7869 would be displayed. */
7874 if (result
!= MOVE_UNDEFINED
)
7877 else if (BUFFER_POS_REACHED_P ())
7880 IT_RESET_X_ASCENT_DESCENT (it
);
7881 result
= MOVE_POS_MATCH_OR_ZV
;
7884 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7886 /* Stop when TO_X specified and reached. This check is
7887 necessary here because of lines consisting of a line end,
7888 only. The line end will not produce any glyphs and we
7889 would never get MOVE_X_REACHED. */
7890 xassert (it
->nglyphs
== 0);
7891 result
= MOVE_X_REACHED
;
7895 /* Is this a line end? If yes, we're done. */
7896 if (ITERATOR_AT_END_OF_LINE_P (it
))
7898 /* If we are past TO_CHARPOS, but never saw any character
7899 positions smaller than TO_CHARPOS, return
7900 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
7902 if ((op
& MOVE_TO_POS
) != 0
7904 && IT_CHARPOS (*it
) > to_charpos
)
7905 result
= MOVE_POS_MATCH_OR_ZV
;
7907 result
= MOVE_NEWLINE_OR_CR
;
7911 prev_method
= it
->method
;
7912 if (it
->method
== GET_FROM_BUFFER
)
7913 prev_pos
= IT_CHARPOS (*it
);
7914 /* The current display element has been consumed. Advance
7916 set_iterator_to_next (it
, 1);
7917 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7918 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7919 if (IT_CHARPOS (*it
) < to_charpos
)
7920 saw_smaller_pos
= 1;
7922 /* Stop if lines are truncated and IT's current x-position is
7923 past the right edge of the window now. */
7924 if (it
->line_wrap
== TRUNCATE
7925 && it
->current_x
>= it
->last_visible_x
)
7927 if (!FRAME_WINDOW_P (it
->f
)
7928 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7930 if (!get_next_display_element (it
)
7931 || BUFFER_POS_REACHED_P ()
7932 /* If we are past TO_CHARPOS, but never saw any
7933 character positions smaller than TO_CHARPOS,
7934 return MOVE_POS_MATCH_OR_ZV, like the
7935 unidirectional display did. */
7936 || ((op
& MOVE_TO_POS
) != 0
7938 && IT_CHARPOS (*it
) > to_charpos
))
7940 result
= MOVE_POS_MATCH_OR_ZV
;
7943 if (ITERATOR_AT_END_OF_LINE_P (it
))
7945 result
= MOVE_NEWLINE_OR_CR
;
7949 else if ((op
& MOVE_TO_POS
) != 0
7951 && IT_CHARPOS (*it
) > to_charpos
)
7953 result
= MOVE_POS_MATCH_OR_ZV
;
7956 result
= MOVE_LINE_TRUNCATED
;
7959 #undef IT_RESET_X_ASCENT_DESCENT
7962 #undef BUFFER_POS_REACHED_P
7964 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7965 restore the saved iterator. */
7966 if (atpos_it
.sp
>= 0)
7967 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7968 else if (atx_it
.sp
>= 0)
7969 RESTORE_IT (it
, &atx_it
, atx_data
);
7980 /* Restore the iterator settings altered at the beginning of this
7982 it
->glyph_row
= saved_glyph_row
;
7986 /* For external use. */
7988 move_it_in_display_line (struct it
*it
,
7989 EMACS_INT to_charpos
, int to_x
,
7990 enum move_operation_enum op
)
7992 if (it
->line_wrap
== WORD_WRAP
7993 && (op
& MOVE_TO_X
))
7996 void *save_data
= NULL
;
7999 SAVE_IT (save_it
, *it
, save_data
);
8000 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8001 /* When word-wrap is on, TO_X may lie past the end
8002 of a wrapped line. Then it->current is the
8003 character on the next line, so backtrack to the
8004 space before the wrap point. */
8005 if (skip
== MOVE_LINE_CONTINUED
)
8007 int prev_x
= max (it
->current_x
- 1, 0);
8008 RESTORE_IT (it
, &save_it
, save_data
);
8009 move_it_in_display_line_to
8010 (it
, -1, prev_x
, MOVE_TO_X
);
8016 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8020 /* Move IT forward until it satisfies one or more of the criteria in
8021 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8023 OP is a bit-mask that specifies where to stop, and in particular,
8024 which of those four position arguments makes a difference. See the
8025 description of enum move_operation_enum.
8027 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8028 screen line, this function will set IT to the next position that is
8029 displayed to the right of TO_CHARPOS on the screen. */
8032 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8034 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8035 int line_height
, line_start_x
= 0, reached
= 0;
8036 void *backup_data
= NULL
;
8040 if (op
& MOVE_TO_VPOS
)
8042 /* If no TO_CHARPOS and no TO_X specified, stop at the
8043 start of the line TO_VPOS. */
8044 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8046 if (it
->vpos
== to_vpos
)
8052 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8056 /* TO_VPOS >= 0 means stop at TO_X in the line at
8057 TO_VPOS, or at TO_POS, whichever comes first. */
8058 if (it
->vpos
== to_vpos
)
8064 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8066 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8071 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8073 /* We have reached TO_X but not in the line we want. */
8074 skip
= move_it_in_display_line_to (it
, to_charpos
,
8076 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8084 else if (op
& MOVE_TO_Y
)
8086 struct it it_backup
;
8088 if (it
->line_wrap
== WORD_WRAP
)
8089 SAVE_IT (it_backup
, *it
, backup_data
);
8091 /* TO_Y specified means stop at TO_X in the line containing
8092 TO_Y---or at TO_CHARPOS if this is reached first. The
8093 problem is that we can't really tell whether the line
8094 contains TO_Y before we have completely scanned it, and
8095 this may skip past TO_X. What we do is to first scan to
8098 If TO_X is not specified, use a TO_X of zero. The reason
8099 is to make the outcome of this function more predictable.
8100 If we didn't use TO_X == 0, we would stop at the end of
8101 the line which is probably not what a caller would expect
8103 skip
= move_it_in_display_line_to
8104 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8105 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8107 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8108 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8110 else if (skip
== MOVE_X_REACHED
)
8112 /* If TO_X was reached, we want to know whether TO_Y is
8113 in the line. We know this is the case if the already
8114 scanned glyphs make the line tall enough. Otherwise,
8115 we must check by scanning the rest of the line. */
8116 line_height
= it
->max_ascent
+ it
->max_descent
;
8117 if (to_y
>= it
->current_y
8118 && to_y
< it
->current_y
+ line_height
)
8123 SAVE_IT (it_backup
, *it
, backup_data
);
8124 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8125 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8127 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8128 line_height
= it
->max_ascent
+ it
->max_descent
;
8129 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8131 if (to_y
>= it
->current_y
8132 && to_y
< it
->current_y
+ line_height
)
8134 /* If TO_Y is in this line and TO_X was reached
8135 above, we scanned too far. We have to restore
8136 IT's settings to the ones before skipping. */
8137 RESTORE_IT (it
, &it_backup
, backup_data
);
8143 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8149 /* Check whether TO_Y is in this line. */
8150 line_height
= it
->max_ascent
+ it
->max_descent
;
8151 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8153 if (to_y
>= it
->current_y
8154 && to_y
< it
->current_y
+ line_height
)
8156 /* When word-wrap is on, TO_X may lie past the end
8157 of a wrapped line. Then it->current is the
8158 character on the next line, so backtrack to the
8159 space before the wrap point. */
8160 if (skip
== MOVE_LINE_CONTINUED
8161 && it
->line_wrap
== WORD_WRAP
)
8163 int prev_x
= max (it
->current_x
- 1, 0);
8164 RESTORE_IT (it
, &it_backup
, backup_data
);
8165 skip
= move_it_in_display_line_to
8166 (it
, -1, prev_x
, MOVE_TO_X
);
8175 else if (BUFFERP (it
->object
)
8176 && (it
->method
== GET_FROM_BUFFER
8177 || it
->method
== GET_FROM_STRETCH
)
8178 && IT_CHARPOS (*it
) >= to_charpos
)
8179 skip
= MOVE_POS_MATCH_OR_ZV
;
8181 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8185 case MOVE_POS_MATCH_OR_ZV
:
8189 case MOVE_NEWLINE_OR_CR
:
8190 set_iterator_to_next (it
, 1);
8191 it
->continuation_lines_width
= 0;
8194 case MOVE_LINE_TRUNCATED
:
8195 it
->continuation_lines_width
= 0;
8196 reseat_at_next_visible_line_start (it
, 0);
8197 if ((op
& MOVE_TO_POS
) != 0
8198 && IT_CHARPOS (*it
) > to_charpos
)
8205 case MOVE_LINE_CONTINUED
:
8206 /* For continued lines ending in a tab, some of the glyphs
8207 associated with the tab are displayed on the current
8208 line. Since it->current_x does not include these glyphs,
8209 we use it->last_visible_x instead. */
8212 it
->continuation_lines_width
+= it
->last_visible_x
;
8213 /* When moving by vpos, ensure that the iterator really
8214 advances to the next line (bug#847, bug#969). Fixme:
8215 do we need to do this in other circumstances? */
8216 if (it
->current_x
!= it
->last_visible_x
8217 && (op
& MOVE_TO_VPOS
)
8218 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8220 line_start_x
= it
->current_x
+ it
->pixel_width
8221 - it
->last_visible_x
;
8222 set_iterator_to_next (it
, 0);
8226 it
->continuation_lines_width
+= it
->current_x
;
8233 /* Reset/increment for the next run. */
8234 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8235 it
->current_x
= line_start_x
;
8238 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8240 last_height
= it
->max_ascent
+ it
->max_descent
;
8241 last_max_ascent
= it
->max_ascent
;
8242 it
->max_ascent
= it
->max_descent
= 0;
8247 /* On text terminals, we may stop at the end of a line in the middle
8248 of a multi-character glyph. If the glyph itself is continued,
8249 i.e. it is actually displayed on the next line, don't treat this
8250 stopping point as valid; move to the next line instead (unless
8251 that brings us offscreen). */
8252 if (!FRAME_WINDOW_P (it
->f
)
8254 && IT_CHARPOS (*it
) == to_charpos
8255 && it
->what
== IT_CHARACTER
8257 && it
->line_wrap
== WINDOW_WRAP
8258 && it
->current_x
== it
->last_visible_x
- 1
8261 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8263 it
->continuation_lines_width
+= it
->current_x
;
8264 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8265 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8267 last_height
= it
->max_ascent
+ it
->max_descent
;
8268 last_max_ascent
= it
->max_ascent
;
8272 xfree (backup_data
);
8274 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8278 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8280 If DY > 0, move IT backward at least that many pixels. DY = 0
8281 means move IT backward to the preceding line start or BEGV. This
8282 function may move over more than DY pixels if IT->current_y - DY
8283 ends up in the middle of a line; in this case IT->current_y will be
8284 set to the top of the line moved to. */
8287 move_it_vertically_backward (struct it
*it
, int dy
)
8291 void *it2data
= NULL
, *it3data
= NULL
;
8292 EMACS_INT start_pos
;
8297 start_pos
= IT_CHARPOS (*it
);
8299 /* Estimate how many newlines we must move back. */
8300 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8302 /* Set the iterator's position that many lines back. */
8303 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8304 back_to_previous_visible_line_start (it
);
8306 /* Reseat the iterator here. When moving backward, we don't want
8307 reseat to skip forward over invisible text, set up the iterator
8308 to deliver from overlay strings at the new position etc. So,
8309 use reseat_1 here. */
8310 reseat_1 (it
, it
->current
.pos
, 1);
8312 /* We are now surely at a line start. */
8313 it
->current_x
= it
->hpos
= 0;
8314 it
->continuation_lines_width
= 0;
8316 /* Move forward and see what y-distance we moved. First move to the
8317 start of the next line so that we get its height. We need this
8318 height to be able to tell whether we reached the specified
8320 SAVE_IT (it2
, *it
, it2data
);
8321 it2
.max_ascent
= it2
.max_descent
= 0;
8324 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8325 MOVE_TO_POS
| MOVE_TO_VPOS
);
8327 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8328 xassert (IT_CHARPOS (*it
) >= BEGV
);
8329 SAVE_IT (it3
, it2
, it3data
);
8331 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8332 xassert (IT_CHARPOS (*it
) >= BEGV
);
8333 /* H is the actual vertical distance from the position in *IT
8334 and the starting position. */
8335 h
= it2
.current_y
- it
->current_y
;
8336 /* NLINES is the distance in number of lines. */
8337 nlines
= it2
.vpos
- it
->vpos
;
8339 /* Correct IT's y and vpos position
8340 so that they are relative to the starting point. */
8346 /* DY == 0 means move to the start of the screen line. The
8347 value of nlines is > 0 if continuation lines were involved. */
8348 RESTORE_IT (it
, it
, it2data
);
8350 move_it_by_lines (it
, nlines
);
8355 /* The y-position we try to reach, relative to *IT.
8356 Note that H has been subtracted in front of the if-statement. */
8357 int target_y
= it
->current_y
+ h
- dy
;
8358 int y0
= it3
.current_y
;
8362 RESTORE_IT (&it3
, &it3
, it3data
);
8363 y1
= line_bottom_y (&it3
);
8364 line_height
= y1
- y0
;
8365 RESTORE_IT (it
, it
, it2data
);
8366 /* If we did not reach target_y, try to move further backward if
8367 we can. If we moved too far backward, try to move forward. */
8368 if (target_y
< it
->current_y
8369 /* This is heuristic. In a window that's 3 lines high, with
8370 a line height of 13 pixels each, recentering with point
8371 on the bottom line will try to move -39/2 = 19 pixels
8372 backward. Try to avoid moving into the first line. */
8373 && (it
->current_y
- target_y
8374 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8375 && IT_CHARPOS (*it
) > BEGV
)
8377 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8378 target_y
- it
->current_y
));
8379 dy
= it
->current_y
- target_y
;
8380 goto move_further_back
;
8382 else if (target_y
>= it
->current_y
+ line_height
8383 && IT_CHARPOS (*it
) < ZV
)
8385 /* Should move forward by at least one line, maybe more.
8387 Note: Calling move_it_by_lines can be expensive on
8388 terminal frames, where compute_motion is used (via
8389 vmotion) to do the job, when there are very long lines
8390 and truncate-lines is nil. That's the reason for
8391 treating terminal frames specially here. */
8393 if (!FRAME_WINDOW_P (it
->f
))
8394 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8399 move_it_by_lines (it
, 1);
8401 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8408 /* Move IT by a specified amount of pixel lines DY. DY negative means
8409 move backwards. DY = 0 means move to start of screen line. At the
8410 end, IT will be on the start of a screen line. */
8413 move_it_vertically (struct it
*it
, int dy
)
8416 move_it_vertically_backward (it
, -dy
);
8419 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8420 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8421 MOVE_TO_POS
| MOVE_TO_Y
);
8422 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8424 /* If buffer ends in ZV without a newline, move to the start of
8425 the line to satisfy the post-condition. */
8426 if (IT_CHARPOS (*it
) == ZV
8428 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8429 move_it_by_lines (it
, 0);
8434 /* Move iterator IT past the end of the text line it is in. */
8437 move_it_past_eol (struct it
*it
)
8439 enum move_it_result rc
;
8441 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8442 if (rc
== MOVE_NEWLINE_OR_CR
)
8443 set_iterator_to_next (it
, 0);
8447 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8448 negative means move up. DVPOS == 0 means move to the start of the
8451 Optimization idea: If we would know that IT->f doesn't use
8452 a face with proportional font, we could be faster for
8453 truncate-lines nil. */
8456 move_it_by_lines (struct it
*it
, int dvpos
)
8459 /* The commented-out optimization uses vmotion on terminals. This
8460 gives bad results, because elements like it->what, on which
8461 callers such as pos_visible_p rely, aren't updated. */
8462 /* struct position pos;
8463 if (!FRAME_WINDOW_P (it->f))
8465 struct text_pos textpos;
8467 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8468 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8469 reseat (it, textpos, 1);
8470 it->vpos += pos.vpos;
8471 it->current_y += pos.vpos;
8477 /* DVPOS == 0 means move to the start of the screen line. */
8478 move_it_vertically_backward (it
, 0);
8479 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8480 /* Let next call to line_bottom_y calculate real line height */
8485 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8486 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8487 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8492 void *it2data
= NULL
;
8493 EMACS_INT start_charpos
, i
;
8495 /* Start at the beginning of the screen line containing IT's
8496 position. This may actually move vertically backwards,
8497 in case of overlays, so adjust dvpos accordingly. */
8499 move_it_vertically_backward (it
, 0);
8502 /* Go back -DVPOS visible lines and reseat the iterator there. */
8503 start_charpos
= IT_CHARPOS (*it
);
8504 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8505 back_to_previous_visible_line_start (it
);
8506 reseat (it
, it
->current
.pos
, 1);
8508 /* Move further back if we end up in a string or an image. */
8509 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8511 /* First try to move to start of display line. */
8513 move_it_vertically_backward (it
, 0);
8515 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8517 /* If start of line is still in string or image,
8518 move further back. */
8519 back_to_previous_visible_line_start (it
);
8520 reseat (it
, it
->current
.pos
, 1);
8524 it
->current_x
= it
->hpos
= 0;
8526 /* Above call may have moved too far if continuation lines
8527 are involved. Scan forward and see if it did. */
8528 SAVE_IT (it2
, *it
, it2data
);
8529 it2
.vpos
= it2
.current_y
= 0;
8530 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8531 it
->vpos
-= it2
.vpos
;
8532 it
->current_y
-= it2
.current_y
;
8533 it
->current_x
= it
->hpos
= 0;
8535 /* If we moved too far back, move IT some lines forward. */
8536 if (it2
.vpos
> -dvpos
)
8538 int delta
= it2
.vpos
+ dvpos
;
8540 RESTORE_IT (&it2
, &it2
, it2data
);
8541 SAVE_IT (it2
, *it
, it2data
);
8542 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8543 /* Move back again if we got too far ahead. */
8544 if (IT_CHARPOS (*it
) >= start_charpos
)
8545 RESTORE_IT (it
, &it2
, it2data
);
8550 RESTORE_IT (it
, it
, it2data
);
8554 /* Return 1 if IT points into the middle of a display vector. */
8557 in_display_vector_p (struct it
*it
)
8559 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8560 && it
->current
.dpvec_index
> 0
8561 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8565 /***********************************************************************
8567 ***********************************************************************/
8570 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8574 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8576 Lisp_Object args
[3];
8577 Lisp_Object msg
, fmt
;
8580 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8583 /* Do nothing if called asynchronously. Inserting text into
8584 a buffer may call after-change-functions and alike and
8585 that would means running Lisp asynchronously. */
8586 if (handling_signal
)
8590 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8592 args
[0] = fmt
= build_string (format
);
8595 msg
= Fformat (3, args
);
8597 len
= SBYTES (msg
) + 1;
8598 SAFE_ALLOCA (buffer
, char *, len
);
8599 memcpy (buffer
, SDATA (msg
), len
);
8601 message_dolog (buffer
, len
- 1, 1, 0);
8608 /* Output a newline in the *Messages* buffer if "needs" one. */
8611 message_log_maybe_newline (void)
8613 if (message_log_need_newline
)
8614 message_dolog ("", 0, 1, 0);
8618 /* Add a string M of length NBYTES to the message log, optionally
8619 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8620 nonzero, means interpret the contents of M as multibyte. This
8621 function calls low-level routines in order to bypass text property
8622 hooks, etc. which might not be safe to run.
8624 This may GC (insert may run before/after change hooks),
8625 so the buffer M must NOT point to a Lisp string. */
8628 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8630 const unsigned char *msg
= (const unsigned char *) m
;
8632 if (!NILP (Vmemory_full
))
8635 if (!NILP (Vmessage_log_max
))
8637 struct buffer
*oldbuf
;
8638 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8639 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8640 EMACS_INT point_at_end
= 0;
8641 EMACS_INT zv_at_end
= 0;
8642 Lisp_Object old_deactivate_mark
, tem
;
8643 struct gcpro gcpro1
;
8645 old_deactivate_mark
= Vdeactivate_mark
;
8646 oldbuf
= current_buffer
;
8647 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8648 BVAR (current_buffer
, undo_list
) = Qt
;
8650 oldpoint
= message_dolog_marker1
;
8651 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8652 oldbegv
= message_dolog_marker2
;
8653 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8654 oldzv
= message_dolog_marker3
;
8655 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8656 GCPRO1 (old_deactivate_mark
);
8664 BEGV_BYTE
= BEG_BYTE
;
8667 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8669 /* Insert the string--maybe converting multibyte to single byte
8670 or vice versa, so that all the text fits the buffer. */
8672 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8678 /* Convert a multibyte string to single-byte
8679 for the *Message* buffer. */
8680 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8682 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8683 work
[0] = (ASCII_CHAR_P (c
)
8685 : multibyte_char_to_unibyte (c
));
8686 insert_1_both (work
, 1, 1, 1, 0, 0);
8689 else if (! multibyte
8690 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8694 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8695 /* Convert a single-byte string to multibyte
8696 for the *Message* buffer. */
8697 for (i
= 0; i
< nbytes
; i
++)
8700 MAKE_CHAR_MULTIBYTE (c
);
8701 char_bytes
= CHAR_STRING (c
, str
);
8702 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8706 insert_1 (m
, nbytes
, 1, 0, 0);
8710 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8712 insert_1 ("\n", 1, 1, 0, 0);
8714 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8716 this_bol_byte
= PT_BYTE
;
8718 /* See if this line duplicates the previous one.
8719 If so, combine duplicates. */
8722 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8724 prev_bol_byte
= PT_BYTE
;
8726 dups
= message_log_check_duplicate (prev_bol_byte
,
8730 del_range_both (prev_bol
, prev_bol_byte
,
8731 this_bol
, this_bol_byte
, 0);
8734 char dupstr
[sizeof " [ times]"
8735 + INT_STRLEN_BOUND (printmax_t
)];
8738 /* If you change this format, don't forget to also
8739 change message_log_check_duplicate. */
8740 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8741 duplen
= strlen (dupstr
);
8742 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8743 insert_1 (dupstr
, duplen
, 1, 0, 1);
8748 /* If we have more than the desired maximum number of lines
8749 in the *Messages* buffer now, delete the oldest ones.
8750 This is safe because we don't have undo in this buffer. */
8752 if (NATNUMP (Vmessage_log_max
))
8754 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8755 -XFASTINT (Vmessage_log_max
) - 1, 0);
8756 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8759 BEGV
= XMARKER (oldbegv
)->charpos
;
8760 BEGV_BYTE
= marker_byte_position (oldbegv
);
8769 ZV
= XMARKER (oldzv
)->charpos
;
8770 ZV_BYTE
= marker_byte_position (oldzv
);
8774 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8776 /* We can't do Fgoto_char (oldpoint) because it will run some
8778 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8779 XMARKER (oldpoint
)->bytepos
);
8782 unchain_marker (XMARKER (oldpoint
));
8783 unchain_marker (XMARKER (oldbegv
));
8784 unchain_marker (XMARKER (oldzv
));
8786 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8787 set_buffer_internal (oldbuf
);
8789 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8790 message_log_need_newline
= !nlflag
;
8791 Vdeactivate_mark
= old_deactivate_mark
;
8796 /* We are at the end of the buffer after just having inserted a newline.
8797 (Note: We depend on the fact we won't be crossing the gap.)
8798 Check to see if the most recent message looks a lot like the previous one.
8799 Return 0 if different, 1 if the new one should just replace it, or a
8800 value N > 1 if we should also append " [N times]". */
8803 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8806 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8808 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8809 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8811 for (i
= 0; i
< len
; i
++)
8813 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8821 if (*p1
++ == ' ' && *p1
++ == '[')
8824 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8825 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8832 /* Display an echo area message M with a specified length of NBYTES
8833 bytes. The string may include null characters. If M is 0, clear
8834 out any existing message, and let the mini-buffer text show
8837 This may GC, so the buffer M must NOT point to a Lisp string. */
8840 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8842 /* First flush out any partial line written with print. */
8843 message_log_maybe_newline ();
8845 message_dolog (m
, nbytes
, 1, multibyte
);
8846 message2_nolog (m
, nbytes
, multibyte
);
8850 /* The non-logging counterpart of message2. */
8853 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8855 struct frame
*sf
= SELECTED_FRAME ();
8856 message_enable_multibyte
= multibyte
;
8858 if (FRAME_INITIAL_P (sf
))
8860 if (noninteractive_need_newline
)
8861 putc ('\n', stderr
);
8862 noninteractive_need_newline
= 0;
8864 fwrite (m
, nbytes
, 1, stderr
);
8865 if (cursor_in_echo_area
== 0)
8866 fprintf (stderr
, "\n");
8869 /* A null message buffer means that the frame hasn't really been
8870 initialized yet. Error messages get reported properly by
8871 cmd_error, so this must be just an informative message; toss it. */
8872 else if (INTERACTIVE
8873 && sf
->glyphs_initialized_p
8874 && FRAME_MESSAGE_BUF (sf
))
8876 Lisp_Object mini_window
;
8879 /* Get the frame containing the mini-buffer
8880 that the selected frame is using. */
8881 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8882 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8884 FRAME_SAMPLE_VISIBILITY (f
);
8885 if (FRAME_VISIBLE_P (sf
)
8886 && ! FRAME_VISIBLE_P (f
))
8887 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8891 set_message (m
, Qnil
, nbytes
, multibyte
);
8892 if (minibuffer_auto_raise
)
8893 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8896 clear_message (1, 1);
8898 do_pending_window_change (0);
8899 echo_area_display (1);
8900 do_pending_window_change (0);
8901 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8902 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8907 /* Display an echo area message M with a specified length of NBYTES
8908 bytes. The string may include null characters. If M is not a
8909 string, clear out any existing message, and let the mini-buffer
8912 This function cancels echoing. */
8915 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8917 struct gcpro gcpro1
;
8920 clear_message (1,1);
8923 /* First flush out any partial line written with print. */
8924 message_log_maybe_newline ();
8930 SAFE_ALLOCA (buffer
, char *, nbytes
);
8931 memcpy (buffer
, SDATA (m
), nbytes
);
8932 message_dolog (buffer
, nbytes
, 1, multibyte
);
8935 message3_nolog (m
, nbytes
, multibyte
);
8941 /* The non-logging version of message3.
8942 This does not cancel echoing, because it is used for echoing.
8943 Perhaps we need to make a separate function for echoing
8944 and make this cancel echoing. */
8947 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8949 struct frame
*sf
= SELECTED_FRAME ();
8950 message_enable_multibyte
= multibyte
;
8952 if (FRAME_INITIAL_P (sf
))
8954 if (noninteractive_need_newline
)
8955 putc ('\n', stderr
);
8956 noninteractive_need_newline
= 0;
8958 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8959 if (cursor_in_echo_area
== 0)
8960 fprintf (stderr
, "\n");
8963 /* A null message buffer means that the frame hasn't really been
8964 initialized yet. Error messages get reported properly by
8965 cmd_error, so this must be just an informative message; toss it. */
8966 else if (INTERACTIVE
8967 && sf
->glyphs_initialized_p
8968 && FRAME_MESSAGE_BUF (sf
))
8970 Lisp_Object mini_window
;
8974 /* Get the frame containing the mini-buffer
8975 that the selected frame is using. */
8976 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8977 frame
= XWINDOW (mini_window
)->frame
;
8980 FRAME_SAMPLE_VISIBILITY (f
);
8981 if (FRAME_VISIBLE_P (sf
)
8982 && !FRAME_VISIBLE_P (f
))
8983 Fmake_frame_visible (frame
);
8985 if (STRINGP (m
) && SCHARS (m
) > 0)
8987 set_message (NULL
, m
, nbytes
, multibyte
);
8988 if (minibuffer_auto_raise
)
8989 Fraise_frame (frame
);
8990 /* Assume we are not echoing.
8991 (If we are, echo_now will override this.) */
8992 echo_message_buffer
= Qnil
;
8995 clear_message (1, 1);
8997 do_pending_window_change (0);
8998 echo_area_display (1);
8999 do_pending_window_change (0);
9000 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9001 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9006 /* Display a null-terminated echo area message M. If M is 0, clear
9007 out any existing message, and let the mini-buffer text show through.
9009 The buffer M must continue to exist until after the echo area gets
9010 cleared or some other message gets displayed there. Do not pass
9011 text that is stored in a Lisp string. Do not pass text in a buffer
9012 that was alloca'd. */
9015 message1 (const char *m
)
9017 message2 (m
, (m
? strlen (m
) : 0), 0);
9021 /* The non-logging counterpart of message1. */
9024 message1_nolog (const char *m
)
9026 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9029 /* Display a message M which contains a single %s
9030 which gets replaced with STRING. */
9033 message_with_string (const char *m
, Lisp_Object string
, int log
)
9035 CHECK_STRING (string
);
9041 if (noninteractive_need_newline
)
9042 putc ('\n', stderr
);
9043 noninteractive_need_newline
= 0;
9044 fprintf (stderr
, m
, SDATA (string
));
9045 if (!cursor_in_echo_area
)
9046 fprintf (stderr
, "\n");
9050 else if (INTERACTIVE
)
9052 /* The frame whose minibuffer we're going to display the message on.
9053 It may be larger than the selected frame, so we need
9054 to use its buffer, not the selected frame's buffer. */
9055 Lisp_Object mini_window
;
9056 struct frame
*f
, *sf
= SELECTED_FRAME ();
9058 /* Get the frame containing the minibuffer
9059 that the selected frame is using. */
9060 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9061 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9063 /* A null message buffer means that the frame hasn't really been
9064 initialized yet. Error messages get reported properly by
9065 cmd_error, so this must be just an informative message; toss it. */
9066 if (FRAME_MESSAGE_BUF (f
))
9068 Lisp_Object args
[2], msg
;
9069 struct gcpro gcpro1
, gcpro2
;
9071 args
[0] = build_string (m
);
9072 args
[1] = msg
= string
;
9073 GCPRO2 (args
[0], msg
);
9076 msg
= Fformat (2, args
);
9079 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9081 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9085 /* Print should start at the beginning of the message
9086 buffer next time. */
9087 message_buf_print
= 0;
9093 /* Dump an informative message to the minibuf. If M is 0, clear out
9094 any existing message, and let the mini-buffer text show through. */
9097 vmessage (const char *m
, va_list ap
)
9103 if (noninteractive_need_newline
)
9104 putc ('\n', stderr
);
9105 noninteractive_need_newline
= 0;
9106 vfprintf (stderr
, m
, ap
);
9107 if (cursor_in_echo_area
== 0)
9108 fprintf (stderr
, "\n");
9112 else if (INTERACTIVE
)
9114 /* The frame whose mini-buffer we're going to display the message
9115 on. It may be larger than the selected frame, so we need to
9116 use its buffer, not the selected frame's buffer. */
9117 Lisp_Object mini_window
;
9118 struct frame
*f
, *sf
= SELECTED_FRAME ();
9120 /* Get the frame containing the mini-buffer
9121 that the selected frame is using. */
9122 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9123 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9125 /* A null message buffer means that the frame hasn't really been
9126 initialized yet. Error messages get reported properly by
9127 cmd_error, so this must be just an informative message; toss
9129 if (FRAME_MESSAGE_BUF (f
))
9135 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9136 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9138 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9143 /* Print should start at the beginning of the message
9144 buffer next time. */
9145 message_buf_print
= 0;
9151 message (const char *m
, ...)
9161 /* The non-logging version of message. */
9164 message_nolog (const char *m
, ...)
9166 Lisp_Object old_log_max
;
9169 old_log_max
= Vmessage_log_max
;
9170 Vmessage_log_max
= Qnil
;
9172 Vmessage_log_max
= old_log_max
;
9178 /* Display the current message in the current mini-buffer. This is
9179 only called from error handlers in process.c, and is not time
9183 update_echo_area (void)
9185 if (!NILP (echo_area_buffer
[0]))
9188 string
= Fcurrent_message ();
9189 message3 (string
, SBYTES (string
),
9190 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9195 /* Make sure echo area buffers in `echo_buffers' are live.
9196 If they aren't, make new ones. */
9199 ensure_echo_area_buffers (void)
9203 for (i
= 0; i
< 2; ++i
)
9204 if (!BUFFERP (echo_buffer
[i
])
9205 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9208 Lisp_Object old_buffer
;
9211 old_buffer
= echo_buffer
[i
];
9212 sprintf (name
, " *Echo Area %d*", i
);
9213 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9214 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9215 /* to force word wrap in echo area -
9216 it was decided to postpone this*/
9217 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9219 for (j
= 0; j
< 2; ++j
)
9220 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9221 echo_area_buffer
[j
] = echo_buffer
[i
];
9226 /* Call FN with args A1..A4 with either the current or last displayed
9227 echo_area_buffer as current buffer.
9229 WHICH zero means use the current message buffer
9230 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9231 from echo_buffer[] and clear it.
9233 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9234 suitable buffer from echo_buffer[] and clear it.
9236 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9237 that the current message becomes the last displayed one, make
9238 choose a suitable buffer for echo_area_buffer[0], and clear it.
9240 Value is what FN returns. */
9243 with_echo_area_buffer (struct window
*w
, int which
,
9244 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9245 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9248 int this_one
, the_other
, clear_buffer_p
, rc
;
9249 int count
= SPECPDL_INDEX ();
9251 /* If buffers aren't live, make new ones. */
9252 ensure_echo_area_buffers ();
9257 this_one
= 0, the_other
= 1;
9259 this_one
= 1, the_other
= 0;
9262 this_one
= 0, the_other
= 1;
9265 /* We need a fresh one in case the current echo buffer equals
9266 the one containing the last displayed echo area message. */
9267 if (!NILP (echo_area_buffer
[this_one
])
9268 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9269 echo_area_buffer
[this_one
] = Qnil
;
9272 /* Choose a suitable buffer from echo_buffer[] is we don't
9274 if (NILP (echo_area_buffer
[this_one
]))
9276 echo_area_buffer
[this_one
]
9277 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9278 ? echo_buffer
[the_other
]
9279 : echo_buffer
[this_one
]);
9283 buffer
= echo_area_buffer
[this_one
];
9285 /* Don't get confused by reusing the buffer used for echoing
9286 for a different purpose. */
9287 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9290 record_unwind_protect (unwind_with_echo_area_buffer
,
9291 with_echo_area_buffer_unwind_data (w
));
9293 /* Make the echo area buffer current. Note that for display
9294 purposes, it is not necessary that the displayed window's buffer
9295 == current_buffer, except for text property lookup. So, let's
9296 only set that buffer temporarily here without doing a full
9297 Fset_window_buffer. We must also change w->pointm, though,
9298 because otherwise an assertions in unshow_buffer fails, and Emacs
9300 set_buffer_internal_1 (XBUFFER (buffer
));
9304 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9307 BVAR (current_buffer
, undo_list
) = Qt
;
9308 BVAR (current_buffer
, read_only
) = Qnil
;
9309 specbind (Qinhibit_read_only
, Qt
);
9310 specbind (Qinhibit_modification_hooks
, Qt
);
9312 if (clear_buffer_p
&& Z
> BEG
)
9315 xassert (BEGV
>= BEG
);
9316 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9318 rc
= fn (a1
, a2
, a3
, a4
);
9320 xassert (BEGV
>= BEG
);
9321 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9323 unbind_to (count
, Qnil
);
9328 /* Save state that should be preserved around the call to the function
9329 FN called in with_echo_area_buffer. */
9332 with_echo_area_buffer_unwind_data (struct window
*w
)
9335 Lisp_Object vector
, tmp
;
9337 /* Reduce consing by keeping one vector in
9338 Vwith_echo_area_save_vector. */
9339 vector
= Vwith_echo_area_save_vector
;
9340 Vwith_echo_area_save_vector
= Qnil
;
9343 vector
= Fmake_vector (make_number (7), Qnil
);
9345 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9346 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9347 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9351 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9352 ASET (vector
, i
, w
->buffer
); ++i
;
9353 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9354 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9359 for (; i
< end
; ++i
)
9360 ASET (vector
, i
, Qnil
);
9363 xassert (i
== ASIZE (vector
));
9368 /* Restore global state from VECTOR which was created by
9369 with_echo_area_buffer_unwind_data. */
9372 unwind_with_echo_area_buffer (Lisp_Object vector
)
9374 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9375 Vdeactivate_mark
= AREF (vector
, 1);
9376 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9378 if (WINDOWP (AREF (vector
, 3)))
9381 Lisp_Object buffer
, charpos
, bytepos
;
9383 w
= XWINDOW (AREF (vector
, 3));
9384 buffer
= AREF (vector
, 4);
9385 charpos
= AREF (vector
, 5);
9386 bytepos
= AREF (vector
, 6);
9389 set_marker_both (w
->pointm
, buffer
,
9390 XFASTINT (charpos
), XFASTINT (bytepos
));
9393 Vwith_echo_area_save_vector
= vector
;
9398 /* Set up the echo area for use by print functions. MULTIBYTE_P
9399 non-zero means we will print multibyte. */
9402 setup_echo_area_for_printing (int multibyte_p
)
9404 /* If we can't find an echo area any more, exit. */
9405 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9408 ensure_echo_area_buffers ();
9410 if (!message_buf_print
)
9412 /* A message has been output since the last time we printed.
9413 Choose a fresh echo area buffer. */
9414 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9415 echo_area_buffer
[0] = echo_buffer
[1];
9417 echo_area_buffer
[0] = echo_buffer
[0];
9419 /* Switch to that buffer and clear it. */
9420 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9421 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9425 int count
= SPECPDL_INDEX ();
9426 specbind (Qinhibit_read_only
, Qt
);
9427 /* Note that undo recording is always disabled. */
9429 unbind_to (count
, Qnil
);
9431 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9433 /* Set up the buffer for the multibyteness we need. */
9435 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9436 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9438 /* Raise the frame containing the echo area. */
9439 if (minibuffer_auto_raise
)
9441 struct frame
*sf
= SELECTED_FRAME ();
9442 Lisp_Object mini_window
;
9443 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9444 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9447 message_log_maybe_newline ();
9448 message_buf_print
= 1;
9452 if (NILP (echo_area_buffer
[0]))
9454 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9455 echo_area_buffer
[0] = echo_buffer
[1];
9457 echo_area_buffer
[0] = echo_buffer
[0];
9460 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9462 /* Someone switched buffers between print requests. */
9463 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9464 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9470 /* Display an echo area message in window W. Value is non-zero if W's
9471 height is changed. If display_last_displayed_message_p is
9472 non-zero, display the message that was last displayed, otherwise
9473 display the current message. */
9476 display_echo_area (struct window
*w
)
9478 int i
, no_message_p
, window_height_changed_p
, count
;
9480 /* Temporarily disable garbage collections while displaying the echo
9481 area. This is done because a GC can print a message itself.
9482 That message would modify the echo area buffer's contents while a
9483 redisplay of the buffer is going on, and seriously confuse
9485 count
= inhibit_garbage_collection ();
9487 /* If there is no message, we must call display_echo_area_1
9488 nevertheless because it resizes the window. But we will have to
9489 reset the echo_area_buffer in question to nil at the end because
9490 with_echo_area_buffer will sets it to an empty buffer. */
9491 i
= display_last_displayed_message_p
? 1 : 0;
9492 no_message_p
= NILP (echo_area_buffer
[i
]);
9494 window_height_changed_p
9495 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9496 display_echo_area_1
,
9497 (intptr_t) w
, Qnil
, 0, 0);
9500 echo_area_buffer
[i
] = Qnil
;
9502 unbind_to (count
, Qnil
);
9503 return window_height_changed_p
;
9507 /* Helper for display_echo_area. Display the current buffer which
9508 contains the current echo area message in window W, a mini-window,
9509 a pointer to which is passed in A1. A2..A4 are currently not used.
9510 Change the height of W so that all of the message is displayed.
9511 Value is non-zero if height of W was changed. */
9514 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9517 struct window
*w
= (struct window
*) i1
;
9519 struct text_pos start
;
9520 int window_height_changed_p
= 0;
9522 /* Do this before displaying, so that we have a large enough glyph
9523 matrix for the display. If we can't get enough space for the
9524 whole text, display the last N lines. That works by setting w->start. */
9525 window_height_changed_p
= resize_mini_window (w
, 0);
9527 /* Use the starting position chosen by resize_mini_window. */
9528 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9531 clear_glyph_matrix (w
->desired_matrix
);
9532 XSETWINDOW (window
, w
);
9533 try_window (window
, start
, 0);
9535 return window_height_changed_p
;
9539 /* Resize the echo area window to exactly the size needed for the
9540 currently displayed message, if there is one. If a mini-buffer
9541 is active, don't shrink it. */
9544 resize_echo_area_exactly (void)
9546 if (BUFFERP (echo_area_buffer
[0])
9547 && WINDOWP (echo_area_window
))
9549 struct window
*w
= XWINDOW (echo_area_window
);
9551 Lisp_Object resize_exactly
;
9553 if (minibuf_level
== 0)
9554 resize_exactly
= Qt
;
9556 resize_exactly
= Qnil
;
9558 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9559 (intptr_t) w
, resize_exactly
,
9563 ++windows_or_buffers_changed
;
9564 ++update_mode_lines
;
9565 redisplay_internal ();
9571 /* Callback function for with_echo_area_buffer, when used from
9572 resize_echo_area_exactly. A1 contains a pointer to the window to
9573 resize, EXACTLY non-nil means resize the mini-window exactly to the
9574 size of the text displayed. A3 and A4 are not used. Value is what
9575 resize_mini_window returns. */
9578 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9581 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9585 /* Resize mini-window W to fit the size of its contents. EXACT_P
9586 means size the window exactly to the size needed. Otherwise, it's
9587 only enlarged until W's buffer is empty.
9589 Set W->start to the right place to begin display. If the whole
9590 contents fit, start at the beginning. Otherwise, start so as
9591 to make the end of the contents appear. This is particularly
9592 important for y-or-n-p, but seems desirable generally.
9594 Value is non-zero if the window height has been changed. */
9597 resize_mini_window (struct window
*w
, int exact_p
)
9599 struct frame
*f
= XFRAME (w
->frame
);
9600 int window_height_changed_p
= 0;
9602 xassert (MINI_WINDOW_P (w
));
9604 /* By default, start display at the beginning. */
9605 set_marker_both (w
->start
, w
->buffer
,
9606 BUF_BEGV (XBUFFER (w
->buffer
)),
9607 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9609 /* Don't resize windows while redisplaying a window; it would
9610 confuse redisplay functions when the size of the window they are
9611 displaying changes from under them. Such a resizing can happen,
9612 for instance, when which-func prints a long message while
9613 we are running fontification-functions. We're running these
9614 functions with safe_call which binds inhibit-redisplay to t. */
9615 if (!NILP (Vinhibit_redisplay
))
9618 /* Nil means don't try to resize. */
9619 if (NILP (Vresize_mini_windows
)
9620 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9623 if (!FRAME_MINIBUF_ONLY_P (f
))
9626 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9627 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9628 int height
, max_height
;
9629 int unit
= FRAME_LINE_HEIGHT (f
);
9630 struct text_pos start
;
9631 struct buffer
*old_current_buffer
= NULL
;
9633 if (current_buffer
!= XBUFFER (w
->buffer
))
9635 old_current_buffer
= current_buffer
;
9636 set_buffer_internal (XBUFFER (w
->buffer
));
9639 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9641 /* Compute the max. number of lines specified by the user. */
9642 if (FLOATP (Vmax_mini_window_height
))
9643 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9644 else if (INTEGERP (Vmax_mini_window_height
))
9645 max_height
= XINT (Vmax_mini_window_height
);
9647 max_height
= total_height
/ 4;
9649 /* Correct that max. height if it's bogus. */
9650 max_height
= max (1, max_height
);
9651 max_height
= min (total_height
, max_height
);
9653 /* Find out the height of the text in the window. */
9654 if (it
.line_wrap
== TRUNCATE
)
9659 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9660 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9661 height
= it
.current_y
+ last_height
;
9663 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9664 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9665 height
= (height
+ unit
- 1) / unit
;
9668 /* Compute a suitable window start. */
9669 if (height
> max_height
)
9671 height
= max_height
;
9672 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9673 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9674 start
= it
.current
.pos
;
9677 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9678 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9680 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9682 /* Let it grow only, until we display an empty message, in which
9683 case the window shrinks again. */
9684 if (height
> WINDOW_TOTAL_LINES (w
))
9686 int old_height
= WINDOW_TOTAL_LINES (w
);
9687 freeze_window_starts (f
, 1);
9688 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9689 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9691 else if (height
< WINDOW_TOTAL_LINES (w
)
9692 && (exact_p
|| BEGV
== ZV
))
9694 int old_height
= WINDOW_TOTAL_LINES (w
);
9695 freeze_window_starts (f
, 0);
9696 shrink_mini_window (w
);
9697 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9702 /* Always resize to exact size needed. */
9703 if (height
> WINDOW_TOTAL_LINES (w
))
9705 int old_height
= WINDOW_TOTAL_LINES (w
);
9706 freeze_window_starts (f
, 1);
9707 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9708 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9710 else if (height
< WINDOW_TOTAL_LINES (w
))
9712 int old_height
= WINDOW_TOTAL_LINES (w
);
9713 freeze_window_starts (f
, 0);
9714 shrink_mini_window (w
);
9718 freeze_window_starts (f
, 1);
9719 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9722 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9726 if (old_current_buffer
)
9727 set_buffer_internal (old_current_buffer
);
9730 return window_height_changed_p
;
9734 /* Value is the current message, a string, or nil if there is no
9738 current_message (void)
9742 if (!BUFFERP (echo_area_buffer
[0]))
9746 with_echo_area_buffer (0, 0, current_message_1
,
9747 (intptr_t) &msg
, Qnil
, 0, 0);
9749 echo_area_buffer
[0] = Qnil
;
9757 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9760 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9763 *msg
= make_buffer_string (BEG
, Z
, 1);
9770 /* Push the current message on Vmessage_stack for later restauration
9771 by restore_message. Value is non-zero if the current message isn't
9772 empty. This is a relatively infrequent operation, so it's not
9773 worth optimizing. */
9779 msg
= current_message ();
9780 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9781 return STRINGP (msg
);
9785 /* Restore message display from the top of Vmessage_stack. */
9788 restore_message (void)
9792 xassert (CONSP (Vmessage_stack
));
9793 msg
= XCAR (Vmessage_stack
);
9795 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9797 message3_nolog (msg
, 0, 0);
9801 /* Handler for record_unwind_protect calling pop_message. */
9804 pop_message_unwind (Lisp_Object dummy
)
9810 /* Pop the top-most entry off Vmessage_stack. */
9815 xassert (CONSP (Vmessage_stack
));
9816 Vmessage_stack
= XCDR (Vmessage_stack
);
9820 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9821 exits. If the stack is not empty, we have a missing pop_message
9825 check_message_stack (void)
9827 if (!NILP (Vmessage_stack
))
9832 /* Truncate to NCHARS what will be displayed in the echo area the next
9833 time we display it---but don't redisplay it now. */
9836 truncate_echo_area (EMACS_INT nchars
)
9839 echo_area_buffer
[0] = Qnil
;
9840 /* A null message buffer means that the frame hasn't really been
9841 initialized yet. Error messages get reported properly by
9842 cmd_error, so this must be just an informative message; toss it. */
9843 else if (!noninteractive
9845 && !NILP (echo_area_buffer
[0]))
9847 struct frame
*sf
= SELECTED_FRAME ();
9848 if (FRAME_MESSAGE_BUF (sf
))
9849 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9854 /* Helper function for truncate_echo_area. Truncate the current
9855 message to at most NCHARS characters. */
9858 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9860 if (BEG
+ nchars
< Z
)
9861 del_range (BEG
+ nchars
, Z
);
9863 echo_area_buffer
[0] = Qnil
;
9868 /* Set the current message to a substring of S or STRING.
9870 If STRING is a Lisp string, set the message to the first NBYTES
9871 bytes from STRING. NBYTES zero means use the whole string. If
9872 STRING is multibyte, the message will be displayed multibyte.
9874 If S is not null, set the message to the first LEN bytes of S. LEN
9875 zero means use the whole string. MULTIBYTE_P non-zero means S is
9876 multibyte. Display the message multibyte in that case.
9878 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9879 to t before calling set_message_1 (which calls insert).
9883 set_message (const char *s
, Lisp_Object string
,
9884 EMACS_INT nbytes
, int multibyte_p
)
9886 message_enable_multibyte
9887 = ((s
&& multibyte_p
)
9888 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9890 with_echo_area_buffer (0, -1, set_message_1
,
9891 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9892 message_buf_print
= 0;
9893 help_echo_showing_p
= 0;
9897 /* Helper function for set_message. Arguments have the same meaning
9898 as there, with A1 corresponding to S and A2 corresponding to STRING
9899 This function is called with the echo area buffer being
9903 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9906 const char *s
= (const char *) i1
;
9907 const unsigned char *msg
= (const unsigned char *) s
;
9908 Lisp_Object string
= a2
;
9910 /* Change multibyteness of the echo buffer appropriately. */
9911 if (message_enable_multibyte
9912 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9913 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9915 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9916 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9917 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9919 /* Insert new message at BEG. */
9920 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9922 if (STRINGP (string
))
9927 nbytes
= SBYTES (string
);
9928 nchars
= string_byte_to_char (string
, nbytes
);
9930 /* This function takes care of single/multibyte conversion. We
9931 just have to ensure that the echo area buffer has the right
9932 setting of enable_multibyte_characters. */
9933 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9938 nbytes
= strlen (s
);
9940 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9942 /* Convert from multi-byte to single-byte. */
9947 /* Convert a multibyte string to single-byte. */
9948 for (i
= 0; i
< nbytes
; i
+= n
)
9950 c
= string_char_and_length (msg
+ i
, &n
);
9951 work
[0] = (ASCII_CHAR_P (c
)
9953 : multibyte_char_to_unibyte (c
));
9954 insert_1_both (work
, 1, 1, 1, 0, 0);
9957 else if (!multibyte_p
9958 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9960 /* Convert from single-byte to multi-byte. */
9963 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9965 /* Convert a single-byte string to multibyte. */
9966 for (i
= 0; i
< nbytes
; i
++)
9969 MAKE_CHAR_MULTIBYTE (c
);
9970 n
= CHAR_STRING (c
, str
);
9971 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9975 insert_1 (s
, nbytes
, 1, 0, 0);
9982 /* Clear messages. CURRENT_P non-zero means clear the current
9983 message. LAST_DISPLAYED_P non-zero means clear the message
9987 clear_message (int current_p
, int last_displayed_p
)
9991 echo_area_buffer
[0] = Qnil
;
9992 message_cleared_p
= 1;
9995 if (last_displayed_p
)
9996 echo_area_buffer
[1] = Qnil
;
9998 message_buf_print
= 0;
10001 /* Clear garbaged frames.
10003 This function is used where the old redisplay called
10004 redraw_garbaged_frames which in turn called redraw_frame which in
10005 turn called clear_frame. The call to clear_frame was a source of
10006 flickering. I believe a clear_frame is not necessary. It should
10007 suffice in the new redisplay to invalidate all current matrices,
10008 and ensure a complete redisplay of all windows. */
10011 clear_garbaged_frames (void)
10013 if (frame_garbaged
)
10015 Lisp_Object tail
, frame
;
10016 int changed_count
= 0;
10018 FOR_EACH_FRAME (tail
, frame
)
10020 struct frame
*f
= XFRAME (frame
);
10022 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10026 Fredraw_frame (frame
);
10027 f
->force_flush_display_p
= 1;
10029 clear_current_matrices (f
);
10036 frame_garbaged
= 0;
10038 ++windows_or_buffers_changed
;
10043 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10044 is non-zero update selected_frame. Value is non-zero if the
10045 mini-windows height has been changed. */
10048 echo_area_display (int update_frame_p
)
10050 Lisp_Object mini_window
;
10053 int window_height_changed_p
= 0;
10054 struct frame
*sf
= SELECTED_FRAME ();
10056 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10057 w
= XWINDOW (mini_window
);
10058 f
= XFRAME (WINDOW_FRAME (w
));
10060 /* Don't display if frame is invisible or not yet initialized. */
10061 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10064 #ifdef HAVE_WINDOW_SYSTEM
10065 /* When Emacs starts, selected_frame may be the initial terminal
10066 frame. If we let this through, a message would be displayed on
10068 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10070 #endif /* HAVE_WINDOW_SYSTEM */
10072 /* Redraw garbaged frames. */
10073 if (frame_garbaged
)
10074 clear_garbaged_frames ();
10076 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10078 echo_area_window
= mini_window
;
10079 window_height_changed_p
= display_echo_area (w
);
10080 w
->must_be_updated_p
= 1;
10082 /* Update the display, unless called from redisplay_internal.
10083 Also don't update the screen during redisplay itself. The
10084 update will happen at the end of redisplay, and an update
10085 here could cause confusion. */
10086 if (update_frame_p
&& !redisplaying_p
)
10090 /* If the display update has been interrupted by pending
10091 input, update mode lines in the frame. Due to the
10092 pending input, it might have been that redisplay hasn't
10093 been called, so that mode lines above the echo area are
10094 garbaged. This looks odd, so we prevent it here. */
10095 if (!display_completed
)
10096 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10098 if (window_height_changed_p
10099 /* Don't do this if Emacs is shutting down. Redisplay
10100 needs to run hooks. */
10101 && !NILP (Vrun_hooks
))
10103 /* Must update other windows. Likewise as in other
10104 cases, don't let this update be interrupted by
10106 int count
= SPECPDL_INDEX ();
10107 specbind (Qredisplay_dont_pause
, Qt
);
10108 windows_or_buffers_changed
= 1;
10109 redisplay_internal ();
10110 unbind_to (count
, Qnil
);
10112 else if (FRAME_WINDOW_P (f
) && n
== 0)
10114 /* Window configuration is the same as before.
10115 Can do with a display update of the echo area,
10116 unless we displayed some mode lines. */
10117 update_single_window (w
, 1);
10118 FRAME_RIF (f
)->flush_display (f
);
10121 update_frame (f
, 1, 1);
10123 /* If cursor is in the echo area, make sure that the next
10124 redisplay displays the minibuffer, so that the cursor will
10125 be replaced with what the minibuffer wants. */
10126 if (cursor_in_echo_area
)
10127 ++windows_or_buffers_changed
;
10130 else if (!EQ (mini_window
, selected_window
))
10131 windows_or_buffers_changed
++;
10133 /* Last displayed message is now the current message. */
10134 echo_area_buffer
[1] = echo_area_buffer
[0];
10135 /* Inform read_char that we're not echoing. */
10136 echo_message_buffer
= Qnil
;
10138 /* Prevent redisplay optimization in redisplay_internal by resetting
10139 this_line_start_pos. This is done because the mini-buffer now
10140 displays the message instead of its buffer text. */
10141 if (EQ (mini_window
, selected_window
))
10142 CHARPOS (this_line_start_pos
) = 0;
10144 return window_height_changed_p
;
10149 /***********************************************************************
10150 Mode Lines and Frame Titles
10151 ***********************************************************************/
10153 /* A buffer for constructing non-propertized mode-line strings and
10154 frame titles in it; allocated from the heap in init_xdisp and
10155 resized as needed in store_mode_line_noprop_char. */
10157 static char *mode_line_noprop_buf
;
10159 /* The buffer's end, and a current output position in it. */
10161 static char *mode_line_noprop_buf_end
;
10162 static char *mode_line_noprop_ptr
;
10164 #define MODE_LINE_NOPROP_LEN(start) \
10165 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10168 MODE_LINE_DISPLAY
= 0,
10172 } mode_line_target
;
10174 /* Alist that caches the results of :propertize.
10175 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10176 static Lisp_Object mode_line_proptrans_alist
;
10178 /* List of strings making up the mode-line. */
10179 static Lisp_Object mode_line_string_list
;
10181 /* Base face property when building propertized mode line string. */
10182 static Lisp_Object mode_line_string_face
;
10183 static Lisp_Object mode_line_string_face_prop
;
10186 /* Unwind data for mode line strings */
10188 static Lisp_Object Vmode_line_unwind_vector
;
10191 format_mode_line_unwind_data (struct buffer
*obuf
,
10193 int save_proptrans
)
10195 Lisp_Object vector
, tmp
;
10197 /* Reduce consing by keeping one vector in
10198 Vwith_echo_area_save_vector. */
10199 vector
= Vmode_line_unwind_vector
;
10200 Vmode_line_unwind_vector
= Qnil
;
10203 vector
= Fmake_vector (make_number (8), Qnil
);
10205 ASET (vector
, 0, make_number (mode_line_target
));
10206 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10207 ASET (vector
, 2, mode_line_string_list
);
10208 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10209 ASET (vector
, 4, mode_line_string_face
);
10210 ASET (vector
, 5, mode_line_string_face_prop
);
10213 XSETBUFFER (tmp
, obuf
);
10216 ASET (vector
, 6, tmp
);
10217 ASET (vector
, 7, owin
);
10223 unwind_format_mode_line (Lisp_Object vector
)
10225 mode_line_target
= XINT (AREF (vector
, 0));
10226 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10227 mode_line_string_list
= AREF (vector
, 2);
10228 if (! EQ (AREF (vector
, 3), Qt
))
10229 mode_line_proptrans_alist
= AREF (vector
, 3);
10230 mode_line_string_face
= AREF (vector
, 4);
10231 mode_line_string_face_prop
= AREF (vector
, 5);
10233 if (!NILP (AREF (vector
, 7)))
10234 /* Select window before buffer, since it may change the buffer. */
10235 Fselect_window (AREF (vector
, 7), Qt
);
10237 if (!NILP (AREF (vector
, 6)))
10239 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10240 ASET (vector
, 6, Qnil
);
10243 Vmode_line_unwind_vector
= vector
;
10248 /* Store a single character C for the frame title in mode_line_noprop_buf.
10249 Re-allocate mode_line_noprop_buf if necessary. */
10252 store_mode_line_noprop_char (char c
)
10254 /* If output position has reached the end of the allocated buffer,
10255 double the buffer's size. */
10256 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10258 int len
= MODE_LINE_NOPROP_LEN (0);
10259 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10260 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10261 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10262 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10265 *mode_line_noprop_ptr
++ = c
;
10269 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10270 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10271 characters that yield more columns than PRECISION; PRECISION <= 0
10272 means copy the whole string. Pad with spaces until FIELD_WIDTH
10273 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10274 pad. Called from display_mode_element when it is used to build a
10278 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10280 const unsigned char *str
= (const unsigned char *) string
;
10282 EMACS_INT dummy
, nbytes
;
10284 /* Copy at most PRECISION chars from STR. */
10285 nbytes
= strlen (string
);
10286 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10288 store_mode_line_noprop_char (*str
++);
10290 /* Fill up with spaces until FIELD_WIDTH reached. */
10291 while (field_width
> 0
10292 && n
< field_width
)
10294 store_mode_line_noprop_char (' ');
10301 /***********************************************************************
10303 ***********************************************************************/
10305 #ifdef HAVE_WINDOW_SYSTEM
10307 /* Set the title of FRAME, if it has changed. The title format is
10308 Vicon_title_format if FRAME is iconified, otherwise it is
10309 frame_title_format. */
10312 x_consider_frame_title (Lisp_Object frame
)
10314 struct frame
*f
= XFRAME (frame
);
10316 if (FRAME_WINDOW_P (f
)
10317 || FRAME_MINIBUF_ONLY_P (f
)
10318 || f
->explicit_name
)
10320 /* Do we have more than one visible frame on this X display? */
10327 int count
= SPECPDL_INDEX ();
10329 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10331 Lisp_Object other_frame
= XCAR (tail
);
10332 struct frame
*tf
= XFRAME (other_frame
);
10335 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10336 && !FRAME_MINIBUF_ONLY_P (tf
)
10337 && !EQ (other_frame
, tip_frame
)
10338 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10342 /* Set global variable indicating that multiple frames exist. */
10343 multiple_frames
= CONSP (tail
);
10345 /* Switch to the buffer of selected window of the frame. Set up
10346 mode_line_target so that display_mode_element will output into
10347 mode_line_noprop_buf; then display the title. */
10348 record_unwind_protect (unwind_format_mode_line
,
10349 format_mode_line_unwind_data
10350 (current_buffer
, selected_window
, 0));
10352 Fselect_window (f
->selected_window
, Qt
);
10353 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10354 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10356 mode_line_target
= MODE_LINE_TITLE
;
10357 title_start
= MODE_LINE_NOPROP_LEN (0);
10358 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10359 NULL
, DEFAULT_FACE_ID
);
10360 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10361 len
= MODE_LINE_NOPROP_LEN (title_start
);
10362 title
= mode_line_noprop_buf
+ title_start
;
10363 unbind_to (count
, Qnil
);
10365 /* Set the title only if it's changed. This avoids consing in
10366 the common case where it hasn't. (If it turns out that we've
10367 already wasted too much time by walking through the list with
10368 display_mode_element, then we might need to optimize at a
10369 higher level than this.) */
10370 if (! STRINGP (f
->name
)
10371 || SBYTES (f
->name
) != len
10372 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10373 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10377 #endif /* not HAVE_WINDOW_SYSTEM */
10382 /***********************************************************************
10384 ***********************************************************************/
10387 /* Prepare for redisplay by updating menu-bar item lists when
10388 appropriate. This can call eval. */
10391 prepare_menu_bars (void)
10394 struct gcpro gcpro1
, gcpro2
;
10396 Lisp_Object tooltip_frame
;
10398 #ifdef HAVE_WINDOW_SYSTEM
10399 tooltip_frame
= tip_frame
;
10401 tooltip_frame
= Qnil
;
10404 /* Update all frame titles based on their buffer names, etc. We do
10405 this before the menu bars so that the buffer-menu will show the
10406 up-to-date frame titles. */
10407 #ifdef HAVE_WINDOW_SYSTEM
10408 if (windows_or_buffers_changed
|| update_mode_lines
)
10410 Lisp_Object tail
, frame
;
10412 FOR_EACH_FRAME (tail
, frame
)
10414 f
= XFRAME (frame
);
10415 if (!EQ (frame
, tooltip_frame
)
10416 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10417 x_consider_frame_title (frame
);
10420 #endif /* HAVE_WINDOW_SYSTEM */
10422 /* Update the menu bar item lists, if appropriate. This has to be
10423 done before any actual redisplay or generation of display lines. */
10424 all_windows
= (update_mode_lines
10425 || buffer_shared
> 1
10426 || windows_or_buffers_changed
);
10429 Lisp_Object tail
, frame
;
10430 int count
= SPECPDL_INDEX ();
10431 /* 1 means that update_menu_bar has run its hooks
10432 so any further calls to update_menu_bar shouldn't do so again. */
10433 int menu_bar_hooks_run
= 0;
10435 record_unwind_save_match_data ();
10437 FOR_EACH_FRAME (tail
, frame
)
10439 f
= XFRAME (frame
);
10441 /* Ignore tooltip frame. */
10442 if (EQ (frame
, tooltip_frame
))
10445 /* If a window on this frame changed size, report that to
10446 the user and clear the size-change flag. */
10447 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10449 Lisp_Object functions
;
10451 /* Clear flag first in case we get an error below. */
10452 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10453 functions
= Vwindow_size_change_functions
;
10454 GCPRO2 (tail
, functions
);
10456 while (CONSP (functions
))
10458 if (!EQ (XCAR (functions
), Qt
))
10459 call1 (XCAR (functions
), frame
);
10460 functions
= XCDR (functions
);
10466 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10467 #ifdef HAVE_WINDOW_SYSTEM
10468 update_tool_bar (f
, 0);
10471 if (windows_or_buffers_changed
10473 ns_set_doc_edited (f
, Fbuffer_modified_p
10474 (XWINDOW (f
->selected_window
)->buffer
));
10479 unbind_to (count
, Qnil
);
10483 struct frame
*sf
= SELECTED_FRAME ();
10484 update_menu_bar (sf
, 1, 0);
10485 #ifdef HAVE_WINDOW_SYSTEM
10486 update_tool_bar (sf
, 1);
10492 /* Update the menu bar item list for frame F. This has to be done
10493 before we start to fill in any display lines, because it can call
10496 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10498 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10499 already ran the menu bar hooks for this redisplay, so there
10500 is no need to run them again. The return value is the
10501 updated value of this flag, to pass to the next call. */
10504 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10506 Lisp_Object window
;
10507 register struct window
*w
;
10509 /* If called recursively during a menu update, do nothing. This can
10510 happen when, for instance, an activate-menubar-hook causes a
10512 if (inhibit_menubar_update
)
10515 window
= FRAME_SELECTED_WINDOW (f
);
10516 w
= XWINDOW (window
);
10518 if (FRAME_WINDOW_P (f
)
10520 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10521 || defined (HAVE_NS) || defined (USE_GTK)
10522 FRAME_EXTERNAL_MENU_BAR (f
)
10524 FRAME_MENU_BAR_LINES (f
) > 0
10526 : FRAME_MENU_BAR_LINES (f
) > 0)
10528 /* If the user has switched buffers or windows, we need to
10529 recompute to reflect the new bindings. But we'll
10530 recompute when update_mode_lines is set too; that means
10531 that people can use force-mode-line-update to request
10532 that the menu bar be recomputed. The adverse effect on
10533 the rest of the redisplay algorithm is about the same as
10534 windows_or_buffers_changed anyway. */
10535 if (windows_or_buffers_changed
10536 /* This used to test w->update_mode_line, but we believe
10537 there is no need to recompute the menu in that case. */
10538 || update_mode_lines
10539 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10540 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10541 != !NILP (w
->last_had_star
))
10542 || ((!NILP (Vtransient_mark_mode
)
10543 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10544 != !NILP (w
->region_showing
)))
10546 struct buffer
*prev
= current_buffer
;
10547 int count
= SPECPDL_INDEX ();
10549 specbind (Qinhibit_menubar_update
, Qt
);
10551 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10552 if (save_match_data
)
10553 record_unwind_save_match_data ();
10554 if (NILP (Voverriding_local_map_menu_flag
))
10556 specbind (Qoverriding_terminal_local_map
, Qnil
);
10557 specbind (Qoverriding_local_map
, Qnil
);
10562 /* Run the Lucid hook. */
10563 safe_run_hooks (Qactivate_menubar_hook
);
10565 /* If it has changed current-menubar from previous value,
10566 really recompute the menu-bar from the value. */
10567 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10568 call0 (Qrecompute_lucid_menubar
);
10570 safe_run_hooks (Qmenu_bar_update_hook
);
10575 XSETFRAME (Vmenu_updating_frame
, f
);
10576 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10578 /* Redisplay the menu bar in case we changed it. */
10579 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10580 || defined (HAVE_NS) || defined (USE_GTK)
10581 if (FRAME_WINDOW_P (f
))
10583 #if defined (HAVE_NS)
10584 /* All frames on Mac OS share the same menubar. So only
10585 the selected frame should be allowed to set it. */
10586 if (f
== SELECTED_FRAME ())
10588 set_frame_menubar (f
, 0, 0);
10591 /* On a terminal screen, the menu bar is an ordinary screen
10592 line, and this makes it get updated. */
10593 w
->update_mode_line
= Qt
;
10594 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10595 /* In the non-toolkit version, the menu bar is an ordinary screen
10596 line, and this makes it get updated. */
10597 w
->update_mode_line
= Qt
;
10598 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10600 unbind_to (count
, Qnil
);
10601 set_buffer_internal_1 (prev
);
10610 /***********************************************************************
10612 ***********************************************************************/
10614 #ifdef HAVE_WINDOW_SYSTEM
10617 Nominal cursor position -- where to draw output.
10618 HPOS and VPOS are window relative glyph matrix coordinates.
10619 X and Y are window relative pixel coordinates. */
10621 struct cursor_pos output_cursor
;
10625 Set the global variable output_cursor to CURSOR. All cursor
10626 positions are relative to updated_window. */
10629 set_output_cursor (struct cursor_pos
*cursor
)
10631 output_cursor
.hpos
= cursor
->hpos
;
10632 output_cursor
.vpos
= cursor
->vpos
;
10633 output_cursor
.x
= cursor
->x
;
10634 output_cursor
.y
= cursor
->y
;
10639 Set a nominal cursor position.
10641 HPOS and VPOS are column/row positions in a window glyph matrix. X
10642 and Y are window text area relative pixel positions.
10644 If this is done during an update, updated_window will contain the
10645 window that is being updated and the position is the future output
10646 cursor position for that window. If updated_window is null, use
10647 selected_window and display the cursor at the given position. */
10650 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10654 /* If updated_window is not set, work on selected_window. */
10655 if (updated_window
)
10656 w
= updated_window
;
10658 w
= XWINDOW (selected_window
);
10660 /* Set the output cursor. */
10661 output_cursor
.hpos
= hpos
;
10662 output_cursor
.vpos
= vpos
;
10663 output_cursor
.x
= x
;
10664 output_cursor
.y
= y
;
10666 /* If not called as part of an update, really display the cursor.
10667 This will also set the cursor position of W. */
10668 if (updated_window
== NULL
)
10671 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10672 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10673 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10678 #endif /* HAVE_WINDOW_SYSTEM */
10681 /***********************************************************************
10683 ***********************************************************************/
10685 #ifdef HAVE_WINDOW_SYSTEM
10687 /* Where the mouse was last time we reported a mouse event. */
10689 FRAME_PTR last_mouse_frame
;
10691 /* Tool-bar item index of the item on which a mouse button was pressed
10694 int last_tool_bar_item
;
10698 update_tool_bar_unwind (Lisp_Object frame
)
10700 selected_frame
= frame
;
10704 /* Update the tool-bar item list for frame F. This has to be done
10705 before we start to fill in any display lines. Called from
10706 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10707 and restore it here. */
10710 update_tool_bar (struct frame
*f
, int save_match_data
)
10712 #if defined (USE_GTK) || defined (HAVE_NS)
10713 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10715 int do_update
= WINDOWP (f
->tool_bar_window
)
10716 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10721 Lisp_Object window
;
10724 window
= FRAME_SELECTED_WINDOW (f
);
10725 w
= XWINDOW (window
);
10727 /* If the user has switched buffers or windows, we need to
10728 recompute to reflect the new bindings. But we'll
10729 recompute when update_mode_lines is set too; that means
10730 that people can use force-mode-line-update to request
10731 that the menu bar be recomputed. The adverse effect on
10732 the rest of the redisplay algorithm is about the same as
10733 windows_or_buffers_changed anyway. */
10734 if (windows_or_buffers_changed
10735 || !NILP (w
->update_mode_line
)
10736 || update_mode_lines
10737 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10738 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10739 != !NILP (w
->last_had_star
))
10740 || ((!NILP (Vtransient_mark_mode
)
10741 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10742 != !NILP (w
->region_showing
)))
10744 struct buffer
*prev
= current_buffer
;
10745 int count
= SPECPDL_INDEX ();
10746 Lisp_Object frame
, new_tool_bar
;
10747 int new_n_tool_bar
;
10748 struct gcpro gcpro1
;
10750 /* Set current_buffer to the buffer of the selected
10751 window of the frame, so that we get the right local
10753 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10755 /* Save match data, if we must. */
10756 if (save_match_data
)
10757 record_unwind_save_match_data ();
10759 /* Make sure that we don't accidentally use bogus keymaps. */
10760 if (NILP (Voverriding_local_map_menu_flag
))
10762 specbind (Qoverriding_terminal_local_map
, Qnil
);
10763 specbind (Qoverriding_local_map
, Qnil
);
10766 GCPRO1 (new_tool_bar
);
10768 /* We must temporarily set the selected frame to this frame
10769 before calling tool_bar_items, because the calculation of
10770 the tool-bar keymap uses the selected frame (see
10771 `tool-bar-make-keymap' in tool-bar.el). */
10772 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10773 XSETFRAME (frame
, f
);
10774 selected_frame
= frame
;
10776 /* Build desired tool-bar items from keymaps. */
10777 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10780 /* Redisplay the tool-bar if we changed it. */
10781 if (new_n_tool_bar
!= f
->n_tool_bar_items
10782 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10784 /* Redisplay that happens asynchronously due to an expose event
10785 may access f->tool_bar_items. Make sure we update both
10786 variables within BLOCK_INPUT so no such event interrupts. */
10788 f
->tool_bar_items
= new_tool_bar
;
10789 f
->n_tool_bar_items
= new_n_tool_bar
;
10790 w
->update_mode_line
= Qt
;
10796 unbind_to (count
, Qnil
);
10797 set_buffer_internal_1 (prev
);
10803 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10804 F's desired tool-bar contents. F->tool_bar_items must have
10805 been set up previously by calling prepare_menu_bars. */
10808 build_desired_tool_bar_string (struct frame
*f
)
10810 int i
, size
, size_needed
;
10811 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10812 Lisp_Object image
, plist
, props
;
10814 image
= plist
= props
= Qnil
;
10815 GCPRO3 (image
, plist
, props
);
10817 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10818 Otherwise, make a new string. */
10820 /* The size of the string we might be able to reuse. */
10821 size
= (STRINGP (f
->desired_tool_bar_string
)
10822 ? SCHARS (f
->desired_tool_bar_string
)
10825 /* We need one space in the string for each image. */
10826 size_needed
= f
->n_tool_bar_items
;
10828 /* Reuse f->desired_tool_bar_string, if possible. */
10829 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10830 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10831 make_number (' '));
10834 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10835 Fremove_text_properties (make_number (0), make_number (size
),
10836 props
, f
->desired_tool_bar_string
);
10839 /* Put a `display' property on the string for the images to display,
10840 put a `menu_item' property on tool-bar items with a value that
10841 is the index of the item in F's tool-bar item vector. */
10842 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10844 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10846 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10847 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10848 int hmargin
, vmargin
, relief
, idx
, end
;
10850 /* If image is a vector, choose the image according to the
10852 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10853 if (VECTORP (image
))
10857 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10858 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10861 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10862 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10864 xassert (ASIZE (image
) >= idx
);
10865 image
= AREF (image
, idx
);
10870 /* Ignore invalid image specifications. */
10871 if (!valid_image_p (image
))
10874 /* Display the tool-bar button pressed, or depressed. */
10875 plist
= Fcopy_sequence (XCDR (image
));
10877 /* Compute margin and relief to draw. */
10878 relief
= (tool_bar_button_relief
>= 0
10879 ? tool_bar_button_relief
10880 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10881 hmargin
= vmargin
= relief
;
10883 if (INTEGERP (Vtool_bar_button_margin
)
10884 && XINT (Vtool_bar_button_margin
) > 0)
10886 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10887 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10889 else if (CONSP (Vtool_bar_button_margin
))
10891 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10892 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10893 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10895 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10896 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10897 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10900 if (auto_raise_tool_bar_buttons_p
)
10902 /* Add a `:relief' property to the image spec if the item is
10906 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10913 /* If image is selected, display it pressed, i.e. with a
10914 negative relief. If it's not selected, display it with a
10916 plist
= Fplist_put (plist
, QCrelief
,
10918 ? make_number (-relief
)
10919 : make_number (relief
)));
10924 /* Put a margin around the image. */
10925 if (hmargin
|| vmargin
)
10927 if (hmargin
== vmargin
)
10928 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10930 plist
= Fplist_put (plist
, QCmargin
,
10931 Fcons (make_number (hmargin
),
10932 make_number (vmargin
)));
10935 /* If button is not enabled, and we don't have special images
10936 for the disabled state, make the image appear disabled by
10937 applying an appropriate algorithm to it. */
10938 if (!enabled_p
&& idx
< 0)
10939 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10941 /* Put a `display' text property on the string for the image to
10942 display. Put a `menu-item' property on the string that gives
10943 the start of this item's properties in the tool-bar items
10945 image
= Fcons (Qimage
, plist
);
10946 props
= list4 (Qdisplay
, image
,
10947 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10949 /* Let the last image hide all remaining spaces in the tool bar
10950 string. The string can be longer than needed when we reuse a
10951 previous string. */
10952 if (i
+ 1 == f
->n_tool_bar_items
)
10953 end
= SCHARS (f
->desired_tool_bar_string
);
10956 Fadd_text_properties (make_number (i
), make_number (end
),
10957 props
, f
->desired_tool_bar_string
);
10965 /* Display one line of the tool-bar of frame IT->f.
10967 HEIGHT specifies the desired height of the tool-bar line.
10968 If the actual height of the glyph row is less than HEIGHT, the
10969 row's height is increased to HEIGHT, and the icons are centered
10970 vertically in the new height.
10972 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10973 count a final empty row in case the tool-bar width exactly matches
10978 display_tool_bar_line (struct it
*it
, int height
)
10980 struct glyph_row
*row
= it
->glyph_row
;
10981 int max_x
= it
->last_visible_x
;
10982 struct glyph
*last
;
10984 prepare_desired_row (row
);
10985 row
->y
= it
->current_y
;
10987 /* Note that this isn't made use of if the face hasn't a box,
10988 so there's no need to check the face here. */
10989 it
->start_of_box_run_p
= 1;
10991 while (it
->current_x
< max_x
)
10993 int x
, n_glyphs_before
, i
, nglyphs
;
10994 struct it it_before
;
10996 /* Get the next display element. */
10997 if (!get_next_display_element (it
))
10999 /* Don't count empty row if we are counting needed tool-bar lines. */
11000 if (height
< 0 && !it
->hpos
)
11005 /* Produce glyphs. */
11006 n_glyphs_before
= row
->used
[TEXT_AREA
];
11009 PRODUCE_GLYPHS (it
);
11011 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11013 x
= it_before
.current_x
;
11014 while (i
< nglyphs
)
11016 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11018 if (x
+ glyph
->pixel_width
> max_x
)
11020 /* Glyph doesn't fit on line. Backtrack. */
11021 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11023 /* If this is the only glyph on this line, it will never fit on the
11024 tool-bar, so skip it. But ensure there is at least one glyph,
11025 so we don't accidentally disable the tool-bar. */
11026 if (n_glyphs_before
== 0
11027 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11033 x
+= glyph
->pixel_width
;
11037 /* Stop at line end. */
11038 if (ITERATOR_AT_END_OF_LINE_P (it
))
11041 set_iterator_to_next (it
, 1);
11046 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11048 /* Use default face for the border below the tool bar.
11050 FIXME: When auto-resize-tool-bars is grow-only, there is
11051 no additional border below the possibly empty tool-bar lines.
11052 So to make the extra empty lines look "normal", we have to
11053 use the tool-bar face for the border too. */
11054 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11055 it
->face_id
= DEFAULT_FACE_ID
;
11057 extend_face_to_end_of_line (it
);
11058 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11059 last
->right_box_line_p
= 1;
11060 if (last
== row
->glyphs
[TEXT_AREA
])
11061 last
->left_box_line_p
= 1;
11063 /* Make line the desired height and center it vertically. */
11064 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11066 /* Don't add more than one line height. */
11067 height
%= FRAME_LINE_HEIGHT (it
->f
);
11068 it
->max_ascent
+= height
/ 2;
11069 it
->max_descent
+= (height
+ 1) / 2;
11072 compute_line_metrics (it
);
11074 /* If line is empty, make it occupy the rest of the tool-bar. */
11075 if (!row
->displays_text_p
)
11077 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11078 row
->visible_height
= row
->height
;
11079 row
->ascent
= row
->phys_ascent
= 0;
11080 row
->extra_line_spacing
= 0;
11083 row
->full_width_p
= 1;
11084 row
->continued_p
= 0;
11085 row
->truncated_on_left_p
= 0;
11086 row
->truncated_on_right_p
= 0;
11088 it
->current_x
= it
->hpos
= 0;
11089 it
->current_y
+= row
->height
;
11095 /* Max tool-bar height. */
11097 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11098 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11100 /* Value is the number of screen lines needed to make all tool-bar
11101 items of frame F visible. The number of actual rows needed is
11102 returned in *N_ROWS if non-NULL. */
11105 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11107 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11109 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11110 the desired matrix, so use (unused) mode-line row as temporary row to
11111 avoid destroying the first tool-bar row. */
11112 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11114 /* Initialize an iterator for iteration over
11115 F->desired_tool_bar_string in the tool-bar window of frame F. */
11116 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11117 it
.first_visible_x
= 0;
11118 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11119 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11120 it
.paragraph_embedding
= L2R
;
11122 while (!ITERATOR_AT_END_P (&it
))
11124 clear_glyph_row (temp_row
);
11125 it
.glyph_row
= temp_row
;
11126 display_tool_bar_line (&it
, -1);
11128 clear_glyph_row (temp_row
);
11130 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11132 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11134 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11138 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11140 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11141 (Lisp_Object frame
)
11148 frame
= selected_frame
;
11150 CHECK_FRAME (frame
);
11151 f
= XFRAME (frame
);
11153 if (WINDOWP (f
->tool_bar_window
)
11154 && (w
= XWINDOW (f
->tool_bar_window
),
11155 WINDOW_TOTAL_LINES (w
) > 0))
11157 update_tool_bar (f
, 1);
11158 if (f
->n_tool_bar_items
)
11160 build_desired_tool_bar_string (f
);
11161 nlines
= tool_bar_lines_needed (f
, NULL
);
11165 return make_number (nlines
);
11169 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11170 height should be changed. */
11173 redisplay_tool_bar (struct frame
*f
)
11177 struct glyph_row
*row
;
11179 #if defined (USE_GTK) || defined (HAVE_NS)
11180 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11181 update_frame_tool_bar (f
);
11185 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11186 do anything. This means you must start with tool-bar-lines
11187 non-zero to get the auto-sizing effect. Or in other words, you
11188 can turn off tool-bars by specifying tool-bar-lines zero. */
11189 if (!WINDOWP (f
->tool_bar_window
)
11190 || (w
= XWINDOW (f
->tool_bar_window
),
11191 WINDOW_TOTAL_LINES (w
) == 0))
11194 /* Set up an iterator for the tool-bar window. */
11195 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11196 it
.first_visible_x
= 0;
11197 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11198 row
= it
.glyph_row
;
11200 /* Build a string that represents the contents of the tool-bar. */
11201 build_desired_tool_bar_string (f
);
11202 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11203 /* FIXME: This should be controlled by a user option. But it
11204 doesn't make sense to have an R2L tool bar if the menu bar cannot
11205 be drawn also R2L, and making the menu bar R2L is tricky due
11206 toolkit-specific code that implements it. If an R2L tool bar is
11207 ever supported, display_tool_bar_line should also be augmented to
11208 call unproduce_glyphs like display_line and display_string
11210 it
.paragraph_embedding
= L2R
;
11212 if (f
->n_tool_bar_rows
== 0)
11216 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11217 nlines
!= WINDOW_TOTAL_LINES (w
)))
11220 int old_height
= WINDOW_TOTAL_LINES (w
);
11222 XSETFRAME (frame
, f
);
11223 Fmodify_frame_parameters (frame
,
11224 Fcons (Fcons (Qtool_bar_lines
,
11225 make_number (nlines
)),
11227 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11229 clear_glyph_matrix (w
->desired_matrix
);
11230 fonts_changed_p
= 1;
11236 /* Display as many lines as needed to display all tool-bar items. */
11238 if (f
->n_tool_bar_rows
> 0)
11240 int border
, rows
, height
, extra
;
11242 if (INTEGERP (Vtool_bar_border
))
11243 border
= XINT (Vtool_bar_border
);
11244 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11245 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11246 else if (EQ (Vtool_bar_border
, Qborder_width
))
11247 border
= f
->border_width
;
11253 rows
= f
->n_tool_bar_rows
;
11254 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11255 extra
= it
.last_visible_y
- border
- height
* rows
;
11257 while (it
.current_y
< it
.last_visible_y
)
11260 if (extra
> 0 && rows
-- > 0)
11262 h
= (extra
+ rows
- 1) / rows
;
11265 display_tool_bar_line (&it
, height
+ h
);
11270 while (it
.current_y
< it
.last_visible_y
)
11271 display_tool_bar_line (&it
, 0);
11274 /* It doesn't make much sense to try scrolling in the tool-bar
11275 window, so don't do it. */
11276 w
->desired_matrix
->no_scrolling_p
= 1;
11277 w
->must_be_updated_p
= 1;
11279 if (!NILP (Vauto_resize_tool_bars
))
11281 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11282 int change_height_p
= 0;
11284 /* If we couldn't display everything, change the tool-bar's
11285 height if there is room for more. */
11286 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11287 && it
.current_y
< max_tool_bar_height
)
11288 change_height_p
= 1;
11290 row
= it
.glyph_row
- 1;
11292 /* If there are blank lines at the end, except for a partially
11293 visible blank line at the end that is smaller than
11294 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11295 if (!row
->displays_text_p
11296 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11297 change_height_p
= 1;
11299 /* If row displays tool-bar items, but is partially visible,
11300 change the tool-bar's height. */
11301 if (row
->displays_text_p
11302 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11303 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11304 change_height_p
= 1;
11306 /* Resize windows as needed by changing the `tool-bar-lines'
11307 frame parameter. */
11308 if (change_height_p
)
11311 int old_height
= WINDOW_TOTAL_LINES (w
);
11313 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11315 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11316 && !f
->minimize_tool_bar_window_p
)
11317 ? (nlines
> old_height
)
11318 : (nlines
!= old_height
));
11319 f
->minimize_tool_bar_window_p
= 0;
11321 if (change_height_p
)
11323 XSETFRAME (frame
, f
);
11324 Fmodify_frame_parameters (frame
,
11325 Fcons (Fcons (Qtool_bar_lines
,
11326 make_number (nlines
)),
11328 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11330 clear_glyph_matrix (w
->desired_matrix
);
11331 f
->n_tool_bar_rows
= nrows
;
11332 fonts_changed_p
= 1;
11339 f
->minimize_tool_bar_window_p
= 0;
11344 /* Get information about the tool-bar item which is displayed in GLYPH
11345 on frame F. Return in *PROP_IDX the index where tool-bar item
11346 properties start in F->tool_bar_items. Value is zero if
11347 GLYPH doesn't display a tool-bar item. */
11350 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11356 /* This function can be called asynchronously, which means we must
11357 exclude any possibility that Fget_text_property signals an
11359 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11360 charpos
= max (0, charpos
);
11362 /* Get the text property `menu-item' at pos. The value of that
11363 property is the start index of this item's properties in
11364 F->tool_bar_items. */
11365 prop
= Fget_text_property (make_number (charpos
),
11366 Qmenu_item
, f
->current_tool_bar_string
);
11367 if (INTEGERP (prop
))
11369 *prop_idx
= XINT (prop
);
11379 /* Get information about the tool-bar item at position X/Y on frame F.
11380 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11381 the current matrix of the tool-bar window of F, or NULL if not
11382 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11383 item in F->tool_bar_items. Value is
11385 -1 if X/Y is not on a tool-bar item
11386 0 if X/Y is on the same item that was highlighted before.
11390 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11391 int *hpos
, int *vpos
, int *prop_idx
)
11393 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11394 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11397 /* Find the glyph under X/Y. */
11398 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11399 if (*glyph
== NULL
)
11402 /* Get the start of this tool-bar item's properties in
11403 f->tool_bar_items. */
11404 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11407 /* Is mouse on the highlighted item? */
11408 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11409 && *vpos
>= hlinfo
->mouse_face_beg_row
11410 && *vpos
<= hlinfo
->mouse_face_end_row
11411 && (*vpos
> hlinfo
->mouse_face_beg_row
11412 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11413 && (*vpos
< hlinfo
->mouse_face_end_row
11414 || *hpos
< hlinfo
->mouse_face_end_col
11415 || hlinfo
->mouse_face_past_end
))
11423 Handle mouse button event on the tool-bar of frame F, at
11424 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11425 0 for button release. MODIFIERS is event modifiers for button
11429 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11430 unsigned int modifiers
)
11432 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11433 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11434 int hpos
, vpos
, prop_idx
;
11435 struct glyph
*glyph
;
11436 Lisp_Object enabled_p
;
11438 /* If not on the highlighted tool-bar item, return. */
11439 frame_to_window_pixel_xy (w
, &x
, &y
);
11440 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11443 /* If item is disabled, do nothing. */
11444 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11445 if (NILP (enabled_p
))
11450 /* Show item in pressed state. */
11451 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11452 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11453 last_tool_bar_item
= prop_idx
;
11457 Lisp_Object key
, frame
;
11458 struct input_event event
;
11459 EVENT_INIT (event
);
11461 /* Show item in released state. */
11462 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11463 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11465 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11467 XSETFRAME (frame
, f
);
11468 event
.kind
= TOOL_BAR_EVENT
;
11469 event
.frame_or_window
= frame
;
11471 kbd_buffer_store_event (&event
);
11473 event
.kind
= TOOL_BAR_EVENT
;
11474 event
.frame_or_window
= frame
;
11476 event
.modifiers
= modifiers
;
11477 kbd_buffer_store_event (&event
);
11478 last_tool_bar_item
= -1;
11483 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11484 tool-bar window-relative coordinates X/Y. Called from
11485 note_mouse_highlight. */
11488 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11490 Lisp_Object window
= f
->tool_bar_window
;
11491 struct window
*w
= XWINDOW (window
);
11492 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11493 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11495 struct glyph
*glyph
;
11496 struct glyph_row
*row
;
11498 Lisp_Object enabled_p
;
11500 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11501 int mouse_down_p
, rc
;
11503 /* Function note_mouse_highlight is called with negative X/Y
11504 values when mouse moves outside of the frame. */
11505 if (x
<= 0 || y
<= 0)
11507 clear_mouse_face (hlinfo
);
11511 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11514 /* Not on tool-bar item. */
11515 clear_mouse_face (hlinfo
);
11519 /* On same tool-bar item as before. */
11520 goto set_help_echo
;
11522 clear_mouse_face (hlinfo
);
11524 /* Mouse is down, but on different tool-bar item? */
11525 mouse_down_p
= (dpyinfo
->grabbed
11526 && f
== last_mouse_frame
11527 && FRAME_LIVE_P (f
));
11529 && last_tool_bar_item
!= prop_idx
)
11532 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11533 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11535 /* If tool-bar item is not enabled, don't highlight it. */
11536 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11537 if (!NILP (enabled_p
))
11539 /* Compute the x-position of the glyph. In front and past the
11540 image is a space. We include this in the highlighted area. */
11541 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11542 for (i
= x
= 0; i
< hpos
; ++i
)
11543 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11545 /* Record this as the current active region. */
11546 hlinfo
->mouse_face_beg_col
= hpos
;
11547 hlinfo
->mouse_face_beg_row
= vpos
;
11548 hlinfo
->mouse_face_beg_x
= x
;
11549 hlinfo
->mouse_face_beg_y
= row
->y
;
11550 hlinfo
->mouse_face_past_end
= 0;
11552 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11553 hlinfo
->mouse_face_end_row
= vpos
;
11554 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11555 hlinfo
->mouse_face_end_y
= row
->y
;
11556 hlinfo
->mouse_face_window
= window
;
11557 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11559 /* Display it as active. */
11560 show_mouse_face (hlinfo
, draw
);
11561 hlinfo
->mouse_face_image_state
= draw
;
11566 /* Set help_echo_string to a help string to display for this tool-bar item.
11567 XTread_socket does the rest. */
11568 help_echo_object
= help_echo_window
= Qnil
;
11569 help_echo_pos
= -1;
11570 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11571 if (NILP (help_echo_string
))
11572 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11575 #endif /* HAVE_WINDOW_SYSTEM */
11579 /************************************************************************
11580 Horizontal scrolling
11581 ************************************************************************/
11583 static int hscroll_window_tree (Lisp_Object
);
11584 static int hscroll_windows (Lisp_Object
);
11586 /* For all leaf windows in the window tree rooted at WINDOW, set their
11587 hscroll value so that PT is (i) visible in the window, and (ii) so
11588 that it is not within a certain margin at the window's left and
11589 right border. Value is non-zero if any window's hscroll has been
11593 hscroll_window_tree (Lisp_Object window
)
11595 int hscrolled_p
= 0;
11596 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11597 int hscroll_step_abs
= 0;
11598 double hscroll_step_rel
= 0;
11600 if (hscroll_relative_p
)
11602 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11603 if (hscroll_step_rel
< 0)
11605 hscroll_relative_p
= 0;
11606 hscroll_step_abs
= 0;
11609 else if (INTEGERP (Vhscroll_step
))
11611 hscroll_step_abs
= XINT (Vhscroll_step
);
11612 if (hscroll_step_abs
< 0)
11613 hscroll_step_abs
= 0;
11616 hscroll_step_abs
= 0;
11618 while (WINDOWP (window
))
11620 struct window
*w
= XWINDOW (window
);
11622 if (WINDOWP (w
->hchild
))
11623 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11624 else if (WINDOWP (w
->vchild
))
11625 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11626 else if (w
->cursor
.vpos
>= 0)
11629 int text_area_width
;
11630 struct glyph_row
*current_cursor_row
11631 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11632 struct glyph_row
*desired_cursor_row
11633 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11634 struct glyph_row
*cursor_row
11635 = (desired_cursor_row
->enabled_p
11636 ? desired_cursor_row
11637 : current_cursor_row
);
11639 text_area_width
= window_box_width (w
, TEXT_AREA
);
11641 /* Scroll when cursor is inside this scroll margin. */
11642 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11644 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11645 && ((XFASTINT (w
->hscroll
)
11646 && w
->cursor
.x
<= h_margin
)
11647 || (cursor_row
->enabled_p
11648 && cursor_row
->truncated_on_right_p
11649 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11653 struct buffer
*saved_current_buffer
;
11657 /* Find point in a display of infinite width. */
11658 saved_current_buffer
= current_buffer
;
11659 current_buffer
= XBUFFER (w
->buffer
);
11661 if (w
== XWINDOW (selected_window
))
11665 pt
= marker_position (w
->pointm
);
11666 pt
= max (BEGV
, pt
);
11670 /* Move iterator to pt starting at cursor_row->start in
11671 a line with infinite width. */
11672 init_to_row_start (&it
, w
, cursor_row
);
11673 it
.last_visible_x
= INFINITY
;
11674 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11675 current_buffer
= saved_current_buffer
;
11677 /* Position cursor in window. */
11678 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11679 hscroll
= max (0, (it
.current_x
11680 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11681 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11682 : (text_area_width
/ 2))))
11683 / FRAME_COLUMN_WIDTH (it
.f
);
11684 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11686 if (hscroll_relative_p
)
11687 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11690 wanted_x
= text_area_width
11691 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11694 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11698 if (hscroll_relative_p
)
11699 wanted_x
= text_area_width
* hscroll_step_rel
11702 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11705 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11707 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11709 /* Don't call Fset_window_hscroll if value hasn't
11710 changed because it will prevent redisplay
11712 if (XFASTINT (w
->hscroll
) != hscroll
)
11714 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11715 w
->hscroll
= make_number (hscroll
);
11724 /* Value is non-zero if hscroll of any leaf window has been changed. */
11725 return hscrolled_p
;
11729 /* Set hscroll so that cursor is visible and not inside horizontal
11730 scroll margins for all windows in the tree rooted at WINDOW. See
11731 also hscroll_window_tree above. Value is non-zero if any window's
11732 hscroll has been changed. If it has, desired matrices on the frame
11733 of WINDOW are cleared. */
11736 hscroll_windows (Lisp_Object window
)
11738 int hscrolled_p
= hscroll_window_tree (window
);
11740 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11741 return hscrolled_p
;
11746 /************************************************************************
11748 ************************************************************************/
11750 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11751 to a non-zero value. This is sometimes handy to have in a debugger
11756 /* First and last unchanged row for try_window_id. */
11758 static int debug_first_unchanged_at_end_vpos
;
11759 static int debug_last_unchanged_at_beg_vpos
;
11761 /* Delta vpos and y. */
11763 static int debug_dvpos
, debug_dy
;
11765 /* Delta in characters and bytes for try_window_id. */
11767 static EMACS_INT debug_delta
, debug_delta_bytes
;
11769 /* Values of window_end_pos and window_end_vpos at the end of
11772 static EMACS_INT debug_end_vpos
;
11774 /* Append a string to W->desired_matrix->method. FMT is a printf
11775 format string. If trace_redisplay_p is non-zero also printf the
11776 resulting string to stderr. */
11778 static void debug_method_add (struct window
*, char const *, ...)
11779 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11782 debug_method_add (struct window
*w
, char const *fmt
, ...)
11785 char *method
= w
->desired_matrix
->method
;
11786 int len
= strlen (method
);
11787 int size
= sizeof w
->desired_matrix
->method
;
11788 int remaining
= size
- len
- 1;
11791 va_start (ap
, fmt
);
11792 vsprintf (buffer
, fmt
, ap
);
11794 if (len
&& remaining
)
11797 --remaining
, ++len
;
11800 strncpy (method
+ len
, buffer
, remaining
);
11802 if (trace_redisplay_p
)
11803 fprintf (stderr
, "%p (%s): %s\n",
11805 ((BUFFERP (w
->buffer
)
11806 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11807 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11812 #endif /* GLYPH_DEBUG */
11815 /* Value is non-zero if all changes in window W, which displays
11816 current_buffer, are in the text between START and END. START is a
11817 buffer position, END is given as a distance from Z. Used in
11818 redisplay_internal for display optimization. */
11821 text_outside_line_unchanged_p (struct window
*w
,
11822 EMACS_INT start
, EMACS_INT end
)
11824 int unchanged_p
= 1;
11826 /* If text or overlays have changed, see where. */
11827 if (XFASTINT (w
->last_modified
) < MODIFF
11828 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11830 /* Gap in the line? */
11831 if (GPT
< start
|| Z
- GPT
< end
)
11834 /* Changes start in front of the line, or end after it? */
11836 && (BEG_UNCHANGED
< start
- 1
11837 || END_UNCHANGED
< end
))
11840 /* If selective display, can't optimize if changes start at the
11841 beginning of the line. */
11843 && INTEGERP (BVAR (current_buffer
, selective_display
))
11844 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11845 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11848 /* If there are overlays at the start or end of the line, these
11849 may have overlay strings with newlines in them. A change at
11850 START, for instance, may actually concern the display of such
11851 overlay strings as well, and they are displayed on different
11852 lines. So, quickly rule out this case. (For the future, it
11853 might be desirable to implement something more telling than
11854 just BEG/END_UNCHANGED.) */
11857 if (BEG
+ BEG_UNCHANGED
== start
11858 && overlay_touches_p (start
))
11860 if (END_UNCHANGED
== end
11861 && overlay_touches_p (Z
- end
))
11865 /* Under bidi reordering, adding or deleting a character in the
11866 beginning of a paragraph, before the first strong directional
11867 character, can change the base direction of the paragraph (unless
11868 the buffer specifies a fixed paragraph direction), which will
11869 require to redisplay the whole paragraph. It might be worthwhile
11870 to find the paragraph limits and widen the range of redisplayed
11871 lines to that, but for now just give up this optimization. */
11872 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11873 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11877 return unchanged_p
;
11881 /* Do a frame update, taking possible shortcuts into account. This is
11882 the main external entry point for redisplay.
11884 If the last redisplay displayed an echo area message and that message
11885 is no longer requested, we clear the echo area or bring back the
11886 mini-buffer if that is in use. */
11891 redisplay_internal ();
11896 overlay_arrow_string_or_property (Lisp_Object var
)
11900 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11903 return Voverlay_arrow_string
;
11906 /* Return 1 if there are any overlay-arrows in current_buffer. */
11908 overlay_arrow_in_current_buffer_p (void)
11912 for (vlist
= Voverlay_arrow_variable_list
;
11914 vlist
= XCDR (vlist
))
11916 Lisp_Object var
= XCAR (vlist
);
11919 if (!SYMBOLP (var
))
11921 val
= find_symbol_value (var
);
11923 && current_buffer
== XMARKER (val
)->buffer
)
11930 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11934 overlay_arrows_changed_p (void)
11938 for (vlist
= Voverlay_arrow_variable_list
;
11940 vlist
= XCDR (vlist
))
11942 Lisp_Object var
= XCAR (vlist
);
11943 Lisp_Object val
, pstr
;
11945 if (!SYMBOLP (var
))
11947 val
= find_symbol_value (var
);
11948 if (!MARKERP (val
))
11950 if (! EQ (COERCE_MARKER (val
),
11951 Fget (var
, Qlast_arrow_position
))
11952 || ! (pstr
= overlay_arrow_string_or_property (var
),
11953 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11959 /* Mark overlay arrows to be updated on next redisplay. */
11962 update_overlay_arrows (int up_to_date
)
11966 for (vlist
= Voverlay_arrow_variable_list
;
11968 vlist
= XCDR (vlist
))
11970 Lisp_Object var
= XCAR (vlist
);
11972 if (!SYMBOLP (var
))
11975 if (up_to_date
> 0)
11977 Lisp_Object val
= find_symbol_value (var
);
11978 Fput (var
, Qlast_arrow_position
,
11979 COERCE_MARKER (val
));
11980 Fput (var
, Qlast_arrow_string
,
11981 overlay_arrow_string_or_property (var
));
11983 else if (up_to_date
< 0
11984 || !NILP (Fget (var
, Qlast_arrow_position
)))
11986 Fput (var
, Qlast_arrow_position
, Qt
);
11987 Fput (var
, Qlast_arrow_string
, Qt
);
11993 /* Return overlay arrow string to display at row.
11994 Return integer (bitmap number) for arrow bitmap in left fringe.
11995 Return nil if no overlay arrow. */
11998 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12002 for (vlist
= Voverlay_arrow_variable_list
;
12004 vlist
= XCDR (vlist
))
12006 Lisp_Object var
= XCAR (vlist
);
12009 if (!SYMBOLP (var
))
12012 val
= find_symbol_value (var
);
12015 && current_buffer
== XMARKER (val
)->buffer
12016 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12018 if (FRAME_WINDOW_P (it
->f
)
12019 /* FIXME: if ROW->reversed_p is set, this should test
12020 the right fringe, not the left one. */
12021 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12023 #ifdef HAVE_WINDOW_SYSTEM
12024 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12027 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12028 return make_number (fringe_bitmap
);
12031 return make_number (-1); /* Use default arrow bitmap */
12033 return overlay_arrow_string_or_property (var
);
12040 /* Return 1 if point moved out of or into a composition. Otherwise
12041 return 0. PREV_BUF and PREV_PT are the last point buffer and
12042 position. BUF and PT are the current point buffer and position. */
12045 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12046 struct buffer
*buf
, EMACS_INT pt
)
12048 EMACS_INT start
, end
;
12050 Lisp_Object buffer
;
12052 XSETBUFFER (buffer
, buf
);
12053 /* Check a composition at the last point if point moved within the
12055 if (prev_buf
== buf
)
12058 /* Point didn't move. */
12061 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12062 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12063 && COMPOSITION_VALID_P (start
, end
, prop
)
12064 && start
< prev_pt
&& end
> prev_pt
)
12065 /* The last point was within the composition. Return 1 iff
12066 point moved out of the composition. */
12067 return (pt
<= start
|| pt
>= end
);
12070 /* Check a composition at the current point. */
12071 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12072 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12073 && COMPOSITION_VALID_P (start
, end
, prop
)
12074 && start
< pt
&& end
> pt
);
12078 /* Reconsider the setting of B->clip_changed which is displayed
12082 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12084 if (b
->clip_changed
12085 && !NILP (w
->window_end_valid
)
12086 && w
->current_matrix
->buffer
== b
12087 && w
->current_matrix
->zv
== BUF_ZV (b
)
12088 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12089 b
->clip_changed
= 0;
12091 /* If display wasn't paused, and W is not a tool bar window, see if
12092 point has been moved into or out of a composition. In that case,
12093 we set b->clip_changed to 1 to force updating the screen. If
12094 b->clip_changed has already been set to 1, we can skip this
12096 if (!b
->clip_changed
12097 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12101 if (w
== XWINDOW (selected_window
))
12104 pt
= marker_position (w
->pointm
);
12106 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12107 || pt
!= XINT (w
->last_point
))
12108 && check_point_in_composition (w
->current_matrix
->buffer
,
12109 XINT (w
->last_point
),
12110 XBUFFER (w
->buffer
), pt
))
12111 b
->clip_changed
= 1;
12116 /* Select FRAME to forward the values of frame-local variables into C
12117 variables so that the redisplay routines can access those values
12121 select_frame_for_redisplay (Lisp_Object frame
)
12123 Lisp_Object tail
, tem
;
12124 Lisp_Object old
= selected_frame
;
12125 struct Lisp_Symbol
*sym
;
12127 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12129 selected_frame
= frame
;
12132 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12133 if (CONSP (XCAR (tail
))
12134 && (tem
= XCAR (XCAR (tail
)),
12136 && (sym
= indirect_variable (XSYMBOL (tem
)),
12137 sym
->redirect
== SYMBOL_LOCALIZED
)
12138 && sym
->val
.blv
->frame_local
)
12139 /* Use find_symbol_value rather than Fsymbol_value
12140 to avoid an error if it is void. */
12141 find_symbol_value (tem
);
12142 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12146 #define STOP_POLLING \
12147 do { if (! polling_stopped_here) stop_polling (); \
12148 polling_stopped_here = 1; } while (0)
12150 #define RESUME_POLLING \
12151 do { if (polling_stopped_here) start_polling (); \
12152 polling_stopped_here = 0; } while (0)
12155 /* Perhaps in the future avoid recentering windows if it
12156 is not necessary; currently that causes some problems. */
12159 redisplay_internal (void)
12161 struct window
*w
= XWINDOW (selected_window
);
12165 int must_finish
= 0;
12166 struct text_pos tlbufpos
, tlendpos
;
12167 int number_of_visible_frames
;
12170 int polling_stopped_here
= 0;
12171 Lisp_Object old_frame
= selected_frame
;
12173 /* Non-zero means redisplay has to consider all windows on all
12174 frames. Zero means, only selected_window is considered. */
12175 int consider_all_windows_p
;
12177 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12179 /* No redisplay if running in batch mode or frame is not yet fully
12180 initialized, or redisplay is explicitly turned off by setting
12181 Vinhibit_redisplay. */
12182 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12183 || !NILP (Vinhibit_redisplay
))
12186 /* Don't examine these until after testing Vinhibit_redisplay.
12187 When Emacs is shutting down, perhaps because its connection to
12188 X has dropped, we should not look at them at all. */
12189 fr
= XFRAME (w
->frame
);
12190 sf
= SELECTED_FRAME ();
12192 if (!fr
->glyphs_initialized_p
)
12195 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12196 if (popup_activated ())
12200 /* I don't think this happens but let's be paranoid. */
12201 if (redisplaying_p
)
12204 /* Record a function that resets redisplaying_p to its old value
12205 when we leave this function. */
12206 count
= SPECPDL_INDEX ();
12207 record_unwind_protect (unwind_redisplay
,
12208 Fcons (make_number (redisplaying_p
), selected_frame
));
12210 specbind (Qinhibit_free_realized_faces
, Qnil
);
12213 Lisp_Object tail
, frame
;
12215 FOR_EACH_FRAME (tail
, frame
)
12217 struct frame
*f
= XFRAME (frame
);
12218 f
->already_hscrolled_p
= 0;
12223 /* Remember the currently selected window. */
12226 if (!EQ (old_frame
, selected_frame
)
12227 && FRAME_LIVE_P (XFRAME (old_frame
)))
12228 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12229 selected_frame and selected_window to be temporarily out-of-sync so
12230 when we come back here via `goto retry', we need to resync because we
12231 may need to run Elisp code (via prepare_menu_bars). */
12232 select_frame_for_redisplay (old_frame
);
12235 reconsider_clip_changes (w
, current_buffer
);
12236 last_escape_glyph_frame
= NULL
;
12237 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12238 last_glyphless_glyph_frame
= NULL
;
12239 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12241 /* If new fonts have been loaded that make a glyph matrix adjustment
12242 necessary, do it. */
12243 if (fonts_changed_p
)
12245 adjust_glyphs (NULL
);
12246 ++windows_or_buffers_changed
;
12247 fonts_changed_p
= 0;
12250 /* If face_change_count is non-zero, init_iterator will free all
12251 realized faces, which includes the faces referenced from current
12252 matrices. So, we can't reuse current matrices in this case. */
12253 if (face_change_count
)
12254 ++windows_or_buffers_changed
;
12256 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12257 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12259 /* Since frames on a single ASCII terminal share the same
12260 display area, displaying a different frame means redisplay
12261 the whole thing. */
12262 windows_or_buffers_changed
++;
12263 SET_FRAME_GARBAGED (sf
);
12265 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12267 FRAME_TTY (sf
)->previous_frame
= sf
;
12270 /* Set the visible flags for all frames. Do this before checking
12271 for resized or garbaged frames; they want to know if their frames
12272 are visible. See the comment in frame.h for
12273 FRAME_SAMPLE_VISIBILITY. */
12275 Lisp_Object tail
, frame
;
12277 number_of_visible_frames
= 0;
12279 FOR_EACH_FRAME (tail
, frame
)
12281 struct frame
*f
= XFRAME (frame
);
12283 FRAME_SAMPLE_VISIBILITY (f
);
12284 if (FRAME_VISIBLE_P (f
))
12285 ++number_of_visible_frames
;
12286 clear_desired_matrices (f
);
12290 /* Notice any pending interrupt request to change frame size. */
12291 do_pending_window_change (1);
12293 /* do_pending_window_change could change the selected_window due to
12294 frame resizing which makes the selected window too small. */
12295 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12298 reconsider_clip_changes (w
, current_buffer
);
12301 /* Clear frames marked as garbaged. */
12302 if (frame_garbaged
)
12303 clear_garbaged_frames ();
12305 /* Build menubar and tool-bar items. */
12306 if (NILP (Vmemory_full
))
12307 prepare_menu_bars ();
12309 if (windows_or_buffers_changed
)
12310 update_mode_lines
++;
12312 /* Detect case that we need to write or remove a star in the mode line. */
12313 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12315 w
->update_mode_line
= Qt
;
12316 if (buffer_shared
> 1)
12317 update_mode_lines
++;
12320 /* Avoid invocation of point motion hooks by `current_column' below. */
12321 count1
= SPECPDL_INDEX ();
12322 specbind (Qinhibit_point_motion_hooks
, Qt
);
12324 /* If %c is in the mode line, update it if needed. */
12325 if (!NILP (w
->column_number_displayed
)
12326 /* This alternative quickly identifies a common case
12327 where no change is needed. */
12328 && !(PT
== XFASTINT (w
->last_point
)
12329 && XFASTINT (w
->last_modified
) >= MODIFF
12330 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12331 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12332 w
->update_mode_line
= Qt
;
12334 unbind_to (count1
, Qnil
);
12336 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12338 /* The variable buffer_shared is set in redisplay_window and
12339 indicates that we redisplay a buffer in different windows. See
12341 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12342 || cursor_type_changed
);
12344 /* If specs for an arrow have changed, do thorough redisplay
12345 to ensure we remove any arrow that should no longer exist. */
12346 if (overlay_arrows_changed_p ())
12347 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12349 /* Normally the message* functions will have already displayed and
12350 updated the echo area, but the frame may have been trashed, or
12351 the update may have been preempted, so display the echo area
12352 again here. Checking message_cleared_p captures the case that
12353 the echo area should be cleared. */
12354 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12355 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12356 || (message_cleared_p
12357 && minibuf_level
== 0
12358 /* If the mini-window is currently selected, this means the
12359 echo-area doesn't show through. */
12360 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12362 int window_height_changed_p
= echo_area_display (0);
12365 /* If we don't display the current message, don't clear the
12366 message_cleared_p flag, because, if we did, we wouldn't clear
12367 the echo area in the next redisplay which doesn't preserve
12369 if (!display_last_displayed_message_p
)
12370 message_cleared_p
= 0;
12372 if (fonts_changed_p
)
12374 else if (window_height_changed_p
)
12376 consider_all_windows_p
= 1;
12377 ++update_mode_lines
;
12378 ++windows_or_buffers_changed
;
12380 /* If window configuration was changed, frames may have been
12381 marked garbaged. Clear them or we will experience
12382 surprises wrt scrolling. */
12383 if (frame_garbaged
)
12384 clear_garbaged_frames ();
12387 else if (EQ (selected_window
, minibuf_window
)
12388 && (current_buffer
->clip_changed
12389 || XFASTINT (w
->last_modified
) < MODIFF
12390 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12391 && resize_mini_window (w
, 0))
12393 /* Resized active mini-window to fit the size of what it is
12394 showing if its contents might have changed. */
12396 /* FIXME: this causes all frames to be updated, which seems unnecessary
12397 since only the current frame needs to be considered. This function needs
12398 to be rewritten with two variables, consider_all_windows and
12399 consider_all_frames. */
12400 consider_all_windows_p
= 1;
12401 ++windows_or_buffers_changed
;
12402 ++update_mode_lines
;
12404 /* If window configuration was changed, frames may have been
12405 marked garbaged. Clear them or we will experience
12406 surprises wrt scrolling. */
12407 if (frame_garbaged
)
12408 clear_garbaged_frames ();
12412 /* If showing the region, and mark has changed, we must redisplay
12413 the whole window. The assignment to this_line_start_pos prevents
12414 the optimization directly below this if-statement. */
12415 if (((!NILP (Vtransient_mark_mode
)
12416 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12417 != !NILP (w
->region_showing
))
12418 || (!NILP (w
->region_showing
)
12419 && !EQ (w
->region_showing
,
12420 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12421 CHARPOS (this_line_start_pos
) = 0;
12423 /* Optimize the case that only the line containing the cursor in the
12424 selected window has changed. Variables starting with this_ are
12425 set in display_line and record information about the line
12426 containing the cursor. */
12427 tlbufpos
= this_line_start_pos
;
12428 tlendpos
= this_line_end_pos
;
12429 if (!consider_all_windows_p
12430 && CHARPOS (tlbufpos
) > 0
12431 && NILP (w
->update_mode_line
)
12432 && !current_buffer
->clip_changed
12433 && !current_buffer
->prevent_redisplay_optimizations_p
12434 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12435 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12436 /* Make sure recorded data applies to current buffer, etc. */
12437 && this_line_buffer
== current_buffer
12438 && current_buffer
== XBUFFER (w
->buffer
)
12439 && NILP (w
->force_start
)
12440 && NILP (w
->optional_new_start
)
12441 /* Point must be on the line that we have info recorded about. */
12442 && PT
>= CHARPOS (tlbufpos
)
12443 && PT
<= Z
- CHARPOS (tlendpos
)
12444 /* All text outside that line, including its final newline,
12445 must be unchanged. */
12446 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12447 CHARPOS (tlendpos
)))
12449 if (CHARPOS (tlbufpos
) > BEGV
12450 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12451 && (CHARPOS (tlbufpos
) == ZV
12452 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12453 /* Former continuation line has disappeared by becoming empty. */
12455 else if (XFASTINT (w
->last_modified
) < MODIFF
12456 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12457 || MINI_WINDOW_P (w
))
12459 /* We have to handle the case of continuation around a
12460 wide-column character (see the comment in indent.c around
12463 For instance, in the following case:
12465 -------- Insert --------
12466 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12467 J_I_ ==> J_I_ `^^' are cursors.
12471 As we have to redraw the line above, we cannot use this
12475 int line_height_before
= this_line_pixel_height
;
12477 /* Note that start_display will handle the case that the
12478 line starting at tlbufpos is a continuation line. */
12479 start_display (&it
, w
, tlbufpos
);
12481 /* Implementation note: It this still necessary? */
12482 if (it
.current_x
!= this_line_start_x
)
12485 TRACE ((stderr
, "trying display optimization 1\n"));
12486 w
->cursor
.vpos
= -1;
12487 overlay_arrow_seen
= 0;
12488 it
.vpos
= this_line_vpos
;
12489 it
.current_y
= this_line_y
;
12490 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12491 display_line (&it
);
12493 /* If line contains point, is not continued,
12494 and ends at same distance from eob as before, we win. */
12495 if (w
->cursor
.vpos
>= 0
12496 /* Line is not continued, otherwise this_line_start_pos
12497 would have been set to 0 in display_line. */
12498 && CHARPOS (this_line_start_pos
)
12499 /* Line ends as before. */
12500 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12501 /* Line has same height as before. Otherwise other lines
12502 would have to be shifted up or down. */
12503 && this_line_pixel_height
== line_height_before
)
12505 /* If this is not the window's last line, we must adjust
12506 the charstarts of the lines below. */
12507 if (it
.current_y
< it
.last_visible_y
)
12509 struct glyph_row
*row
12510 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12511 EMACS_INT delta
, delta_bytes
;
12513 /* We used to distinguish between two cases here,
12514 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12515 when the line ends in a newline or the end of the
12516 buffer's accessible portion. But both cases did
12517 the same, so they were collapsed. */
12519 - CHARPOS (tlendpos
)
12520 - MATRIX_ROW_START_CHARPOS (row
));
12521 delta_bytes
= (Z_BYTE
12522 - BYTEPOS (tlendpos
)
12523 - MATRIX_ROW_START_BYTEPOS (row
));
12525 increment_matrix_positions (w
->current_matrix
,
12526 this_line_vpos
+ 1,
12527 w
->current_matrix
->nrows
,
12528 delta
, delta_bytes
);
12531 /* If this row displays text now but previously didn't,
12532 or vice versa, w->window_end_vpos may have to be
12534 if ((it
.glyph_row
- 1)->displays_text_p
)
12536 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12537 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12539 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12540 && this_line_vpos
> 0)
12541 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12542 w
->window_end_valid
= Qnil
;
12544 /* Update hint: No need to try to scroll in update_window. */
12545 w
->desired_matrix
->no_scrolling_p
= 1;
12548 *w
->desired_matrix
->method
= 0;
12549 debug_method_add (w
, "optimization 1");
12551 #ifdef HAVE_WINDOW_SYSTEM
12552 update_window_fringes (w
, 0);
12559 else if (/* Cursor position hasn't changed. */
12560 PT
== XFASTINT (w
->last_point
)
12561 /* Make sure the cursor was last displayed
12562 in this window. Otherwise we have to reposition it. */
12563 && 0 <= w
->cursor
.vpos
12564 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12568 do_pending_window_change (1);
12569 /* If selected_window changed, redisplay again. */
12570 if (WINDOWP (selected_window
)
12571 && (w
= XWINDOW (selected_window
)) != sw
)
12574 /* We used to always goto end_of_redisplay here, but this
12575 isn't enough if we have a blinking cursor. */
12576 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12577 goto end_of_redisplay
;
12581 /* If highlighting the region, or if the cursor is in the echo area,
12582 then we can't just move the cursor. */
12583 else if (! (!NILP (Vtransient_mark_mode
)
12584 && !NILP (BVAR (current_buffer
, mark_active
)))
12585 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12586 || highlight_nonselected_windows
)
12587 && NILP (w
->region_showing
)
12588 && NILP (Vshow_trailing_whitespace
)
12589 && !cursor_in_echo_area
)
12592 struct glyph_row
*row
;
12594 /* Skip from tlbufpos to PT and see where it is. Note that
12595 PT may be in invisible text. If so, we will end at the
12596 next visible position. */
12597 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12598 NULL
, DEFAULT_FACE_ID
);
12599 it
.current_x
= this_line_start_x
;
12600 it
.current_y
= this_line_y
;
12601 it
.vpos
= this_line_vpos
;
12603 /* The call to move_it_to stops in front of PT, but
12604 moves over before-strings. */
12605 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12607 if (it
.vpos
== this_line_vpos
12608 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12611 xassert (this_line_vpos
== it
.vpos
);
12612 xassert (this_line_y
== it
.current_y
);
12613 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12615 *w
->desired_matrix
->method
= 0;
12616 debug_method_add (w
, "optimization 3");
12625 /* Text changed drastically or point moved off of line. */
12626 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12629 CHARPOS (this_line_start_pos
) = 0;
12630 consider_all_windows_p
|= buffer_shared
> 1;
12631 ++clear_face_cache_count
;
12632 #ifdef HAVE_WINDOW_SYSTEM
12633 ++clear_image_cache_count
;
12636 /* Build desired matrices, and update the display. If
12637 consider_all_windows_p is non-zero, do it for all windows on all
12638 frames. Otherwise do it for selected_window, only. */
12640 if (consider_all_windows_p
)
12642 Lisp_Object tail
, frame
;
12644 FOR_EACH_FRAME (tail
, frame
)
12645 XFRAME (frame
)->updated_p
= 0;
12647 /* Recompute # windows showing selected buffer. This will be
12648 incremented each time such a window is displayed. */
12651 FOR_EACH_FRAME (tail
, frame
)
12653 struct frame
*f
= XFRAME (frame
);
12655 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12657 if (! EQ (frame
, selected_frame
))
12658 /* Select the frame, for the sake of frame-local
12660 select_frame_for_redisplay (frame
);
12662 /* Mark all the scroll bars to be removed; we'll redeem
12663 the ones we want when we redisplay their windows. */
12664 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12665 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12667 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12668 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12670 /* The X error handler may have deleted that frame. */
12671 if (!FRAME_LIVE_P (f
))
12674 /* Any scroll bars which redisplay_windows should have
12675 nuked should now go away. */
12676 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12677 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12679 /* If fonts changed, display again. */
12680 /* ??? rms: I suspect it is a mistake to jump all the way
12681 back to retry here. It should just retry this frame. */
12682 if (fonts_changed_p
)
12685 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12687 /* See if we have to hscroll. */
12688 if (!f
->already_hscrolled_p
)
12690 f
->already_hscrolled_p
= 1;
12691 if (hscroll_windows (f
->root_window
))
12695 /* Prevent various kinds of signals during display
12696 update. stdio is not robust about handling
12697 signals, which can cause an apparent I/O
12699 if (interrupt_input
)
12700 unrequest_sigio ();
12703 /* Update the display. */
12704 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12705 pending
|= update_frame (f
, 0, 0);
12711 if (!EQ (old_frame
, selected_frame
)
12712 && FRAME_LIVE_P (XFRAME (old_frame
)))
12713 /* We played a bit fast-and-loose above and allowed selected_frame
12714 and selected_window to be temporarily out-of-sync but let's make
12715 sure this stays contained. */
12716 select_frame_for_redisplay (old_frame
);
12717 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12721 /* Do the mark_window_display_accurate after all windows have
12722 been redisplayed because this call resets flags in buffers
12723 which are needed for proper redisplay. */
12724 FOR_EACH_FRAME (tail
, frame
)
12726 struct frame
*f
= XFRAME (frame
);
12729 mark_window_display_accurate (f
->root_window
, 1);
12730 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12731 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12736 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12738 Lisp_Object mini_window
;
12739 struct frame
*mini_frame
;
12741 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12742 /* Use list_of_error, not Qerror, so that
12743 we catch only errors and don't run the debugger. */
12744 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12746 redisplay_window_error
);
12748 /* Compare desired and current matrices, perform output. */
12751 /* If fonts changed, display again. */
12752 if (fonts_changed_p
)
12755 /* Prevent various kinds of signals during display update.
12756 stdio is not robust about handling signals,
12757 which can cause an apparent I/O error. */
12758 if (interrupt_input
)
12759 unrequest_sigio ();
12762 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12764 if (hscroll_windows (selected_window
))
12767 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12768 pending
= update_frame (sf
, 0, 0);
12771 /* We may have called echo_area_display at the top of this
12772 function. If the echo area is on another frame, that may
12773 have put text on a frame other than the selected one, so the
12774 above call to update_frame would not have caught it. Catch
12776 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12777 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12779 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12781 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12782 pending
|= update_frame (mini_frame
, 0, 0);
12783 if (!pending
&& hscroll_windows (mini_window
))
12788 /* If display was paused because of pending input, make sure we do a
12789 thorough update the next time. */
12792 /* Prevent the optimization at the beginning of
12793 redisplay_internal that tries a single-line update of the
12794 line containing the cursor in the selected window. */
12795 CHARPOS (this_line_start_pos
) = 0;
12797 /* Let the overlay arrow be updated the next time. */
12798 update_overlay_arrows (0);
12800 /* If we pause after scrolling, some rows in the current
12801 matrices of some windows are not valid. */
12802 if (!WINDOW_FULL_WIDTH_P (w
)
12803 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12804 update_mode_lines
= 1;
12808 if (!consider_all_windows_p
)
12810 /* This has already been done above if
12811 consider_all_windows_p is set. */
12812 mark_window_display_accurate_1 (w
, 1);
12814 /* Say overlay arrows are up to date. */
12815 update_overlay_arrows (1);
12817 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12818 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12821 update_mode_lines
= 0;
12822 windows_or_buffers_changed
= 0;
12823 cursor_type_changed
= 0;
12826 /* Start SIGIO interrupts coming again. Having them off during the
12827 code above makes it less likely one will discard output, but not
12828 impossible, since there might be stuff in the system buffer here.
12829 But it is much hairier to try to do anything about that. */
12830 if (interrupt_input
)
12834 /* If a frame has become visible which was not before, redisplay
12835 again, so that we display it. Expose events for such a frame
12836 (which it gets when becoming visible) don't call the parts of
12837 redisplay constructing glyphs, so simply exposing a frame won't
12838 display anything in this case. So, we have to display these
12839 frames here explicitly. */
12842 Lisp_Object tail
, frame
;
12845 FOR_EACH_FRAME (tail
, frame
)
12847 int this_is_visible
= 0;
12849 if (XFRAME (frame
)->visible
)
12850 this_is_visible
= 1;
12851 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12852 if (XFRAME (frame
)->visible
)
12853 this_is_visible
= 1;
12855 if (this_is_visible
)
12859 if (new_count
!= number_of_visible_frames
)
12860 windows_or_buffers_changed
++;
12863 /* Change frame size now if a change is pending. */
12864 do_pending_window_change (1);
12866 /* If we just did a pending size change, or have additional
12867 visible frames, or selected_window changed, redisplay again. */
12868 if ((windows_or_buffers_changed
&& !pending
)
12869 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12872 /* Clear the face and image caches.
12874 We used to do this only if consider_all_windows_p. But the cache
12875 needs to be cleared if a timer creates images in the current
12876 buffer (e.g. the test case in Bug#6230). */
12878 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12880 clear_face_cache (0);
12881 clear_face_cache_count
= 0;
12884 #ifdef HAVE_WINDOW_SYSTEM
12885 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12887 clear_image_caches (Qnil
);
12888 clear_image_cache_count
= 0;
12890 #endif /* HAVE_WINDOW_SYSTEM */
12893 unbind_to (count
, Qnil
);
12898 /* Redisplay, but leave alone any recent echo area message unless
12899 another message has been requested in its place.
12901 This is useful in situations where you need to redisplay but no
12902 user action has occurred, making it inappropriate for the message
12903 area to be cleared. See tracking_off and
12904 wait_reading_process_output for examples of these situations.
12906 FROM_WHERE is an integer saying from where this function was
12907 called. This is useful for debugging. */
12910 redisplay_preserve_echo_area (int from_where
)
12912 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12914 if (!NILP (echo_area_buffer
[1]))
12916 /* We have a previously displayed message, but no current
12917 message. Redisplay the previous message. */
12918 display_last_displayed_message_p
= 1;
12919 redisplay_internal ();
12920 display_last_displayed_message_p
= 0;
12923 redisplay_internal ();
12925 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12926 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12927 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12931 /* Function registered with record_unwind_protect in
12932 redisplay_internal. Reset redisplaying_p to the value it had
12933 before redisplay_internal was called, and clear
12934 prevent_freeing_realized_faces_p. It also selects the previously
12935 selected frame, unless it has been deleted (by an X connection
12936 failure during redisplay, for example). */
12939 unwind_redisplay (Lisp_Object val
)
12941 Lisp_Object old_redisplaying_p
, old_frame
;
12943 old_redisplaying_p
= XCAR (val
);
12944 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12945 old_frame
= XCDR (val
);
12946 if (! EQ (old_frame
, selected_frame
)
12947 && FRAME_LIVE_P (XFRAME (old_frame
)))
12948 select_frame_for_redisplay (old_frame
);
12953 /* Mark the display of window W as accurate or inaccurate. If
12954 ACCURATE_P is non-zero mark display of W as accurate. If
12955 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12956 redisplay_internal is called. */
12959 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12961 if (BUFFERP (w
->buffer
))
12963 struct buffer
*b
= XBUFFER (w
->buffer
);
12966 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12967 w
->last_overlay_modified
12968 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12970 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12974 b
->clip_changed
= 0;
12975 b
->prevent_redisplay_optimizations_p
= 0;
12977 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12978 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12979 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12980 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12982 w
->current_matrix
->buffer
= b
;
12983 w
->current_matrix
->begv
= BUF_BEGV (b
);
12984 w
->current_matrix
->zv
= BUF_ZV (b
);
12986 w
->last_cursor
= w
->cursor
;
12987 w
->last_cursor_off_p
= w
->cursor_off_p
;
12989 if (w
== XWINDOW (selected_window
))
12990 w
->last_point
= make_number (BUF_PT (b
));
12992 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12998 w
->window_end_valid
= w
->buffer
;
12999 w
->update_mode_line
= Qnil
;
13004 /* Mark the display of windows in the window tree rooted at WINDOW as
13005 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13006 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13007 be redisplayed the next time redisplay_internal is called. */
13010 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13014 for (; !NILP (window
); window
= w
->next
)
13016 w
= XWINDOW (window
);
13017 mark_window_display_accurate_1 (w
, accurate_p
);
13019 if (!NILP (w
->vchild
))
13020 mark_window_display_accurate (w
->vchild
, accurate_p
);
13021 if (!NILP (w
->hchild
))
13022 mark_window_display_accurate (w
->hchild
, accurate_p
);
13027 update_overlay_arrows (1);
13031 /* Force a thorough redisplay the next time by setting
13032 last_arrow_position and last_arrow_string to t, which is
13033 unequal to any useful value of Voverlay_arrow_... */
13034 update_overlay_arrows (-1);
13039 /* Return value in display table DP (Lisp_Char_Table *) for character
13040 C. Since a display table doesn't have any parent, we don't have to
13041 follow parent. Do not call this function directly but use the
13042 macro DISP_CHAR_VECTOR. */
13045 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13049 if (ASCII_CHAR_P (c
))
13052 if (SUB_CHAR_TABLE_P (val
))
13053 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13059 XSETCHAR_TABLE (table
, dp
);
13060 val
= char_table_ref (table
, c
);
13069 /***********************************************************************
13071 ***********************************************************************/
13073 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13076 redisplay_windows (Lisp_Object window
)
13078 while (!NILP (window
))
13080 struct window
*w
= XWINDOW (window
);
13082 if (!NILP (w
->hchild
))
13083 redisplay_windows (w
->hchild
);
13084 else if (!NILP (w
->vchild
))
13085 redisplay_windows (w
->vchild
);
13086 else if (!NILP (w
->buffer
))
13088 displayed_buffer
= XBUFFER (w
->buffer
);
13089 /* Use list_of_error, not Qerror, so that
13090 we catch only errors and don't run the debugger. */
13091 internal_condition_case_1 (redisplay_window_0
, window
,
13093 redisplay_window_error
);
13101 redisplay_window_error (Lisp_Object ignore
)
13103 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13108 redisplay_window_0 (Lisp_Object window
)
13110 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13111 redisplay_window (window
, 0);
13116 redisplay_window_1 (Lisp_Object window
)
13118 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13119 redisplay_window (window
, 1);
13124 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13125 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13126 which positions recorded in ROW differ from current buffer
13129 Return 0 if cursor is not on this row, 1 otherwise. */
13132 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13133 struct glyph_matrix
*matrix
,
13134 EMACS_INT delta
, EMACS_INT delta_bytes
,
13137 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13138 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13139 struct glyph
*cursor
= NULL
;
13140 /* The last known character position in row. */
13141 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13143 EMACS_INT pt_old
= PT
- delta
;
13144 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13145 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13146 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13147 /* A glyph beyond the edge of TEXT_AREA which we should never
13149 struct glyph
*glyphs_end
= end
;
13150 /* Non-zero means we've found a match for cursor position, but that
13151 glyph has the avoid_cursor_p flag set. */
13152 int match_with_avoid_cursor
= 0;
13153 /* Non-zero means we've seen at least one glyph that came from a
13155 int string_seen
= 0;
13156 /* Largest and smalles buffer positions seen so far during scan of
13158 EMACS_INT bpos_max
= pos_before
;
13159 EMACS_INT bpos_min
= pos_after
;
13160 /* Last buffer position covered by an overlay string with an integer
13161 `cursor' property. */
13162 EMACS_INT bpos_covered
= 0;
13164 /* Skip over glyphs not having an object at the start and the end of
13165 the row. These are special glyphs like truncation marks on
13166 terminal frames. */
13167 if (row
->displays_text_p
)
13169 if (!row
->reversed_p
)
13172 && INTEGERP (glyph
->object
)
13173 && glyph
->charpos
< 0)
13175 x
+= glyph
->pixel_width
;
13179 && INTEGERP ((end
- 1)->object
)
13180 /* CHARPOS is zero for blanks and stretch glyphs
13181 inserted by extend_face_to_end_of_line. */
13182 && (end
- 1)->charpos
<= 0)
13184 glyph_before
= glyph
- 1;
13191 /* If the glyph row is reversed, we need to process it from back
13192 to front, so swap the edge pointers. */
13193 glyphs_end
= end
= glyph
- 1;
13194 glyph
+= row
->used
[TEXT_AREA
] - 1;
13196 while (glyph
> end
+ 1
13197 && INTEGERP (glyph
->object
)
13198 && glyph
->charpos
< 0)
13201 x
-= glyph
->pixel_width
;
13203 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13205 /* By default, in reversed rows we put the cursor on the
13206 rightmost (first in the reading order) glyph. */
13207 for (g
= end
+ 1; g
< glyph
; g
++)
13208 x
+= g
->pixel_width
;
13210 && INTEGERP ((end
+ 1)->object
)
13211 && (end
+ 1)->charpos
<= 0)
13213 glyph_before
= glyph
+ 1;
13217 else if (row
->reversed_p
)
13219 /* In R2L rows that don't display text, put the cursor on the
13220 rightmost glyph. Case in point: an empty last line that is
13221 part of an R2L paragraph. */
13223 /* Avoid placing the cursor on the last glyph of the row, where
13224 on terminal frames we hold the vertical border between
13225 adjacent windows. */
13226 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13227 && !WINDOW_RIGHTMOST_P (w
)
13228 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13230 x
= -1; /* will be computed below, at label compute_x */
13233 /* Step 1: Try to find the glyph whose character position
13234 corresponds to point. If that's not possible, find 2 glyphs
13235 whose character positions are the closest to point, one before
13236 point, the other after it. */
13237 if (!row
->reversed_p
)
13238 while (/* not marched to end of glyph row */
13240 /* glyph was not inserted by redisplay for internal purposes */
13241 && !INTEGERP (glyph
->object
))
13243 if (BUFFERP (glyph
->object
))
13245 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13247 if (glyph
->charpos
> bpos_max
)
13248 bpos_max
= glyph
->charpos
;
13249 if (glyph
->charpos
< bpos_min
)
13250 bpos_min
= glyph
->charpos
;
13251 if (!glyph
->avoid_cursor_p
)
13253 /* If we hit point, we've found the glyph on which to
13254 display the cursor. */
13257 match_with_avoid_cursor
= 0;
13260 /* See if we've found a better approximation to
13261 POS_BEFORE or to POS_AFTER. Note that we want the
13262 first (leftmost) glyph of all those that are the
13263 closest from below, and the last (rightmost) of all
13264 those from above. */
13265 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13267 pos_before
= glyph
->charpos
;
13268 glyph_before
= glyph
;
13270 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13272 pos_after
= glyph
->charpos
;
13273 glyph_after
= glyph
;
13276 else if (dpos
== 0)
13277 match_with_avoid_cursor
= 1;
13279 else if (STRINGP (glyph
->object
))
13281 Lisp_Object chprop
;
13282 EMACS_INT glyph_pos
= glyph
->charpos
;
13284 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13286 if (INTEGERP (chprop
))
13288 bpos_covered
= bpos_max
+ XINT (chprop
);
13289 /* If the `cursor' property covers buffer positions up
13290 to and including point, we should display cursor on
13291 this glyph. Note that overlays and text properties
13292 with string values stop bidi reordering, so every
13293 buffer position to the left of the string is always
13294 smaller than any position to the right of the
13295 string. Therefore, if a `cursor' property on one
13296 of the string's characters has an integer value, we
13297 will break out of the loop below _before_ we get to
13298 the position match above. IOW, integer values of
13299 the `cursor' property override the "exact match for
13300 point" strategy of positioning the cursor. */
13301 /* Implementation note: bpos_max == pt_old when, e.g.,
13302 we are in an empty line, where bpos_max is set to
13303 MATRIX_ROW_START_CHARPOS, see above. */
13304 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13313 x
+= glyph
->pixel_width
;
13316 else if (glyph
> end
) /* row is reversed */
13317 while (!INTEGERP (glyph
->object
))
13319 if (BUFFERP (glyph
->object
))
13321 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13323 if (glyph
->charpos
> bpos_max
)
13324 bpos_max
= glyph
->charpos
;
13325 if (glyph
->charpos
< bpos_min
)
13326 bpos_min
= glyph
->charpos
;
13327 if (!glyph
->avoid_cursor_p
)
13331 match_with_avoid_cursor
= 0;
13334 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13336 pos_before
= glyph
->charpos
;
13337 glyph_before
= glyph
;
13339 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13341 pos_after
= glyph
->charpos
;
13342 glyph_after
= glyph
;
13345 else if (dpos
== 0)
13346 match_with_avoid_cursor
= 1;
13348 else if (STRINGP (glyph
->object
))
13350 Lisp_Object chprop
;
13351 EMACS_INT glyph_pos
= glyph
->charpos
;
13353 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13355 if (INTEGERP (chprop
))
13357 bpos_covered
= bpos_max
+ XINT (chprop
);
13358 /* If the `cursor' property covers buffer positions up
13359 to and including point, we should display cursor on
13361 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13370 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13372 x
--; /* can't use any pixel_width */
13375 x
-= glyph
->pixel_width
;
13378 /* Step 2: If we didn't find an exact match for point, we need to
13379 look for a proper place to put the cursor among glyphs between
13380 GLYPH_BEFORE and GLYPH_AFTER. */
13381 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13382 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13383 && bpos_covered
< pt_old
)
13385 /* An empty line has a single glyph whose OBJECT is zero and
13386 whose CHARPOS is the position of a newline on that line.
13387 Note that on a TTY, there are more glyphs after that, which
13388 were produced by extend_face_to_end_of_line, but their
13389 CHARPOS is zero or negative. */
13391 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13392 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13394 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13396 EMACS_INT ellipsis_pos
;
13398 /* Scan back over the ellipsis glyphs. */
13399 if (!row
->reversed_p
)
13401 ellipsis_pos
= (glyph
- 1)->charpos
;
13402 while (glyph
> row
->glyphs
[TEXT_AREA
]
13403 && (glyph
- 1)->charpos
== ellipsis_pos
)
13404 glyph
--, x
-= glyph
->pixel_width
;
13405 /* That loop always goes one position too far, including
13406 the glyph before the ellipsis. So scan forward over
13408 x
+= glyph
->pixel_width
;
13411 else /* row is reversed */
13413 ellipsis_pos
= (glyph
+ 1)->charpos
;
13414 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13415 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13416 glyph
++, x
+= glyph
->pixel_width
;
13417 x
-= glyph
->pixel_width
;
13421 else if (match_with_avoid_cursor
13422 /* A truncated row may not include PT among its
13423 character positions. Setting the cursor inside the
13424 scroll margin will trigger recalculation of hscroll
13425 in hscroll_window_tree. */
13426 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13427 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13428 /* Zero-width characters produce no glyphs. */
13431 && (row
->reversed_p
13432 ? glyph_after
> glyphs_end
13433 : glyph_after
< glyphs_end
)))
13435 cursor
= glyph_after
;
13438 else if (string_seen
)
13440 int incr
= row
->reversed_p
? -1 : +1;
13442 /* Need to find the glyph that came out of a string which is
13443 present at point. That glyph is somewhere between
13444 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13445 positioned between POS_BEFORE and POS_AFTER in the
13447 struct glyph
*start
, *stop
;
13448 EMACS_INT pos
= pos_before
;
13452 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13453 correspond to POS_BEFORE and POS_AFTER, respectively. We
13454 need START and STOP in the order that corresponds to the
13455 row's direction as given by its reversed_p flag. If the
13456 directionality of characters between POS_BEFORE and
13457 POS_AFTER is the opposite of the row's base direction,
13458 these characters will have been reordered for display,
13459 and we need to reverse START and STOP. */
13460 if (!row
->reversed_p
)
13462 start
= min (glyph_before
, glyph_after
);
13463 stop
= max (glyph_before
, glyph_after
);
13467 start
= max (glyph_before
, glyph_after
);
13468 stop
= min (glyph_before
, glyph_after
);
13470 for (glyph
= start
+ incr
;
13471 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13474 /* Any glyphs that come from the buffer are here because
13475 of bidi reordering. Skip them, and only pay
13476 attention to glyphs that came from some string. */
13477 if (STRINGP (glyph
->object
))
13482 str
= glyph
->object
;
13483 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13484 if (tem
== 0 /* from overlay */
13487 /* If the string from which this glyph came is
13488 found in the buffer at point, then we've
13489 found the glyph we've been looking for. If
13490 it comes from an overlay (tem == 0), and it
13491 has the `cursor' property on one of its
13492 glyphs, record that glyph as a candidate for
13493 displaying the cursor. (As in the
13494 unidirectional version, we will display the
13495 cursor on the last candidate we find.) */
13496 if (tem
== 0 || tem
== pt_old
)
13498 /* The glyphs from this string could have
13499 been reordered. Find the one with the
13500 smallest string position. Or there could
13501 be a character in the string with the
13502 `cursor' property, which means display
13503 cursor on that character's glyph. */
13504 EMACS_INT strpos
= glyph
->charpos
;
13509 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13510 && EQ (glyph
->object
, str
);
13514 EMACS_INT gpos
= glyph
->charpos
;
13516 cprop
= Fget_char_property (make_number (gpos
),
13524 if (tem
&& glyph
->charpos
< strpos
)
13526 strpos
= glyph
->charpos
;
13535 pos
= tem
+ 1; /* don't find previous instances */
13537 /* This string is not what we want; skip all of the
13538 glyphs that came from it. */
13539 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13540 && EQ (glyph
->object
, str
))
13547 /* If we reached the end of the line, and END was from a string,
13548 the cursor is not on this line. */
13550 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13551 && STRINGP (end
->object
)
13552 && row
->continued_p
)
13558 if (cursor
!= NULL
)
13564 /* Need to compute x that corresponds to GLYPH. */
13565 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13567 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13569 x
+= g
->pixel_width
;
13573 /* ROW could be part of a continued line, which, under bidi
13574 reordering, might have other rows whose start and end charpos
13575 occlude point. Only set w->cursor if we found a better
13576 approximation to the cursor position than we have from previously
13577 examined candidate rows belonging to the same continued line. */
13578 if (/* we already have a candidate row */
13579 w
->cursor
.vpos
>= 0
13580 /* that candidate is not the row we are processing */
13581 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13582 /* the row we are processing is part of a continued line */
13583 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13584 /* Make sure cursor.vpos specifies a row whose start and end
13585 charpos occlude point. This is because some callers of this
13586 function leave cursor.vpos at the row where the cursor was
13587 displayed during the last redisplay cycle. */
13588 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13589 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13592 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13594 /* Don't consider glyphs that are outside TEXT_AREA. */
13595 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13597 /* Keep the candidate whose buffer position is the closest to
13599 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13600 w
->cursor
.hpos
>= 0
13601 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13602 && BUFFERP (g1
->object
)
13603 && (g1
->charpos
== pt_old
/* an exact match always wins */
13604 || (BUFFERP (glyph
->object
)
13605 && eabs (g1
->charpos
- pt_old
)
13606 < eabs (glyph
->charpos
- pt_old
))))
13608 /* If this candidate gives an exact match, use that. */
13609 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13610 /* Otherwise, keep the candidate that comes from a row
13611 spanning less buffer positions. This may win when one or
13612 both candidate positions are on glyphs that came from
13613 display strings, for which we cannot compare buffer
13615 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13616 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13617 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13620 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13622 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13623 w
->cursor
.y
= row
->y
+ dy
;
13625 if (w
== XWINDOW (selected_window
))
13627 if (!row
->continued_p
13628 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13631 this_line_buffer
= XBUFFER (w
->buffer
);
13633 CHARPOS (this_line_start_pos
)
13634 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13635 BYTEPOS (this_line_start_pos
)
13636 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13638 CHARPOS (this_line_end_pos
)
13639 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13640 BYTEPOS (this_line_end_pos
)
13641 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13643 this_line_y
= w
->cursor
.y
;
13644 this_line_pixel_height
= row
->height
;
13645 this_line_vpos
= w
->cursor
.vpos
;
13646 this_line_start_x
= row
->x
;
13649 CHARPOS (this_line_start_pos
) = 0;
13656 /* Run window scroll functions, if any, for WINDOW with new window
13657 start STARTP. Sets the window start of WINDOW to that position.
13659 We assume that the window's buffer is really current. */
13661 static inline struct text_pos
13662 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13664 struct window
*w
= XWINDOW (window
);
13665 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13667 if (current_buffer
!= XBUFFER (w
->buffer
))
13670 if (!NILP (Vwindow_scroll_functions
))
13672 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13673 make_number (CHARPOS (startp
)));
13674 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13675 /* In case the hook functions switch buffers. */
13676 if (current_buffer
!= XBUFFER (w
->buffer
))
13677 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13684 /* Make sure the line containing the cursor is fully visible.
13685 A value of 1 means there is nothing to be done.
13686 (Either the line is fully visible, or it cannot be made so,
13687 or we cannot tell.)
13689 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13690 is higher than window.
13692 A value of 0 means the caller should do scrolling
13693 as if point had gone off the screen. */
13696 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13698 struct glyph_matrix
*matrix
;
13699 struct glyph_row
*row
;
13702 if (!make_cursor_line_fully_visible_p
)
13705 /* It's not always possible to find the cursor, e.g, when a window
13706 is full of overlay strings. Don't do anything in that case. */
13707 if (w
->cursor
.vpos
< 0)
13710 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13711 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13713 /* If the cursor row is not partially visible, there's nothing to do. */
13714 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13717 /* If the row the cursor is in is taller than the window's height,
13718 it's not clear what to do, so do nothing. */
13719 window_height
= window_box_height (w
);
13720 if (row
->height
>= window_height
)
13722 if (!force_p
|| MINI_WINDOW_P (w
)
13723 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13730 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13731 non-zero means only WINDOW is redisplayed in redisplay_internal.
13732 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13733 in redisplay_window to bring a partially visible line into view in
13734 the case that only the cursor has moved.
13736 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13737 last screen line's vertical height extends past the end of the screen.
13741 1 if scrolling succeeded
13743 0 if scrolling didn't find point.
13745 -1 if new fonts have been loaded so that we must interrupt
13746 redisplay, adjust glyph matrices, and try again. */
13752 SCROLLING_NEED_LARGER_MATRICES
13755 /* If scroll-conservatively is more than this, never recenter.
13757 If you change this, don't forget to update the doc string of
13758 `scroll-conservatively' and the Emacs manual. */
13759 #define SCROLL_LIMIT 100
13762 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13763 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13764 int temp_scroll_step
, int last_line_misfit
)
13766 struct window
*w
= XWINDOW (window
);
13767 struct frame
*f
= XFRAME (w
->frame
);
13768 struct text_pos pos
, startp
;
13770 int this_scroll_margin
, scroll_max
, rc
, height
;
13771 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13772 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13773 Lisp_Object aggressive
;
13774 /* We will never try scrolling more than this number of lines. */
13775 int scroll_limit
= SCROLL_LIMIT
;
13778 debug_method_add (w
, "try_scrolling");
13781 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13783 /* Compute scroll margin height in pixels. We scroll when point is
13784 within this distance from the top or bottom of the window. */
13785 if (scroll_margin
> 0)
13786 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13787 * FRAME_LINE_HEIGHT (f
);
13789 this_scroll_margin
= 0;
13791 /* Force arg_scroll_conservatively to have a reasonable value, to
13792 avoid scrolling too far away with slow move_it_* functions. Note
13793 that the user can supply scroll-conservatively equal to
13794 `most-positive-fixnum', which can be larger than INT_MAX. */
13795 if (arg_scroll_conservatively
> scroll_limit
)
13797 arg_scroll_conservatively
= scroll_limit
+ 1;
13798 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13800 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13801 /* Compute how much we should try to scroll maximally to bring
13802 point into view. */
13803 scroll_max
= (max (scroll_step
,
13804 max (arg_scroll_conservatively
, temp_scroll_step
))
13805 * FRAME_LINE_HEIGHT (f
));
13806 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13807 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13808 /* We're trying to scroll because of aggressive scrolling but no
13809 scroll_step is set. Choose an arbitrary one. */
13810 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13816 /* Decide whether to scroll down. */
13817 if (PT
> CHARPOS (startp
))
13819 int scroll_margin_y
;
13821 /* Compute the pixel ypos of the scroll margin, then move it to
13822 either that ypos or PT, whichever comes first. */
13823 start_display (&it
, w
, startp
);
13824 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13825 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13826 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13827 (MOVE_TO_POS
| MOVE_TO_Y
));
13829 if (PT
> CHARPOS (it
.current
.pos
))
13831 int y0
= line_bottom_y (&it
);
13832 /* Compute how many pixels below window bottom to stop searching
13833 for PT. This avoids costly search for PT that is far away if
13834 the user limited scrolling by a small number of lines, but
13835 always finds PT if scroll_conservatively is set to a large
13836 number, such as most-positive-fixnum. */
13837 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13838 int y_to_move
= it
.last_visible_y
+ slack
;
13840 /* Compute the distance from the scroll margin to PT or to
13841 the scroll limit, whichever comes first. This should
13842 include the height of the cursor line, to make that line
13844 move_it_to (&it
, PT
, -1, y_to_move
,
13845 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13846 dy
= line_bottom_y (&it
) - y0
;
13848 if (dy
> scroll_max
)
13849 return SCROLLING_FAILED
;
13857 /* Point is in or below the bottom scroll margin, so move the
13858 window start down. If scrolling conservatively, move it just
13859 enough down to make point visible. If scroll_step is set,
13860 move it down by scroll_step. */
13861 if (arg_scroll_conservatively
)
13863 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13864 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13865 else if (scroll_step
|| temp_scroll_step
)
13866 amount_to_scroll
= scroll_max
;
13869 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13870 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13871 if (NUMBERP (aggressive
))
13873 double float_amount
= XFLOATINT (aggressive
) * height
;
13874 amount_to_scroll
= float_amount
;
13875 if (amount_to_scroll
== 0 && float_amount
> 0)
13876 amount_to_scroll
= 1;
13877 /* Don't let point enter the scroll margin near top of
13879 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13880 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13884 if (amount_to_scroll
<= 0)
13885 return SCROLLING_FAILED
;
13887 start_display (&it
, w
, startp
);
13888 if (arg_scroll_conservatively
<= scroll_limit
)
13889 move_it_vertically (&it
, amount_to_scroll
);
13892 /* Extra precision for users who set scroll-conservatively
13893 to a large number: make sure the amount we scroll
13894 the window start is never less than amount_to_scroll,
13895 which was computed as distance from window bottom to
13896 point. This matters when lines at window top and lines
13897 below window bottom have different height. */
13899 void *it1data
= NULL
;
13900 /* We use a temporary it1 because line_bottom_y can modify
13901 its argument, if it moves one line down; see there. */
13904 SAVE_IT (it1
, it
, it1data
);
13905 start_y
= line_bottom_y (&it1
);
13907 RESTORE_IT (&it
, &it
, it1data
);
13908 move_it_by_lines (&it
, 1);
13909 SAVE_IT (it1
, it
, it1data
);
13910 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13913 /* If STARTP is unchanged, move it down another screen line. */
13914 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13915 move_it_by_lines (&it
, 1);
13916 startp
= it
.current
.pos
;
13920 struct text_pos scroll_margin_pos
= startp
;
13922 /* See if point is inside the scroll margin at the top of the
13924 if (this_scroll_margin
)
13926 start_display (&it
, w
, startp
);
13927 move_it_vertically (&it
, this_scroll_margin
);
13928 scroll_margin_pos
= it
.current
.pos
;
13931 if (PT
< CHARPOS (scroll_margin_pos
))
13933 /* Point is in the scroll margin at the top of the window or
13934 above what is displayed in the window. */
13937 /* Compute the vertical distance from PT to the scroll
13938 margin position. Move as far as scroll_max allows, or
13939 one screenful, or 10 screen lines, whichever is largest.
13940 Give up if distance is greater than scroll_max. */
13941 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13942 start_display (&it
, w
, pos
);
13944 y_to_move
= max (it
.last_visible_y
,
13945 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13946 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13948 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13949 dy
= it
.current_y
- y0
;
13950 if (dy
> scroll_max
)
13951 return SCROLLING_FAILED
;
13953 /* Compute new window start. */
13954 start_display (&it
, w
, startp
);
13956 if (arg_scroll_conservatively
)
13957 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13958 max (scroll_step
, temp_scroll_step
));
13959 else if (scroll_step
|| temp_scroll_step
)
13960 amount_to_scroll
= scroll_max
;
13963 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13964 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13965 if (NUMBERP (aggressive
))
13967 double float_amount
= XFLOATINT (aggressive
) * height
;
13968 amount_to_scroll
= float_amount
;
13969 if (amount_to_scroll
== 0 && float_amount
> 0)
13970 amount_to_scroll
= 1;
13971 amount_to_scroll
-=
13972 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13973 /* Don't let point enter the scroll margin near
13974 bottom of the window. */
13975 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13976 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13980 if (amount_to_scroll
<= 0)
13981 return SCROLLING_FAILED
;
13983 move_it_vertically_backward (&it
, amount_to_scroll
);
13984 startp
= it
.current
.pos
;
13988 /* Run window scroll functions. */
13989 startp
= run_window_scroll_functions (window
, startp
);
13991 /* Display the window. Give up if new fonts are loaded, or if point
13993 if (!try_window (window
, startp
, 0))
13994 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13995 else if (w
->cursor
.vpos
< 0)
13997 clear_glyph_matrix (w
->desired_matrix
);
13998 rc
= SCROLLING_FAILED
;
14002 /* Maybe forget recorded base line for line number display. */
14003 if (!just_this_one_p
14004 || current_buffer
->clip_changed
14005 || BEG_UNCHANGED
< CHARPOS (startp
))
14006 w
->base_line_number
= Qnil
;
14008 /* If cursor ends up on a partially visible line,
14009 treat that as being off the bottom of the screen. */
14010 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14011 /* It's possible that the cursor is on the first line of the
14012 buffer, which is partially obscured due to a vscroll
14013 (Bug#7537). In that case, avoid looping forever . */
14014 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14016 clear_glyph_matrix (w
->desired_matrix
);
14017 ++extra_scroll_margin_lines
;
14020 rc
= SCROLLING_SUCCESS
;
14027 /* Compute a suitable window start for window W if display of W starts
14028 on a continuation line. Value is non-zero if a new window start
14031 The new window start will be computed, based on W's width, starting
14032 from the start of the continued line. It is the start of the
14033 screen line with the minimum distance from the old start W->start. */
14036 compute_window_start_on_continuation_line (struct window
*w
)
14038 struct text_pos pos
, start_pos
;
14039 int window_start_changed_p
= 0;
14041 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14043 /* If window start is on a continuation line... Window start may be
14044 < BEGV in case there's invisible text at the start of the
14045 buffer (M-x rmail, for example). */
14046 if (CHARPOS (start_pos
) > BEGV
14047 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14050 struct glyph_row
*row
;
14052 /* Handle the case that the window start is out of range. */
14053 if (CHARPOS (start_pos
) < BEGV
)
14054 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14055 else if (CHARPOS (start_pos
) > ZV
)
14056 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14058 /* Find the start of the continued line. This should be fast
14059 because scan_buffer is fast (newline cache). */
14060 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14061 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14062 row
, DEFAULT_FACE_ID
);
14063 reseat_at_previous_visible_line_start (&it
);
14065 /* If the line start is "too far" away from the window start,
14066 say it takes too much time to compute a new window start. */
14067 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14068 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14070 int min_distance
, distance
;
14072 /* Move forward by display lines to find the new window
14073 start. If window width was enlarged, the new start can
14074 be expected to be > the old start. If window width was
14075 decreased, the new window start will be < the old start.
14076 So, we're looking for the display line start with the
14077 minimum distance from the old window start. */
14078 pos
= it
.current
.pos
;
14079 min_distance
= INFINITY
;
14080 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14081 distance
< min_distance
)
14083 min_distance
= distance
;
14084 pos
= it
.current
.pos
;
14085 move_it_by_lines (&it
, 1);
14088 /* Set the window start there. */
14089 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14090 window_start_changed_p
= 1;
14094 return window_start_changed_p
;
14098 /* Try cursor movement in case text has not changed in window WINDOW,
14099 with window start STARTP. Value is
14101 CURSOR_MOVEMENT_SUCCESS if successful
14103 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14105 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14106 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14107 we want to scroll as if scroll-step were set to 1. See the code.
14109 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14110 which case we have to abort this redisplay, and adjust matrices
14115 CURSOR_MOVEMENT_SUCCESS
,
14116 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14117 CURSOR_MOVEMENT_MUST_SCROLL
,
14118 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14122 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14124 struct window
*w
= XWINDOW (window
);
14125 struct frame
*f
= XFRAME (w
->frame
);
14126 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14129 if (inhibit_try_cursor_movement
)
14133 /* Handle case where text has not changed, only point, and it has
14134 not moved off the frame. */
14135 if (/* Point may be in this window. */
14136 PT
>= CHARPOS (startp
)
14137 /* Selective display hasn't changed. */
14138 && !current_buffer
->clip_changed
14139 /* Function force-mode-line-update is used to force a thorough
14140 redisplay. It sets either windows_or_buffers_changed or
14141 update_mode_lines. So don't take a shortcut here for these
14143 && !update_mode_lines
14144 && !windows_or_buffers_changed
14145 && !cursor_type_changed
14146 /* Can't use this case if highlighting a region. When a
14147 region exists, cursor movement has to do more than just
14149 && !(!NILP (Vtransient_mark_mode
)
14150 && !NILP (BVAR (current_buffer
, mark_active
)))
14151 && NILP (w
->region_showing
)
14152 && NILP (Vshow_trailing_whitespace
)
14153 /* Right after splitting windows, last_point may be nil. */
14154 && INTEGERP (w
->last_point
)
14155 /* This code is not used for mini-buffer for the sake of the case
14156 of redisplaying to replace an echo area message; since in
14157 that case the mini-buffer contents per se are usually
14158 unchanged. This code is of no real use in the mini-buffer
14159 since the handling of this_line_start_pos, etc., in redisplay
14160 handles the same cases. */
14161 && !EQ (window
, minibuf_window
)
14162 /* When splitting windows or for new windows, it happens that
14163 redisplay is called with a nil window_end_vpos or one being
14164 larger than the window. This should really be fixed in
14165 window.c. I don't have this on my list, now, so we do
14166 approximately the same as the old redisplay code. --gerd. */
14167 && INTEGERP (w
->window_end_vpos
)
14168 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14169 && (FRAME_WINDOW_P (f
)
14170 || !overlay_arrow_in_current_buffer_p ()))
14172 int this_scroll_margin
, top_scroll_margin
;
14173 struct glyph_row
*row
= NULL
;
14176 debug_method_add (w
, "cursor movement");
14179 /* Scroll if point within this distance from the top or bottom
14180 of the window. This is a pixel value. */
14181 if (scroll_margin
> 0)
14183 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14184 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14187 this_scroll_margin
= 0;
14189 top_scroll_margin
= this_scroll_margin
;
14190 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14191 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14193 /* Start with the row the cursor was displayed during the last
14194 not paused redisplay. Give up if that row is not valid. */
14195 if (w
->last_cursor
.vpos
< 0
14196 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14197 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14200 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14201 if (row
->mode_line_p
)
14203 if (!row
->enabled_p
)
14204 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14207 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14209 int scroll_p
= 0, must_scroll
= 0;
14210 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14212 if (PT
> XFASTINT (w
->last_point
))
14214 /* Point has moved forward. */
14215 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14216 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14218 xassert (row
->enabled_p
);
14222 /* If the end position of a row equals the start
14223 position of the next row, and PT is at that position,
14224 we would rather display cursor in the next line. */
14225 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14226 && MATRIX_ROW_END_CHARPOS (row
) == PT
14227 && row
< w
->current_matrix
->rows
14228 + w
->current_matrix
->nrows
- 1
14229 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14230 && !cursor_row_p (row
))
14233 /* If within the scroll margin, scroll. Note that
14234 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14235 the next line would be drawn, and that
14236 this_scroll_margin can be zero. */
14237 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14238 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14239 /* Line is completely visible last line in window
14240 and PT is to be set in the next line. */
14241 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14242 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14243 && !row
->ends_at_zv_p
14244 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14247 else if (PT
< XFASTINT (w
->last_point
))
14249 /* Cursor has to be moved backward. Note that PT >=
14250 CHARPOS (startp) because of the outer if-statement. */
14251 while (!row
->mode_line_p
14252 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14253 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14254 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14255 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14256 row
> w
->current_matrix
->rows
14257 && (row
-1)->ends_in_newline_from_string_p
))))
14258 && (row
->y
> top_scroll_margin
14259 || CHARPOS (startp
) == BEGV
))
14261 xassert (row
->enabled_p
);
14265 /* Consider the following case: Window starts at BEGV,
14266 there is invisible, intangible text at BEGV, so that
14267 display starts at some point START > BEGV. It can
14268 happen that we are called with PT somewhere between
14269 BEGV and START. Try to handle that case. */
14270 if (row
< w
->current_matrix
->rows
14271 || row
->mode_line_p
)
14273 row
= w
->current_matrix
->rows
;
14274 if (row
->mode_line_p
)
14278 /* Due to newlines in overlay strings, we may have to
14279 skip forward over overlay strings. */
14280 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14281 && MATRIX_ROW_END_CHARPOS (row
) == PT
14282 && !cursor_row_p (row
))
14285 /* If within the scroll margin, scroll. */
14286 if (row
->y
< top_scroll_margin
14287 && CHARPOS (startp
) != BEGV
)
14292 /* Cursor did not move. So don't scroll even if cursor line
14293 is partially visible, as it was so before. */
14294 rc
= CURSOR_MOVEMENT_SUCCESS
;
14297 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14298 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14300 /* if PT is not in the glyph row, give up. */
14301 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14304 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14305 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14307 /* If rows are bidi-reordered and point moved, back up
14308 until we find a row that does not belong to a
14309 continuation line. This is because we must consider
14310 all rows of a continued line as candidates for the
14311 new cursor positioning, since row start and end
14312 positions change non-linearly with vertical position
14314 /* FIXME: Revisit this when glyph ``spilling'' in
14315 continuation lines' rows is implemented for
14316 bidi-reordered rows. */
14317 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14319 xassert (row
->enabled_p
);
14321 /* If we hit the beginning of the displayed portion
14322 without finding the first row of a continued
14324 if (row
<= w
->current_matrix
->rows
)
14326 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14334 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14335 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14336 && make_cursor_line_fully_visible_p
)
14338 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14339 && !row
->ends_at_zv_p
14340 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14341 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14342 else if (row
->height
> window_box_height (w
))
14344 /* If we end up in a partially visible line, let's
14345 make it fully visible, except when it's taller
14346 than the window, in which case we can't do much
14349 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14353 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14354 if (!cursor_row_fully_visible_p (w
, 0, 1))
14355 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14357 rc
= CURSOR_MOVEMENT_SUCCESS
;
14361 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14362 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14363 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14365 /* With bidi-reordered rows, there could be more than
14366 one candidate row whose start and end positions
14367 occlude point. We need to let set_cursor_from_row
14368 find the best candidate. */
14369 /* FIXME: Revisit this when glyph ``spilling'' in
14370 continuation lines' rows is implemented for
14371 bidi-reordered rows. */
14376 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14377 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14378 && cursor_row_p (row
))
14379 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14381 /* As soon as we've found the first suitable row
14382 whose ends_at_zv_p flag is set, we are done. */
14384 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14386 rc
= CURSOR_MOVEMENT_SUCCESS
;
14391 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14392 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14393 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14394 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14395 /* If we didn't find any candidate rows, or exited the
14396 loop before all the candidates were examined, signal
14397 to the caller that this method failed. */
14398 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14399 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14400 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14402 rc
= CURSOR_MOVEMENT_SUCCESS
;
14408 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14410 rc
= CURSOR_MOVEMENT_SUCCESS
;
14415 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14416 && MATRIX_ROW_START_CHARPOS (row
) == PT
14417 && cursor_row_p (row
));
14425 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14429 set_vertical_scroll_bar (struct window
*w
)
14431 EMACS_INT start
, end
, whole
;
14433 /* Calculate the start and end positions for the current window.
14434 At some point, it would be nice to choose between scrollbars
14435 which reflect the whole buffer size, with special markers
14436 indicating narrowing, and scrollbars which reflect only the
14439 Note that mini-buffers sometimes aren't displaying any text. */
14440 if (!MINI_WINDOW_P (w
)
14441 || (w
== XWINDOW (minibuf_window
)
14442 && NILP (echo_area_buffer
[0])))
14444 struct buffer
*buf
= XBUFFER (w
->buffer
);
14445 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14446 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14447 /* I don't think this is guaranteed to be right. For the
14448 moment, we'll pretend it is. */
14449 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14453 if (whole
< (end
- start
))
14454 whole
= end
- start
;
14457 start
= end
= whole
= 0;
14459 /* Indicate what this scroll bar ought to be displaying now. */
14460 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14461 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14462 (w
, end
- start
, whole
, start
);
14466 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14467 selected_window is redisplayed.
14469 We can return without actually redisplaying the window if
14470 fonts_changed_p is nonzero. In that case, redisplay_internal will
14474 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14476 struct window
*w
= XWINDOW (window
);
14477 struct frame
*f
= XFRAME (w
->frame
);
14478 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14479 struct buffer
*old
= current_buffer
;
14480 struct text_pos lpoint
, opoint
, startp
;
14481 int update_mode_line
;
14484 /* Record it now because it's overwritten. */
14485 int current_matrix_up_to_date_p
= 0;
14486 int used_current_matrix_p
= 0;
14487 /* This is less strict than current_matrix_up_to_date_p.
14488 It indictes that the buffer contents and narrowing are unchanged. */
14489 int buffer_unchanged_p
= 0;
14490 int temp_scroll_step
= 0;
14491 int count
= SPECPDL_INDEX ();
14493 int centering_position
= -1;
14494 int last_line_misfit
= 0;
14495 EMACS_INT beg_unchanged
, end_unchanged
;
14497 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14500 /* W must be a leaf window here. */
14501 xassert (!NILP (w
->buffer
));
14503 *w
->desired_matrix
->method
= 0;
14507 reconsider_clip_changes (w
, buffer
);
14509 /* Has the mode line to be updated? */
14510 update_mode_line
= (!NILP (w
->update_mode_line
)
14511 || update_mode_lines
14512 || buffer
->clip_changed
14513 || buffer
->prevent_redisplay_optimizations_p
);
14515 if (MINI_WINDOW_P (w
))
14517 if (w
== XWINDOW (echo_area_window
)
14518 && !NILP (echo_area_buffer
[0]))
14520 if (update_mode_line
)
14521 /* We may have to update a tty frame's menu bar or a
14522 tool-bar. Example `M-x C-h C-h C-g'. */
14523 goto finish_menu_bars
;
14525 /* We've already displayed the echo area glyphs in this window. */
14526 goto finish_scroll_bars
;
14528 else if ((w
!= XWINDOW (minibuf_window
)
14529 || minibuf_level
== 0)
14530 /* When buffer is nonempty, redisplay window normally. */
14531 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14532 /* Quail displays non-mini buffers in minibuffer window.
14533 In that case, redisplay the window normally. */
14534 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14536 /* W is a mini-buffer window, but it's not active, so clear
14538 int yb
= window_text_bottom_y (w
);
14539 struct glyph_row
*row
;
14542 for (y
= 0, row
= w
->desired_matrix
->rows
;
14544 y
+= row
->height
, ++row
)
14545 blank_row (w
, row
, y
);
14546 goto finish_scroll_bars
;
14549 clear_glyph_matrix (w
->desired_matrix
);
14552 /* Otherwise set up data on this window; select its buffer and point
14554 /* Really select the buffer, for the sake of buffer-local
14556 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14558 current_matrix_up_to_date_p
14559 = (!NILP (w
->window_end_valid
)
14560 && !current_buffer
->clip_changed
14561 && !current_buffer
->prevent_redisplay_optimizations_p
14562 && XFASTINT (w
->last_modified
) >= MODIFF
14563 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14565 /* Run the window-bottom-change-functions
14566 if it is possible that the text on the screen has changed
14567 (either due to modification of the text, or any other reason). */
14568 if (!current_matrix_up_to_date_p
14569 && !NILP (Vwindow_text_change_functions
))
14571 safe_run_hooks (Qwindow_text_change_functions
);
14575 beg_unchanged
= BEG_UNCHANGED
;
14576 end_unchanged
= END_UNCHANGED
;
14578 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14580 specbind (Qinhibit_point_motion_hooks
, Qt
);
14583 = (!NILP (w
->window_end_valid
)
14584 && !current_buffer
->clip_changed
14585 && XFASTINT (w
->last_modified
) >= MODIFF
14586 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14588 /* When windows_or_buffers_changed is non-zero, we can't rely on
14589 the window end being valid, so set it to nil there. */
14590 if (windows_or_buffers_changed
)
14592 /* If window starts on a continuation line, maybe adjust the
14593 window start in case the window's width changed. */
14594 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14595 compute_window_start_on_continuation_line (w
);
14597 w
->window_end_valid
= Qnil
;
14600 /* Some sanity checks. */
14601 CHECK_WINDOW_END (w
);
14602 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14604 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14607 /* If %c is in mode line, update it if needed. */
14608 if (!NILP (w
->column_number_displayed
)
14609 /* This alternative quickly identifies a common case
14610 where no change is needed. */
14611 && !(PT
== XFASTINT (w
->last_point
)
14612 && XFASTINT (w
->last_modified
) >= MODIFF
14613 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14614 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14615 update_mode_line
= 1;
14617 /* Count number of windows showing the selected buffer. An indirect
14618 buffer counts as its base buffer. */
14619 if (!just_this_one_p
)
14621 struct buffer
*current_base
, *window_base
;
14622 current_base
= current_buffer
;
14623 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14624 if (current_base
->base_buffer
)
14625 current_base
= current_base
->base_buffer
;
14626 if (window_base
->base_buffer
)
14627 window_base
= window_base
->base_buffer
;
14628 if (current_base
== window_base
)
14632 /* Point refers normally to the selected window. For any other
14633 window, set up appropriate value. */
14634 if (!EQ (window
, selected_window
))
14636 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14637 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14641 new_pt_byte
= BEGV_BYTE
;
14642 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14644 else if (new_pt
> (ZV
- 1))
14647 new_pt_byte
= ZV_BYTE
;
14648 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14651 /* We don't use SET_PT so that the point-motion hooks don't run. */
14652 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14655 /* If any of the character widths specified in the display table
14656 have changed, invalidate the width run cache. It's true that
14657 this may be a bit late to catch such changes, but the rest of
14658 redisplay goes (non-fatally) haywire when the display table is
14659 changed, so why should we worry about doing any better? */
14660 if (current_buffer
->width_run_cache
)
14662 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14664 if (! disptab_matches_widthtab (disptab
,
14665 XVECTOR (BVAR (current_buffer
, width_table
))))
14667 invalidate_region_cache (current_buffer
,
14668 current_buffer
->width_run_cache
,
14670 recompute_width_table (current_buffer
, disptab
);
14674 /* If window-start is screwed up, choose a new one. */
14675 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14678 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14680 /* If someone specified a new starting point but did not insist,
14681 check whether it can be used. */
14682 if (!NILP (w
->optional_new_start
)
14683 && CHARPOS (startp
) >= BEGV
14684 && CHARPOS (startp
) <= ZV
)
14686 w
->optional_new_start
= Qnil
;
14687 start_display (&it
, w
, startp
);
14688 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14689 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14690 if (IT_CHARPOS (it
) == PT
)
14691 w
->force_start
= Qt
;
14692 /* IT may overshoot PT if text at PT is invisible. */
14693 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14694 w
->force_start
= Qt
;
14699 /* Handle case where place to start displaying has been specified,
14700 unless the specified location is outside the accessible range. */
14701 if (!NILP (w
->force_start
)
14702 || w
->frozen_window_start_p
)
14704 /* We set this later on if we have to adjust point. */
14707 w
->force_start
= Qnil
;
14709 w
->window_end_valid
= Qnil
;
14711 /* Forget any recorded base line for line number display. */
14712 if (!buffer_unchanged_p
)
14713 w
->base_line_number
= Qnil
;
14715 /* Redisplay the mode line. Select the buffer properly for that.
14716 Also, run the hook window-scroll-functions
14717 because we have scrolled. */
14718 /* Note, we do this after clearing force_start because
14719 if there's an error, it is better to forget about force_start
14720 than to get into an infinite loop calling the hook functions
14721 and having them get more errors. */
14722 if (!update_mode_line
14723 || ! NILP (Vwindow_scroll_functions
))
14725 update_mode_line
= 1;
14726 w
->update_mode_line
= Qt
;
14727 startp
= run_window_scroll_functions (window
, startp
);
14730 w
->last_modified
= make_number (0);
14731 w
->last_overlay_modified
= make_number (0);
14732 if (CHARPOS (startp
) < BEGV
)
14733 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14734 else if (CHARPOS (startp
) > ZV
)
14735 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14737 /* Redisplay, then check if cursor has been set during the
14738 redisplay. Give up if new fonts were loaded. */
14739 /* We used to issue a CHECK_MARGINS argument to try_window here,
14740 but this causes scrolling to fail when point begins inside
14741 the scroll margin (bug#148) -- cyd */
14742 if (!try_window (window
, startp
, 0))
14744 w
->force_start
= Qt
;
14745 clear_glyph_matrix (w
->desired_matrix
);
14746 goto need_larger_matrices
;
14749 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14751 /* If point does not appear, try to move point so it does
14752 appear. The desired matrix has been built above, so we
14753 can use it here. */
14754 new_vpos
= window_box_height (w
) / 2;
14757 if (!cursor_row_fully_visible_p (w
, 0, 0))
14759 /* Point does appear, but on a line partly visible at end of window.
14760 Move it back to a fully-visible line. */
14761 new_vpos
= window_box_height (w
);
14764 /* If we need to move point for either of the above reasons,
14765 now actually do it. */
14768 struct glyph_row
*row
;
14770 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14771 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14774 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14775 MATRIX_ROW_START_BYTEPOS (row
));
14777 if (w
!= XWINDOW (selected_window
))
14778 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14779 else if (current_buffer
== old
)
14780 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14782 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14784 /* If we are highlighting the region, then we just changed
14785 the region, so redisplay to show it. */
14786 if (!NILP (Vtransient_mark_mode
)
14787 && !NILP (BVAR (current_buffer
, mark_active
)))
14789 clear_glyph_matrix (w
->desired_matrix
);
14790 if (!try_window (window
, startp
, 0))
14791 goto need_larger_matrices
;
14796 debug_method_add (w
, "forced window start");
14801 /* Handle case where text has not changed, only point, and it has
14802 not moved off the frame, and we are not retrying after hscroll.
14803 (current_matrix_up_to_date_p is nonzero when retrying.) */
14804 if (current_matrix_up_to_date_p
14805 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14806 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14810 case CURSOR_MOVEMENT_SUCCESS
:
14811 used_current_matrix_p
= 1;
14814 case CURSOR_MOVEMENT_MUST_SCROLL
:
14815 goto try_to_scroll
;
14821 /* If current starting point was originally the beginning of a line
14822 but no longer is, find a new starting point. */
14823 else if (!NILP (w
->start_at_line_beg
)
14824 && !(CHARPOS (startp
) <= BEGV
14825 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14828 debug_method_add (w
, "recenter 1");
14833 /* Try scrolling with try_window_id. Value is > 0 if update has
14834 been done, it is -1 if we know that the same window start will
14835 not work. It is 0 if unsuccessful for some other reason. */
14836 else if ((tem
= try_window_id (w
)) != 0)
14839 debug_method_add (w
, "try_window_id %d", tem
);
14842 if (fonts_changed_p
)
14843 goto need_larger_matrices
;
14847 /* Otherwise try_window_id has returned -1 which means that we
14848 don't want the alternative below this comment to execute. */
14850 else if (CHARPOS (startp
) >= BEGV
14851 && CHARPOS (startp
) <= ZV
14852 && PT
>= CHARPOS (startp
)
14853 && (CHARPOS (startp
) < ZV
14854 /* Avoid starting at end of buffer. */
14855 || CHARPOS (startp
) == BEGV
14856 || (XFASTINT (w
->last_modified
) >= MODIFF
14857 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14860 /* If first window line is a continuation line, and window start
14861 is inside the modified region, but the first change is before
14862 current window start, we must select a new window start.
14864 However, if this is the result of a down-mouse event (e.g. by
14865 extending the mouse-drag-overlay), we don't want to select a
14866 new window start, since that would change the position under
14867 the mouse, resulting in an unwanted mouse-movement rather
14868 than a simple mouse-click. */
14869 if (NILP (w
->start_at_line_beg
)
14870 && NILP (do_mouse_tracking
)
14871 && CHARPOS (startp
) > BEGV
14872 && CHARPOS (startp
) > BEG
+ beg_unchanged
14873 && CHARPOS (startp
) <= Z
- end_unchanged
14874 /* Even if w->start_at_line_beg is nil, a new window may
14875 start at a line_beg, since that's how set_buffer_window
14876 sets it. So, we need to check the return value of
14877 compute_window_start_on_continuation_line. (See also
14879 && XMARKER (w
->start
)->buffer
== current_buffer
14880 && compute_window_start_on_continuation_line (w
))
14882 w
->force_start
= Qt
;
14883 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14888 debug_method_add (w
, "same window start");
14891 /* Try to redisplay starting at same place as before.
14892 If point has not moved off frame, accept the results. */
14893 if (!current_matrix_up_to_date_p
14894 /* Don't use try_window_reusing_current_matrix in this case
14895 because a window scroll function can have changed the
14897 || !NILP (Vwindow_scroll_functions
)
14898 || MINI_WINDOW_P (w
)
14899 || !(used_current_matrix_p
14900 = try_window_reusing_current_matrix (w
)))
14902 IF_DEBUG (debug_method_add (w
, "1"));
14903 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14904 /* -1 means we need to scroll.
14905 0 means we need new matrices, but fonts_changed_p
14906 is set in that case, so we will detect it below. */
14907 goto try_to_scroll
;
14910 if (fonts_changed_p
)
14911 goto need_larger_matrices
;
14913 if (w
->cursor
.vpos
>= 0)
14915 if (!just_this_one_p
14916 || current_buffer
->clip_changed
14917 || BEG_UNCHANGED
< CHARPOS (startp
))
14918 /* Forget any recorded base line for line number display. */
14919 w
->base_line_number
= Qnil
;
14921 if (!cursor_row_fully_visible_p (w
, 1, 0))
14923 clear_glyph_matrix (w
->desired_matrix
);
14924 last_line_misfit
= 1;
14926 /* Drop through and scroll. */
14931 clear_glyph_matrix (w
->desired_matrix
);
14936 w
->last_modified
= make_number (0);
14937 w
->last_overlay_modified
= make_number (0);
14939 /* Redisplay the mode line. Select the buffer properly for that. */
14940 if (!update_mode_line
)
14942 update_mode_line
= 1;
14943 w
->update_mode_line
= Qt
;
14946 /* Try to scroll by specified few lines. */
14947 if ((scroll_conservatively
14948 || emacs_scroll_step
14949 || temp_scroll_step
14950 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14951 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14952 && CHARPOS (startp
) >= BEGV
14953 && CHARPOS (startp
) <= ZV
)
14955 /* The function returns -1 if new fonts were loaded, 1 if
14956 successful, 0 if not successful. */
14957 int ss
= try_scrolling (window
, just_this_one_p
,
14958 scroll_conservatively
,
14960 temp_scroll_step
, last_line_misfit
);
14963 case SCROLLING_SUCCESS
:
14966 case SCROLLING_NEED_LARGER_MATRICES
:
14967 goto need_larger_matrices
;
14969 case SCROLLING_FAILED
:
14977 /* Finally, just choose a place to start which positions point
14978 according to user preferences. */
14983 debug_method_add (w
, "recenter");
14986 /* w->vscroll = 0; */
14988 /* Forget any previously recorded base line for line number display. */
14989 if (!buffer_unchanged_p
)
14990 w
->base_line_number
= Qnil
;
14992 /* Determine the window start relative to point. */
14993 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14994 it
.current_y
= it
.last_visible_y
;
14995 if (centering_position
< 0)
14999 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15001 EMACS_INT margin_pos
= CHARPOS (startp
);
15003 Lisp_Object aggressive
;
15005 /* If there is a scroll margin at the top of the window, find
15006 its character position. */
15008 /* Cannot call start_display if startp is not in the
15009 accessible region of the buffer. This can happen when we
15010 have just switched to a different buffer and/or changed
15011 its restriction. In that case, startp is initialized to
15012 the character position 1 (BEG) because we did not yet
15013 have chance to display the buffer even once. */
15014 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15017 void *it1data
= NULL
;
15019 SAVE_IT (it1
, it
, it1data
);
15020 start_display (&it1
, w
, startp
);
15021 move_it_vertically (&it1
, margin
);
15022 margin_pos
= IT_CHARPOS (it1
);
15023 RESTORE_IT (&it
, &it
, it1data
);
15025 scrolling_up
= PT
> margin_pos
;
15028 ? BVAR (current_buffer
, scroll_up_aggressively
)
15029 : BVAR (current_buffer
, scroll_down_aggressively
);
15031 if (!MINI_WINDOW_P (w
)
15032 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15036 /* Setting scroll-conservatively overrides
15037 scroll-*-aggressively. */
15038 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15040 double float_amount
= XFLOATINT (aggressive
);
15042 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15043 if (pt_offset
== 0 && float_amount
> 0)
15048 /* Compute how much to move the window start backward from
15049 point so that point will be displayed where the user
15053 centering_position
= it
.last_visible_y
;
15055 centering_position
-= pt_offset
;
15056 centering_position
-=
15057 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15058 /* Don't let point enter the scroll margin near top of
15060 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15061 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15064 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15067 /* Set the window start half the height of the window backward
15069 centering_position
= window_box_height (w
) / 2;
15071 move_it_vertically_backward (&it
, centering_position
);
15073 xassert (IT_CHARPOS (it
) >= BEGV
);
15075 /* The function move_it_vertically_backward may move over more
15076 than the specified y-distance. If it->w is small, e.g. a
15077 mini-buffer window, we may end up in front of the window's
15078 display area. Start displaying at the start of the line
15079 containing PT in this case. */
15080 if (it
.current_y
<= 0)
15082 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15083 move_it_vertically_backward (&it
, 0);
15087 it
.current_x
= it
.hpos
= 0;
15089 /* Set the window start position here explicitly, to avoid an
15090 infinite loop in case the functions in window-scroll-functions
15092 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15094 /* Run scroll hooks. */
15095 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15097 /* Redisplay the window. */
15098 if (!current_matrix_up_to_date_p
15099 || windows_or_buffers_changed
15100 || cursor_type_changed
15101 /* Don't use try_window_reusing_current_matrix in this case
15102 because it can have changed the buffer. */
15103 || !NILP (Vwindow_scroll_functions
)
15104 || !just_this_one_p
15105 || MINI_WINDOW_P (w
)
15106 || !(used_current_matrix_p
15107 = try_window_reusing_current_matrix (w
)))
15108 try_window (window
, startp
, 0);
15110 /* If new fonts have been loaded (due to fontsets), give up. We
15111 have to start a new redisplay since we need to re-adjust glyph
15113 if (fonts_changed_p
)
15114 goto need_larger_matrices
;
15116 /* If cursor did not appear assume that the middle of the window is
15117 in the first line of the window. Do it again with the next line.
15118 (Imagine a window of height 100, displaying two lines of height
15119 60. Moving back 50 from it->last_visible_y will end in the first
15121 if (w
->cursor
.vpos
< 0)
15123 if (!NILP (w
->window_end_valid
)
15124 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15126 clear_glyph_matrix (w
->desired_matrix
);
15127 move_it_by_lines (&it
, 1);
15128 try_window (window
, it
.current
.pos
, 0);
15130 else if (PT
< IT_CHARPOS (it
))
15132 clear_glyph_matrix (w
->desired_matrix
);
15133 move_it_by_lines (&it
, -1);
15134 try_window (window
, it
.current
.pos
, 0);
15138 /* Not much we can do about it. */
15142 /* Consider the following case: Window starts at BEGV, there is
15143 invisible, intangible text at BEGV, so that display starts at
15144 some point START > BEGV. It can happen that we are called with
15145 PT somewhere between BEGV and START. Try to handle that case. */
15146 if (w
->cursor
.vpos
< 0)
15148 struct glyph_row
*row
= w
->current_matrix
->rows
;
15149 if (row
->mode_line_p
)
15151 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15154 if (!cursor_row_fully_visible_p (w
, 0, 0))
15156 /* If vscroll is enabled, disable it and try again. */
15160 clear_glyph_matrix (w
->desired_matrix
);
15164 /* If centering point failed to make the whole line visible,
15165 put point at the top instead. That has to make the whole line
15166 visible, if it can be done. */
15167 if (centering_position
== 0)
15170 clear_glyph_matrix (w
->desired_matrix
);
15171 centering_position
= 0;
15177 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15178 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15179 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15182 /* Display the mode line, if we must. */
15183 if ((update_mode_line
15184 /* If window not full width, must redo its mode line
15185 if (a) the window to its side is being redone and
15186 (b) we do a frame-based redisplay. This is a consequence
15187 of how inverted lines are drawn in frame-based redisplay. */
15188 || (!just_this_one_p
15189 && !FRAME_WINDOW_P (f
)
15190 && !WINDOW_FULL_WIDTH_P (w
))
15191 /* Line number to display. */
15192 || INTEGERP (w
->base_line_pos
)
15193 /* Column number is displayed and different from the one displayed. */
15194 || (!NILP (w
->column_number_displayed
)
15195 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15196 /* This means that the window has a mode line. */
15197 && (WINDOW_WANTS_MODELINE_P (w
)
15198 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15200 display_mode_lines (w
);
15202 /* If mode line height has changed, arrange for a thorough
15203 immediate redisplay using the correct mode line height. */
15204 if (WINDOW_WANTS_MODELINE_P (w
)
15205 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15207 fonts_changed_p
= 1;
15208 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15209 = DESIRED_MODE_LINE_HEIGHT (w
);
15212 /* If header line height has changed, arrange for a thorough
15213 immediate redisplay using the correct header line height. */
15214 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15215 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15217 fonts_changed_p
= 1;
15218 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15219 = DESIRED_HEADER_LINE_HEIGHT (w
);
15222 if (fonts_changed_p
)
15223 goto need_larger_matrices
;
15226 if (!line_number_displayed
15227 && !BUFFERP (w
->base_line_pos
))
15229 w
->base_line_pos
= Qnil
;
15230 w
->base_line_number
= Qnil
;
15235 /* When we reach a frame's selected window, redo the frame's menu bar. */
15236 if (update_mode_line
15237 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15239 int redisplay_menu_p
= 0;
15241 if (FRAME_WINDOW_P (f
))
15243 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15244 || defined (HAVE_NS) || defined (USE_GTK)
15245 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15247 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15251 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15253 if (redisplay_menu_p
)
15254 display_menu_bar (w
);
15256 #ifdef HAVE_WINDOW_SYSTEM
15257 if (FRAME_WINDOW_P (f
))
15259 #if defined (USE_GTK) || defined (HAVE_NS)
15260 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15261 redisplay_tool_bar (f
);
15263 if (WINDOWP (f
->tool_bar_window
)
15264 && (FRAME_TOOL_BAR_LINES (f
) > 0
15265 || !NILP (Vauto_resize_tool_bars
))
15266 && redisplay_tool_bar (f
))
15267 ignore_mouse_drag_p
= 1;
15273 #ifdef HAVE_WINDOW_SYSTEM
15274 if (FRAME_WINDOW_P (f
)
15275 && update_window_fringes (w
, (just_this_one_p
15276 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15277 || w
->pseudo_window_p
)))
15281 if (draw_window_fringes (w
, 1))
15282 x_draw_vertical_border (w
);
15286 #endif /* HAVE_WINDOW_SYSTEM */
15288 /* We go to this label, with fonts_changed_p nonzero,
15289 if it is necessary to try again using larger glyph matrices.
15290 We have to redeem the scroll bar even in this case,
15291 because the loop in redisplay_internal expects that. */
15292 need_larger_matrices
:
15294 finish_scroll_bars
:
15296 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15298 /* Set the thumb's position and size. */
15299 set_vertical_scroll_bar (w
);
15301 /* Note that we actually used the scroll bar attached to this
15302 window, so it shouldn't be deleted at the end of redisplay. */
15303 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15304 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15307 /* Restore current_buffer and value of point in it. The window
15308 update may have changed the buffer, so first make sure `opoint'
15309 is still valid (Bug#6177). */
15310 if (CHARPOS (opoint
) < BEGV
)
15311 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15312 else if (CHARPOS (opoint
) > ZV
)
15313 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15315 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15317 set_buffer_internal_1 (old
);
15318 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15319 shorter. This can be caused by log truncation in *Messages*. */
15320 if (CHARPOS (lpoint
) <= ZV
)
15321 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15323 unbind_to (count
, Qnil
);
15327 /* Build the complete desired matrix of WINDOW with a window start
15328 buffer position POS.
15330 Value is 1 if successful. It is zero if fonts were loaded during
15331 redisplay which makes re-adjusting glyph matrices necessary, and -1
15332 if point would appear in the scroll margins.
15333 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15334 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15338 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15340 struct window
*w
= XWINDOW (window
);
15342 struct glyph_row
*last_text_row
= NULL
;
15343 struct frame
*f
= XFRAME (w
->frame
);
15345 /* Make POS the new window start. */
15346 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15348 /* Mark cursor position as unknown. No overlay arrow seen. */
15349 w
->cursor
.vpos
= -1;
15350 overlay_arrow_seen
= 0;
15352 /* Initialize iterator and info to start at POS. */
15353 start_display (&it
, w
, pos
);
15355 /* Display all lines of W. */
15356 while (it
.current_y
< it
.last_visible_y
)
15358 if (display_line (&it
))
15359 last_text_row
= it
.glyph_row
- 1;
15360 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15364 /* Don't let the cursor end in the scroll margins. */
15365 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15366 && !MINI_WINDOW_P (w
))
15368 int this_scroll_margin
;
15370 if (scroll_margin
> 0)
15372 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15373 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15376 this_scroll_margin
= 0;
15378 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15379 && w
->cursor
.y
< this_scroll_margin
15380 && CHARPOS (pos
) > BEGV
15381 && IT_CHARPOS (it
) < ZV
)
15382 /* rms: considering make_cursor_line_fully_visible_p here
15383 seems to give wrong results. We don't want to recenter
15384 when the last line is partly visible, we want to allow
15385 that case to be handled in the usual way. */
15386 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15388 w
->cursor
.vpos
= -1;
15389 clear_glyph_matrix (w
->desired_matrix
);
15394 /* If bottom moved off end of frame, change mode line percentage. */
15395 if (XFASTINT (w
->window_end_pos
) <= 0
15396 && Z
!= IT_CHARPOS (it
))
15397 w
->update_mode_line
= Qt
;
15399 /* Set window_end_pos to the offset of the last character displayed
15400 on the window from the end of current_buffer. Set
15401 window_end_vpos to its row number. */
15404 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15405 w
->window_end_bytepos
15406 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15408 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15410 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15411 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15412 ->displays_text_p
);
15416 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15417 w
->window_end_pos
= make_number (Z
- ZV
);
15418 w
->window_end_vpos
= make_number (0);
15421 /* But that is not valid info until redisplay finishes. */
15422 w
->window_end_valid
= Qnil
;
15428 /************************************************************************
15429 Window redisplay reusing current matrix when buffer has not changed
15430 ************************************************************************/
15432 /* Try redisplay of window W showing an unchanged buffer with a
15433 different window start than the last time it was displayed by
15434 reusing its current matrix. Value is non-zero if successful.
15435 W->start is the new window start. */
15438 try_window_reusing_current_matrix (struct window
*w
)
15440 struct frame
*f
= XFRAME (w
->frame
);
15441 struct glyph_row
*bottom_row
;
15444 struct text_pos start
, new_start
;
15445 int nrows_scrolled
, i
;
15446 struct glyph_row
*last_text_row
;
15447 struct glyph_row
*last_reused_text_row
;
15448 struct glyph_row
*start_row
;
15449 int start_vpos
, min_y
, max_y
;
15452 if (inhibit_try_window_reusing
)
15456 if (/* This function doesn't handle terminal frames. */
15457 !FRAME_WINDOW_P (f
)
15458 /* Don't try to reuse the display if windows have been split
15460 || windows_or_buffers_changed
15461 || cursor_type_changed
)
15464 /* Can't do this if region may have changed. */
15465 if ((!NILP (Vtransient_mark_mode
)
15466 && !NILP (BVAR (current_buffer
, mark_active
)))
15467 || !NILP (w
->region_showing
)
15468 || !NILP (Vshow_trailing_whitespace
))
15471 /* If top-line visibility has changed, give up. */
15472 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15473 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15476 /* Give up if old or new display is scrolled vertically. We could
15477 make this function handle this, but right now it doesn't. */
15478 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15479 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15482 /* The variable new_start now holds the new window start. The old
15483 start `start' can be determined from the current matrix. */
15484 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15485 start
= start_row
->minpos
;
15486 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15488 /* Clear the desired matrix for the display below. */
15489 clear_glyph_matrix (w
->desired_matrix
);
15491 if (CHARPOS (new_start
) <= CHARPOS (start
))
15493 /* Don't use this method if the display starts with an ellipsis
15494 displayed for invisible text. It's not easy to handle that case
15495 below, and it's certainly not worth the effort since this is
15496 not a frequent case. */
15497 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15500 IF_DEBUG (debug_method_add (w
, "twu1"));
15502 /* Display up to a row that can be reused. The variable
15503 last_text_row is set to the last row displayed that displays
15504 text. Note that it.vpos == 0 if or if not there is a
15505 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15506 start_display (&it
, w
, new_start
);
15507 w
->cursor
.vpos
= -1;
15508 last_text_row
= last_reused_text_row
= NULL
;
15510 while (it
.current_y
< it
.last_visible_y
15511 && !fonts_changed_p
)
15513 /* If we have reached into the characters in the START row,
15514 that means the line boundaries have changed. So we
15515 can't start copying with the row START. Maybe it will
15516 work to start copying with the following row. */
15517 while (IT_CHARPOS (it
) > CHARPOS (start
))
15519 /* Advance to the next row as the "start". */
15521 start
= start_row
->minpos
;
15522 /* If there are no more rows to try, or just one, give up. */
15523 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15524 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15525 || CHARPOS (start
) == ZV
)
15527 clear_glyph_matrix (w
->desired_matrix
);
15531 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15533 /* If we have reached alignment,
15534 we can copy the rest of the rows. */
15535 if (IT_CHARPOS (it
) == CHARPOS (start
))
15538 if (display_line (&it
))
15539 last_text_row
= it
.glyph_row
- 1;
15542 /* A value of current_y < last_visible_y means that we stopped
15543 at the previous window start, which in turn means that we
15544 have at least one reusable row. */
15545 if (it
.current_y
< it
.last_visible_y
)
15547 struct glyph_row
*row
;
15549 /* IT.vpos always starts from 0; it counts text lines. */
15550 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15552 /* Find PT if not already found in the lines displayed. */
15553 if (w
->cursor
.vpos
< 0)
15555 int dy
= it
.current_y
- start_row
->y
;
15557 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15558 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15560 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15561 dy
, nrows_scrolled
);
15564 clear_glyph_matrix (w
->desired_matrix
);
15569 /* Scroll the display. Do it before the current matrix is
15570 changed. The problem here is that update has not yet
15571 run, i.e. part of the current matrix is not up to date.
15572 scroll_run_hook will clear the cursor, and use the
15573 current matrix to get the height of the row the cursor is
15575 run
.current_y
= start_row
->y
;
15576 run
.desired_y
= it
.current_y
;
15577 run
.height
= it
.last_visible_y
- it
.current_y
;
15579 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15582 FRAME_RIF (f
)->update_window_begin_hook (w
);
15583 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15584 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15585 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15589 /* Shift current matrix down by nrows_scrolled lines. */
15590 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15591 rotate_matrix (w
->current_matrix
,
15593 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15596 /* Disable lines that must be updated. */
15597 for (i
= 0; i
< nrows_scrolled
; ++i
)
15598 (start_row
+ i
)->enabled_p
= 0;
15600 /* Re-compute Y positions. */
15601 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15602 max_y
= it
.last_visible_y
;
15603 for (row
= start_row
+ nrows_scrolled
;
15607 row
->y
= it
.current_y
;
15608 row
->visible_height
= row
->height
;
15610 if (row
->y
< min_y
)
15611 row
->visible_height
-= min_y
- row
->y
;
15612 if (row
->y
+ row
->height
> max_y
)
15613 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15614 if (row
->fringe_bitmap_periodic_p
)
15615 row
->redraw_fringe_bitmaps_p
= 1;
15617 it
.current_y
+= row
->height
;
15619 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15620 last_reused_text_row
= row
;
15621 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15625 /* Disable lines in the current matrix which are now
15626 below the window. */
15627 for (++row
; row
< bottom_row
; ++row
)
15628 row
->enabled_p
= row
->mode_line_p
= 0;
15631 /* Update window_end_pos etc.; last_reused_text_row is the last
15632 reused row from the current matrix containing text, if any.
15633 The value of last_text_row is the last displayed line
15634 containing text. */
15635 if (last_reused_text_row
)
15637 w
->window_end_bytepos
15638 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15640 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15642 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15643 w
->current_matrix
));
15645 else if (last_text_row
)
15647 w
->window_end_bytepos
15648 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15650 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15652 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15656 /* This window must be completely empty. */
15657 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15658 w
->window_end_pos
= make_number (Z
- ZV
);
15659 w
->window_end_vpos
= make_number (0);
15661 w
->window_end_valid
= Qnil
;
15663 /* Update hint: don't try scrolling again in update_window. */
15664 w
->desired_matrix
->no_scrolling_p
= 1;
15667 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15671 else if (CHARPOS (new_start
) > CHARPOS (start
))
15673 struct glyph_row
*pt_row
, *row
;
15674 struct glyph_row
*first_reusable_row
;
15675 struct glyph_row
*first_row_to_display
;
15677 int yb
= window_text_bottom_y (w
);
15679 /* Find the row starting at new_start, if there is one. Don't
15680 reuse a partially visible line at the end. */
15681 first_reusable_row
= start_row
;
15682 while (first_reusable_row
->enabled_p
15683 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15684 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15685 < CHARPOS (new_start
)))
15686 ++first_reusable_row
;
15688 /* Give up if there is no row to reuse. */
15689 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15690 || !first_reusable_row
->enabled_p
15691 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15692 != CHARPOS (new_start
)))
15695 /* We can reuse fully visible rows beginning with
15696 first_reusable_row to the end of the window. Set
15697 first_row_to_display to the first row that cannot be reused.
15698 Set pt_row to the row containing point, if there is any. */
15700 for (first_row_to_display
= first_reusable_row
;
15701 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15702 ++first_row_to_display
)
15704 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15705 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15706 pt_row
= first_row_to_display
;
15709 /* Start displaying at the start of first_row_to_display. */
15710 xassert (first_row_to_display
->y
< yb
);
15711 init_to_row_start (&it
, w
, first_row_to_display
);
15713 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15715 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15717 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15718 + WINDOW_HEADER_LINE_HEIGHT (w
));
15720 /* Display lines beginning with first_row_to_display in the
15721 desired matrix. Set last_text_row to the last row displayed
15722 that displays text. */
15723 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15724 if (pt_row
== NULL
)
15725 w
->cursor
.vpos
= -1;
15726 last_text_row
= NULL
;
15727 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15728 if (display_line (&it
))
15729 last_text_row
= it
.glyph_row
- 1;
15731 /* If point is in a reused row, adjust y and vpos of the cursor
15735 w
->cursor
.vpos
-= nrows_scrolled
;
15736 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15739 /* Give up if point isn't in a row displayed or reused. (This
15740 also handles the case where w->cursor.vpos < nrows_scrolled
15741 after the calls to display_line, which can happen with scroll
15742 margins. See bug#1295.) */
15743 if (w
->cursor
.vpos
< 0)
15745 clear_glyph_matrix (w
->desired_matrix
);
15749 /* Scroll the display. */
15750 run
.current_y
= first_reusable_row
->y
;
15751 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15752 run
.height
= it
.last_visible_y
- run
.current_y
;
15753 dy
= run
.current_y
- run
.desired_y
;
15758 FRAME_RIF (f
)->update_window_begin_hook (w
);
15759 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15760 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15761 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15765 /* Adjust Y positions of reused rows. */
15766 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15767 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15768 max_y
= it
.last_visible_y
;
15769 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15772 row
->visible_height
= row
->height
;
15773 if (row
->y
< min_y
)
15774 row
->visible_height
-= min_y
- row
->y
;
15775 if (row
->y
+ row
->height
> max_y
)
15776 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15777 if (row
->fringe_bitmap_periodic_p
)
15778 row
->redraw_fringe_bitmaps_p
= 1;
15781 /* Scroll the current matrix. */
15782 xassert (nrows_scrolled
> 0);
15783 rotate_matrix (w
->current_matrix
,
15785 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15788 /* Disable rows not reused. */
15789 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15790 row
->enabled_p
= 0;
15792 /* Point may have moved to a different line, so we cannot assume that
15793 the previous cursor position is valid; locate the correct row. */
15796 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15797 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15801 w
->cursor
.y
= row
->y
;
15803 if (row
< bottom_row
)
15805 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15806 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15808 /* Can't use this optimization with bidi-reordered glyph
15809 rows, unless cursor is already at point. */
15810 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15812 if (!(w
->cursor
.hpos
>= 0
15813 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15814 && BUFFERP (glyph
->object
)
15815 && glyph
->charpos
== PT
))
15820 && (!BUFFERP (glyph
->object
)
15821 || glyph
->charpos
< PT
);
15825 w
->cursor
.x
+= glyph
->pixel_width
;
15830 /* Adjust window end. A null value of last_text_row means that
15831 the window end is in reused rows which in turn means that
15832 only its vpos can have changed. */
15835 w
->window_end_bytepos
15836 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15838 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15840 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15845 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15848 w
->window_end_valid
= Qnil
;
15849 w
->desired_matrix
->no_scrolling_p
= 1;
15852 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15862 /************************************************************************
15863 Window redisplay reusing current matrix when buffer has changed
15864 ************************************************************************/
15866 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15867 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15868 EMACS_INT
*, EMACS_INT
*);
15869 static struct glyph_row
*
15870 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15871 struct glyph_row
*);
15874 /* Return the last row in MATRIX displaying text. If row START is
15875 non-null, start searching with that row. IT gives the dimensions
15876 of the display. Value is null if matrix is empty; otherwise it is
15877 a pointer to the row found. */
15879 static struct glyph_row
*
15880 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15881 struct glyph_row
*start
)
15883 struct glyph_row
*row
, *row_found
;
15885 /* Set row_found to the last row in IT->w's current matrix
15886 displaying text. The loop looks funny but think of partially
15889 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15890 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15892 xassert (row
->enabled_p
);
15894 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15903 /* Return the last row in the current matrix of W that is not affected
15904 by changes at the start of current_buffer that occurred since W's
15905 current matrix was built. Value is null if no such row exists.
15907 BEG_UNCHANGED us the number of characters unchanged at the start of
15908 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15909 first changed character in current_buffer. Characters at positions <
15910 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15911 when the current matrix was built. */
15913 static struct glyph_row
*
15914 find_last_unchanged_at_beg_row (struct window
*w
)
15916 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15917 struct glyph_row
*row
;
15918 struct glyph_row
*row_found
= NULL
;
15919 int yb
= window_text_bottom_y (w
);
15921 /* Find the last row displaying unchanged text. */
15922 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15923 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15924 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15927 if (/* If row ends before first_changed_pos, it is unchanged,
15928 except in some case. */
15929 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15930 /* When row ends in ZV and we write at ZV it is not
15932 && !row
->ends_at_zv_p
15933 /* When first_changed_pos is the end of a continued line,
15934 row is not unchanged because it may be no longer
15936 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15937 && (row
->continued_p
15938 || row
->exact_window_width_line_p
)))
15941 /* Stop if last visible row. */
15942 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15950 /* Find the first glyph row in the current matrix of W that is not
15951 affected by changes at the end of current_buffer since the
15952 time W's current matrix was built.
15954 Return in *DELTA the number of chars by which buffer positions in
15955 unchanged text at the end of current_buffer must be adjusted.
15957 Return in *DELTA_BYTES the corresponding number of bytes.
15959 Value is null if no such row exists, i.e. all rows are affected by
15962 static struct glyph_row
*
15963 find_first_unchanged_at_end_row (struct window
*w
,
15964 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15966 struct glyph_row
*row
;
15967 struct glyph_row
*row_found
= NULL
;
15969 *delta
= *delta_bytes
= 0;
15971 /* Display must not have been paused, otherwise the current matrix
15972 is not up to date. */
15973 eassert (!NILP (w
->window_end_valid
));
15975 /* A value of window_end_pos >= END_UNCHANGED means that the window
15976 end is in the range of changed text. If so, there is no
15977 unchanged row at the end of W's current matrix. */
15978 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15981 /* Set row to the last row in W's current matrix displaying text. */
15982 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15984 /* If matrix is entirely empty, no unchanged row exists. */
15985 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15987 /* The value of row is the last glyph row in the matrix having a
15988 meaningful buffer position in it. The end position of row
15989 corresponds to window_end_pos. This allows us to translate
15990 buffer positions in the current matrix to current buffer
15991 positions for characters not in changed text. */
15993 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15994 EMACS_INT Z_BYTE_old
=
15995 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15996 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15997 struct glyph_row
*first_text_row
15998 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16000 *delta
= Z
- Z_old
;
16001 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16003 /* Set last_unchanged_pos to the buffer position of the last
16004 character in the buffer that has not been changed. Z is the
16005 index + 1 of the last character in current_buffer, i.e. by
16006 subtracting END_UNCHANGED we get the index of the last
16007 unchanged character, and we have to add BEG to get its buffer
16009 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16010 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16012 /* Search backward from ROW for a row displaying a line that
16013 starts at a minimum position >= last_unchanged_pos_old. */
16014 for (; row
> first_text_row
; --row
)
16016 /* This used to abort, but it can happen.
16017 It is ok to just stop the search instead here. KFS. */
16018 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16021 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16026 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16032 /* Make sure that glyph rows in the current matrix of window W
16033 reference the same glyph memory as corresponding rows in the
16034 frame's frame matrix. This function is called after scrolling W's
16035 current matrix on a terminal frame in try_window_id and
16036 try_window_reusing_current_matrix. */
16039 sync_frame_with_window_matrix_rows (struct window
*w
)
16041 struct frame
*f
= XFRAME (w
->frame
);
16042 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16044 /* Preconditions: W must be a leaf window and full-width. Its frame
16045 must have a frame matrix. */
16046 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16047 xassert (WINDOW_FULL_WIDTH_P (w
));
16048 xassert (!FRAME_WINDOW_P (f
));
16050 /* If W is a full-width window, glyph pointers in W's current matrix
16051 have, by definition, to be the same as glyph pointers in the
16052 corresponding frame matrix. Note that frame matrices have no
16053 marginal areas (see build_frame_matrix). */
16054 window_row
= w
->current_matrix
->rows
;
16055 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16056 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16057 while (window_row
< window_row_end
)
16059 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16060 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16062 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16063 frame_row
->glyphs
[TEXT_AREA
] = start
;
16064 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16065 frame_row
->glyphs
[LAST_AREA
] = end
;
16067 /* Disable frame rows whose corresponding window rows have
16068 been disabled in try_window_id. */
16069 if (!window_row
->enabled_p
)
16070 frame_row
->enabled_p
= 0;
16072 ++window_row
, ++frame_row
;
16077 /* Find the glyph row in window W containing CHARPOS. Consider all
16078 rows between START and END (not inclusive). END null means search
16079 all rows to the end of the display area of W. Value is the row
16080 containing CHARPOS or null. */
16083 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16084 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16086 struct glyph_row
*row
= start
;
16087 struct glyph_row
*best_row
= NULL
;
16088 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16091 /* If we happen to start on a header-line, skip that. */
16092 if (row
->mode_line_p
)
16095 if ((end
&& row
>= end
) || !row
->enabled_p
)
16098 last_y
= window_text_bottom_y (w
) - dy
;
16102 /* Give up if we have gone too far. */
16103 if (end
&& row
>= end
)
16105 /* This formerly returned if they were equal.
16106 I think that both quantities are of a "last plus one" type;
16107 if so, when they are equal, the row is within the screen. -- rms. */
16108 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16111 /* If it is in this row, return this row. */
16112 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16113 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16114 /* The end position of a row equals the start
16115 position of the next row. If CHARPOS is there, we
16116 would rather display it in the next line, except
16117 when this line ends in ZV. */
16118 && !row
->ends_at_zv_p
16119 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16120 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16124 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16125 || (!best_row
&& !row
->continued_p
))
16127 /* In bidi-reordered rows, there could be several rows
16128 occluding point, all of them belonging to the same
16129 continued line. We need to find the row which fits
16130 CHARPOS the best. */
16131 for (g
= row
->glyphs
[TEXT_AREA
];
16132 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16135 if (!STRINGP (g
->object
))
16137 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16139 mindif
= eabs (g
->charpos
- charpos
);
16141 /* Exact match always wins. */
16148 else if (best_row
&& !row
->continued_p
)
16155 /* Try to redisplay window W by reusing its existing display. W's
16156 current matrix must be up to date when this function is called,
16157 i.e. window_end_valid must not be nil.
16161 1 if display has been updated
16162 0 if otherwise unsuccessful
16163 -1 if redisplay with same window start is known not to succeed
16165 The following steps are performed:
16167 1. Find the last row in the current matrix of W that is not
16168 affected by changes at the start of current_buffer. If no such row
16171 2. Find the first row in W's current matrix that is not affected by
16172 changes at the end of current_buffer. Maybe there is no such row.
16174 3. Display lines beginning with the row + 1 found in step 1 to the
16175 row found in step 2 or, if step 2 didn't find a row, to the end of
16178 4. If cursor is not known to appear on the window, give up.
16180 5. If display stopped at the row found in step 2, scroll the
16181 display and current matrix as needed.
16183 6. Maybe display some lines at the end of W, if we must. This can
16184 happen under various circumstances, like a partially visible line
16185 becoming fully visible, or because newly displayed lines are displayed
16186 in smaller font sizes.
16188 7. Update W's window end information. */
16191 try_window_id (struct window
*w
)
16193 struct frame
*f
= XFRAME (w
->frame
);
16194 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16195 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16196 struct glyph_row
*last_unchanged_at_beg_row
;
16197 struct glyph_row
*first_unchanged_at_end_row
;
16198 struct glyph_row
*row
;
16199 struct glyph_row
*bottom_row
;
16202 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16204 struct text_pos start_pos
;
16206 int first_unchanged_at_end_vpos
= 0;
16207 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16208 struct text_pos start
;
16209 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16212 if (inhibit_try_window_id
)
16216 /* This is handy for debugging. */
16218 #define GIVE_UP(X) \
16220 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16224 #define GIVE_UP(X) return 0
16227 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16229 /* Don't use this for mini-windows because these can show
16230 messages and mini-buffers, and we don't handle that here. */
16231 if (MINI_WINDOW_P (w
))
16234 /* This flag is used to prevent redisplay optimizations. */
16235 if (windows_or_buffers_changed
|| cursor_type_changed
)
16238 /* Verify that narrowing has not changed.
16239 Also verify that we were not told to prevent redisplay optimizations.
16240 It would be nice to further
16241 reduce the number of cases where this prevents try_window_id. */
16242 if (current_buffer
->clip_changed
16243 || current_buffer
->prevent_redisplay_optimizations_p
)
16246 /* Window must either use window-based redisplay or be full width. */
16247 if (!FRAME_WINDOW_P (f
)
16248 && (!FRAME_LINE_INS_DEL_OK (f
)
16249 || !WINDOW_FULL_WIDTH_P (w
)))
16252 /* Give up if point is known NOT to appear in W. */
16253 if (PT
< CHARPOS (start
))
16256 /* Another way to prevent redisplay optimizations. */
16257 if (XFASTINT (w
->last_modified
) == 0)
16260 /* Verify that window is not hscrolled. */
16261 if (XFASTINT (w
->hscroll
) != 0)
16264 /* Verify that display wasn't paused. */
16265 if (NILP (w
->window_end_valid
))
16268 /* Can't use this if highlighting a region because a cursor movement
16269 will do more than just set the cursor. */
16270 if (!NILP (Vtransient_mark_mode
)
16271 && !NILP (BVAR (current_buffer
, mark_active
)))
16274 /* Likewise if highlighting trailing whitespace. */
16275 if (!NILP (Vshow_trailing_whitespace
))
16278 /* Likewise if showing a region. */
16279 if (!NILP (w
->region_showing
))
16282 /* Can't use this if overlay arrow position and/or string have
16284 if (overlay_arrows_changed_p ())
16287 /* When word-wrap is on, adding a space to the first word of a
16288 wrapped line can change the wrap position, altering the line
16289 above it. It might be worthwhile to handle this more
16290 intelligently, but for now just redisplay from scratch. */
16291 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16294 /* Under bidi reordering, adding or deleting a character in the
16295 beginning of a paragraph, before the first strong directional
16296 character, can change the base direction of the paragraph (unless
16297 the buffer specifies a fixed paragraph direction), which will
16298 require to redisplay the whole paragraph. It might be worthwhile
16299 to find the paragraph limits and widen the range of redisplayed
16300 lines to that, but for now just give up this optimization and
16301 redisplay from scratch. */
16302 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16303 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16306 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16307 only if buffer has really changed. The reason is that the gap is
16308 initially at Z for freshly visited files. The code below would
16309 set end_unchanged to 0 in that case. */
16310 if (MODIFF
> SAVE_MODIFF
16311 /* This seems to happen sometimes after saving a buffer. */
16312 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16314 if (GPT
- BEG
< BEG_UNCHANGED
)
16315 BEG_UNCHANGED
= GPT
- BEG
;
16316 if (Z
- GPT
< END_UNCHANGED
)
16317 END_UNCHANGED
= Z
- GPT
;
16320 /* The position of the first and last character that has been changed. */
16321 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16322 last_changed_charpos
= Z
- END_UNCHANGED
;
16324 /* If window starts after a line end, and the last change is in
16325 front of that newline, then changes don't affect the display.
16326 This case happens with stealth-fontification. Note that although
16327 the display is unchanged, glyph positions in the matrix have to
16328 be adjusted, of course. */
16329 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16330 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16331 && ((last_changed_charpos
< CHARPOS (start
)
16332 && CHARPOS (start
) == BEGV
)
16333 || (last_changed_charpos
< CHARPOS (start
) - 1
16334 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16336 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16337 struct glyph_row
*r0
;
16339 /* Compute how many chars/bytes have been added to or removed
16340 from the buffer. */
16341 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16342 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16343 Z_delta
= Z
- Z_old
;
16344 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16346 /* Give up if PT is not in the window. Note that it already has
16347 been checked at the start of try_window_id that PT is not in
16348 front of the window start. */
16349 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16352 /* If window start is unchanged, we can reuse the whole matrix
16353 as is, after adjusting glyph positions. No need to compute
16354 the window end again, since its offset from Z hasn't changed. */
16355 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16356 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16357 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16358 /* PT must not be in a partially visible line. */
16359 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16360 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16362 /* Adjust positions in the glyph matrix. */
16363 if (Z_delta
|| Z_delta_bytes
)
16365 struct glyph_row
*r1
16366 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16367 increment_matrix_positions (w
->current_matrix
,
16368 MATRIX_ROW_VPOS (r0
, current_matrix
),
16369 MATRIX_ROW_VPOS (r1
, current_matrix
),
16370 Z_delta
, Z_delta_bytes
);
16373 /* Set the cursor. */
16374 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16376 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16383 /* Handle the case that changes are all below what is displayed in
16384 the window, and that PT is in the window. This shortcut cannot
16385 be taken if ZV is visible in the window, and text has been added
16386 there that is visible in the window. */
16387 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16388 /* ZV is not visible in the window, or there are no
16389 changes at ZV, actually. */
16390 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16391 || first_changed_charpos
== last_changed_charpos
))
16393 struct glyph_row
*r0
;
16395 /* Give up if PT is not in the window. Note that it already has
16396 been checked at the start of try_window_id that PT is not in
16397 front of the window start. */
16398 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16401 /* If window start is unchanged, we can reuse the whole matrix
16402 as is, without changing glyph positions since no text has
16403 been added/removed in front of the window end. */
16404 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16405 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16406 /* PT must not be in a partially visible line. */
16407 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16408 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16410 /* We have to compute the window end anew since text
16411 could have been added/removed after it. */
16413 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16414 w
->window_end_bytepos
16415 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16417 /* Set the cursor. */
16418 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16420 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16427 /* Give up if window start is in the changed area.
16429 The condition used to read
16431 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16433 but why that was tested escapes me at the moment. */
16434 if (CHARPOS (start
) >= first_changed_charpos
16435 && CHARPOS (start
) <= last_changed_charpos
)
16438 /* Check that window start agrees with the start of the first glyph
16439 row in its current matrix. Check this after we know the window
16440 start is not in changed text, otherwise positions would not be
16442 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16443 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16446 /* Give up if the window ends in strings. Overlay strings
16447 at the end are difficult to handle, so don't try. */
16448 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16449 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16452 /* Compute the position at which we have to start displaying new
16453 lines. Some of the lines at the top of the window might be
16454 reusable because they are not displaying changed text. Find the
16455 last row in W's current matrix not affected by changes at the
16456 start of current_buffer. Value is null if changes start in the
16457 first line of window. */
16458 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16459 if (last_unchanged_at_beg_row
)
16461 /* Avoid starting to display in the moddle of a character, a TAB
16462 for instance. This is easier than to set up the iterator
16463 exactly, and it's not a frequent case, so the additional
16464 effort wouldn't really pay off. */
16465 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16466 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16467 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16468 --last_unchanged_at_beg_row
;
16470 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16473 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16475 start_pos
= it
.current
.pos
;
16477 /* Start displaying new lines in the desired matrix at the same
16478 vpos we would use in the current matrix, i.e. below
16479 last_unchanged_at_beg_row. */
16480 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16482 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16483 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16485 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16489 /* There are no reusable lines at the start of the window.
16490 Start displaying in the first text line. */
16491 start_display (&it
, w
, start
);
16492 it
.vpos
= it
.first_vpos
;
16493 start_pos
= it
.current
.pos
;
16496 /* Find the first row that is not affected by changes at the end of
16497 the buffer. Value will be null if there is no unchanged row, in
16498 which case we must redisplay to the end of the window. delta
16499 will be set to the value by which buffer positions beginning with
16500 first_unchanged_at_end_row have to be adjusted due to text
16502 first_unchanged_at_end_row
16503 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16504 IF_DEBUG (debug_delta
= delta
);
16505 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16507 /* Set stop_pos to the buffer position up to which we will have to
16508 display new lines. If first_unchanged_at_end_row != NULL, this
16509 is the buffer position of the start of the line displayed in that
16510 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16511 that we don't stop at a buffer position. */
16513 if (first_unchanged_at_end_row
)
16515 xassert (last_unchanged_at_beg_row
== NULL
16516 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16518 /* If this is a continuation line, move forward to the next one
16519 that isn't. Changes in lines above affect this line.
16520 Caution: this may move first_unchanged_at_end_row to a row
16521 not displaying text. */
16522 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16523 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16524 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16525 < it
.last_visible_y
))
16526 ++first_unchanged_at_end_row
;
16528 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16529 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16530 >= it
.last_visible_y
))
16531 first_unchanged_at_end_row
= NULL
;
16534 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16536 first_unchanged_at_end_vpos
16537 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16538 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16541 else if (last_unchanged_at_beg_row
== NULL
)
16547 /* Either there is no unchanged row at the end, or the one we have
16548 now displays text. This is a necessary condition for the window
16549 end pos calculation at the end of this function. */
16550 xassert (first_unchanged_at_end_row
== NULL
16551 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16553 debug_last_unchanged_at_beg_vpos
16554 = (last_unchanged_at_beg_row
16555 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16557 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16559 #endif /* GLYPH_DEBUG != 0 */
16562 /* Display new lines. Set last_text_row to the last new line
16563 displayed which has text on it, i.e. might end up as being the
16564 line where the window_end_vpos is. */
16565 w
->cursor
.vpos
= -1;
16566 last_text_row
= NULL
;
16567 overlay_arrow_seen
= 0;
16568 while (it
.current_y
< it
.last_visible_y
16569 && !fonts_changed_p
16570 && (first_unchanged_at_end_row
== NULL
16571 || IT_CHARPOS (it
) < stop_pos
))
16573 if (display_line (&it
))
16574 last_text_row
= it
.glyph_row
- 1;
16577 if (fonts_changed_p
)
16581 /* Compute differences in buffer positions, y-positions etc. for
16582 lines reused at the bottom of the window. Compute what we can
16584 if (first_unchanged_at_end_row
16585 /* No lines reused because we displayed everything up to the
16586 bottom of the window. */
16587 && it
.current_y
< it
.last_visible_y
)
16590 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16592 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16593 run
.current_y
= first_unchanged_at_end_row
->y
;
16594 run
.desired_y
= run
.current_y
+ dy
;
16595 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16599 delta
= delta_bytes
= dvpos
= dy
16600 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16601 first_unchanged_at_end_row
= NULL
;
16603 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16606 /* Find the cursor if not already found. We have to decide whether
16607 PT will appear on this window (it sometimes doesn't, but this is
16608 not a very frequent case.) This decision has to be made before
16609 the current matrix is altered. A value of cursor.vpos < 0 means
16610 that PT is either in one of the lines beginning at
16611 first_unchanged_at_end_row or below the window. Don't care for
16612 lines that might be displayed later at the window end; as
16613 mentioned, this is not a frequent case. */
16614 if (w
->cursor
.vpos
< 0)
16616 /* Cursor in unchanged rows at the top? */
16617 if (PT
< CHARPOS (start_pos
)
16618 && last_unchanged_at_beg_row
)
16620 row
= row_containing_pos (w
, PT
,
16621 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16622 last_unchanged_at_beg_row
+ 1, 0);
16624 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16627 /* Start from first_unchanged_at_end_row looking for PT. */
16628 else if (first_unchanged_at_end_row
)
16630 row
= row_containing_pos (w
, PT
- delta
,
16631 first_unchanged_at_end_row
, NULL
, 0);
16633 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16634 delta_bytes
, dy
, dvpos
);
16637 /* Give up if cursor was not found. */
16638 if (w
->cursor
.vpos
< 0)
16640 clear_glyph_matrix (w
->desired_matrix
);
16645 /* Don't let the cursor end in the scroll margins. */
16647 int this_scroll_margin
, cursor_height
;
16649 this_scroll_margin
= max (0, scroll_margin
);
16650 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16651 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16652 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16654 if ((w
->cursor
.y
< this_scroll_margin
16655 && CHARPOS (start
) > BEGV
)
16656 /* Old redisplay didn't take scroll margin into account at the bottom,
16657 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16658 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16659 ? cursor_height
+ this_scroll_margin
16660 : 1)) > it
.last_visible_y
)
16662 w
->cursor
.vpos
= -1;
16663 clear_glyph_matrix (w
->desired_matrix
);
16668 /* Scroll the display. Do it before changing the current matrix so
16669 that xterm.c doesn't get confused about where the cursor glyph is
16671 if (dy
&& run
.height
)
16675 if (FRAME_WINDOW_P (f
))
16677 FRAME_RIF (f
)->update_window_begin_hook (w
);
16678 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16679 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16680 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16684 /* Terminal frame. In this case, dvpos gives the number of
16685 lines to scroll by; dvpos < 0 means scroll up. */
16687 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16688 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16689 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16690 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16691 + window_internal_height (w
));
16693 #if defined (HAVE_GPM) || defined (MSDOS)
16694 x_clear_window_mouse_face (w
);
16696 /* Perform the operation on the screen. */
16699 /* Scroll last_unchanged_at_beg_row to the end of the
16700 window down dvpos lines. */
16701 set_terminal_window (f
, end
);
16703 /* On dumb terminals delete dvpos lines at the end
16704 before inserting dvpos empty lines. */
16705 if (!FRAME_SCROLL_REGION_OK (f
))
16706 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16708 /* Insert dvpos empty lines in front of
16709 last_unchanged_at_beg_row. */
16710 ins_del_lines (f
, from
, dvpos
);
16712 else if (dvpos
< 0)
16714 /* Scroll up last_unchanged_at_beg_vpos to the end of
16715 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16716 set_terminal_window (f
, end
);
16718 /* Delete dvpos lines in front of
16719 last_unchanged_at_beg_vpos. ins_del_lines will set
16720 the cursor to the given vpos and emit |dvpos| delete
16722 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16724 /* On a dumb terminal insert dvpos empty lines at the
16726 if (!FRAME_SCROLL_REGION_OK (f
))
16727 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16730 set_terminal_window (f
, 0);
16736 /* Shift reused rows of the current matrix to the right position.
16737 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16739 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16740 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16743 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16744 bottom_vpos
, dvpos
);
16745 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16748 else if (dvpos
> 0)
16750 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16751 bottom_vpos
, dvpos
);
16752 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16753 first_unchanged_at_end_vpos
+ dvpos
, 0);
16756 /* For frame-based redisplay, make sure that current frame and window
16757 matrix are in sync with respect to glyph memory. */
16758 if (!FRAME_WINDOW_P (f
))
16759 sync_frame_with_window_matrix_rows (w
);
16761 /* Adjust buffer positions in reused rows. */
16762 if (delta
|| delta_bytes
)
16763 increment_matrix_positions (current_matrix
,
16764 first_unchanged_at_end_vpos
+ dvpos
,
16765 bottom_vpos
, delta
, delta_bytes
);
16767 /* Adjust Y positions. */
16769 shift_glyph_matrix (w
, current_matrix
,
16770 first_unchanged_at_end_vpos
+ dvpos
,
16773 if (first_unchanged_at_end_row
)
16775 first_unchanged_at_end_row
+= dvpos
;
16776 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16777 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16778 first_unchanged_at_end_row
= NULL
;
16781 /* If scrolling up, there may be some lines to display at the end of
16783 last_text_row_at_end
= NULL
;
16786 /* Scrolling up can leave for example a partially visible line
16787 at the end of the window to be redisplayed. */
16788 /* Set last_row to the glyph row in the current matrix where the
16789 window end line is found. It has been moved up or down in
16790 the matrix by dvpos. */
16791 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16792 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16794 /* If last_row is the window end line, it should display text. */
16795 xassert (last_row
->displays_text_p
);
16797 /* If window end line was partially visible before, begin
16798 displaying at that line. Otherwise begin displaying with the
16799 line following it. */
16800 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16802 init_to_row_start (&it
, w
, last_row
);
16803 it
.vpos
= last_vpos
;
16804 it
.current_y
= last_row
->y
;
16808 init_to_row_end (&it
, w
, last_row
);
16809 it
.vpos
= 1 + last_vpos
;
16810 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16814 /* We may start in a continuation line. If so, we have to
16815 get the right continuation_lines_width and current_x. */
16816 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16817 it
.hpos
= it
.current_x
= 0;
16819 /* Display the rest of the lines at the window end. */
16820 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16821 while (it
.current_y
< it
.last_visible_y
16822 && !fonts_changed_p
)
16824 /* Is it always sure that the display agrees with lines in
16825 the current matrix? I don't think so, so we mark rows
16826 displayed invalid in the current matrix by setting their
16827 enabled_p flag to zero. */
16828 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16829 if (display_line (&it
))
16830 last_text_row_at_end
= it
.glyph_row
- 1;
16834 /* Update window_end_pos and window_end_vpos. */
16835 if (first_unchanged_at_end_row
16836 && !last_text_row_at_end
)
16838 /* Window end line if one of the preserved rows from the current
16839 matrix. Set row to the last row displaying text in current
16840 matrix starting at first_unchanged_at_end_row, after
16842 xassert (first_unchanged_at_end_row
->displays_text_p
);
16843 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16844 first_unchanged_at_end_row
);
16845 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16847 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16848 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16850 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16851 xassert (w
->window_end_bytepos
>= 0);
16852 IF_DEBUG (debug_method_add (w
, "A"));
16854 else if (last_text_row_at_end
)
16857 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16858 w
->window_end_bytepos
16859 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16861 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16862 xassert (w
->window_end_bytepos
>= 0);
16863 IF_DEBUG (debug_method_add (w
, "B"));
16865 else if (last_text_row
)
16867 /* We have displayed either to the end of the window or at the
16868 end of the window, i.e. the last row with text is to be found
16869 in the desired matrix. */
16871 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16872 w
->window_end_bytepos
16873 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16875 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16876 xassert (w
->window_end_bytepos
>= 0);
16878 else if (first_unchanged_at_end_row
== NULL
16879 && last_text_row
== NULL
16880 && last_text_row_at_end
== NULL
)
16882 /* Displayed to end of window, but no line containing text was
16883 displayed. Lines were deleted at the end of the window. */
16884 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16885 int vpos
= XFASTINT (w
->window_end_vpos
);
16886 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16887 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16890 row
== NULL
&& vpos
>= first_vpos
;
16891 --vpos
, --current_row
, --desired_row
)
16893 if (desired_row
->enabled_p
)
16895 if (desired_row
->displays_text_p
)
16898 else if (current_row
->displays_text_p
)
16902 xassert (row
!= NULL
);
16903 w
->window_end_vpos
= make_number (vpos
+ 1);
16904 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16905 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16906 xassert (w
->window_end_bytepos
>= 0);
16907 IF_DEBUG (debug_method_add (w
, "C"));
16912 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16913 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16915 /* Record that display has not been completed. */
16916 w
->window_end_valid
= Qnil
;
16917 w
->desired_matrix
->no_scrolling_p
= 1;
16925 /***********************************************************************
16926 More debugging support
16927 ***********************************************************************/
16931 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
16932 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
16933 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
16936 /* Dump the contents of glyph matrix MATRIX on stderr.
16938 GLYPHS 0 means don't show glyph contents.
16939 GLYPHS 1 means show glyphs in short form
16940 GLYPHS > 1 means show glyphs in long form. */
16943 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
16946 for (i
= 0; i
< matrix
->nrows
; ++i
)
16947 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16951 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16952 the glyph row and area where the glyph comes from. */
16955 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
16957 if (glyph
->type
== CHAR_GLYPH
)
16960 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16961 glyph
- row
->glyphs
[TEXT_AREA
],
16964 (BUFFERP (glyph
->object
)
16966 : (STRINGP (glyph
->object
)
16969 glyph
->pixel_width
,
16971 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16975 glyph
->left_box_line_p
,
16976 glyph
->right_box_line_p
);
16978 else if (glyph
->type
== STRETCH_GLYPH
)
16981 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16982 glyph
- row
->glyphs
[TEXT_AREA
],
16985 (BUFFERP (glyph
->object
)
16987 : (STRINGP (glyph
->object
)
16990 glyph
->pixel_width
,
16994 glyph
->left_box_line_p
,
16995 glyph
->right_box_line_p
);
16997 else if (glyph
->type
== IMAGE_GLYPH
)
17000 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17001 glyph
- row
->glyphs
[TEXT_AREA
],
17004 (BUFFERP (glyph
->object
)
17006 : (STRINGP (glyph
->object
)
17009 glyph
->pixel_width
,
17013 glyph
->left_box_line_p
,
17014 glyph
->right_box_line_p
);
17016 else if (glyph
->type
== COMPOSITE_GLYPH
)
17019 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17020 glyph
- row
->glyphs
[TEXT_AREA
],
17023 (BUFFERP (glyph
->object
)
17025 : (STRINGP (glyph
->object
)
17028 glyph
->pixel_width
,
17030 if (glyph
->u
.cmp
.automatic
)
17033 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17034 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17036 glyph
->left_box_line_p
,
17037 glyph
->right_box_line_p
);
17042 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17043 GLYPHS 0 means don't show glyph contents.
17044 GLYPHS 1 means show glyphs in short form
17045 GLYPHS > 1 means show glyphs in long form. */
17048 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17052 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17053 fprintf (stderr
, "======================================================================\n");
17055 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17056 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17058 MATRIX_ROW_START_CHARPOS (row
),
17059 MATRIX_ROW_END_CHARPOS (row
),
17060 row
->used
[TEXT_AREA
],
17061 row
->contains_overlapping_glyphs_p
,
17063 row
->truncated_on_left_p
,
17064 row
->truncated_on_right_p
,
17066 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17067 row
->displays_text_p
,
17070 row
->ends_in_middle_of_char_p
,
17071 row
->starts_in_middle_of_char_p
,
17077 row
->visible_height
,
17080 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17081 row
->end
.overlay_string_index
,
17082 row
->continuation_lines_width
);
17083 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17084 CHARPOS (row
->start
.string_pos
),
17085 CHARPOS (row
->end
.string_pos
));
17086 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17087 row
->end
.dpvec_index
);
17094 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17096 struct glyph
*glyph
= row
->glyphs
[area
];
17097 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17099 /* Glyph for a line end in text. */
17100 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17103 if (glyph
< glyph_end
)
17104 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17106 for (; glyph
< glyph_end
; ++glyph
)
17107 dump_glyph (row
, glyph
, area
);
17110 else if (glyphs
== 1)
17114 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17116 char *s
= (char *) alloca (row
->used
[area
] + 1);
17119 for (i
= 0; i
< row
->used
[area
]; ++i
)
17121 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17122 if (glyph
->type
== CHAR_GLYPH
17123 && glyph
->u
.ch
< 0x80
17124 && glyph
->u
.ch
>= ' ')
17125 s
[i
] = glyph
->u
.ch
;
17131 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17137 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17138 Sdump_glyph_matrix
, 0, 1, "p",
17139 doc
: /* Dump the current matrix of the selected window to stderr.
17140 Shows contents of glyph row structures. With non-nil
17141 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17142 glyphs in short form, otherwise show glyphs in long form. */)
17143 (Lisp_Object glyphs
)
17145 struct window
*w
= XWINDOW (selected_window
);
17146 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17148 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17149 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17150 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17151 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17152 fprintf (stderr
, "=============================================\n");
17153 dump_glyph_matrix (w
->current_matrix
,
17154 NILP (glyphs
) ? 0 : XINT (glyphs
));
17159 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17160 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17163 struct frame
*f
= XFRAME (selected_frame
);
17164 dump_glyph_matrix (f
->current_matrix
, 1);
17169 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17170 doc
: /* Dump glyph row ROW to stderr.
17171 GLYPH 0 means don't dump glyphs.
17172 GLYPH 1 means dump glyphs in short form.
17173 GLYPH > 1 or omitted means dump glyphs in long form. */)
17174 (Lisp_Object row
, Lisp_Object glyphs
)
17176 struct glyph_matrix
*matrix
;
17179 CHECK_NUMBER (row
);
17180 matrix
= XWINDOW (selected_window
)->current_matrix
;
17182 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17183 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17185 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17190 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17191 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17192 GLYPH 0 means don't dump glyphs.
17193 GLYPH 1 means dump glyphs in short form.
17194 GLYPH > 1 or omitted means dump glyphs in long form. */)
17195 (Lisp_Object row
, Lisp_Object glyphs
)
17197 struct frame
*sf
= SELECTED_FRAME ();
17198 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17201 CHECK_NUMBER (row
);
17203 if (vpos
>= 0 && vpos
< m
->nrows
)
17204 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17205 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17210 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17211 doc
: /* Toggle tracing of redisplay.
17212 With ARG, turn tracing on if and only if ARG is positive. */)
17216 trace_redisplay_p
= !trace_redisplay_p
;
17219 arg
= Fprefix_numeric_value (arg
);
17220 trace_redisplay_p
= XINT (arg
) > 0;
17227 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17228 doc
: /* Like `format', but print result to stderr.
17229 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17230 (ptrdiff_t nargs
, Lisp_Object
*args
)
17232 Lisp_Object s
= Fformat (nargs
, args
);
17233 fprintf (stderr
, "%s", SDATA (s
));
17237 #endif /* GLYPH_DEBUG */
17241 /***********************************************************************
17242 Building Desired Matrix Rows
17243 ***********************************************************************/
17245 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17246 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17248 static struct glyph_row
*
17249 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17251 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17252 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17253 struct buffer
*old
= current_buffer
;
17254 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17255 int arrow_len
= SCHARS (overlay_arrow_string
);
17256 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17257 const unsigned char *p
;
17260 int n_glyphs_before
;
17262 set_buffer_temp (buffer
);
17263 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17264 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17265 SET_TEXT_POS (it
.position
, 0, 0);
17267 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17269 while (p
< arrow_end
)
17271 Lisp_Object face
, ilisp
;
17273 /* Get the next character. */
17275 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17278 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17279 if (! ASCII_CHAR_P (it
.c
))
17280 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17284 /* Get its face. */
17285 ilisp
= make_number (p
- arrow_string
);
17286 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17287 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17289 /* Compute its width, get its glyphs. */
17290 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17291 SET_TEXT_POS (it
.position
, -1, -1);
17292 PRODUCE_GLYPHS (&it
);
17294 /* If this character doesn't fit any more in the line, we have
17295 to remove some glyphs. */
17296 if (it
.current_x
> it
.last_visible_x
)
17298 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17303 set_buffer_temp (old
);
17304 return it
.glyph_row
;
17308 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17309 glyphs are only inserted for terminal frames since we can't really
17310 win with truncation glyphs when partially visible glyphs are
17311 involved. Which glyphs to insert is determined by
17312 produce_special_glyphs. */
17315 insert_left_trunc_glyphs (struct it
*it
)
17317 struct it truncate_it
;
17318 struct glyph
*from
, *end
, *to
, *toend
;
17320 xassert (!FRAME_WINDOW_P (it
->f
));
17322 /* Get the truncation glyphs. */
17324 truncate_it
.current_x
= 0;
17325 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17326 truncate_it
.glyph_row
= &scratch_glyph_row
;
17327 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17328 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17329 truncate_it
.object
= make_number (0);
17330 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17332 /* Overwrite glyphs from IT with truncation glyphs. */
17333 if (!it
->glyph_row
->reversed_p
)
17335 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17336 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17337 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17338 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17343 /* There may be padding glyphs left over. Overwrite them too. */
17344 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17346 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17352 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17356 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17357 that back to front. */
17358 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17359 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17360 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17361 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17363 while (from
>= end
&& to
>= toend
)
17365 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17368 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17369 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17370 while (from
>= end
&& to
>= toend
)
17375 /* Need to free some room before prepending additional
17377 int move_by
= from
- end
+ 1;
17378 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17379 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17381 for ( ; g
>= g0
; g
--)
17383 while (from
>= end
)
17385 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17391 /* Compute the pixel height and width of IT->glyph_row.
17393 Most of the time, ascent and height of a display line will be equal
17394 to the max_ascent and max_height values of the display iterator
17395 structure. This is not the case if
17397 1. We hit ZV without displaying anything. In this case, max_ascent
17398 and max_height will be zero.
17400 2. We have some glyphs that don't contribute to the line height.
17401 (The glyph row flag contributes_to_line_height_p is for future
17402 pixmap extensions).
17404 The first case is easily covered by using default values because in
17405 these cases, the line height does not really matter, except that it
17406 must not be zero. */
17409 compute_line_metrics (struct it
*it
)
17411 struct glyph_row
*row
= it
->glyph_row
;
17413 if (FRAME_WINDOW_P (it
->f
))
17415 int i
, min_y
, max_y
;
17417 /* The line may consist of one space only, that was added to
17418 place the cursor on it. If so, the row's height hasn't been
17420 if (row
->height
== 0)
17422 if (it
->max_ascent
+ it
->max_descent
== 0)
17423 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17424 row
->ascent
= it
->max_ascent
;
17425 row
->height
= it
->max_ascent
+ it
->max_descent
;
17426 row
->phys_ascent
= it
->max_phys_ascent
;
17427 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17428 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17431 /* Compute the width of this line. */
17432 row
->pixel_width
= row
->x
;
17433 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17434 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17436 xassert (row
->pixel_width
>= 0);
17437 xassert (row
->ascent
>= 0 && row
->height
> 0);
17439 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17440 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17442 /* If first line's physical ascent is larger than its logical
17443 ascent, use the physical ascent, and make the row taller.
17444 This makes accented characters fully visible. */
17445 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17446 && row
->phys_ascent
> row
->ascent
)
17448 row
->height
+= row
->phys_ascent
- row
->ascent
;
17449 row
->ascent
= row
->phys_ascent
;
17452 /* Compute how much of the line is visible. */
17453 row
->visible_height
= row
->height
;
17455 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17456 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17458 if (row
->y
< min_y
)
17459 row
->visible_height
-= min_y
- row
->y
;
17460 if (row
->y
+ row
->height
> max_y
)
17461 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17465 row
->pixel_width
= row
->used
[TEXT_AREA
];
17466 if (row
->continued_p
)
17467 row
->pixel_width
-= it
->continuation_pixel_width
;
17468 else if (row
->truncated_on_right_p
)
17469 row
->pixel_width
-= it
->truncation_pixel_width
;
17470 row
->ascent
= row
->phys_ascent
= 0;
17471 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17472 row
->extra_line_spacing
= 0;
17475 /* Compute a hash code for this row. */
17479 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17480 for (i
= 0; i
< row
->used
[area
]; ++i
)
17481 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17482 + row
->glyphs
[area
][i
].u
.val
17483 + row
->glyphs
[area
][i
].face_id
17484 + row
->glyphs
[area
][i
].padding_p
17485 + (row
->glyphs
[area
][i
].type
<< 2));
17488 it
->max_ascent
= it
->max_descent
= 0;
17489 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17493 /* Append one space to the glyph row of iterator IT if doing a
17494 window-based redisplay. The space has the same face as
17495 IT->face_id. Value is non-zero if a space was added.
17497 This function is called to make sure that there is always one glyph
17498 at the end of a glyph row that the cursor can be set on under
17499 window-systems. (If there weren't such a glyph we would not know
17500 how wide and tall a box cursor should be displayed).
17502 At the same time this space let's a nicely handle clearing to the
17503 end of the line if the row ends in italic text. */
17506 append_space_for_newline (struct it
*it
, int default_face_p
)
17508 if (FRAME_WINDOW_P (it
->f
))
17510 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17512 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17513 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17515 /* Save some values that must not be changed.
17516 Must save IT->c and IT->len because otherwise
17517 ITERATOR_AT_END_P wouldn't work anymore after
17518 append_space_for_newline has been called. */
17519 enum display_element_type saved_what
= it
->what
;
17520 int saved_c
= it
->c
, saved_len
= it
->len
;
17521 int saved_char_to_display
= it
->char_to_display
;
17522 int saved_x
= it
->current_x
;
17523 int saved_face_id
= it
->face_id
;
17524 struct text_pos saved_pos
;
17525 Lisp_Object saved_object
;
17528 saved_object
= it
->object
;
17529 saved_pos
= it
->position
;
17531 it
->what
= IT_CHARACTER
;
17532 memset (&it
->position
, 0, sizeof it
->position
);
17533 it
->object
= make_number (0);
17534 it
->c
= it
->char_to_display
= ' ';
17537 if (default_face_p
)
17538 it
->face_id
= DEFAULT_FACE_ID
;
17539 else if (it
->face_before_selective_p
)
17540 it
->face_id
= it
->saved_face_id
;
17541 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17542 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17544 PRODUCE_GLYPHS (it
);
17546 it
->override_ascent
= -1;
17547 it
->constrain_row_ascent_descent_p
= 0;
17548 it
->current_x
= saved_x
;
17549 it
->object
= saved_object
;
17550 it
->position
= saved_pos
;
17551 it
->what
= saved_what
;
17552 it
->face_id
= saved_face_id
;
17553 it
->len
= saved_len
;
17555 it
->char_to_display
= saved_char_to_display
;
17564 /* Extend the face of the last glyph in the text area of IT->glyph_row
17565 to the end of the display line. Called from display_line. If the
17566 glyph row is empty, add a space glyph to it so that we know the
17567 face to draw. Set the glyph row flag fill_line_p. If the glyph
17568 row is R2L, prepend a stretch glyph to cover the empty space to the
17569 left of the leftmost glyph. */
17572 extend_face_to_end_of_line (struct it
*it
)
17575 struct frame
*f
= it
->f
;
17577 /* If line is already filled, do nothing. Non window-system frames
17578 get a grace of one more ``pixel'' because their characters are
17579 1-``pixel'' wide, so they hit the equality too early. This grace
17580 is needed only for R2L rows that are not continued, to produce
17581 one extra blank where we could display the cursor. */
17582 if (it
->current_x
>= it
->last_visible_x
17583 + (!FRAME_WINDOW_P (f
)
17584 && it
->glyph_row
->reversed_p
17585 && !it
->glyph_row
->continued_p
))
17588 /* Face extension extends the background and box of IT->face_id
17589 to the end of the line. If the background equals the background
17590 of the frame, we don't have to do anything. */
17591 if (it
->face_before_selective_p
)
17592 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17594 face
= FACE_FROM_ID (f
, it
->face_id
);
17596 if (FRAME_WINDOW_P (f
)
17597 && it
->glyph_row
->displays_text_p
17598 && face
->box
== FACE_NO_BOX
17599 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17601 && !it
->glyph_row
->reversed_p
)
17604 /* Set the glyph row flag indicating that the face of the last glyph
17605 in the text area has to be drawn to the end of the text area. */
17606 it
->glyph_row
->fill_line_p
= 1;
17608 /* If current character of IT is not ASCII, make sure we have the
17609 ASCII face. This will be automatically undone the next time
17610 get_next_display_element returns a multibyte character. Note
17611 that the character will always be single byte in unibyte
17613 if (!ASCII_CHAR_P (it
->c
))
17615 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17618 if (FRAME_WINDOW_P (f
))
17620 /* If the row is empty, add a space with the current face of IT,
17621 so that we know which face to draw. */
17622 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17624 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17625 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17626 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17628 #ifdef HAVE_WINDOW_SYSTEM
17629 if (it
->glyph_row
->reversed_p
)
17631 /* Prepend a stretch glyph to the row, such that the
17632 rightmost glyph will be drawn flushed all the way to the
17633 right margin of the window. The stretch glyph that will
17634 occupy the empty space, if any, to the left of the
17636 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17637 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17638 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17640 int row_width
, stretch_ascent
, stretch_width
;
17641 struct text_pos saved_pos
;
17642 int saved_face_id
, saved_avoid_cursor
;
17644 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17645 row_width
+= g
->pixel_width
;
17646 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17647 if (stretch_width
> 0)
17650 (((it
->ascent
+ it
->descent
)
17651 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17652 saved_pos
= it
->position
;
17653 memset (&it
->position
, 0, sizeof it
->position
);
17654 saved_avoid_cursor
= it
->avoid_cursor_p
;
17655 it
->avoid_cursor_p
= 1;
17656 saved_face_id
= it
->face_id
;
17657 /* The last row's stretch glyph should get the default
17658 face, to avoid painting the rest of the window with
17659 the region face, if the region ends at ZV. */
17660 if (it
->glyph_row
->ends_at_zv_p
)
17661 it
->face_id
= DEFAULT_FACE_ID
;
17663 it
->face_id
= face
->id
;
17664 append_stretch_glyph (it
, make_number (0), stretch_width
,
17665 it
->ascent
+ it
->descent
, stretch_ascent
);
17666 it
->position
= saved_pos
;
17667 it
->avoid_cursor_p
= saved_avoid_cursor
;
17668 it
->face_id
= saved_face_id
;
17671 #endif /* HAVE_WINDOW_SYSTEM */
17675 /* Save some values that must not be changed. */
17676 int saved_x
= it
->current_x
;
17677 struct text_pos saved_pos
;
17678 Lisp_Object saved_object
;
17679 enum display_element_type saved_what
= it
->what
;
17680 int saved_face_id
= it
->face_id
;
17682 saved_object
= it
->object
;
17683 saved_pos
= it
->position
;
17685 it
->what
= IT_CHARACTER
;
17686 memset (&it
->position
, 0, sizeof it
->position
);
17687 it
->object
= make_number (0);
17688 it
->c
= it
->char_to_display
= ' ';
17690 /* The last row's blank glyphs should get the default face, to
17691 avoid painting the rest of the window with the region face,
17692 if the region ends at ZV. */
17693 if (it
->glyph_row
->ends_at_zv_p
)
17694 it
->face_id
= DEFAULT_FACE_ID
;
17696 it
->face_id
= face
->id
;
17698 PRODUCE_GLYPHS (it
);
17700 while (it
->current_x
<= it
->last_visible_x
)
17701 PRODUCE_GLYPHS (it
);
17703 /* Don't count these blanks really. It would let us insert a left
17704 truncation glyph below and make us set the cursor on them, maybe. */
17705 it
->current_x
= saved_x
;
17706 it
->object
= saved_object
;
17707 it
->position
= saved_pos
;
17708 it
->what
= saved_what
;
17709 it
->face_id
= saved_face_id
;
17714 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17715 trailing whitespace. */
17718 trailing_whitespace_p (EMACS_INT charpos
)
17720 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17723 while (bytepos
< ZV_BYTE
17724 && (c
= FETCH_CHAR (bytepos
),
17725 c
== ' ' || c
== '\t'))
17728 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17730 if (bytepos
!= PT_BYTE
)
17737 /* Highlight trailing whitespace, if any, in ROW. */
17740 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17742 int used
= row
->used
[TEXT_AREA
];
17746 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17747 struct glyph
*glyph
= start
+ used
- 1;
17749 if (row
->reversed_p
)
17751 /* Right-to-left rows need to be processed in the opposite
17752 direction, so swap the edge pointers. */
17754 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17757 /* Skip over glyphs inserted to display the cursor at the
17758 end of a line, for extending the face of the last glyph
17759 to the end of the line on terminals, and for truncation
17760 and continuation glyphs. */
17761 if (!row
->reversed_p
)
17763 while (glyph
>= start
17764 && glyph
->type
== CHAR_GLYPH
17765 && INTEGERP (glyph
->object
))
17770 while (glyph
<= start
17771 && glyph
->type
== CHAR_GLYPH
17772 && INTEGERP (glyph
->object
))
17776 /* If last glyph is a space or stretch, and it's trailing
17777 whitespace, set the face of all trailing whitespace glyphs in
17778 IT->glyph_row to `trailing-whitespace'. */
17779 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17780 && BUFFERP (glyph
->object
)
17781 && (glyph
->type
== STRETCH_GLYPH
17782 || (glyph
->type
== CHAR_GLYPH
17783 && glyph
->u
.ch
== ' '))
17784 && trailing_whitespace_p (glyph
->charpos
))
17786 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17790 if (!row
->reversed_p
)
17792 while (glyph
>= start
17793 && BUFFERP (glyph
->object
)
17794 && (glyph
->type
== STRETCH_GLYPH
17795 || (glyph
->type
== CHAR_GLYPH
17796 && glyph
->u
.ch
== ' ')))
17797 (glyph
--)->face_id
= face_id
;
17801 while (glyph
<= start
17802 && BUFFERP (glyph
->object
)
17803 && (glyph
->type
== STRETCH_GLYPH
17804 || (glyph
->type
== CHAR_GLYPH
17805 && glyph
->u
.ch
== ' ')))
17806 (glyph
++)->face_id
= face_id
;
17813 /* Value is non-zero if glyph row ROW should be
17814 used to hold the cursor. */
17817 cursor_row_p (struct glyph_row
*row
)
17821 if (PT
== CHARPOS (row
->end
.pos
))
17823 /* Suppose the row ends on a string.
17824 Unless the row is continued, that means it ends on a newline
17825 in the string. If it's anything other than a display string
17826 (e.g. a before-string from an overlay), we don't want the
17827 cursor there. (This heuristic seems to give the optimal
17828 behavior for the various types of multi-line strings.) */
17829 if (CHARPOS (row
->end
.string_pos
) >= 0)
17831 if (row
->continued_p
)
17835 /* Check for `display' property. */
17836 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17837 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17838 struct glyph
*glyph
;
17841 for (glyph
= end
; glyph
>= beg
; --glyph
)
17842 if (STRINGP (glyph
->object
))
17845 = Fget_char_property (make_number (PT
),
17849 && display_prop_string_p (prop
, glyph
->object
));
17854 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17856 /* If the row ends in middle of a real character,
17857 and the line is continued, we want the cursor here.
17858 That's because CHARPOS (ROW->end.pos) would equal
17859 PT if PT is before the character. */
17860 if (!row
->ends_in_ellipsis_p
)
17861 result
= row
->continued_p
;
17863 /* If the row ends in an ellipsis, then
17864 CHARPOS (ROW->end.pos) will equal point after the
17865 invisible text. We want that position to be displayed
17866 after the ellipsis. */
17869 /* If the row ends at ZV, display the cursor at the end of that
17870 row instead of at the start of the row below. */
17871 else if (row
->ends_at_zv_p
)
17882 /* Push the display property PROP so that it will be rendered at the
17883 current position in IT. Return 1 if PROP was successfully pushed,
17887 push_display_prop (struct it
*it
, Lisp_Object prop
)
17889 xassert (it
->method
== GET_FROM_BUFFER
);
17891 push_it (it
, NULL
);
17893 if (STRINGP (prop
))
17895 if (SCHARS (prop
) == 0)
17902 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17903 it
->current
.overlay_string_index
= -1;
17904 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17905 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17906 it
->method
= GET_FROM_STRING
;
17907 it
->stop_charpos
= 0;
17909 it
->base_level_stop
= 0;
17910 it
->string_from_display_prop_p
= 1;
17911 it
->from_disp_prop_p
= 1;
17913 /* Force paragraph direction to be that of the parent
17915 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
17916 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
17918 it
->paragraph_embedding
= L2R
;
17920 /* Set up the bidi iterator for this display string. */
17923 it
->bidi_it
.string
.lstring
= it
->string
;
17924 it
->bidi_it
.string
.s
= NULL
;
17925 it
->bidi_it
.string
.schars
= it
->end_charpos
;
17926 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
17927 it
->bidi_it
.string
.from_disp_str
= 1;
17928 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
17929 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
17932 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17934 it
->method
= GET_FROM_STRETCH
;
17937 #ifdef HAVE_WINDOW_SYSTEM
17938 else if (IMAGEP (prop
))
17940 it
->what
= IT_IMAGE
;
17941 it
->image_id
= lookup_image (it
->f
, prop
);
17942 it
->method
= GET_FROM_IMAGE
;
17944 #endif /* HAVE_WINDOW_SYSTEM */
17947 pop_it (it
); /* bogus display property, give up */
17954 /* Return the character-property PROP at the current position in IT. */
17957 get_it_property (struct it
*it
, Lisp_Object prop
)
17959 Lisp_Object position
;
17961 if (STRINGP (it
->object
))
17962 position
= make_number (IT_STRING_CHARPOS (*it
));
17963 else if (BUFFERP (it
->object
))
17964 position
= make_number (IT_CHARPOS (*it
));
17968 return Fget_char_property (position
, prop
, it
->object
);
17971 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17974 handle_line_prefix (struct it
*it
)
17976 Lisp_Object prefix
;
17978 if (it
->continuation_lines_width
> 0)
17980 prefix
= get_it_property (it
, Qwrap_prefix
);
17982 prefix
= Vwrap_prefix
;
17986 prefix
= get_it_property (it
, Qline_prefix
);
17988 prefix
= Vline_prefix
;
17990 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17992 /* If the prefix is wider than the window, and we try to wrap
17993 it, it would acquire its own wrap prefix, and so on till the
17994 iterator stack overflows. So, don't wrap the prefix. */
17995 it
->line_wrap
= TRUNCATE
;
17996 it
->avoid_cursor_p
= 1;
18002 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18003 only for R2L lines from display_line and display_string, when they
18004 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18005 the line/string needs to be continued on the next glyph row. */
18007 unproduce_glyphs (struct it
*it
, int n
)
18009 struct glyph
*glyph
, *end
;
18011 xassert (it
->glyph_row
);
18012 xassert (it
->glyph_row
->reversed_p
);
18013 xassert (it
->area
== TEXT_AREA
);
18014 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18016 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18017 n
= it
->glyph_row
->used
[TEXT_AREA
];
18018 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18019 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18020 for ( ; glyph
< end
; glyph
++)
18021 glyph
[-n
] = *glyph
;
18024 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18025 and ROW->maxpos. */
18027 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18028 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18029 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18031 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18032 lines' rows is implemented for bidi-reordered rows. */
18034 /* ROW->minpos is the value of min_pos, the minimal buffer position
18035 we have in ROW, or ROW->start.pos if that is smaller. */
18036 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18037 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18039 /* We didn't find buffer positions smaller than ROW->start, or
18040 didn't find _any_ valid buffer positions in any of the glyphs,
18041 so we must trust the iterator's computed positions. */
18042 row
->minpos
= row
->start
.pos
;
18045 max_pos
= CHARPOS (it
->current
.pos
);
18046 max_bpos
= BYTEPOS (it
->current
.pos
);
18049 /* Here are the various use-cases for ending the row, and the
18050 corresponding values for ROW->maxpos:
18052 Line ends in a newline from buffer eol_pos + 1
18053 Line is continued from buffer max_pos + 1
18054 Line is truncated on right it->current.pos
18055 Line ends in a newline from string max_pos
18056 Line is continued from string max_pos
18057 Line is continued from display vector max_pos
18058 Line is entirely from a string min_pos == max_pos
18059 Line is entirely from a display vector min_pos == max_pos
18060 Line that ends at ZV ZV
18062 If you discover other use-cases, please add them here as
18064 if (row
->ends_at_zv_p
)
18065 row
->maxpos
= it
->current
.pos
;
18066 else if (row
->used
[TEXT_AREA
])
18068 if (row
->ends_in_newline_from_string_p
)
18069 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18070 else if (CHARPOS (it
->eol_pos
) > 0)
18071 SET_TEXT_POS (row
->maxpos
,
18072 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18073 else if (row
->continued_p
)
18075 /* If max_pos is different from IT's current position, it
18076 means IT->method does not belong to the display element
18077 at max_pos. However, it also means that the display
18078 element at max_pos was displayed in its entirety on this
18079 line, which is equivalent to saying that the next line
18080 starts at the next buffer position. */
18081 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18082 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18085 INC_BOTH (max_pos
, max_bpos
);
18086 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18089 else if (row
->truncated_on_right_p
)
18090 /* display_line already called reseat_at_next_visible_line_start,
18091 which puts the iterator at the beginning of the next line, in
18092 the logical order. */
18093 row
->maxpos
= it
->current
.pos
;
18094 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18095 /* A line that is entirely from a string/image/stretch... */
18096 row
->maxpos
= row
->minpos
;
18101 row
->maxpos
= it
->current
.pos
;
18104 /* Construct the glyph row IT->glyph_row in the desired matrix of
18105 IT->w from text at the current position of IT. See dispextern.h
18106 for an overview of struct it. Value is non-zero if
18107 IT->glyph_row displays text, as opposed to a line displaying ZV
18111 display_line (struct it
*it
)
18113 struct glyph_row
*row
= it
->glyph_row
;
18114 Lisp_Object overlay_arrow_string
;
18116 void *wrap_data
= NULL
;
18117 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18118 int wrap_row_used
= -1;
18119 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18120 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18121 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18122 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18123 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18125 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18126 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18128 /* We always start displaying at hpos zero even if hscrolled. */
18129 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18131 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18132 >= it
->w
->desired_matrix
->nrows
)
18134 it
->w
->nrows_scale_factor
++;
18135 fonts_changed_p
= 1;
18139 /* Is IT->w showing the region? */
18140 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18142 /* Clear the result glyph row and enable it. */
18143 prepare_desired_row (row
);
18145 row
->y
= it
->current_y
;
18146 row
->start
= it
->start
;
18147 row
->continuation_lines_width
= it
->continuation_lines_width
;
18148 row
->displays_text_p
= 1;
18149 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18150 it
->starts_in_middle_of_char_p
= 0;
18152 /* Arrange the overlays nicely for our purposes. Usually, we call
18153 display_line on only one line at a time, in which case this
18154 can't really hurt too much, or we call it on lines which appear
18155 one after another in the buffer, in which case all calls to
18156 recenter_overlay_lists but the first will be pretty cheap. */
18157 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18159 /* Move over display elements that are not visible because we are
18160 hscrolled. This may stop at an x-position < IT->first_visible_x
18161 if the first glyph is partially visible or if we hit a line end. */
18162 if (it
->current_x
< it
->first_visible_x
)
18164 this_line_min_pos
= row
->start
.pos
;
18165 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18166 MOVE_TO_POS
| MOVE_TO_X
);
18167 /* Record the smallest positions seen while we moved over
18168 display elements that are not visible. This is needed by
18169 redisplay_internal for optimizing the case where the cursor
18170 stays inside the same line. The rest of this function only
18171 considers positions that are actually displayed, so
18172 RECORD_MAX_MIN_POS will not otherwise record positions that
18173 are hscrolled to the left of the left edge of the window. */
18174 min_pos
= CHARPOS (this_line_min_pos
);
18175 min_bpos
= BYTEPOS (this_line_min_pos
);
18179 /* We only do this when not calling `move_it_in_display_line_to'
18180 above, because move_it_in_display_line_to calls
18181 handle_line_prefix itself. */
18182 handle_line_prefix (it
);
18185 /* Get the initial row height. This is either the height of the
18186 text hscrolled, if there is any, or zero. */
18187 row
->ascent
= it
->max_ascent
;
18188 row
->height
= it
->max_ascent
+ it
->max_descent
;
18189 row
->phys_ascent
= it
->max_phys_ascent
;
18190 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18191 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18193 /* Utility macro to record max and min buffer positions seen until now. */
18194 #define RECORD_MAX_MIN_POS(IT) \
18197 if (IT_CHARPOS (*(IT)) < min_pos) \
18199 min_pos = IT_CHARPOS (*(IT)); \
18200 min_bpos = IT_BYTEPOS (*(IT)); \
18202 if (IT_CHARPOS (*(IT)) > max_pos) \
18204 max_pos = IT_CHARPOS (*(IT)); \
18205 max_bpos = IT_BYTEPOS (*(IT)); \
18210 /* Loop generating characters. The loop is left with IT on the next
18211 character to display. */
18214 int n_glyphs_before
, hpos_before
, x_before
;
18216 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18218 /* Retrieve the next thing to display. Value is zero if end of
18220 if (!get_next_display_element (it
))
18222 /* Maybe add a space at the end of this line that is used to
18223 display the cursor there under X. Set the charpos of the
18224 first glyph of blank lines not corresponding to any text
18226 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18227 row
->exact_window_width_line_p
= 1;
18228 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18229 || row
->used
[TEXT_AREA
] == 0)
18231 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18232 row
->displays_text_p
= 0;
18234 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18235 && (!MINI_WINDOW_P (it
->w
)
18236 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18237 row
->indicate_empty_line_p
= 1;
18240 it
->continuation_lines_width
= 0;
18241 row
->ends_at_zv_p
= 1;
18242 /* A row that displays right-to-left text must always have
18243 its last face extended all the way to the end of line,
18244 even if this row ends in ZV, because we still write to
18245 the screen left to right. */
18246 if (row
->reversed_p
)
18247 extend_face_to_end_of_line (it
);
18251 /* Now, get the metrics of what we want to display. This also
18252 generates glyphs in `row' (which is IT->glyph_row). */
18253 n_glyphs_before
= row
->used
[TEXT_AREA
];
18256 /* Remember the line height so far in case the next element doesn't
18257 fit on the line. */
18258 if (it
->line_wrap
!= TRUNCATE
)
18260 ascent
= it
->max_ascent
;
18261 descent
= it
->max_descent
;
18262 phys_ascent
= it
->max_phys_ascent
;
18263 phys_descent
= it
->max_phys_descent
;
18265 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18267 if (IT_DISPLAYING_WHITESPACE (it
))
18271 SAVE_IT (wrap_it
, *it
, wrap_data
);
18273 wrap_row_used
= row
->used
[TEXT_AREA
];
18274 wrap_row_ascent
= row
->ascent
;
18275 wrap_row_height
= row
->height
;
18276 wrap_row_phys_ascent
= row
->phys_ascent
;
18277 wrap_row_phys_height
= row
->phys_height
;
18278 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18279 wrap_row_min_pos
= min_pos
;
18280 wrap_row_min_bpos
= min_bpos
;
18281 wrap_row_max_pos
= max_pos
;
18282 wrap_row_max_bpos
= max_bpos
;
18288 PRODUCE_GLYPHS (it
);
18290 /* If this display element was in marginal areas, continue with
18292 if (it
->area
!= TEXT_AREA
)
18294 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18295 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18296 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18297 row
->phys_height
= max (row
->phys_height
,
18298 it
->max_phys_ascent
+ it
->max_phys_descent
);
18299 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18300 it
->max_extra_line_spacing
);
18301 set_iterator_to_next (it
, 1);
18305 /* Does the display element fit on the line? If we truncate
18306 lines, we should draw past the right edge of the window. If
18307 we don't truncate, we want to stop so that we can display the
18308 continuation glyph before the right margin. If lines are
18309 continued, there are two possible strategies for characters
18310 resulting in more than 1 glyph (e.g. tabs): Display as many
18311 glyphs as possible in this line and leave the rest for the
18312 continuation line, or display the whole element in the next
18313 line. Original redisplay did the former, so we do it also. */
18314 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18315 hpos_before
= it
->hpos
;
18318 if (/* Not a newline. */
18320 /* Glyphs produced fit entirely in the line. */
18321 && it
->current_x
< it
->last_visible_x
)
18323 it
->hpos
+= nglyphs
;
18324 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18325 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18326 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18327 row
->phys_height
= max (row
->phys_height
,
18328 it
->max_phys_ascent
+ it
->max_phys_descent
);
18329 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18330 it
->max_extra_line_spacing
);
18331 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18332 row
->x
= x
- it
->first_visible_x
;
18333 /* Record the maximum and minimum buffer positions seen so
18334 far in glyphs that will be displayed by this row. */
18336 RECORD_MAX_MIN_POS (it
);
18341 struct glyph
*glyph
;
18343 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18345 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18346 new_x
= x
+ glyph
->pixel_width
;
18348 if (/* Lines are continued. */
18349 it
->line_wrap
!= TRUNCATE
18350 && (/* Glyph doesn't fit on the line. */
18351 new_x
> it
->last_visible_x
18352 /* Or it fits exactly on a window system frame. */
18353 || (new_x
== it
->last_visible_x
18354 && FRAME_WINDOW_P (it
->f
))))
18356 /* End of a continued line. */
18359 || (new_x
== it
->last_visible_x
18360 && FRAME_WINDOW_P (it
->f
)))
18362 /* Current glyph is the only one on the line or
18363 fits exactly on the line. We must continue
18364 the line because we can't draw the cursor
18365 after the glyph. */
18366 row
->continued_p
= 1;
18367 it
->current_x
= new_x
;
18368 it
->continuation_lines_width
+= new_x
;
18370 /* Record the maximum and minimum buffer
18371 positions seen so far in glyphs that will be
18372 displayed by this row. */
18374 RECORD_MAX_MIN_POS (it
);
18375 if (i
== nglyphs
- 1)
18377 /* If line-wrap is on, check if a previous
18378 wrap point was found. */
18379 if (wrap_row_used
> 0
18380 /* Even if there is a previous wrap
18381 point, continue the line here as
18382 usual, if (i) the previous character
18383 was a space or tab AND (ii) the
18384 current character is not. */
18386 || IT_DISPLAYING_WHITESPACE (it
)))
18389 set_iterator_to_next (it
, 1);
18390 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18392 if (!get_next_display_element (it
))
18394 row
->exact_window_width_line_p
= 1;
18395 it
->continuation_lines_width
= 0;
18396 row
->continued_p
= 0;
18397 row
->ends_at_zv_p
= 1;
18399 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18401 row
->continued_p
= 0;
18402 row
->exact_window_width_line_p
= 1;
18407 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18408 && !FRAME_WINDOW_P (it
->f
))
18410 /* A padding glyph that doesn't fit on this line.
18411 This means the whole character doesn't fit
18413 if (row
->reversed_p
)
18414 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18415 - n_glyphs_before
);
18416 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18418 /* Fill the rest of the row with continuation
18419 glyphs like in 20.x. */
18420 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18421 < row
->glyphs
[1 + TEXT_AREA
])
18422 produce_special_glyphs (it
, IT_CONTINUATION
);
18424 row
->continued_p
= 1;
18425 it
->current_x
= x_before
;
18426 it
->continuation_lines_width
+= x_before
;
18428 /* Restore the height to what it was before the
18429 element not fitting on the line. */
18430 it
->max_ascent
= ascent
;
18431 it
->max_descent
= descent
;
18432 it
->max_phys_ascent
= phys_ascent
;
18433 it
->max_phys_descent
= phys_descent
;
18435 else if (wrap_row_used
> 0)
18438 if (row
->reversed_p
)
18439 unproduce_glyphs (it
,
18440 row
->used
[TEXT_AREA
] - wrap_row_used
);
18441 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18442 it
->continuation_lines_width
+= wrap_x
;
18443 row
->used
[TEXT_AREA
] = wrap_row_used
;
18444 row
->ascent
= wrap_row_ascent
;
18445 row
->height
= wrap_row_height
;
18446 row
->phys_ascent
= wrap_row_phys_ascent
;
18447 row
->phys_height
= wrap_row_phys_height
;
18448 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18449 min_pos
= wrap_row_min_pos
;
18450 min_bpos
= wrap_row_min_bpos
;
18451 max_pos
= wrap_row_max_pos
;
18452 max_bpos
= wrap_row_max_bpos
;
18453 row
->continued_p
= 1;
18454 row
->ends_at_zv_p
= 0;
18455 row
->exact_window_width_line_p
= 0;
18456 it
->continuation_lines_width
+= x
;
18458 /* Make sure that a non-default face is extended
18459 up to the right margin of the window. */
18460 extend_face_to_end_of_line (it
);
18462 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18464 /* A TAB that extends past the right edge of the
18465 window. This produces a single glyph on
18466 window system frames. We leave the glyph in
18467 this row and let it fill the row, but don't
18468 consume the TAB. */
18469 it
->continuation_lines_width
+= it
->last_visible_x
;
18470 row
->ends_in_middle_of_char_p
= 1;
18471 row
->continued_p
= 1;
18472 glyph
->pixel_width
= it
->last_visible_x
- x
;
18473 it
->starts_in_middle_of_char_p
= 1;
18477 /* Something other than a TAB that draws past
18478 the right edge of the window. Restore
18479 positions to values before the element. */
18480 if (row
->reversed_p
)
18481 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18482 - (n_glyphs_before
+ i
));
18483 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18485 /* Display continuation glyphs. */
18486 if (!FRAME_WINDOW_P (it
->f
))
18487 produce_special_glyphs (it
, IT_CONTINUATION
);
18488 row
->continued_p
= 1;
18490 it
->current_x
= x_before
;
18491 it
->continuation_lines_width
+= x
;
18492 extend_face_to_end_of_line (it
);
18494 if (nglyphs
> 1 && i
> 0)
18496 row
->ends_in_middle_of_char_p
= 1;
18497 it
->starts_in_middle_of_char_p
= 1;
18500 /* Restore the height to what it was before the
18501 element not fitting on the line. */
18502 it
->max_ascent
= ascent
;
18503 it
->max_descent
= descent
;
18504 it
->max_phys_ascent
= phys_ascent
;
18505 it
->max_phys_descent
= phys_descent
;
18510 else if (new_x
> it
->first_visible_x
)
18512 /* Increment number of glyphs actually displayed. */
18515 /* Record the maximum and minimum buffer positions
18516 seen so far in glyphs that will be displayed by
18519 RECORD_MAX_MIN_POS (it
);
18521 if (x
< it
->first_visible_x
)
18522 /* Glyph is partially visible, i.e. row starts at
18523 negative X position. */
18524 row
->x
= x
- it
->first_visible_x
;
18528 /* Glyph is completely off the left margin of the
18529 window. This should not happen because of the
18530 move_it_in_display_line at the start of this
18531 function, unless the text display area of the
18532 window is empty. */
18533 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18537 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18538 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18539 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18540 row
->phys_height
= max (row
->phys_height
,
18541 it
->max_phys_ascent
+ it
->max_phys_descent
);
18542 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18543 it
->max_extra_line_spacing
);
18545 /* End of this display line if row is continued. */
18546 if (row
->continued_p
|| row
->ends_at_zv_p
)
18551 /* Is this a line end? If yes, we're also done, after making
18552 sure that a non-default face is extended up to the right
18553 margin of the window. */
18554 if (ITERATOR_AT_END_OF_LINE_P (it
))
18556 int used_before
= row
->used
[TEXT_AREA
];
18558 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18560 /* Add a space at the end of the line that is used to
18561 display the cursor there. */
18562 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18563 append_space_for_newline (it
, 0);
18565 /* Extend the face to the end of the line. */
18566 extend_face_to_end_of_line (it
);
18568 /* Make sure we have the position. */
18569 if (used_before
== 0)
18570 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18572 /* Record the position of the newline, for use in
18574 it
->eol_pos
= it
->current
.pos
;
18576 /* Consume the line end. This skips over invisible lines. */
18577 set_iterator_to_next (it
, 1);
18578 it
->continuation_lines_width
= 0;
18582 /* Proceed with next display element. Note that this skips
18583 over lines invisible because of selective display. */
18584 set_iterator_to_next (it
, 1);
18586 /* If we truncate lines, we are done when the last displayed
18587 glyphs reach past the right margin of the window. */
18588 if (it
->line_wrap
== TRUNCATE
18589 && (FRAME_WINDOW_P (it
->f
)
18590 ? (it
->current_x
>= it
->last_visible_x
)
18591 : (it
->current_x
> it
->last_visible_x
)))
18593 /* Maybe add truncation glyphs. */
18594 if (!FRAME_WINDOW_P (it
->f
))
18598 if (!row
->reversed_p
)
18600 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18601 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18606 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18607 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18609 /* Remove any padding glyphs at the front of ROW, to
18610 make room for the truncation glyphs we will be
18611 adding below. The loop below always inserts at
18612 least one truncation glyph, so also remove the
18613 last glyph added to ROW. */
18614 unproduce_glyphs (it
, i
+ 1);
18615 /* Adjust i for the loop below. */
18616 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18619 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18621 row
->used
[TEXT_AREA
] = i
;
18622 produce_special_glyphs (it
, IT_TRUNCATION
);
18625 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18627 /* Don't truncate if we can overflow newline into fringe. */
18628 if (!get_next_display_element (it
))
18630 it
->continuation_lines_width
= 0;
18631 row
->ends_at_zv_p
= 1;
18632 row
->exact_window_width_line_p
= 1;
18635 if (ITERATOR_AT_END_OF_LINE_P (it
))
18637 row
->exact_window_width_line_p
= 1;
18638 goto at_end_of_line
;
18642 row
->truncated_on_right_p
= 1;
18643 it
->continuation_lines_width
= 0;
18644 reseat_at_next_visible_line_start (it
, 0);
18645 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18646 it
->hpos
= hpos_before
;
18647 it
->current_x
= x_before
;
18652 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18653 at the left window margin. */
18654 if (it
->first_visible_x
18655 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18657 if (!FRAME_WINDOW_P (it
->f
))
18658 insert_left_trunc_glyphs (it
);
18659 row
->truncated_on_left_p
= 1;
18662 /* Remember the position at which this line ends.
18664 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18665 cannot be before the call to find_row_edges below, since that is
18666 where these positions are determined. */
18667 row
->end
= it
->current
;
18670 row
->minpos
= row
->start
.pos
;
18671 row
->maxpos
= row
->end
.pos
;
18675 /* ROW->minpos and ROW->maxpos must be the smallest and
18676 `1 + the largest' buffer positions in ROW. But if ROW was
18677 bidi-reordered, these two positions can be anywhere in the
18678 row, so we must determine them now. */
18679 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18682 /* If the start of this line is the overlay arrow-position, then
18683 mark this glyph row as the one containing the overlay arrow.
18684 This is clearly a mess with variable size fonts. It would be
18685 better to let it be displayed like cursors under X. */
18686 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18687 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18688 !NILP (overlay_arrow_string
)))
18690 /* Overlay arrow in window redisplay is a fringe bitmap. */
18691 if (STRINGP (overlay_arrow_string
))
18693 struct glyph_row
*arrow_row
18694 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18695 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18696 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18697 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18698 struct glyph
*p2
, *end
;
18700 /* Copy the arrow glyphs. */
18701 while (glyph
< arrow_end
)
18704 /* Throw away padding glyphs. */
18706 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18707 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18713 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18718 xassert (INTEGERP (overlay_arrow_string
));
18719 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18721 overlay_arrow_seen
= 1;
18724 /* Compute pixel dimensions of this line. */
18725 compute_line_metrics (it
);
18727 /* Record whether this row ends inside an ellipsis. */
18728 row
->ends_in_ellipsis_p
18729 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18730 && it
->ellipsis_p
);
18732 /* Save fringe bitmaps in this row. */
18733 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18734 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18735 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18736 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18738 it
->left_user_fringe_bitmap
= 0;
18739 it
->left_user_fringe_face_id
= 0;
18740 it
->right_user_fringe_bitmap
= 0;
18741 it
->right_user_fringe_face_id
= 0;
18743 /* Maybe set the cursor. */
18744 cvpos
= it
->w
->cursor
.vpos
;
18746 /* In bidi-reordered rows, keep checking for proper cursor
18747 position even if one has been found already, because buffer
18748 positions in such rows change non-linearly with ROW->VPOS,
18749 when a line is continued. One exception: when we are at ZV,
18750 display cursor on the first suitable glyph row, since all
18751 the empty rows after that also have their position set to ZV. */
18752 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18753 lines' rows is implemented for bidi-reordered rows. */
18755 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18756 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18757 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18758 && cursor_row_p (row
))
18759 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18761 /* Highlight trailing whitespace. */
18762 if (!NILP (Vshow_trailing_whitespace
))
18763 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18765 /* Prepare for the next line. This line starts horizontally at (X
18766 HPOS) = (0 0). Vertical positions are incremented. As a
18767 convenience for the caller, IT->glyph_row is set to the next
18769 it
->current_x
= it
->hpos
= 0;
18770 it
->current_y
+= row
->height
;
18771 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18774 /* The next row should by default use the same value of the
18775 reversed_p flag as this one. set_iterator_to_next decides when
18776 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18777 the flag accordingly. */
18778 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18779 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18780 it
->start
= row
->end
;
18781 return row
->displays_text_p
;
18783 #undef RECORD_MAX_MIN_POS
18786 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18787 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18788 doc
: /* Return paragraph direction at point in BUFFER.
18789 Value is either `left-to-right' or `right-to-left'.
18790 If BUFFER is omitted or nil, it defaults to the current buffer.
18792 Paragraph direction determines how the text in the paragraph is displayed.
18793 In left-to-right paragraphs, text begins at the left margin of the window
18794 and the reading direction is generally left to right. In right-to-left
18795 paragraphs, text begins at the right margin and is read from right to left.
18797 See also `bidi-paragraph-direction'. */)
18798 (Lisp_Object buffer
)
18800 struct buffer
*buf
= current_buffer
;
18801 struct buffer
*old
= buf
;
18803 if (! NILP (buffer
))
18805 CHECK_BUFFER (buffer
);
18806 buf
= XBUFFER (buffer
);
18809 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18810 return Qleft_to_right
;
18811 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18812 return BVAR (buf
, bidi_paragraph_direction
);
18815 /* Determine the direction from buffer text. We could try to
18816 use current_matrix if it is up to date, but this seems fast
18817 enough as it is. */
18818 struct bidi_it itb
;
18819 EMACS_INT pos
= BUF_PT (buf
);
18820 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18823 set_buffer_temp (buf
);
18824 /* bidi_paragraph_init finds the base direction of the paragraph
18825 by searching forward from paragraph start. We need the base
18826 direction of the current or _previous_ paragraph, so we need
18827 to make sure we are within that paragraph. To that end, find
18828 the previous non-empty line. */
18829 if (pos
>= ZV
&& pos
> BEGV
)
18832 bytepos
= CHAR_TO_BYTE (pos
);
18834 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18835 || c
== ' ' || c
== '\t' || c
== '\f')
18837 if (bytepos
<= BEGV_BYTE
)
18842 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18845 itb
.bytepos
= bytepos
;
18847 itb
.string
.s
= NULL
;
18848 itb
.string
.lstring
= Qnil
;
18849 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18851 itb
.separator_limit
= -1;
18852 itb
.paragraph_dir
= NEUTRAL_DIR
;
18854 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18855 set_buffer_temp (old
);
18856 switch (itb
.paragraph_dir
)
18859 return Qleft_to_right
;
18862 return Qright_to_left
;
18872 /***********************************************************************
18874 ***********************************************************************/
18876 /* Redisplay the menu bar in the frame for window W.
18878 The menu bar of X frames that don't have X toolkit support is
18879 displayed in a special window W->frame->menu_bar_window.
18881 The menu bar of terminal frames is treated specially as far as
18882 glyph matrices are concerned. Menu bar lines are not part of
18883 windows, so the update is done directly on the frame matrix rows
18884 for the menu bar. */
18887 display_menu_bar (struct window
*w
)
18889 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18894 /* Don't do all this for graphical frames. */
18896 if (FRAME_W32_P (f
))
18899 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18905 if (FRAME_NS_P (f
))
18907 #endif /* HAVE_NS */
18909 #ifdef USE_X_TOOLKIT
18910 xassert (!FRAME_WINDOW_P (f
));
18911 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18912 it
.first_visible_x
= 0;
18913 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18914 #else /* not USE_X_TOOLKIT */
18915 if (FRAME_WINDOW_P (f
))
18917 /* Menu bar lines are displayed in the desired matrix of the
18918 dummy window menu_bar_window. */
18919 struct window
*menu_w
;
18920 xassert (WINDOWP (f
->menu_bar_window
));
18921 menu_w
= XWINDOW (f
->menu_bar_window
);
18922 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18924 it
.first_visible_x
= 0;
18925 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18929 /* This is a TTY frame, i.e. character hpos/vpos are used as
18931 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18933 it
.first_visible_x
= 0;
18934 it
.last_visible_x
= FRAME_COLS (f
);
18936 #endif /* not USE_X_TOOLKIT */
18938 /* FIXME: This should be controlled by a user option. See the
18939 comments in redisplay_tool_bar and display_mode_line about
18941 it
.paragraph_embedding
= L2R
;
18943 if (! mode_line_inverse_video
)
18944 /* Force the menu-bar to be displayed in the default face. */
18945 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18947 /* Clear all rows of the menu bar. */
18948 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18950 struct glyph_row
*row
= it
.glyph_row
+ i
;
18951 clear_glyph_row (row
);
18952 row
->enabled_p
= 1;
18953 row
->full_width_p
= 1;
18956 /* Display all items of the menu bar. */
18957 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18958 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18960 Lisp_Object string
;
18962 /* Stop at nil string. */
18963 string
= AREF (items
, i
+ 1);
18967 /* Remember where item was displayed. */
18968 ASET (items
, i
+ 3, make_number (it
.hpos
));
18970 /* Display the item, pad with one space. */
18971 if (it
.current_x
< it
.last_visible_x
)
18972 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18973 SCHARS (string
) + 1, 0, 0, -1);
18976 /* Fill out the line with spaces. */
18977 if (it
.current_x
< it
.last_visible_x
)
18978 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18980 /* Compute the total height of the lines. */
18981 compute_line_metrics (&it
);
18986 /***********************************************************************
18988 ***********************************************************************/
18990 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18991 FORCE is non-zero, redisplay mode lines unconditionally.
18992 Otherwise, redisplay only mode lines that are garbaged. Value is
18993 the number of windows whose mode lines were redisplayed. */
18996 redisplay_mode_lines (Lisp_Object window
, int force
)
19000 while (!NILP (window
))
19002 struct window
*w
= XWINDOW (window
);
19004 if (WINDOWP (w
->hchild
))
19005 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19006 else if (WINDOWP (w
->vchild
))
19007 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19009 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19010 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19012 struct text_pos lpoint
;
19013 struct buffer
*old
= current_buffer
;
19015 /* Set the window's buffer for the mode line display. */
19016 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19017 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19019 /* Point refers normally to the selected window. For any
19020 other window, set up appropriate value. */
19021 if (!EQ (window
, selected_window
))
19023 struct text_pos pt
;
19025 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19026 if (CHARPOS (pt
) < BEGV
)
19027 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19028 else if (CHARPOS (pt
) > (ZV
- 1))
19029 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19031 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19034 /* Display mode lines. */
19035 clear_glyph_matrix (w
->desired_matrix
);
19036 if (display_mode_lines (w
))
19039 w
->must_be_updated_p
= 1;
19042 /* Restore old settings. */
19043 set_buffer_internal_1 (old
);
19044 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19054 /* Display the mode and/or header line of window W. Value is the
19055 sum number of mode lines and header lines displayed. */
19058 display_mode_lines (struct window
*w
)
19060 Lisp_Object old_selected_window
, old_selected_frame
;
19063 old_selected_frame
= selected_frame
;
19064 selected_frame
= w
->frame
;
19065 old_selected_window
= selected_window
;
19066 XSETWINDOW (selected_window
, w
);
19068 /* These will be set while the mode line specs are processed. */
19069 line_number_displayed
= 0;
19070 w
->column_number_displayed
= Qnil
;
19072 if (WINDOW_WANTS_MODELINE_P (w
))
19074 struct window
*sel_w
= XWINDOW (old_selected_window
);
19076 /* Select mode line face based on the real selected window. */
19077 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19078 BVAR (current_buffer
, mode_line_format
));
19082 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19084 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19085 BVAR (current_buffer
, header_line_format
));
19089 selected_frame
= old_selected_frame
;
19090 selected_window
= old_selected_window
;
19095 /* Display mode or header line of window W. FACE_ID specifies which
19096 line to display; it is either MODE_LINE_FACE_ID or
19097 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19098 display. Value is the pixel height of the mode/header line
19102 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19106 int count
= SPECPDL_INDEX ();
19108 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19109 /* Don't extend on a previously drawn mode-line.
19110 This may happen if called from pos_visible_p. */
19111 it
.glyph_row
->enabled_p
= 0;
19112 prepare_desired_row (it
.glyph_row
);
19114 it
.glyph_row
->mode_line_p
= 1;
19116 if (! mode_line_inverse_video
)
19117 /* Force the mode-line to be displayed in the default face. */
19118 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19120 /* FIXME: This should be controlled by a user option. But
19121 supporting such an option is not trivial, since the mode line is
19122 made up of many separate strings. */
19123 it
.paragraph_embedding
= L2R
;
19125 record_unwind_protect (unwind_format_mode_line
,
19126 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19128 mode_line_target
= MODE_LINE_DISPLAY
;
19130 /* Temporarily make frame's keyboard the current kboard so that
19131 kboard-local variables in the mode_line_format will get the right
19133 push_kboard (FRAME_KBOARD (it
.f
));
19134 record_unwind_save_match_data ();
19135 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19138 unbind_to (count
, Qnil
);
19140 /* Fill up with spaces. */
19141 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19143 compute_line_metrics (&it
);
19144 it
.glyph_row
->full_width_p
= 1;
19145 it
.glyph_row
->continued_p
= 0;
19146 it
.glyph_row
->truncated_on_left_p
= 0;
19147 it
.glyph_row
->truncated_on_right_p
= 0;
19149 /* Make a 3D mode-line have a shadow at its right end. */
19150 face
= FACE_FROM_ID (it
.f
, face_id
);
19151 extend_face_to_end_of_line (&it
);
19152 if (face
->box
!= FACE_NO_BOX
)
19154 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19155 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19156 last
->right_box_line_p
= 1;
19159 return it
.glyph_row
->height
;
19162 /* Move element ELT in LIST to the front of LIST.
19163 Return the updated list. */
19166 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19168 register Lisp_Object tail
, prev
;
19169 register Lisp_Object tem
;
19173 while (CONSP (tail
))
19179 /* Splice out the link TAIL. */
19181 list
= XCDR (tail
);
19183 Fsetcdr (prev
, XCDR (tail
));
19185 /* Now make it the first. */
19186 Fsetcdr (tail
, list
);
19191 tail
= XCDR (tail
);
19195 /* Not found--return unchanged LIST. */
19199 /* Contribute ELT to the mode line for window IT->w. How it
19200 translates into text depends on its data type.
19202 IT describes the display environment in which we display, as usual.
19204 DEPTH is the depth in recursion. It is used to prevent
19205 infinite recursion here.
19207 FIELD_WIDTH is the number of characters the display of ELT should
19208 occupy in the mode line, and PRECISION is the maximum number of
19209 characters to display from ELT's representation. See
19210 display_string for details.
19212 Returns the hpos of the end of the text generated by ELT.
19214 PROPS is a property list to add to any string we encounter.
19216 If RISKY is nonzero, remove (disregard) any properties in any string
19217 we encounter, and ignore :eval and :propertize.
19219 The global variable `mode_line_target' determines whether the
19220 output is passed to `store_mode_line_noprop',
19221 `store_mode_line_string', or `display_string'. */
19224 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19225 Lisp_Object elt
, Lisp_Object props
, int risky
)
19227 int n
= 0, field
, prec
;
19232 elt
= build_string ("*too-deep*");
19236 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19240 /* A string: output it and check for %-constructs within it. */
19242 EMACS_INT offset
= 0;
19244 if (SCHARS (elt
) > 0
19245 && (!NILP (props
) || risky
))
19247 Lisp_Object oprops
, aelt
;
19248 oprops
= Ftext_properties_at (make_number (0), elt
);
19250 /* If the starting string's properties are not what
19251 we want, translate the string. Also, if the string
19252 is risky, do that anyway. */
19254 if (NILP (Fequal (props
, oprops
)) || risky
)
19256 /* If the starting string has properties,
19257 merge the specified ones onto the existing ones. */
19258 if (! NILP (oprops
) && !risky
)
19262 oprops
= Fcopy_sequence (oprops
);
19264 while (CONSP (tem
))
19266 oprops
= Fplist_put (oprops
, XCAR (tem
),
19267 XCAR (XCDR (tem
)));
19268 tem
= XCDR (XCDR (tem
));
19273 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19274 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19276 /* AELT is what we want. Move it to the front
19277 without consing. */
19279 mode_line_proptrans_alist
19280 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19286 /* If AELT has the wrong props, it is useless.
19287 so get rid of it. */
19289 mode_line_proptrans_alist
19290 = Fdelq (aelt
, mode_line_proptrans_alist
);
19292 elt
= Fcopy_sequence (elt
);
19293 Fset_text_properties (make_number (0), Flength (elt
),
19295 /* Add this item to mode_line_proptrans_alist. */
19296 mode_line_proptrans_alist
19297 = Fcons (Fcons (elt
, props
),
19298 mode_line_proptrans_alist
);
19299 /* Truncate mode_line_proptrans_alist
19300 to at most 50 elements. */
19301 tem
= Fnthcdr (make_number (50),
19302 mode_line_proptrans_alist
);
19304 XSETCDR (tem
, Qnil
);
19313 prec
= precision
- n
;
19314 switch (mode_line_target
)
19316 case MODE_LINE_NOPROP
:
19317 case MODE_LINE_TITLE
:
19318 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19320 case MODE_LINE_STRING
:
19321 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19323 case MODE_LINE_DISPLAY
:
19324 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19325 0, prec
, 0, STRING_MULTIBYTE (elt
));
19332 /* Handle the non-literal case. */
19334 while ((precision
<= 0 || n
< precision
)
19335 && SREF (elt
, offset
) != 0
19336 && (mode_line_target
!= MODE_LINE_DISPLAY
19337 || it
->current_x
< it
->last_visible_x
))
19339 EMACS_INT last_offset
= offset
;
19341 /* Advance to end of string or next format specifier. */
19342 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19345 if (offset
- 1 != last_offset
)
19347 EMACS_INT nchars
, nbytes
;
19349 /* Output to end of string or up to '%'. Field width
19350 is length of string. Don't output more than
19351 PRECISION allows us. */
19354 prec
= c_string_width (SDATA (elt
) + last_offset
,
19355 offset
- last_offset
, precision
- n
,
19358 switch (mode_line_target
)
19360 case MODE_LINE_NOPROP
:
19361 case MODE_LINE_TITLE
:
19362 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19364 case MODE_LINE_STRING
:
19366 EMACS_INT bytepos
= last_offset
;
19367 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19368 EMACS_INT endpos
= (precision
<= 0
19369 ? string_byte_to_char (elt
, offset
)
19370 : charpos
+ nchars
);
19372 n
+= store_mode_line_string (NULL
,
19373 Fsubstring (elt
, make_number (charpos
),
19374 make_number (endpos
)),
19378 case MODE_LINE_DISPLAY
:
19380 EMACS_INT bytepos
= last_offset
;
19381 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19383 if (precision
<= 0)
19384 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19385 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19387 STRING_MULTIBYTE (elt
));
19392 else /* c == '%' */
19394 EMACS_INT percent_position
= offset
;
19396 /* Get the specified minimum width. Zero means
19399 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19400 field
= field
* 10 + c
- '0';
19402 /* Don't pad beyond the total padding allowed. */
19403 if (field_width
- n
> 0 && field
> field_width
- n
)
19404 field
= field_width
- n
;
19406 /* Note that either PRECISION <= 0 or N < PRECISION. */
19407 prec
= precision
- n
;
19410 n
+= display_mode_element (it
, depth
, field
, prec
,
19411 Vglobal_mode_string
, props
,
19416 EMACS_INT bytepos
, charpos
;
19418 Lisp_Object string
;
19420 bytepos
= percent_position
;
19421 charpos
= (STRING_MULTIBYTE (elt
)
19422 ? string_byte_to_char (elt
, bytepos
)
19424 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19425 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19427 switch (mode_line_target
)
19429 case MODE_LINE_NOPROP
:
19430 case MODE_LINE_TITLE
:
19431 n
+= store_mode_line_noprop (spec
, field
, prec
);
19433 case MODE_LINE_STRING
:
19435 Lisp_Object tem
= build_string (spec
);
19436 props
= Ftext_properties_at (make_number (charpos
), elt
);
19437 /* Should only keep face property in props */
19438 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19441 case MODE_LINE_DISPLAY
:
19443 int nglyphs_before
, nwritten
;
19445 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19446 nwritten
= display_string (spec
, string
, elt
,
19451 /* Assign to the glyphs written above the
19452 string where the `%x' came from, position
19456 struct glyph
*glyph
19457 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19461 for (i
= 0; i
< nwritten
; ++i
)
19463 glyph
[i
].object
= elt
;
19464 glyph
[i
].charpos
= charpos
;
19481 /* A symbol: process the value of the symbol recursively
19482 as if it appeared here directly. Avoid error if symbol void.
19483 Special case: if value of symbol is a string, output the string
19486 register Lisp_Object tem
;
19488 /* If the variable is not marked as risky to set
19489 then its contents are risky to use. */
19490 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19493 tem
= Fboundp (elt
);
19496 tem
= Fsymbol_value (elt
);
19497 /* If value is a string, output that string literally:
19498 don't check for % within it. */
19502 if (!EQ (tem
, elt
))
19504 /* Give up right away for nil or t. */
19514 register Lisp_Object car
, tem
;
19516 /* A cons cell: five distinct cases.
19517 If first element is :eval or :propertize, do something special.
19518 If first element is a string or a cons, process all the elements
19519 and effectively concatenate them.
19520 If first element is a negative number, truncate displaying cdr to
19521 at most that many characters. If positive, pad (with spaces)
19522 to at least that many characters.
19523 If first element is a symbol, process the cadr or caddr recursively
19524 according to whether the symbol's value is non-nil or nil. */
19526 if (EQ (car
, QCeval
))
19528 /* An element of the form (:eval FORM) means evaluate FORM
19529 and use the result as mode line elements. */
19534 if (CONSP (XCDR (elt
)))
19537 spec
= safe_eval (XCAR (XCDR (elt
)));
19538 n
+= display_mode_element (it
, depth
, field_width
- n
,
19539 precision
- n
, spec
, props
,
19543 else if (EQ (car
, QCpropertize
))
19545 /* An element of the form (:propertize ELT PROPS...)
19546 means display ELT but applying properties PROPS. */
19551 if (CONSP (XCDR (elt
)))
19552 n
+= display_mode_element (it
, depth
, field_width
- n
,
19553 precision
- n
, XCAR (XCDR (elt
)),
19554 XCDR (XCDR (elt
)), risky
);
19556 else if (SYMBOLP (car
))
19558 tem
= Fboundp (car
);
19562 /* elt is now the cdr, and we know it is a cons cell.
19563 Use its car if CAR has a non-nil value. */
19566 tem
= Fsymbol_value (car
);
19573 /* Symbol's value is nil (or symbol is unbound)
19574 Get the cddr of the original list
19575 and if possible find the caddr and use that. */
19579 else if (!CONSP (elt
))
19584 else if (INTEGERP (car
))
19586 register int lim
= XINT (car
);
19590 /* Negative int means reduce maximum width. */
19591 if (precision
<= 0)
19594 precision
= min (precision
, -lim
);
19598 /* Padding specified. Don't let it be more than
19599 current maximum. */
19601 lim
= min (precision
, lim
);
19603 /* If that's more padding than already wanted, queue it.
19604 But don't reduce padding already specified even if
19605 that is beyond the current truncation point. */
19606 field_width
= max (lim
, field_width
);
19610 else if (STRINGP (car
) || CONSP (car
))
19612 Lisp_Object halftail
= elt
;
19616 && (precision
<= 0 || n
< precision
))
19618 n
+= display_mode_element (it
, depth
,
19619 /* Do padding only after the last
19620 element in the list. */
19621 (! CONSP (XCDR (elt
))
19624 precision
- n
, XCAR (elt
),
19628 if ((len
& 1) == 0)
19629 halftail
= XCDR (halftail
);
19630 /* Check for cycle. */
19631 if (EQ (halftail
, elt
))
19640 elt
= build_string ("*invalid*");
19644 /* Pad to FIELD_WIDTH. */
19645 if (field_width
> 0 && n
< field_width
)
19647 switch (mode_line_target
)
19649 case MODE_LINE_NOPROP
:
19650 case MODE_LINE_TITLE
:
19651 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19653 case MODE_LINE_STRING
:
19654 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19656 case MODE_LINE_DISPLAY
:
19657 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19666 /* Store a mode-line string element in mode_line_string_list.
19668 If STRING is non-null, display that C string. Otherwise, the Lisp
19669 string LISP_STRING is displayed.
19671 FIELD_WIDTH is the minimum number of output glyphs to produce.
19672 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19673 with spaces. FIELD_WIDTH <= 0 means don't pad.
19675 PRECISION is the maximum number of characters to output from
19676 STRING. PRECISION <= 0 means don't truncate the string.
19678 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19679 properties to the string.
19681 PROPS are the properties to add to the string.
19682 The mode_line_string_face face property is always added to the string.
19686 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19687 int field_width
, int precision
, Lisp_Object props
)
19692 if (string
!= NULL
)
19694 len
= strlen (string
);
19695 if (precision
> 0 && len
> precision
)
19697 lisp_string
= make_string (string
, len
);
19699 props
= mode_line_string_face_prop
;
19700 else if (!NILP (mode_line_string_face
))
19702 Lisp_Object face
= Fplist_get (props
, Qface
);
19703 props
= Fcopy_sequence (props
);
19705 face
= mode_line_string_face
;
19707 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19708 props
= Fplist_put (props
, Qface
, face
);
19710 Fadd_text_properties (make_number (0), make_number (len
),
19711 props
, lisp_string
);
19715 len
= XFASTINT (Flength (lisp_string
));
19716 if (precision
> 0 && len
> precision
)
19719 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19722 if (!NILP (mode_line_string_face
))
19726 props
= Ftext_properties_at (make_number (0), lisp_string
);
19727 face
= Fplist_get (props
, Qface
);
19729 face
= mode_line_string_face
;
19731 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19732 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19734 lisp_string
= Fcopy_sequence (lisp_string
);
19737 Fadd_text_properties (make_number (0), make_number (len
),
19738 props
, lisp_string
);
19743 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19747 if (field_width
> len
)
19749 field_width
-= len
;
19750 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19752 Fadd_text_properties (make_number (0), make_number (field_width
),
19753 props
, lisp_string
);
19754 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19762 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19764 doc
: /* Format a string out of a mode line format specification.
19765 First arg FORMAT specifies the mode line format (see `mode-line-format'
19766 for details) to use.
19768 By default, the format is evaluated for the currently selected window.
19770 Optional second arg FACE specifies the face property to put on all
19771 characters for which no face is specified. The value nil means the
19772 default face. The value t means whatever face the window's mode line
19773 currently uses (either `mode-line' or `mode-line-inactive',
19774 depending on whether the window is the selected window or not).
19775 An integer value means the value string has no text
19778 Optional third and fourth args WINDOW and BUFFER specify the window
19779 and buffer to use as the context for the formatting (defaults
19780 are the selected window and the WINDOW's buffer). */)
19781 (Lisp_Object format
, Lisp_Object face
,
19782 Lisp_Object window
, Lisp_Object buffer
)
19787 struct buffer
*old_buffer
= NULL
;
19789 int no_props
= INTEGERP (face
);
19790 int count
= SPECPDL_INDEX ();
19792 int string_start
= 0;
19795 window
= selected_window
;
19796 CHECK_WINDOW (window
);
19797 w
= XWINDOW (window
);
19800 buffer
= w
->buffer
;
19801 CHECK_BUFFER (buffer
);
19803 /* Make formatting the modeline a non-op when noninteractive, otherwise
19804 there will be problems later caused by a partially initialized frame. */
19805 if (NILP (format
) || noninteractive
)
19806 return empty_unibyte_string
;
19811 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19812 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19813 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19814 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19815 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19816 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19817 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19820 if (XBUFFER (buffer
) != current_buffer
)
19821 old_buffer
= current_buffer
;
19823 /* Save things including mode_line_proptrans_alist,
19824 and set that to nil so that we don't alter the outer value. */
19825 record_unwind_protect (unwind_format_mode_line
,
19826 format_mode_line_unwind_data
19827 (old_buffer
, selected_window
, 1));
19828 mode_line_proptrans_alist
= Qnil
;
19830 Fselect_window (window
, Qt
);
19832 set_buffer_internal_1 (XBUFFER (buffer
));
19834 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19838 mode_line_target
= MODE_LINE_NOPROP
;
19839 mode_line_string_face_prop
= Qnil
;
19840 mode_line_string_list
= Qnil
;
19841 string_start
= MODE_LINE_NOPROP_LEN (0);
19845 mode_line_target
= MODE_LINE_STRING
;
19846 mode_line_string_list
= Qnil
;
19847 mode_line_string_face
= face
;
19848 mode_line_string_face_prop
19849 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19852 push_kboard (FRAME_KBOARD (it
.f
));
19853 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19858 len
= MODE_LINE_NOPROP_LEN (string_start
);
19859 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19863 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19864 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19865 empty_unibyte_string
);
19868 unbind_to (count
, Qnil
);
19872 /* Write a null-terminated, right justified decimal representation of
19873 the positive integer D to BUF using a minimal field width WIDTH. */
19876 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19878 register char *p
= buf
;
19886 *p
++ = d
% 10 + '0';
19891 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19902 /* Write a null-terminated, right justified decimal and "human
19903 readable" representation of the nonnegative integer D to BUF using
19904 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19906 static const char power_letter
[] =
19920 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19922 /* We aim to represent the nonnegative integer D as
19923 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19924 EMACS_INT quotient
= d
;
19926 /* -1 means: do not use TENTHS. */
19930 /* Length of QUOTIENT.TENTHS as a string. */
19936 if (1000 <= quotient
)
19938 /* Scale to the appropriate EXPONENT. */
19941 remainder
= quotient
% 1000;
19945 while (1000 <= quotient
);
19947 /* Round to nearest and decide whether to use TENTHS or not. */
19950 tenths
= remainder
/ 100;
19951 if (50 <= remainder
% 100)
19958 if (quotient
== 10)
19966 if (500 <= remainder
)
19968 if (quotient
< 999)
19979 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19980 if (tenths
== -1 && quotient
<= 99)
19987 p
= psuffix
= buf
+ max (width
, length
);
19989 /* Print EXPONENT. */
19990 *psuffix
++ = power_letter
[exponent
];
19993 /* Print TENTHS. */
19996 *--p
= '0' + tenths
;
20000 /* Print QUOTIENT. */
20003 int digit
= quotient
% 10;
20004 *--p
= '0' + digit
;
20006 while ((quotient
/= 10) != 0);
20008 /* Print leading spaces. */
20013 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20014 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20015 type of CODING_SYSTEM. Return updated pointer into BUF. */
20017 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20020 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20023 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20024 const unsigned char *eol_str
;
20026 /* The EOL conversion we are using. */
20027 Lisp_Object eoltype
;
20029 val
= CODING_SYSTEM_SPEC (coding_system
);
20032 if (!VECTORP (val
)) /* Not yet decided. */
20037 eoltype
= eol_mnemonic_undecided
;
20038 /* Don't mention EOL conversion if it isn't decided. */
20043 Lisp_Object eolvalue
;
20045 attrs
= AREF (val
, 0);
20046 eolvalue
= AREF (val
, 2);
20049 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20053 /* The EOL conversion that is normal on this system. */
20055 if (NILP (eolvalue
)) /* Not yet decided. */
20056 eoltype
= eol_mnemonic_undecided
;
20057 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20058 eoltype
= eol_mnemonic_undecided
;
20059 else /* eolvalue is Qunix, Qdos, or Qmac. */
20060 eoltype
= (EQ (eolvalue
, Qunix
)
20061 ? eol_mnemonic_unix
20062 : (EQ (eolvalue
, Qdos
) == 1
20063 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20069 /* Mention the EOL conversion if it is not the usual one. */
20070 if (STRINGP (eoltype
))
20072 eol_str
= SDATA (eoltype
);
20073 eol_str_len
= SBYTES (eoltype
);
20075 else if (CHARACTERP (eoltype
))
20077 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20078 int c
= XFASTINT (eoltype
);
20079 eol_str_len
= CHAR_STRING (c
, tmp
);
20084 eol_str
= invalid_eol_type
;
20085 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20087 memcpy (buf
, eol_str
, eol_str_len
);
20088 buf
+= eol_str_len
;
20094 /* Return a string for the output of a mode line %-spec for window W,
20095 generated by character C. FIELD_WIDTH > 0 means pad the string
20096 returned with spaces to that value. Return a Lisp string in
20097 *STRING if the resulting string is taken from that Lisp string.
20099 Note we operate on the current buffer for most purposes,
20100 the exception being w->base_line_pos. */
20102 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20104 static const char *
20105 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20106 Lisp_Object
*string
)
20109 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20110 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20111 struct buffer
*b
= current_buffer
;
20119 if (!NILP (BVAR (b
, read_only
)))
20121 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20126 /* This differs from %* only for a modified read-only buffer. */
20127 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20129 if (!NILP (BVAR (b
, read_only
)))
20134 /* This differs from %* in ignoring read-only-ness. */
20135 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20147 if (command_loop_level
> 5)
20149 p
= decode_mode_spec_buf
;
20150 for (i
= 0; i
< command_loop_level
; i
++)
20153 return decode_mode_spec_buf
;
20161 if (command_loop_level
> 5)
20163 p
= decode_mode_spec_buf
;
20164 for (i
= 0; i
< command_loop_level
; i
++)
20167 return decode_mode_spec_buf
;
20174 /* Let lots_of_dashes be a string of infinite length. */
20175 if (mode_line_target
== MODE_LINE_NOPROP
||
20176 mode_line_target
== MODE_LINE_STRING
)
20178 if (field_width
<= 0
20179 || field_width
> sizeof (lots_of_dashes
))
20181 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20182 decode_mode_spec_buf
[i
] = '-';
20183 decode_mode_spec_buf
[i
] = '\0';
20184 return decode_mode_spec_buf
;
20187 return lots_of_dashes
;
20191 obj
= BVAR (b
, name
);
20195 /* %c and %l are ignored in `frame-title-format'.
20196 (In redisplay_internal, the frame title is drawn _before_ the
20197 windows are updated, so the stuff which depends on actual
20198 window contents (such as %l) may fail to render properly, or
20199 even crash emacs.) */
20200 if (mode_line_target
== MODE_LINE_TITLE
)
20204 EMACS_INT col
= current_column ();
20205 w
->column_number_displayed
= make_number (col
);
20206 pint2str (decode_mode_spec_buf
, field_width
, col
);
20207 return decode_mode_spec_buf
;
20211 #ifndef SYSTEM_MALLOC
20213 if (NILP (Vmemory_full
))
20216 return "!MEM FULL! ";
20223 /* %F displays the frame name. */
20224 if (!NILP (f
->title
))
20225 return SSDATA (f
->title
);
20226 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20227 return SSDATA (f
->name
);
20231 obj
= BVAR (b
, filename
);
20236 EMACS_INT size
= ZV
- BEGV
;
20237 pint2str (decode_mode_spec_buf
, field_width
, size
);
20238 return decode_mode_spec_buf
;
20243 EMACS_INT size
= ZV
- BEGV
;
20244 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20245 return decode_mode_spec_buf
;
20250 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20251 EMACS_INT topline
, nlines
, height
;
20254 /* %c and %l are ignored in `frame-title-format'. */
20255 if (mode_line_target
== MODE_LINE_TITLE
)
20258 startpos
= XMARKER (w
->start
)->charpos
;
20259 startpos_byte
= marker_byte_position (w
->start
);
20260 height
= WINDOW_TOTAL_LINES (w
);
20262 /* If we decided that this buffer isn't suitable for line numbers,
20263 don't forget that too fast. */
20264 if (EQ (w
->base_line_pos
, w
->buffer
))
20266 /* But do forget it, if the window shows a different buffer now. */
20267 else if (BUFFERP (w
->base_line_pos
))
20268 w
->base_line_pos
= Qnil
;
20270 /* If the buffer is very big, don't waste time. */
20271 if (INTEGERP (Vline_number_display_limit
)
20272 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20274 w
->base_line_pos
= Qnil
;
20275 w
->base_line_number
= Qnil
;
20279 if (INTEGERP (w
->base_line_number
)
20280 && INTEGERP (w
->base_line_pos
)
20281 && XFASTINT (w
->base_line_pos
) <= startpos
)
20283 line
= XFASTINT (w
->base_line_number
);
20284 linepos
= XFASTINT (w
->base_line_pos
);
20285 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20290 linepos
= BUF_BEGV (b
);
20291 linepos_byte
= BUF_BEGV_BYTE (b
);
20294 /* Count lines from base line to window start position. */
20295 nlines
= display_count_lines (linepos_byte
,
20299 topline
= nlines
+ line
;
20301 /* Determine a new base line, if the old one is too close
20302 or too far away, or if we did not have one.
20303 "Too close" means it's plausible a scroll-down would
20304 go back past it. */
20305 if (startpos
== BUF_BEGV (b
))
20307 w
->base_line_number
= make_number (topline
);
20308 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20310 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20311 || linepos
== BUF_BEGV (b
))
20313 EMACS_INT limit
= BUF_BEGV (b
);
20314 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20315 EMACS_INT position
;
20316 EMACS_INT distance
=
20317 (height
* 2 + 30) * line_number_display_limit_width
;
20319 if (startpos
- distance
> limit
)
20321 limit
= startpos
- distance
;
20322 limit_byte
= CHAR_TO_BYTE (limit
);
20325 nlines
= display_count_lines (startpos_byte
,
20327 - (height
* 2 + 30),
20329 /* If we couldn't find the lines we wanted within
20330 line_number_display_limit_width chars per line,
20331 give up on line numbers for this window. */
20332 if (position
== limit_byte
&& limit
== startpos
- distance
)
20334 w
->base_line_pos
= w
->buffer
;
20335 w
->base_line_number
= Qnil
;
20339 w
->base_line_number
= make_number (topline
- nlines
);
20340 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20343 /* Now count lines from the start pos to point. */
20344 nlines
= display_count_lines (startpos_byte
,
20345 PT_BYTE
, PT
, &junk
);
20347 /* Record that we did display the line number. */
20348 line_number_displayed
= 1;
20350 /* Make the string to show. */
20351 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20352 return decode_mode_spec_buf
;
20355 char* p
= decode_mode_spec_buf
;
20356 int pad
= field_width
- 2;
20362 return decode_mode_spec_buf
;
20368 obj
= BVAR (b
, mode_name
);
20372 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20378 EMACS_INT pos
= marker_position (w
->start
);
20379 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20381 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20383 if (pos
<= BUF_BEGV (b
))
20388 else if (pos
<= BUF_BEGV (b
))
20392 if (total
> 1000000)
20393 /* Do it differently for a large value, to avoid overflow. */
20394 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20396 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20397 /* We can't normally display a 3-digit number,
20398 so get us a 2-digit number that is close. */
20401 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20402 return decode_mode_spec_buf
;
20406 /* Display percentage of size above the bottom of the screen. */
20409 EMACS_INT toppos
= marker_position (w
->start
);
20410 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20411 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20413 if (botpos
>= BUF_ZV (b
))
20415 if (toppos
<= BUF_BEGV (b
))
20422 if (total
> 1000000)
20423 /* Do it differently for a large value, to avoid overflow. */
20424 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20426 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20427 /* We can't normally display a 3-digit number,
20428 so get us a 2-digit number that is close. */
20431 if (toppos
<= BUF_BEGV (b
))
20432 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20434 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20435 return decode_mode_spec_buf
;
20440 /* status of process */
20441 obj
= Fget_buffer_process (Fcurrent_buffer ());
20443 return "no process";
20445 obj
= Fsymbol_name (Fprocess_status (obj
));
20451 int count
= inhibit_garbage_collection ();
20452 Lisp_Object val
= call1 (intern ("file-remote-p"),
20453 BVAR (current_buffer
, directory
));
20454 unbind_to (count
, Qnil
);
20462 case 't': /* indicate TEXT or BINARY */
20466 /* coding-system (not including end-of-line format) */
20468 /* coding-system (including end-of-line type) */
20470 int eol_flag
= (c
== 'Z');
20471 char *p
= decode_mode_spec_buf
;
20473 if (! FRAME_WINDOW_P (f
))
20475 /* No need to mention EOL here--the terminal never needs
20476 to do EOL conversion. */
20477 p
= decode_mode_spec_coding (CODING_ID_NAME
20478 (FRAME_KEYBOARD_CODING (f
)->id
),
20480 p
= decode_mode_spec_coding (CODING_ID_NAME
20481 (FRAME_TERMINAL_CODING (f
)->id
),
20484 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20487 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20488 #ifdef subprocesses
20489 obj
= Fget_buffer_process (Fcurrent_buffer ());
20490 if (PROCESSP (obj
))
20492 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20494 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20497 #endif /* subprocesses */
20500 return decode_mode_spec_buf
;
20507 return SSDATA (obj
);
20514 /* Count up to COUNT lines starting from START_BYTE.
20515 But don't go beyond LIMIT_BYTE.
20516 Return the number of lines thus found (always nonnegative).
20518 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20521 display_count_lines (EMACS_INT start_byte
,
20522 EMACS_INT limit_byte
, EMACS_INT count
,
20523 EMACS_INT
*byte_pos_ptr
)
20525 register unsigned char *cursor
;
20526 unsigned char *base
;
20528 register EMACS_INT ceiling
;
20529 register unsigned char *ceiling_addr
;
20530 EMACS_INT orig_count
= count
;
20532 /* If we are not in selective display mode,
20533 check only for newlines. */
20534 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20535 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20539 while (start_byte
< limit_byte
)
20541 ceiling
= BUFFER_CEILING_OF (start_byte
);
20542 ceiling
= min (limit_byte
- 1, ceiling
);
20543 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20544 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20547 if (selective_display
)
20548 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20551 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20554 if (cursor
!= ceiling_addr
)
20558 start_byte
+= cursor
- base
+ 1;
20559 *byte_pos_ptr
= start_byte
;
20563 if (++cursor
== ceiling_addr
)
20569 start_byte
+= cursor
- base
;
20574 while (start_byte
> limit_byte
)
20576 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20577 ceiling
= max (limit_byte
, ceiling
);
20578 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20579 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20582 if (selective_display
)
20583 while (--cursor
!= ceiling_addr
20584 && *cursor
!= '\n' && *cursor
!= 015)
20587 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20590 if (cursor
!= ceiling_addr
)
20594 start_byte
+= cursor
- base
+ 1;
20595 *byte_pos_ptr
= start_byte
;
20596 /* When scanning backwards, we should
20597 not count the newline posterior to which we stop. */
20598 return - orig_count
- 1;
20604 /* Here we add 1 to compensate for the last decrement
20605 of CURSOR, which took it past the valid range. */
20606 start_byte
+= cursor
- base
+ 1;
20610 *byte_pos_ptr
= limit_byte
;
20613 return - orig_count
+ count
;
20614 return orig_count
- count
;
20620 /***********************************************************************
20622 ***********************************************************************/
20624 /* Display a NUL-terminated string, starting with index START.
20626 If STRING is non-null, display that C string. Otherwise, the Lisp
20627 string LISP_STRING is displayed. There's a case that STRING is
20628 non-null and LISP_STRING is not nil. It means STRING is a string
20629 data of LISP_STRING. In that case, we display LISP_STRING while
20630 ignoring its text properties.
20632 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20633 FACE_STRING. Display STRING or LISP_STRING with the face at
20634 FACE_STRING_POS in FACE_STRING:
20636 Display the string in the environment given by IT, but use the
20637 standard display table, temporarily.
20639 FIELD_WIDTH is the minimum number of output glyphs to produce.
20640 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20641 with spaces. If STRING has more characters, more than FIELD_WIDTH
20642 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20644 PRECISION is the maximum number of characters to output from
20645 STRING. PRECISION < 0 means don't truncate the string.
20647 This is roughly equivalent to printf format specifiers:
20649 FIELD_WIDTH PRECISION PRINTF
20650 ----------------------------------------
20656 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20657 display them, and < 0 means obey the current buffer's value of
20658 enable_multibyte_characters.
20660 Value is the number of columns displayed. */
20663 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20664 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20665 int field_width
, int precision
, int max_x
, int multibyte
)
20667 int hpos_at_start
= it
->hpos
;
20668 int saved_face_id
= it
->face_id
;
20669 struct glyph_row
*row
= it
->glyph_row
;
20670 EMACS_INT it_charpos
;
20672 /* Initialize the iterator IT for iteration over STRING beginning
20673 with index START. */
20674 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20675 precision
, field_width
, multibyte
);
20676 if (string
&& STRINGP (lisp_string
))
20677 /* LISP_STRING is the one returned by decode_mode_spec. We should
20678 ignore its text properties. */
20679 it
->stop_charpos
= it
->end_charpos
;
20681 /* If displaying STRING, set up the face of the iterator from
20682 FACE_STRING, if that's given. */
20683 if (STRINGP (face_string
))
20689 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20690 0, it
->region_beg_charpos
,
20691 it
->region_end_charpos
,
20692 &endptr
, it
->base_face_id
, 0);
20693 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20694 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20697 /* Set max_x to the maximum allowed X position. Don't let it go
20698 beyond the right edge of the window. */
20700 max_x
= it
->last_visible_x
;
20702 max_x
= min (max_x
, it
->last_visible_x
);
20704 /* Skip over display elements that are not visible. because IT->w is
20706 if (it
->current_x
< it
->first_visible_x
)
20707 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20708 MOVE_TO_POS
| MOVE_TO_X
);
20710 row
->ascent
= it
->max_ascent
;
20711 row
->height
= it
->max_ascent
+ it
->max_descent
;
20712 row
->phys_ascent
= it
->max_phys_ascent
;
20713 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20714 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20716 if (STRINGP (it
->string
))
20717 it_charpos
= IT_STRING_CHARPOS (*it
);
20719 it_charpos
= IT_CHARPOS (*it
);
20721 /* This condition is for the case that we are called with current_x
20722 past last_visible_x. */
20723 while (it
->current_x
< max_x
)
20725 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20727 /* Get the next display element. */
20728 if (!get_next_display_element (it
))
20731 /* Produce glyphs. */
20732 x_before
= it
->current_x
;
20733 n_glyphs_before
= row
->used
[TEXT_AREA
];
20734 PRODUCE_GLYPHS (it
);
20736 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20739 while (i
< nglyphs
)
20741 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20743 if (it
->line_wrap
!= TRUNCATE
20744 && x
+ glyph
->pixel_width
> max_x
)
20746 /* End of continued line or max_x reached. */
20747 if (CHAR_GLYPH_PADDING_P (*glyph
))
20749 /* A wide character is unbreakable. */
20750 if (row
->reversed_p
)
20751 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20752 - n_glyphs_before
);
20753 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20754 it
->current_x
= x_before
;
20758 if (row
->reversed_p
)
20759 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20760 - (n_glyphs_before
+ i
));
20761 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20766 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20768 /* Glyph is at least partially visible. */
20770 if (x
< it
->first_visible_x
)
20771 row
->x
= x
- it
->first_visible_x
;
20775 /* Glyph is off the left margin of the display area.
20776 Should not happen. */
20780 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20781 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20782 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20783 row
->phys_height
= max (row
->phys_height
,
20784 it
->max_phys_ascent
+ it
->max_phys_descent
);
20785 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20786 it
->max_extra_line_spacing
);
20787 x
+= glyph
->pixel_width
;
20791 /* Stop if max_x reached. */
20795 /* Stop at line ends. */
20796 if (ITERATOR_AT_END_OF_LINE_P (it
))
20798 it
->continuation_lines_width
= 0;
20802 set_iterator_to_next (it
, 1);
20803 if (STRINGP (it
->string
))
20804 it_charpos
= IT_STRING_CHARPOS (*it
);
20806 it_charpos
= IT_CHARPOS (*it
);
20808 /* Stop if truncating at the right edge. */
20809 if (it
->line_wrap
== TRUNCATE
20810 && it
->current_x
>= it
->last_visible_x
)
20812 /* Add truncation mark, but don't do it if the line is
20813 truncated at a padding space. */
20814 if (it_charpos
< it
->string_nchars
)
20816 if (!FRAME_WINDOW_P (it
->f
))
20820 if (it
->current_x
> it
->last_visible_x
)
20822 if (!row
->reversed_p
)
20824 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20825 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20830 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20831 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20833 unproduce_glyphs (it
, ii
+ 1);
20834 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20836 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20838 row
->used
[TEXT_AREA
] = ii
;
20839 produce_special_glyphs (it
, IT_TRUNCATION
);
20842 produce_special_glyphs (it
, IT_TRUNCATION
);
20844 row
->truncated_on_right_p
= 1;
20850 /* Maybe insert a truncation at the left. */
20851 if (it
->first_visible_x
20854 if (!FRAME_WINDOW_P (it
->f
))
20855 insert_left_trunc_glyphs (it
);
20856 row
->truncated_on_left_p
= 1;
20859 it
->face_id
= saved_face_id
;
20861 /* Value is number of columns displayed. */
20862 return it
->hpos
- hpos_at_start
;
20867 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20868 appears as an element of LIST or as the car of an element of LIST.
20869 If PROPVAL is a list, compare each element against LIST in that
20870 way, and return 1/2 if any element of PROPVAL is found in LIST.
20871 Otherwise return 0. This function cannot quit.
20872 The return value is 2 if the text is invisible but with an ellipsis
20873 and 1 if it's invisible and without an ellipsis. */
20876 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20878 register Lisp_Object tail
, proptail
;
20880 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20882 register Lisp_Object tem
;
20884 if (EQ (propval
, tem
))
20886 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20887 return NILP (XCDR (tem
)) ? 1 : 2;
20890 if (CONSP (propval
))
20892 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20894 Lisp_Object propelt
;
20895 propelt
= XCAR (proptail
);
20896 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20898 register Lisp_Object tem
;
20900 if (EQ (propelt
, tem
))
20902 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20903 return NILP (XCDR (tem
)) ? 1 : 2;
20911 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20912 doc
: /* Non-nil if the property makes the text invisible.
20913 POS-OR-PROP can be a marker or number, in which case it is taken to be
20914 a position in the current buffer and the value of the `invisible' property
20915 is checked; or it can be some other value, which is then presumed to be the
20916 value of the `invisible' property of the text of interest.
20917 The non-nil value returned can be t for truly invisible text or something
20918 else if the text is replaced by an ellipsis. */)
20919 (Lisp_Object pos_or_prop
)
20922 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20923 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20925 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20926 return (invis
== 0 ? Qnil
20928 : make_number (invis
));
20931 /* Calculate a width or height in pixels from a specification using
20932 the following elements:
20935 NUM - a (fractional) multiple of the default font width/height
20936 (NUM) - specifies exactly NUM pixels
20937 UNIT - a fixed number of pixels, see below.
20938 ELEMENT - size of a display element in pixels, see below.
20939 (NUM . SPEC) - equals NUM * SPEC
20940 (+ SPEC SPEC ...) - add pixel values
20941 (- SPEC SPEC ...) - subtract pixel values
20942 (- SPEC) - negate pixel value
20945 INT or FLOAT - a number constant
20946 SYMBOL - use symbol's (buffer local) variable binding.
20949 in - pixels per inch *)
20950 mm - pixels per 1/1000 meter *)
20951 cm - pixels per 1/100 meter *)
20952 width - width of current font in pixels.
20953 height - height of current font in pixels.
20955 *) using the ratio(s) defined in display-pixels-per-inch.
20959 left-fringe - left fringe width in pixels
20960 right-fringe - right fringe width in pixels
20962 left-margin - left margin width in pixels
20963 right-margin - right margin width in pixels
20965 scroll-bar - scroll-bar area width in pixels
20969 Pixels corresponding to 5 inches:
20972 Total width of non-text areas on left side of window (if scroll-bar is on left):
20973 '(space :width (+ left-fringe left-margin scroll-bar))
20975 Align to first text column (in header line):
20976 '(space :align-to 0)
20978 Align to middle of text area minus half the width of variable `my-image'
20979 containing a loaded image:
20980 '(space :align-to (0.5 . (- text my-image)))
20982 Width of left margin minus width of 1 character in the default font:
20983 '(space :width (- left-margin 1))
20985 Width of left margin minus width of 2 characters in the current font:
20986 '(space :width (- left-margin (2 . width)))
20988 Center 1 character over left-margin (in header line):
20989 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20991 Different ways to express width of left fringe plus left margin minus one pixel:
20992 '(space :width (- (+ left-fringe left-margin) (1)))
20993 '(space :width (+ left-fringe left-margin (- (1))))
20994 '(space :width (+ left-fringe left-margin (-1)))
20998 #define NUMVAL(X) \
20999 ((INTEGERP (X) || FLOATP (X)) \
21004 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21005 struct font
*font
, int width_p
, int *align_to
)
21009 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21010 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21013 return OK_PIXELS (0);
21015 xassert (FRAME_LIVE_P (it
->f
));
21017 if (SYMBOLP (prop
))
21019 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21021 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21023 if (unit
[0] == 'i' && unit
[1] == 'n')
21025 else if (unit
[0] == 'm' && unit
[1] == 'm')
21027 else if (unit
[0] == 'c' && unit
[1] == 'm')
21034 #ifdef HAVE_WINDOW_SYSTEM
21035 if (FRAME_WINDOW_P (it
->f
)
21037 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21038 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21040 return OK_PIXELS (ppi
/ pixels
);
21043 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21044 || (CONSP (Vdisplay_pixels_per_inch
)
21046 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21047 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21049 return OK_PIXELS (ppi
/ pixels
);
21055 #ifdef HAVE_WINDOW_SYSTEM
21056 if (EQ (prop
, Qheight
))
21057 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21058 if (EQ (prop
, Qwidth
))
21059 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21061 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21062 return OK_PIXELS (1);
21065 if (EQ (prop
, Qtext
))
21066 return OK_PIXELS (width_p
21067 ? window_box_width (it
->w
, TEXT_AREA
)
21068 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21070 if (align_to
&& *align_to
< 0)
21073 if (EQ (prop
, Qleft
))
21074 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21075 if (EQ (prop
, Qright
))
21076 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21077 if (EQ (prop
, Qcenter
))
21078 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21079 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21080 if (EQ (prop
, Qleft_fringe
))
21081 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21082 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21083 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21084 if (EQ (prop
, Qright_fringe
))
21085 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21086 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21087 : window_box_right_offset (it
->w
, TEXT_AREA
));
21088 if (EQ (prop
, Qleft_margin
))
21089 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21090 if (EQ (prop
, Qright_margin
))
21091 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21092 if (EQ (prop
, Qscroll_bar
))
21093 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21095 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21096 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21097 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21102 if (EQ (prop
, Qleft_fringe
))
21103 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21104 if (EQ (prop
, Qright_fringe
))
21105 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21106 if (EQ (prop
, Qleft_margin
))
21107 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21108 if (EQ (prop
, Qright_margin
))
21109 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21110 if (EQ (prop
, Qscroll_bar
))
21111 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21114 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21117 if (INTEGERP (prop
) || FLOATP (prop
))
21119 int base_unit
= (width_p
21120 ? FRAME_COLUMN_WIDTH (it
->f
)
21121 : FRAME_LINE_HEIGHT (it
->f
));
21122 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21127 Lisp_Object car
= XCAR (prop
);
21128 Lisp_Object cdr
= XCDR (prop
);
21132 #ifdef HAVE_WINDOW_SYSTEM
21133 if (FRAME_WINDOW_P (it
->f
)
21134 && valid_image_p (prop
))
21136 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21137 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21139 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21142 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21148 while (CONSP (cdr
))
21150 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21151 font
, width_p
, align_to
))
21154 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21159 if (EQ (car
, Qminus
))
21161 return OK_PIXELS (pixels
);
21164 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21167 if (INTEGERP (car
) || FLOATP (car
))
21170 pixels
= XFLOATINT (car
);
21172 return OK_PIXELS (pixels
);
21173 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21174 font
, width_p
, align_to
))
21175 return OK_PIXELS (pixels
* fact
);
21186 /***********************************************************************
21188 ***********************************************************************/
21190 #ifdef HAVE_WINDOW_SYSTEM
21195 dump_glyph_string (struct glyph_string
*s
)
21197 fprintf (stderr
, "glyph string\n");
21198 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21199 s
->x
, s
->y
, s
->width
, s
->height
);
21200 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21201 fprintf (stderr
, " hl = %d\n", s
->hl
);
21202 fprintf (stderr
, " left overhang = %d, right = %d\n",
21203 s
->left_overhang
, s
->right_overhang
);
21204 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21205 fprintf (stderr
, " extends to end of line = %d\n",
21206 s
->extends_to_end_of_line_p
);
21207 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21208 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21211 #endif /* GLYPH_DEBUG */
21213 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21214 of XChar2b structures for S; it can't be allocated in
21215 init_glyph_string because it must be allocated via `alloca'. W
21216 is the window on which S is drawn. ROW and AREA are the glyph row
21217 and area within the row from which S is constructed. START is the
21218 index of the first glyph structure covered by S. HL is a
21219 face-override for drawing S. */
21222 #define OPTIONAL_HDC(hdc) HDC hdc,
21223 #define DECLARE_HDC(hdc) HDC hdc;
21224 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21225 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21228 #ifndef OPTIONAL_HDC
21229 #define OPTIONAL_HDC(hdc)
21230 #define DECLARE_HDC(hdc)
21231 #define ALLOCATE_HDC(hdc, f)
21232 #define RELEASE_HDC(hdc, f)
21236 init_glyph_string (struct glyph_string
*s
,
21238 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21239 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21241 memset (s
, 0, sizeof *s
);
21243 s
->f
= XFRAME (w
->frame
);
21247 s
->display
= FRAME_X_DISPLAY (s
->f
);
21248 s
->window
= FRAME_X_WINDOW (s
->f
);
21249 s
->char2b
= char2b
;
21253 s
->first_glyph
= row
->glyphs
[area
] + start
;
21254 s
->height
= row
->height
;
21255 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21256 s
->ybase
= s
->y
+ row
->ascent
;
21260 /* Append the list of glyph strings with head H and tail T to the list
21261 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21264 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21265 struct glyph_string
*h
, struct glyph_string
*t
)
21279 /* Prepend the list of glyph strings with head H and tail T to the
21280 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21284 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21285 struct glyph_string
*h
, struct glyph_string
*t
)
21299 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21300 Set *HEAD and *TAIL to the resulting list. */
21303 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21304 struct glyph_string
*s
)
21306 s
->next
= s
->prev
= NULL
;
21307 append_glyph_string_lists (head
, tail
, s
, s
);
21311 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21312 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21313 make sure that X resources for the face returned are allocated.
21314 Value is a pointer to a realized face that is ready for display if
21315 DISPLAY_P is non-zero. */
21317 static inline struct face
*
21318 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21319 XChar2b
*char2b
, int display_p
)
21321 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21325 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21327 if (code
!= FONT_INVALID_CODE
)
21328 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21330 STORE_XCHAR2B (char2b
, 0, 0);
21333 /* Make sure X resources of the face are allocated. */
21334 #ifdef HAVE_X_WINDOWS
21338 xassert (face
!= NULL
);
21339 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21346 /* Get face and two-byte form of character glyph GLYPH on frame F.
21347 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21348 a pointer to a realized face that is ready for display. */
21350 static inline struct face
*
21351 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21352 XChar2b
*char2b
, int *two_byte_p
)
21356 xassert (glyph
->type
== CHAR_GLYPH
);
21357 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21366 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21367 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21369 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21371 if (code
!= FONT_INVALID_CODE
)
21372 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21374 STORE_XCHAR2B (char2b
, 0, 0);
21377 /* Make sure X resources of the face are allocated. */
21378 xassert (face
!= NULL
);
21379 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21384 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21385 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21388 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21392 if (CHAR_BYTE8_P (c
))
21393 code
= CHAR_TO_BYTE8 (c
);
21395 code
= font
->driver
->encode_char (font
, c
);
21397 if (code
== FONT_INVALID_CODE
)
21399 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21404 /* Fill glyph string S with composition components specified by S->cmp.
21406 BASE_FACE is the base face of the composition.
21407 S->cmp_from is the index of the first component for S.
21409 OVERLAPS non-zero means S should draw the foreground only, and use
21410 its physical height for clipping. See also draw_glyphs.
21412 Value is the index of a component not in S. */
21415 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21419 /* For all glyphs of this composition, starting at the offset
21420 S->cmp_from, until we reach the end of the definition or encounter a
21421 glyph that requires the different face, add it to S. */
21426 s
->for_overlaps
= overlaps
;
21429 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21431 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21435 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21438 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21445 s
->font
= s
->face
->font
;
21447 else if (s
->face
!= face
)
21455 /* All glyph strings for the same composition has the same width,
21456 i.e. the width set for the first component of the composition. */
21457 s
->width
= s
->first_glyph
->pixel_width
;
21459 /* If the specified font could not be loaded, use the frame's
21460 default font, but record the fact that we couldn't load it in
21461 the glyph string so that we can draw rectangles for the
21462 characters of the glyph string. */
21463 if (s
->font
== NULL
)
21465 s
->font_not_found_p
= 1;
21466 s
->font
= FRAME_FONT (s
->f
);
21469 /* Adjust base line for subscript/superscript text. */
21470 s
->ybase
+= s
->first_glyph
->voffset
;
21472 /* This glyph string must always be drawn with 16-bit functions. */
21479 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21480 int start
, int end
, int overlaps
)
21482 struct glyph
*glyph
, *last
;
21483 Lisp_Object lgstring
;
21486 s
->for_overlaps
= overlaps
;
21487 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21488 last
= s
->row
->glyphs
[s
->area
] + end
;
21489 s
->cmp_id
= glyph
->u
.cmp
.id
;
21490 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21491 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21492 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21493 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21494 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21496 while (glyph
< last
21497 && glyph
->u
.cmp
.automatic
21498 && glyph
->u
.cmp
.id
== s
->cmp_id
21499 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21500 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21502 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21504 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21505 unsigned code
= LGLYPH_CODE (lglyph
);
21507 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21509 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21510 return glyph
- s
->row
->glyphs
[s
->area
];
21514 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21515 See the comment of fill_glyph_string for arguments.
21516 Value is the index of the first glyph not in S. */
21520 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21521 int start
, int end
, int overlaps
)
21523 struct glyph
*glyph
, *last
;
21526 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21527 s
->for_overlaps
= overlaps
;
21528 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21529 last
= s
->row
->glyphs
[s
->area
] + end
;
21530 voffset
= glyph
->voffset
;
21531 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21532 s
->font
= s
->face
->font
;
21534 s
->width
= glyph
->pixel_width
;
21536 while (glyph
< last
21537 && glyph
->type
== GLYPHLESS_GLYPH
21538 && glyph
->voffset
== voffset
21539 && glyph
->face_id
== face_id
)
21542 s
->width
+= glyph
->pixel_width
;
21545 s
->ybase
+= voffset
;
21546 return glyph
- s
->row
->glyphs
[s
->area
];
21550 /* Fill glyph string S from a sequence of character glyphs.
21552 FACE_ID is the face id of the string. START is the index of the
21553 first glyph to consider, END is the index of the last + 1.
21554 OVERLAPS non-zero means S should draw the foreground only, and use
21555 its physical height for clipping. See also draw_glyphs.
21557 Value is the index of the first glyph not in S. */
21560 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21561 int start
, int end
, int overlaps
)
21563 struct glyph
*glyph
, *last
;
21565 int glyph_not_available_p
;
21567 xassert (s
->f
== XFRAME (s
->w
->frame
));
21568 xassert (s
->nchars
== 0);
21569 xassert (start
>= 0 && end
> start
);
21571 s
->for_overlaps
= overlaps
;
21572 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21573 last
= s
->row
->glyphs
[s
->area
] + end
;
21574 voffset
= glyph
->voffset
;
21575 s
->padding_p
= glyph
->padding_p
;
21576 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21578 while (glyph
< last
21579 && glyph
->type
== CHAR_GLYPH
21580 && glyph
->voffset
== voffset
21581 /* Same face id implies same font, nowadays. */
21582 && glyph
->face_id
== face_id
21583 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21587 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21588 s
->char2b
+ s
->nchars
,
21590 s
->two_byte_p
= two_byte_p
;
21592 xassert (s
->nchars
<= end
- start
);
21593 s
->width
+= glyph
->pixel_width
;
21594 if (glyph
++->padding_p
!= s
->padding_p
)
21598 s
->font
= s
->face
->font
;
21600 /* If the specified font could not be loaded, use the frame's font,
21601 but record the fact that we couldn't load it in
21602 S->font_not_found_p so that we can draw rectangles for the
21603 characters of the glyph string. */
21604 if (s
->font
== NULL
|| glyph_not_available_p
)
21606 s
->font_not_found_p
= 1;
21607 s
->font
= FRAME_FONT (s
->f
);
21610 /* Adjust base line for subscript/superscript text. */
21611 s
->ybase
+= voffset
;
21613 xassert (s
->face
&& s
->face
->gc
);
21614 return glyph
- s
->row
->glyphs
[s
->area
];
21618 /* Fill glyph string S from image glyph S->first_glyph. */
21621 fill_image_glyph_string (struct glyph_string
*s
)
21623 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21624 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21626 s
->slice
= s
->first_glyph
->slice
.img
;
21627 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21628 s
->font
= s
->face
->font
;
21629 s
->width
= s
->first_glyph
->pixel_width
;
21631 /* Adjust base line for subscript/superscript text. */
21632 s
->ybase
+= s
->first_glyph
->voffset
;
21636 /* Fill glyph string S from a sequence of stretch glyphs.
21638 START is the index of the first glyph to consider,
21639 END is the index of the last + 1.
21641 Value is the index of the first glyph not in S. */
21644 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21646 struct glyph
*glyph
, *last
;
21647 int voffset
, face_id
;
21649 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21651 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21652 last
= s
->row
->glyphs
[s
->area
] + end
;
21653 face_id
= glyph
->face_id
;
21654 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21655 s
->font
= s
->face
->font
;
21656 s
->width
= glyph
->pixel_width
;
21658 voffset
= glyph
->voffset
;
21662 && glyph
->type
== STRETCH_GLYPH
21663 && glyph
->voffset
== voffset
21664 && glyph
->face_id
== face_id
);
21666 s
->width
+= glyph
->pixel_width
;
21668 /* Adjust base line for subscript/superscript text. */
21669 s
->ybase
+= voffset
;
21671 /* The case that face->gc == 0 is handled when drawing the glyph
21672 string by calling PREPARE_FACE_FOR_DISPLAY. */
21674 return glyph
- s
->row
->glyphs
[s
->area
];
21677 static struct font_metrics
*
21678 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21680 static struct font_metrics metrics
;
21681 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21683 if (! font
|| code
== FONT_INVALID_CODE
)
21685 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21690 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21691 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21692 assumed to be zero. */
21695 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21697 *left
= *right
= 0;
21699 if (glyph
->type
== CHAR_GLYPH
)
21703 struct font_metrics
*pcm
;
21705 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21706 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21708 if (pcm
->rbearing
> pcm
->width
)
21709 *right
= pcm
->rbearing
- pcm
->width
;
21710 if (pcm
->lbearing
< 0)
21711 *left
= -pcm
->lbearing
;
21714 else if (glyph
->type
== COMPOSITE_GLYPH
)
21716 if (! glyph
->u
.cmp
.automatic
)
21718 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21720 if (cmp
->rbearing
> cmp
->pixel_width
)
21721 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21722 if (cmp
->lbearing
< 0)
21723 *left
= - cmp
->lbearing
;
21727 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21728 struct font_metrics metrics
;
21730 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21731 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21732 if (metrics
.rbearing
> metrics
.width
)
21733 *right
= metrics
.rbearing
- metrics
.width
;
21734 if (metrics
.lbearing
< 0)
21735 *left
= - metrics
.lbearing
;
21741 /* Return the index of the first glyph preceding glyph string S that
21742 is overwritten by S because of S's left overhang. Value is -1
21743 if no glyphs are overwritten. */
21746 left_overwritten (struct glyph_string
*s
)
21750 if (s
->left_overhang
)
21753 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21754 int first
= s
->first_glyph
- glyphs
;
21756 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21757 x
-= glyphs
[i
].pixel_width
;
21768 /* Return the index of the first glyph preceding glyph string S that
21769 is overwriting S because of its right overhang. Value is -1 if no
21770 glyph in front of S overwrites S. */
21773 left_overwriting (struct glyph_string
*s
)
21776 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21777 int first
= s
->first_glyph
- glyphs
;
21781 for (i
= first
- 1; i
>= 0; --i
)
21784 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21787 x
-= glyphs
[i
].pixel_width
;
21794 /* Return the index of the last glyph following glyph string S that is
21795 overwritten by S because of S's right overhang. Value is -1 if
21796 no such glyph is found. */
21799 right_overwritten (struct glyph_string
*s
)
21803 if (s
->right_overhang
)
21806 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21807 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21808 int end
= s
->row
->used
[s
->area
];
21810 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21811 x
+= glyphs
[i
].pixel_width
;
21820 /* Return the index of the last glyph following glyph string S that
21821 overwrites S because of its left overhang. Value is negative
21822 if no such glyph is found. */
21825 right_overwriting (struct glyph_string
*s
)
21828 int end
= s
->row
->used
[s
->area
];
21829 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21830 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21834 for (i
= first
; i
< end
; ++i
)
21837 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21840 x
+= glyphs
[i
].pixel_width
;
21847 /* Set background width of glyph string S. START is the index of the
21848 first glyph following S. LAST_X is the right-most x-position + 1
21849 in the drawing area. */
21852 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21854 /* If the face of this glyph string has to be drawn to the end of
21855 the drawing area, set S->extends_to_end_of_line_p. */
21857 if (start
== s
->row
->used
[s
->area
]
21858 && s
->area
== TEXT_AREA
21859 && ((s
->row
->fill_line_p
21860 && (s
->hl
== DRAW_NORMAL_TEXT
21861 || s
->hl
== DRAW_IMAGE_RAISED
21862 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21863 || s
->hl
== DRAW_MOUSE_FACE
))
21864 s
->extends_to_end_of_line_p
= 1;
21866 /* If S extends its face to the end of the line, set its
21867 background_width to the distance to the right edge of the drawing
21869 if (s
->extends_to_end_of_line_p
)
21870 s
->background_width
= last_x
- s
->x
+ 1;
21872 s
->background_width
= s
->width
;
21876 /* Compute overhangs and x-positions for glyph string S and its
21877 predecessors, or successors. X is the starting x-position for S.
21878 BACKWARD_P non-zero means process predecessors. */
21881 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21887 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21888 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21898 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21899 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21909 /* The following macros are only called from draw_glyphs below.
21910 They reference the following parameters of that function directly:
21911 `w', `row', `area', and `overlap_p'
21912 as well as the following local variables:
21913 `s', `f', and `hdc' (in W32) */
21916 /* On W32, silently add local `hdc' variable to argument list of
21917 init_glyph_string. */
21918 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21919 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21921 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21922 init_glyph_string (s, char2b, w, row, area, start, hl)
21925 /* Add a glyph string for a stretch glyph to the list of strings
21926 between HEAD and TAIL. START is the index of the stretch glyph in
21927 row area AREA of glyph row ROW. END is the index of the last glyph
21928 in that glyph row area. X is the current output position assigned
21929 to the new glyph string constructed. HL overrides that face of the
21930 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21931 is the right-most x-position of the drawing area. */
21933 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21934 and below -- keep them on one line. */
21935 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21938 s = (struct glyph_string *) alloca (sizeof *s); \
21939 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21940 START = fill_stretch_glyph_string (s, START, END); \
21941 append_glyph_string (&HEAD, &TAIL, s); \
21947 /* Add a glyph string for an image glyph to the list of strings
21948 between HEAD and TAIL. START is the index of the image glyph in
21949 row area AREA of glyph row ROW. END is the index of the last glyph
21950 in that glyph row area. X is the current output position assigned
21951 to the new glyph string constructed. HL overrides that face of the
21952 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21953 is the right-most x-position of the drawing area. */
21955 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21958 s = (struct glyph_string *) alloca (sizeof *s); \
21959 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21960 fill_image_glyph_string (s); \
21961 append_glyph_string (&HEAD, &TAIL, s); \
21968 /* Add a glyph string for a sequence of character glyphs to the list
21969 of strings between HEAD and TAIL. START is the index of the first
21970 glyph in row area AREA of glyph row ROW that is part of the new
21971 glyph string. END is the index of the last glyph in that glyph row
21972 area. X is the current output position assigned to the new glyph
21973 string constructed. HL overrides that face of the glyph; e.g. it
21974 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21975 right-most x-position of the drawing area. */
21977 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21983 face_id = (row)->glyphs[area][START].face_id; \
21985 s = (struct glyph_string *) alloca (sizeof *s); \
21986 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21987 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21988 append_glyph_string (&HEAD, &TAIL, s); \
21990 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21995 /* Add a glyph string for a composite sequence to the list of strings
21996 between HEAD and TAIL. START is the index of the first glyph in
21997 row area AREA of glyph row ROW that is part of the new glyph
21998 string. END is the index of the last glyph in that glyph row area.
21999 X is the current output position assigned to the new glyph string
22000 constructed. HL overrides that face of the glyph; e.g. it is
22001 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22002 x-position of the drawing area. */
22004 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22006 int face_id = (row)->glyphs[area][START].face_id; \
22007 struct face *base_face = FACE_FROM_ID (f, face_id); \
22008 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22009 struct composition *cmp = composition_table[cmp_id]; \
22011 struct glyph_string *first_s IF_LINT (= NULL); \
22014 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22016 /* Make glyph_strings for each glyph sequence that is drawable by \
22017 the same face, and append them to HEAD/TAIL. */ \
22018 for (n = 0; n < cmp->glyph_len;) \
22020 s = (struct glyph_string *) alloca (sizeof *s); \
22021 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22022 append_glyph_string (&(HEAD), &(TAIL), s); \
22028 n = fill_composite_glyph_string (s, base_face, overlaps); \
22036 /* Add a glyph string for a glyph-string sequence to the list of strings
22037 between HEAD and TAIL. */
22039 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22043 Lisp_Object gstring; \
22045 face_id = (row)->glyphs[area][START].face_id; \
22046 gstring = (composition_gstring_from_id \
22047 ((row)->glyphs[area][START].u.cmp.id)); \
22048 s = (struct glyph_string *) alloca (sizeof *s); \
22049 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22050 * LGSTRING_GLYPH_LEN (gstring)); \
22051 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22052 append_glyph_string (&(HEAD), &(TAIL), s); \
22054 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22058 /* Add a glyph string for a sequence of glyphless character's glyphs
22059 to the list of strings between HEAD and TAIL. The meanings of
22060 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22062 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22067 face_id = (row)->glyphs[area][START].face_id; \
22069 s = (struct glyph_string *) alloca (sizeof *s); \
22070 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22071 append_glyph_string (&HEAD, &TAIL, s); \
22073 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22079 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22080 of AREA of glyph row ROW on window W between indices START and END.
22081 HL overrides the face for drawing glyph strings, e.g. it is
22082 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22083 x-positions of the drawing area.
22085 This is an ugly monster macro construct because we must use alloca
22086 to allocate glyph strings (because draw_glyphs can be called
22087 asynchronously). */
22089 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22092 HEAD = TAIL = NULL; \
22093 while (START < END) \
22095 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22096 switch (first_glyph->type) \
22099 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22103 case COMPOSITE_GLYPH: \
22104 if (first_glyph->u.cmp.automatic) \
22105 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22108 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22112 case STRETCH_GLYPH: \
22113 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22117 case IMAGE_GLYPH: \
22118 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22122 case GLYPHLESS_GLYPH: \
22123 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22133 set_glyph_string_background_width (s, START, LAST_X); \
22140 /* Draw glyphs between START and END in AREA of ROW on window W,
22141 starting at x-position X. X is relative to AREA in W. HL is a
22142 face-override with the following meaning:
22144 DRAW_NORMAL_TEXT draw normally
22145 DRAW_CURSOR draw in cursor face
22146 DRAW_MOUSE_FACE draw in mouse face.
22147 DRAW_INVERSE_VIDEO draw in mode line face
22148 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22149 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22151 If OVERLAPS is non-zero, draw only the foreground of characters and
22152 clip to the physical height of ROW. Non-zero value also defines
22153 the overlapping part to be drawn:
22155 OVERLAPS_PRED overlap with preceding rows
22156 OVERLAPS_SUCC overlap with succeeding rows
22157 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22158 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22160 Value is the x-position reached, relative to AREA of W. */
22163 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22164 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22165 enum draw_glyphs_face hl
, int overlaps
)
22167 struct glyph_string
*head
, *tail
;
22168 struct glyph_string
*s
;
22169 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22170 int i
, j
, x_reached
, last_x
, area_left
= 0;
22171 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22174 ALLOCATE_HDC (hdc
, f
);
22176 /* Let's rather be paranoid than getting a SEGV. */
22177 end
= min (end
, row
->used
[area
]);
22178 start
= max (0, start
);
22179 start
= min (end
, start
);
22181 /* Translate X to frame coordinates. Set last_x to the right
22182 end of the drawing area. */
22183 if (row
->full_width_p
)
22185 /* X is relative to the left edge of W, without scroll bars
22187 area_left
= WINDOW_LEFT_EDGE_X (w
);
22188 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22192 area_left
= window_box_left (w
, area
);
22193 last_x
= area_left
+ window_box_width (w
, area
);
22197 /* Build a doubly-linked list of glyph_string structures between
22198 head and tail from what we have to draw. Note that the macro
22199 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22200 the reason we use a separate variable `i'. */
22202 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22204 x_reached
= tail
->x
+ tail
->background_width
;
22208 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22209 the row, redraw some glyphs in front or following the glyph
22210 strings built above. */
22211 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22213 struct glyph_string
*h
, *t
;
22214 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22215 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22216 int check_mouse_face
= 0;
22219 /* If mouse highlighting is on, we may need to draw adjacent
22220 glyphs using mouse-face highlighting. */
22221 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22223 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22225 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22226 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22228 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22230 check_mouse_face
= 1;
22231 mouse_beg_col
= (row
== mouse_beg_row
)
22232 ? hlinfo
->mouse_face_beg_col
: 0;
22233 mouse_end_col
= (row
== mouse_end_row
)
22234 ? hlinfo
->mouse_face_end_col
22235 : row
->used
[TEXT_AREA
];
22239 /* Compute overhangs for all glyph strings. */
22240 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22241 for (s
= head
; s
; s
= s
->next
)
22242 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22244 /* Prepend glyph strings for glyphs in front of the first glyph
22245 string that are overwritten because of the first glyph
22246 string's left overhang. The background of all strings
22247 prepended must be drawn because the first glyph string
22249 i
= left_overwritten (head
);
22252 enum draw_glyphs_face overlap_hl
;
22254 /* If this row contains mouse highlighting, attempt to draw
22255 the overlapped glyphs with the correct highlight. This
22256 code fails if the overlap encompasses more than one glyph
22257 and mouse-highlight spans only some of these glyphs.
22258 However, making it work perfectly involves a lot more
22259 code, and I don't know if the pathological case occurs in
22260 practice, so we'll stick to this for now. --- cyd */
22261 if (check_mouse_face
22262 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22263 overlap_hl
= DRAW_MOUSE_FACE
;
22265 overlap_hl
= DRAW_NORMAL_TEXT
;
22268 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22269 overlap_hl
, dummy_x
, last_x
);
22271 compute_overhangs_and_x (t
, head
->x
, 1);
22272 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22276 /* Prepend glyph strings for glyphs in front of the first glyph
22277 string that overwrite that glyph string because of their
22278 right overhang. For these strings, only the foreground must
22279 be drawn, because it draws over the glyph string at `head'.
22280 The background must not be drawn because this would overwrite
22281 right overhangs of preceding glyphs for which no glyph
22283 i
= left_overwriting (head
);
22286 enum draw_glyphs_face overlap_hl
;
22288 if (check_mouse_face
22289 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22290 overlap_hl
= DRAW_MOUSE_FACE
;
22292 overlap_hl
= DRAW_NORMAL_TEXT
;
22295 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22296 overlap_hl
, dummy_x
, last_x
);
22297 for (s
= h
; s
; s
= s
->next
)
22298 s
->background_filled_p
= 1;
22299 compute_overhangs_and_x (t
, head
->x
, 1);
22300 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22303 /* Append glyphs strings for glyphs following the last glyph
22304 string tail that are overwritten by tail. The background of
22305 these strings has to be drawn because tail's foreground draws
22307 i
= right_overwritten (tail
);
22310 enum draw_glyphs_face overlap_hl
;
22312 if (check_mouse_face
22313 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22314 overlap_hl
= DRAW_MOUSE_FACE
;
22316 overlap_hl
= DRAW_NORMAL_TEXT
;
22318 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22319 overlap_hl
, x
, last_x
);
22320 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22321 we don't have `end = i;' here. */
22322 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22323 append_glyph_string_lists (&head
, &tail
, h
, t
);
22327 /* Append glyph strings for glyphs following the last glyph
22328 string tail that overwrite tail. The foreground of such
22329 glyphs has to be drawn because it writes into the background
22330 of tail. The background must not be drawn because it could
22331 paint over the foreground of following glyphs. */
22332 i
= right_overwriting (tail
);
22335 enum draw_glyphs_face overlap_hl
;
22336 if (check_mouse_face
22337 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22338 overlap_hl
= DRAW_MOUSE_FACE
;
22340 overlap_hl
= DRAW_NORMAL_TEXT
;
22343 i
++; /* We must include the Ith glyph. */
22344 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22345 overlap_hl
, x
, last_x
);
22346 for (s
= h
; s
; s
= s
->next
)
22347 s
->background_filled_p
= 1;
22348 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22349 append_glyph_string_lists (&head
, &tail
, h
, t
);
22351 if (clip_head
|| clip_tail
)
22352 for (s
= head
; s
; s
= s
->next
)
22354 s
->clip_head
= clip_head
;
22355 s
->clip_tail
= clip_tail
;
22359 /* Draw all strings. */
22360 for (s
= head
; s
; s
= s
->next
)
22361 FRAME_RIF (f
)->draw_glyph_string (s
);
22364 /* When focus a sole frame and move horizontally, this sets on_p to 0
22365 causing a failure to erase prev cursor position. */
22366 if (area
== TEXT_AREA
22367 && !row
->full_width_p
22368 /* When drawing overlapping rows, only the glyph strings'
22369 foreground is drawn, which doesn't erase a cursor
22373 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22374 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22375 : (tail
? tail
->x
+ tail
->background_width
: x
));
22379 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22380 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22384 /* Value is the x-position up to which drawn, relative to AREA of W.
22385 This doesn't include parts drawn because of overhangs. */
22386 if (row
->full_width_p
)
22387 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22389 x_reached
-= area_left
;
22391 RELEASE_HDC (hdc
, f
);
22396 /* Expand row matrix if too narrow. Don't expand if area
22399 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22401 if (!fonts_changed_p \
22402 && (it->glyph_row->glyphs[area] \
22403 < it->glyph_row->glyphs[area + 1])) \
22405 it->w->ncols_scale_factor++; \
22406 fonts_changed_p = 1; \
22410 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22411 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22414 append_glyph (struct it
*it
)
22416 struct glyph
*glyph
;
22417 enum glyph_row_area area
= it
->area
;
22419 xassert (it
->glyph_row
);
22420 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22422 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22423 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22425 /* If the glyph row is reversed, we need to prepend the glyph
22426 rather than append it. */
22427 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22431 /* Make room for the additional glyph. */
22432 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22434 glyph
= it
->glyph_row
->glyphs
[area
];
22436 glyph
->charpos
= CHARPOS (it
->position
);
22437 glyph
->object
= it
->object
;
22438 if (it
->pixel_width
> 0)
22440 glyph
->pixel_width
= it
->pixel_width
;
22441 glyph
->padding_p
= 0;
22445 /* Assure at least 1-pixel width. Otherwise, cursor can't
22446 be displayed correctly. */
22447 glyph
->pixel_width
= 1;
22448 glyph
->padding_p
= 1;
22450 glyph
->ascent
= it
->ascent
;
22451 glyph
->descent
= it
->descent
;
22452 glyph
->voffset
= it
->voffset
;
22453 glyph
->type
= CHAR_GLYPH
;
22454 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22455 glyph
->multibyte_p
= it
->multibyte_p
;
22456 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22457 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22458 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22459 || it
->phys_descent
> it
->descent
);
22460 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22461 glyph
->face_id
= it
->face_id
;
22462 glyph
->u
.ch
= it
->char_to_display
;
22463 glyph
->slice
.img
= null_glyph_slice
;
22464 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22467 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22468 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22470 glyph
->bidi_type
= it
->bidi_it
.type
;
22474 glyph
->resolved_level
= 0;
22475 glyph
->bidi_type
= UNKNOWN_BT
;
22477 ++it
->glyph_row
->used
[area
];
22480 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22483 /* Store one glyph for the composition IT->cmp_it.id in
22484 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22488 append_composite_glyph (struct it
*it
)
22490 struct glyph
*glyph
;
22491 enum glyph_row_area area
= it
->area
;
22493 xassert (it
->glyph_row
);
22495 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22496 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22498 /* If the glyph row is reversed, we need to prepend the glyph
22499 rather than append it. */
22500 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22504 /* Make room for the new glyph. */
22505 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22507 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22509 glyph
->charpos
= it
->cmp_it
.charpos
;
22510 glyph
->object
= it
->object
;
22511 glyph
->pixel_width
= it
->pixel_width
;
22512 glyph
->ascent
= it
->ascent
;
22513 glyph
->descent
= it
->descent
;
22514 glyph
->voffset
= it
->voffset
;
22515 glyph
->type
= COMPOSITE_GLYPH
;
22516 if (it
->cmp_it
.ch
< 0)
22518 glyph
->u
.cmp
.automatic
= 0;
22519 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22520 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22524 glyph
->u
.cmp
.automatic
= 1;
22525 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22526 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22527 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22529 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22530 glyph
->multibyte_p
= it
->multibyte_p
;
22531 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22532 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22533 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22534 || it
->phys_descent
> it
->descent
);
22535 glyph
->padding_p
= 0;
22536 glyph
->glyph_not_available_p
= 0;
22537 glyph
->face_id
= it
->face_id
;
22538 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22541 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22542 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22544 glyph
->bidi_type
= it
->bidi_it
.type
;
22546 ++it
->glyph_row
->used
[area
];
22549 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22553 /* Change IT->ascent and IT->height according to the setting of
22557 take_vertical_position_into_account (struct it
*it
)
22561 if (it
->voffset
< 0)
22562 /* Increase the ascent so that we can display the text higher
22564 it
->ascent
-= it
->voffset
;
22566 /* Increase the descent so that we can display the text lower
22568 it
->descent
+= it
->voffset
;
22573 /* Produce glyphs/get display metrics for the image IT is loaded with.
22574 See the description of struct display_iterator in dispextern.h for
22575 an overview of struct display_iterator. */
22578 produce_image_glyph (struct it
*it
)
22582 int glyph_ascent
, crop
;
22583 struct glyph_slice slice
;
22585 xassert (it
->what
== IT_IMAGE
);
22587 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22589 /* Make sure X resources of the face is loaded. */
22590 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22592 if (it
->image_id
< 0)
22594 /* Fringe bitmap. */
22595 it
->ascent
= it
->phys_ascent
= 0;
22596 it
->descent
= it
->phys_descent
= 0;
22597 it
->pixel_width
= 0;
22602 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22604 /* Make sure X resources of the image is loaded. */
22605 prepare_image_for_display (it
->f
, img
);
22607 slice
.x
= slice
.y
= 0;
22608 slice
.width
= img
->width
;
22609 slice
.height
= img
->height
;
22611 if (INTEGERP (it
->slice
.x
))
22612 slice
.x
= XINT (it
->slice
.x
);
22613 else if (FLOATP (it
->slice
.x
))
22614 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22616 if (INTEGERP (it
->slice
.y
))
22617 slice
.y
= XINT (it
->slice
.y
);
22618 else if (FLOATP (it
->slice
.y
))
22619 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22621 if (INTEGERP (it
->slice
.width
))
22622 slice
.width
= XINT (it
->slice
.width
);
22623 else if (FLOATP (it
->slice
.width
))
22624 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22626 if (INTEGERP (it
->slice
.height
))
22627 slice
.height
= XINT (it
->slice
.height
);
22628 else if (FLOATP (it
->slice
.height
))
22629 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22631 if (slice
.x
>= img
->width
)
22632 slice
.x
= img
->width
;
22633 if (slice
.y
>= img
->height
)
22634 slice
.y
= img
->height
;
22635 if (slice
.x
+ slice
.width
>= img
->width
)
22636 slice
.width
= img
->width
- slice
.x
;
22637 if (slice
.y
+ slice
.height
> img
->height
)
22638 slice
.height
= img
->height
- slice
.y
;
22640 if (slice
.width
== 0 || slice
.height
== 0)
22643 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22645 it
->descent
= slice
.height
- glyph_ascent
;
22647 it
->descent
+= img
->vmargin
;
22648 if (slice
.y
+ slice
.height
== img
->height
)
22649 it
->descent
+= img
->vmargin
;
22650 it
->phys_descent
= it
->descent
;
22652 it
->pixel_width
= slice
.width
;
22654 it
->pixel_width
+= img
->hmargin
;
22655 if (slice
.x
+ slice
.width
== img
->width
)
22656 it
->pixel_width
+= img
->hmargin
;
22658 /* It's quite possible for images to have an ascent greater than
22659 their height, so don't get confused in that case. */
22660 if (it
->descent
< 0)
22665 if (face
->box
!= FACE_NO_BOX
)
22667 if (face
->box_line_width
> 0)
22670 it
->ascent
+= face
->box_line_width
;
22671 if (slice
.y
+ slice
.height
== img
->height
)
22672 it
->descent
+= face
->box_line_width
;
22675 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22676 it
->pixel_width
+= eabs (face
->box_line_width
);
22677 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22678 it
->pixel_width
+= eabs (face
->box_line_width
);
22681 take_vertical_position_into_account (it
);
22683 /* Automatically crop wide image glyphs at right edge so we can
22684 draw the cursor on same display row. */
22685 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22686 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22688 it
->pixel_width
-= crop
;
22689 slice
.width
-= crop
;
22694 struct glyph
*glyph
;
22695 enum glyph_row_area area
= it
->area
;
22697 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22698 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22700 glyph
->charpos
= CHARPOS (it
->position
);
22701 glyph
->object
= it
->object
;
22702 glyph
->pixel_width
= it
->pixel_width
;
22703 glyph
->ascent
= glyph_ascent
;
22704 glyph
->descent
= it
->descent
;
22705 glyph
->voffset
= it
->voffset
;
22706 glyph
->type
= IMAGE_GLYPH
;
22707 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22708 glyph
->multibyte_p
= it
->multibyte_p
;
22709 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22710 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22711 glyph
->overlaps_vertically_p
= 0;
22712 glyph
->padding_p
= 0;
22713 glyph
->glyph_not_available_p
= 0;
22714 glyph
->face_id
= it
->face_id
;
22715 glyph
->u
.img_id
= img
->id
;
22716 glyph
->slice
.img
= slice
;
22717 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22720 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22721 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22723 glyph
->bidi_type
= it
->bidi_it
.type
;
22725 ++it
->glyph_row
->used
[area
];
22728 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22733 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22734 of the glyph, WIDTH and HEIGHT are the width and height of the
22735 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22738 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22739 int width
, int height
, int ascent
)
22741 struct glyph
*glyph
;
22742 enum glyph_row_area area
= it
->area
;
22744 xassert (ascent
>= 0 && ascent
<= height
);
22746 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22747 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22749 /* If the glyph row is reversed, we need to prepend the glyph
22750 rather than append it. */
22751 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22755 /* Make room for the additional glyph. */
22756 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22758 glyph
= it
->glyph_row
->glyphs
[area
];
22760 glyph
->charpos
= CHARPOS (it
->position
);
22761 glyph
->object
= object
;
22762 glyph
->pixel_width
= width
;
22763 glyph
->ascent
= ascent
;
22764 glyph
->descent
= height
- ascent
;
22765 glyph
->voffset
= it
->voffset
;
22766 glyph
->type
= STRETCH_GLYPH
;
22767 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22768 glyph
->multibyte_p
= it
->multibyte_p
;
22769 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22770 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22771 glyph
->overlaps_vertically_p
= 0;
22772 glyph
->padding_p
= 0;
22773 glyph
->glyph_not_available_p
= 0;
22774 glyph
->face_id
= it
->face_id
;
22775 glyph
->u
.stretch
.ascent
= ascent
;
22776 glyph
->u
.stretch
.height
= height
;
22777 glyph
->slice
.img
= null_glyph_slice
;
22778 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22781 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22782 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22784 glyph
->bidi_type
= it
->bidi_it
.type
;
22788 glyph
->resolved_level
= 0;
22789 glyph
->bidi_type
= UNKNOWN_BT
;
22791 ++it
->glyph_row
->used
[area
];
22794 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22798 /* Produce a stretch glyph for iterator IT. IT->object is the value
22799 of the glyph property displayed. The value must be a list
22800 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22803 1. `:width WIDTH' specifies that the space should be WIDTH *
22804 canonical char width wide. WIDTH may be an integer or floating
22807 2. `:relative-width FACTOR' specifies that the width of the stretch
22808 should be computed from the width of the first character having the
22809 `glyph' property, and should be FACTOR times that width.
22811 3. `:align-to HPOS' specifies that the space should be wide enough
22812 to reach HPOS, a value in canonical character units.
22814 Exactly one of the above pairs must be present.
22816 4. `:height HEIGHT' specifies that the height of the stretch produced
22817 should be HEIGHT, measured in canonical character units.
22819 5. `:relative-height FACTOR' specifies that the height of the
22820 stretch should be FACTOR times the height of the characters having
22821 the glyph property.
22823 Either none or exactly one of 4 or 5 must be present.
22825 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22826 of the stretch should be used for the ascent of the stretch.
22827 ASCENT must be in the range 0 <= ASCENT <= 100. */
22830 produce_stretch_glyph (struct it
*it
)
22832 /* (space :width WIDTH :height HEIGHT ...) */
22833 Lisp_Object prop
, plist
;
22834 int width
= 0, height
= 0, align_to
= -1;
22835 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22838 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22839 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22841 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22843 /* List should start with `space'. */
22844 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22845 plist
= XCDR (it
->object
);
22847 /* Compute the width of the stretch. */
22848 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22849 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22851 /* Absolute width `:width WIDTH' specified and valid. */
22852 zero_width_ok_p
= 1;
22855 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22858 /* Relative width `:relative-width FACTOR' specified and valid.
22859 Compute the width of the characters having the `glyph'
22862 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22865 if (it
->multibyte_p
)
22866 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22869 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22870 if (! ASCII_CHAR_P (it2
.c
))
22871 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22874 it2
.glyph_row
= NULL
;
22875 it2
.what
= IT_CHARACTER
;
22876 x_produce_glyphs (&it2
);
22877 width
= NUMVAL (prop
) * it2
.pixel_width
;
22879 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22880 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22882 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22883 align_to
= (align_to
< 0
22885 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22886 else if (align_to
< 0)
22887 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22888 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22889 zero_width_ok_p
= 1;
22892 /* Nothing specified -> width defaults to canonical char width. */
22893 width
= FRAME_COLUMN_WIDTH (it
->f
);
22895 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22898 /* Compute height. */
22899 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22900 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22903 zero_height_ok_p
= 1;
22905 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22907 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22909 height
= FONT_HEIGHT (font
);
22911 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22914 /* Compute percentage of height used for ascent. If
22915 `:ascent ASCENT' is present and valid, use that. Otherwise,
22916 derive the ascent from the font in use. */
22917 if (prop
= Fplist_get (plist
, QCascent
),
22918 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22919 ascent
= height
* NUMVAL (prop
) / 100.0;
22920 else if (!NILP (prop
)
22921 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22922 ascent
= min (max (0, (int)tem
), height
);
22924 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22926 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22927 && it
->current_x
+ width
> it
->last_visible_x
)
22928 width
= it
->last_visible_x
- it
->current_x
- 1;
22930 if (width
> 0 && height
> 0 && it
->glyph_row
)
22932 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22933 if (!STRINGP (object
))
22934 object
= it
->w
->buffer
;
22935 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22938 it
->pixel_width
= width
;
22939 it
->ascent
= it
->phys_ascent
= ascent
;
22940 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22941 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22943 take_vertical_position_into_account (it
);
22946 /* Calculate line-height and line-spacing properties.
22947 An integer value specifies explicit pixel value.
22948 A float value specifies relative value to current face height.
22949 A cons (float . face-name) specifies relative value to
22950 height of specified face font.
22952 Returns height in pixels, or nil. */
22956 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22957 int boff
, int override
)
22959 Lisp_Object face_name
= Qnil
;
22960 int ascent
, descent
, height
;
22962 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22967 face_name
= XCAR (val
);
22969 if (!NUMBERP (val
))
22970 val
= make_number (1);
22971 if (NILP (face_name
))
22973 height
= it
->ascent
+ it
->descent
;
22978 if (NILP (face_name
))
22980 font
= FRAME_FONT (it
->f
);
22981 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22983 else if (EQ (face_name
, Qt
))
22992 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22994 return make_number (-1);
22996 face
= FACE_FROM_ID (it
->f
, face_id
);
22999 return make_number (-1);
23000 boff
= font
->baseline_offset
;
23001 if (font
->vertical_centering
)
23002 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23005 ascent
= FONT_BASE (font
) + boff
;
23006 descent
= FONT_DESCENT (font
) - boff
;
23010 it
->override_ascent
= ascent
;
23011 it
->override_descent
= descent
;
23012 it
->override_boff
= boff
;
23015 height
= ascent
+ descent
;
23019 height
= (int)(XFLOAT_DATA (val
) * height
);
23020 else if (INTEGERP (val
))
23021 height
*= XINT (val
);
23023 return make_number (height
);
23027 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23028 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23029 and only if this is for a character for which no font was found.
23031 If the display method (it->glyphless_method) is
23032 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23033 length of the acronym or the hexadecimal string, UPPER_XOFF and
23034 UPPER_YOFF are pixel offsets for the upper part of the string,
23035 LOWER_XOFF and LOWER_YOFF are for the lower part.
23037 For the other display methods, LEN through LOWER_YOFF are zero. */
23040 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23041 short upper_xoff
, short upper_yoff
,
23042 short lower_xoff
, short lower_yoff
)
23044 struct glyph
*glyph
;
23045 enum glyph_row_area area
= it
->area
;
23047 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23048 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23050 /* If the glyph row is reversed, we need to prepend the glyph
23051 rather than append it. */
23052 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23056 /* Make room for the additional glyph. */
23057 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23059 glyph
= it
->glyph_row
->glyphs
[area
];
23061 glyph
->charpos
= CHARPOS (it
->position
);
23062 glyph
->object
= it
->object
;
23063 glyph
->pixel_width
= it
->pixel_width
;
23064 glyph
->ascent
= it
->ascent
;
23065 glyph
->descent
= it
->descent
;
23066 glyph
->voffset
= it
->voffset
;
23067 glyph
->type
= GLYPHLESS_GLYPH
;
23068 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23069 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23070 glyph
->u
.glyphless
.len
= len
;
23071 glyph
->u
.glyphless
.ch
= it
->c
;
23072 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23073 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23074 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23075 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23076 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23077 glyph
->multibyte_p
= it
->multibyte_p
;
23078 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23079 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23080 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23081 || it
->phys_descent
> it
->descent
);
23082 glyph
->padding_p
= 0;
23083 glyph
->glyph_not_available_p
= 0;
23084 glyph
->face_id
= face_id
;
23085 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23088 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23089 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23091 glyph
->bidi_type
= it
->bidi_it
.type
;
23093 ++it
->glyph_row
->used
[area
];
23096 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23100 /* Produce a glyph for a glyphless character for iterator IT.
23101 IT->glyphless_method specifies which method to use for displaying
23102 the character. See the description of enum
23103 glyphless_display_method in dispextern.h for the detail.
23105 FOR_NO_FONT is nonzero if and only if this is for a character for
23106 which no font was found. ACRONYM, if non-nil, is an acronym string
23107 for the character. */
23110 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23115 int base_width
, base_height
, width
, height
;
23116 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23119 /* Get the metrics of the base font. We always refer to the current
23121 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23122 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23123 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23124 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23125 base_height
= it
->ascent
+ it
->descent
;
23126 base_width
= font
->average_width
;
23128 /* Get a face ID for the glyph by utilizing a cache (the same way as
23129 doen for `escape-glyph' in get_next_display_element). */
23130 if (it
->f
== last_glyphless_glyph_frame
23131 && it
->face_id
== last_glyphless_glyph_face_id
)
23133 face_id
= last_glyphless_glyph_merged_face_id
;
23137 /* Merge the `glyphless-char' face into the current face. */
23138 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23139 last_glyphless_glyph_frame
= it
->f
;
23140 last_glyphless_glyph_face_id
= it
->face_id
;
23141 last_glyphless_glyph_merged_face_id
= face_id
;
23144 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23146 it
->pixel_width
= THIN_SPACE_WIDTH
;
23148 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23150 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23152 width
= CHAR_WIDTH (it
->c
);
23155 else if (width
> 4)
23157 it
->pixel_width
= base_width
* width
;
23159 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23165 unsigned int code
[6];
23167 int ascent
, descent
;
23168 struct font_metrics metrics_upper
, metrics_lower
;
23170 face
= FACE_FROM_ID (it
->f
, face_id
);
23171 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23172 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23174 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23176 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23177 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23178 if (CONSP (acronym
))
23179 acronym
= XCAR (acronym
);
23180 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23184 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23185 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23188 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23189 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23190 upper_len
= (len
+ 1) / 2;
23191 font
->driver
->text_extents (font
, code
, upper_len
,
23193 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23198 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23199 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23200 upper_xoff
= upper_yoff
= 2; /* the typical case */
23201 if (base_width
>= width
)
23203 /* Align the upper to the left, the lower to the right. */
23204 it
->pixel_width
= base_width
;
23205 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23209 /* Center the shorter one. */
23210 it
->pixel_width
= width
;
23211 if (metrics_upper
.width
>= metrics_lower
.width
)
23212 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23215 /* FIXME: This code doesn't look right. It formerly was
23216 missing the "lower_xoff = 0;", which couldn't have
23217 been right since it left lower_xoff uninitialized. */
23219 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23223 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23224 top, bottom, and between upper and lower strings. */
23225 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23226 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23227 /* Center vertically.
23228 H:base_height, D:base_descent
23229 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23231 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23232 descent = D - H/2 + h/2;
23233 lower_yoff = descent - 2 - ld;
23234 upper_yoff = lower_yoff - la - 1 - ud; */
23235 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23236 descent
= it
->descent
- (base_height
- height
) / 2;
23237 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23238 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23239 - metrics_upper
.descent
);
23240 /* Don't make the height shorter than the base height. */
23241 if (height
> base_height
)
23243 it
->ascent
= ascent
;
23244 it
->descent
= descent
;
23248 it
->phys_ascent
= it
->ascent
;
23249 it
->phys_descent
= it
->descent
;
23251 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23252 upper_xoff
, upper_yoff
,
23253 lower_xoff
, lower_yoff
);
23255 take_vertical_position_into_account (it
);
23260 Produce glyphs/get display metrics for the display element IT is
23261 loaded with. See the description of struct it in dispextern.h
23262 for an overview of struct it. */
23265 x_produce_glyphs (struct it
*it
)
23267 int extra_line_spacing
= it
->extra_line_spacing
;
23269 it
->glyph_not_available_p
= 0;
23271 if (it
->what
== IT_CHARACTER
)
23274 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23275 struct font
*font
= face
->font
;
23276 struct font_metrics
*pcm
= NULL
;
23277 int boff
; /* baseline offset */
23281 /* When no suitable font is found, display this character by
23282 the method specified in the first extra slot of
23283 Vglyphless_char_display. */
23284 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23286 xassert (it
->what
== IT_GLYPHLESS
);
23287 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23291 boff
= font
->baseline_offset
;
23292 if (font
->vertical_centering
)
23293 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23295 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23301 if (it
->override_ascent
>= 0)
23303 it
->ascent
= it
->override_ascent
;
23304 it
->descent
= it
->override_descent
;
23305 boff
= it
->override_boff
;
23309 it
->ascent
= FONT_BASE (font
) + boff
;
23310 it
->descent
= FONT_DESCENT (font
) - boff
;
23313 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23315 pcm
= get_per_char_metric (font
, &char2b
);
23316 if (pcm
->width
== 0
23317 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23323 it
->phys_ascent
= pcm
->ascent
+ boff
;
23324 it
->phys_descent
= pcm
->descent
- boff
;
23325 it
->pixel_width
= pcm
->width
;
23329 it
->glyph_not_available_p
= 1;
23330 it
->phys_ascent
= it
->ascent
;
23331 it
->phys_descent
= it
->descent
;
23332 it
->pixel_width
= font
->space_width
;
23335 if (it
->constrain_row_ascent_descent_p
)
23337 if (it
->descent
> it
->max_descent
)
23339 it
->ascent
+= it
->descent
- it
->max_descent
;
23340 it
->descent
= it
->max_descent
;
23342 if (it
->ascent
> it
->max_ascent
)
23344 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23345 it
->ascent
= it
->max_ascent
;
23347 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23348 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23349 extra_line_spacing
= 0;
23352 /* If this is a space inside a region of text with
23353 `space-width' property, change its width. */
23354 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23356 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23358 /* If face has a box, add the box thickness to the character
23359 height. If character has a box line to the left and/or
23360 right, add the box line width to the character's width. */
23361 if (face
->box
!= FACE_NO_BOX
)
23363 int thick
= face
->box_line_width
;
23367 it
->ascent
+= thick
;
23368 it
->descent
+= thick
;
23373 if (it
->start_of_box_run_p
)
23374 it
->pixel_width
+= thick
;
23375 if (it
->end_of_box_run_p
)
23376 it
->pixel_width
+= thick
;
23379 /* If face has an overline, add the height of the overline
23380 (1 pixel) and a 1 pixel margin to the character height. */
23381 if (face
->overline_p
)
23382 it
->ascent
+= overline_margin
;
23384 if (it
->constrain_row_ascent_descent_p
)
23386 if (it
->ascent
> it
->max_ascent
)
23387 it
->ascent
= it
->max_ascent
;
23388 if (it
->descent
> it
->max_descent
)
23389 it
->descent
= it
->max_descent
;
23392 take_vertical_position_into_account (it
);
23394 /* If we have to actually produce glyphs, do it. */
23399 /* Translate a space with a `space-width' property
23400 into a stretch glyph. */
23401 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23402 / FONT_HEIGHT (font
));
23403 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23404 it
->ascent
+ it
->descent
, ascent
);
23409 /* If characters with lbearing or rbearing are displayed
23410 in this line, record that fact in a flag of the
23411 glyph row. This is used to optimize X output code. */
23412 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23413 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23415 if (! stretched_p
&& it
->pixel_width
== 0)
23416 /* We assure that all visible glyphs have at least 1-pixel
23418 it
->pixel_width
= 1;
23420 else if (it
->char_to_display
== '\n')
23422 /* A newline has no width, but we need the height of the
23423 line. But if previous part of the line sets a height,
23424 don't increase that height */
23426 Lisp_Object height
;
23427 Lisp_Object total_height
= Qnil
;
23429 it
->override_ascent
= -1;
23430 it
->pixel_width
= 0;
23433 height
= get_it_property (it
, Qline_height
);
23434 /* Split (line-height total-height) list */
23436 && CONSP (XCDR (height
))
23437 && NILP (XCDR (XCDR (height
))))
23439 total_height
= XCAR (XCDR (height
));
23440 height
= XCAR (height
);
23442 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23444 if (it
->override_ascent
>= 0)
23446 it
->ascent
= it
->override_ascent
;
23447 it
->descent
= it
->override_descent
;
23448 boff
= it
->override_boff
;
23452 it
->ascent
= FONT_BASE (font
) + boff
;
23453 it
->descent
= FONT_DESCENT (font
) - boff
;
23456 if (EQ (height
, Qt
))
23458 if (it
->descent
> it
->max_descent
)
23460 it
->ascent
+= it
->descent
- it
->max_descent
;
23461 it
->descent
= it
->max_descent
;
23463 if (it
->ascent
> it
->max_ascent
)
23465 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23466 it
->ascent
= it
->max_ascent
;
23468 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23469 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23470 it
->constrain_row_ascent_descent_p
= 1;
23471 extra_line_spacing
= 0;
23475 Lisp_Object spacing
;
23477 it
->phys_ascent
= it
->ascent
;
23478 it
->phys_descent
= it
->descent
;
23480 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23481 && face
->box
!= FACE_NO_BOX
23482 && face
->box_line_width
> 0)
23484 it
->ascent
+= face
->box_line_width
;
23485 it
->descent
+= face
->box_line_width
;
23488 && XINT (height
) > it
->ascent
+ it
->descent
)
23489 it
->ascent
= XINT (height
) - it
->descent
;
23491 if (!NILP (total_height
))
23492 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23495 spacing
= get_it_property (it
, Qline_spacing
);
23496 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23498 if (INTEGERP (spacing
))
23500 extra_line_spacing
= XINT (spacing
);
23501 if (!NILP (total_height
))
23502 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23506 else /* i.e. (it->char_to_display == '\t') */
23508 if (font
->space_width
> 0)
23510 int tab_width
= it
->tab_width
* font
->space_width
;
23511 int x
= it
->current_x
+ it
->continuation_lines_width
;
23512 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23514 /* If the distance from the current position to the next tab
23515 stop is less than a space character width, use the
23516 tab stop after that. */
23517 if (next_tab_x
- x
< font
->space_width
)
23518 next_tab_x
+= tab_width
;
23520 it
->pixel_width
= next_tab_x
- x
;
23522 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23523 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23527 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23528 it
->ascent
+ it
->descent
, it
->ascent
);
23533 it
->pixel_width
= 0;
23538 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23540 /* A static composition.
23542 Note: A composition is represented as one glyph in the
23543 glyph matrix. There are no padding glyphs.
23545 Important note: pixel_width, ascent, and descent are the
23546 values of what is drawn by draw_glyphs (i.e. the values of
23547 the overall glyphs composed). */
23548 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23549 int boff
; /* baseline offset */
23550 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23551 int glyph_len
= cmp
->glyph_len
;
23552 struct font
*font
= face
->font
;
23556 /* If we have not yet calculated pixel size data of glyphs of
23557 the composition for the current face font, calculate them
23558 now. Theoretically, we have to check all fonts for the
23559 glyphs, but that requires much time and memory space. So,
23560 here we check only the font of the first glyph. This may
23561 lead to incorrect display, but it's very rare, and C-l
23562 (recenter-top-bottom) can correct the display anyway. */
23563 if (! cmp
->font
|| cmp
->font
!= font
)
23565 /* Ascent and descent of the font of the first character
23566 of this composition (adjusted by baseline offset).
23567 Ascent and descent of overall glyphs should not be less
23568 than these, respectively. */
23569 int font_ascent
, font_descent
, font_height
;
23570 /* Bounding box of the overall glyphs. */
23571 int leftmost
, rightmost
, lowest
, highest
;
23572 int lbearing
, rbearing
;
23573 int i
, width
, ascent
, descent
;
23574 int left_padded
= 0, right_padded
= 0;
23575 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23577 struct font_metrics
*pcm
;
23578 int font_not_found_p
;
23581 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23582 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23584 if (glyph_len
< cmp
->glyph_len
)
23586 for (i
= 0; i
< glyph_len
; i
++)
23588 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23590 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23595 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23596 : IT_CHARPOS (*it
));
23597 /* If no suitable font is found, use the default font. */
23598 font_not_found_p
= font
== NULL
;
23599 if (font_not_found_p
)
23601 face
= face
->ascii_face
;
23604 boff
= font
->baseline_offset
;
23605 if (font
->vertical_centering
)
23606 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23607 font_ascent
= FONT_BASE (font
) + boff
;
23608 font_descent
= FONT_DESCENT (font
) - boff
;
23609 font_height
= FONT_HEIGHT (font
);
23611 cmp
->font
= (void *) font
;
23614 if (! font_not_found_p
)
23616 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23618 pcm
= get_per_char_metric (font
, &char2b
);
23621 /* Initialize the bounding box. */
23624 width
= pcm
->width
;
23625 ascent
= pcm
->ascent
;
23626 descent
= pcm
->descent
;
23627 lbearing
= pcm
->lbearing
;
23628 rbearing
= pcm
->rbearing
;
23632 width
= font
->space_width
;
23633 ascent
= FONT_BASE (font
);
23634 descent
= FONT_DESCENT (font
);
23641 lowest
= - descent
+ boff
;
23642 highest
= ascent
+ boff
;
23644 if (! font_not_found_p
23645 && font
->default_ascent
23646 && CHAR_TABLE_P (Vuse_default_ascent
)
23647 && !NILP (Faref (Vuse_default_ascent
,
23648 make_number (it
->char_to_display
))))
23649 highest
= font
->default_ascent
+ boff
;
23651 /* Draw the first glyph at the normal position. It may be
23652 shifted to right later if some other glyphs are drawn
23654 cmp
->offsets
[i
* 2] = 0;
23655 cmp
->offsets
[i
* 2 + 1] = boff
;
23656 cmp
->lbearing
= lbearing
;
23657 cmp
->rbearing
= rbearing
;
23659 /* Set cmp->offsets for the remaining glyphs. */
23660 for (i
++; i
< glyph_len
; i
++)
23662 int left
, right
, btm
, top
;
23663 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23665 struct face
*this_face
;
23669 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23670 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23671 font
= this_face
->font
;
23677 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23679 pcm
= get_per_char_metric (font
, &char2b
);
23682 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23685 width
= pcm
->width
;
23686 ascent
= pcm
->ascent
;
23687 descent
= pcm
->descent
;
23688 lbearing
= pcm
->lbearing
;
23689 rbearing
= pcm
->rbearing
;
23690 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23692 /* Relative composition with or without
23693 alternate chars. */
23694 left
= (leftmost
+ rightmost
- width
) / 2;
23695 btm
= - descent
+ boff
;
23696 if (font
->relative_compose
23697 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23698 || NILP (Faref (Vignore_relative_composition
,
23699 make_number (ch
)))))
23702 if (- descent
>= font
->relative_compose
)
23703 /* One extra pixel between two glyphs. */
23705 else if (ascent
<= 0)
23706 /* One extra pixel between two glyphs. */
23707 btm
= lowest
- 1 - ascent
- descent
;
23712 /* A composition rule is specified by an integer
23713 value that encodes global and new reference
23714 points (GREF and NREF). GREF and NREF are
23715 specified by numbers as below:
23717 0---1---2 -- ascent
23721 9--10--11 -- center
23723 ---3---4---5--- baseline
23725 6---7---8 -- descent
23727 int rule
= COMPOSITION_RULE (cmp
, i
);
23728 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23730 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23731 grefx
= gref
% 3, nrefx
= nref
% 3;
23732 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23734 xoff
= font_height
* (xoff
- 128) / 256;
23736 yoff
= font_height
* (yoff
- 128) / 256;
23739 + grefx
* (rightmost
- leftmost
) / 2
23740 - nrefx
* width
/ 2
23743 btm
= ((grefy
== 0 ? highest
23745 : grefy
== 2 ? lowest
23746 : (highest
+ lowest
) / 2)
23747 - (nrefy
== 0 ? ascent
+ descent
23748 : nrefy
== 1 ? descent
- boff
23750 : (ascent
+ descent
) / 2)
23754 cmp
->offsets
[i
* 2] = left
;
23755 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23757 /* Update the bounding box of the overall glyphs. */
23760 right
= left
+ width
;
23761 if (left
< leftmost
)
23763 if (right
> rightmost
)
23766 top
= btm
+ descent
+ ascent
;
23772 if (cmp
->lbearing
> left
+ lbearing
)
23773 cmp
->lbearing
= left
+ lbearing
;
23774 if (cmp
->rbearing
< left
+ rbearing
)
23775 cmp
->rbearing
= left
+ rbearing
;
23779 /* If there are glyphs whose x-offsets are negative,
23780 shift all glyphs to the right and make all x-offsets
23784 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23785 cmp
->offsets
[i
* 2] -= leftmost
;
23786 rightmost
-= leftmost
;
23787 cmp
->lbearing
-= leftmost
;
23788 cmp
->rbearing
-= leftmost
;
23791 if (left_padded
&& cmp
->lbearing
< 0)
23793 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23794 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23795 rightmost
-= cmp
->lbearing
;
23796 cmp
->rbearing
-= cmp
->lbearing
;
23799 if (right_padded
&& rightmost
< cmp
->rbearing
)
23801 rightmost
= cmp
->rbearing
;
23804 cmp
->pixel_width
= rightmost
;
23805 cmp
->ascent
= highest
;
23806 cmp
->descent
= - lowest
;
23807 if (cmp
->ascent
< font_ascent
)
23808 cmp
->ascent
= font_ascent
;
23809 if (cmp
->descent
< font_descent
)
23810 cmp
->descent
= font_descent
;
23814 && (cmp
->lbearing
< 0
23815 || cmp
->rbearing
> cmp
->pixel_width
))
23816 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23818 it
->pixel_width
= cmp
->pixel_width
;
23819 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23820 it
->descent
= it
->phys_descent
= cmp
->descent
;
23821 if (face
->box
!= FACE_NO_BOX
)
23823 int thick
= face
->box_line_width
;
23827 it
->ascent
+= thick
;
23828 it
->descent
+= thick
;
23833 if (it
->start_of_box_run_p
)
23834 it
->pixel_width
+= thick
;
23835 if (it
->end_of_box_run_p
)
23836 it
->pixel_width
+= thick
;
23839 /* If face has an overline, add the height of the overline
23840 (1 pixel) and a 1 pixel margin to the character height. */
23841 if (face
->overline_p
)
23842 it
->ascent
+= overline_margin
;
23844 take_vertical_position_into_account (it
);
23845 if (it
->ascent
< 0)
23847 if (it
->descent
< 0)
23851 append_composite_glyph (it
);
23853 else if (it
->what
== IT_COMPOSITION
)
23855 /* A dynamic (automatic) composition. */
23856 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23857 Lisp_Object gstring
;
23858 struct font_metrics metrics
;
23860 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23862 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23865 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23866 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23867 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23868 it
->descent
= it
->phys_descent
= metrics
.descent
;
23869 if (face
->box
!= FACE_NO_BOX
)
23871 int thick
= face
->box_line_width
;
23875 it
->ascent
+= thick
;
23876 it
->descent
+= thick
;
23881 if (it
->start_of_box_run_p
)
23882 it
->pixel_width
+= thick
;
23883 if (it
->end_of_box_run_p
)
23884 it
->pixel_width
+= thick
;
23886 /* If face has an overline, add the height of the overline
23887 (1 pixel) and a 1 pixel margin to the character height. */
23888 if (face
->overline_p
)
23889 it
->ascent
+= overline_margin
;
23890 take_vertical_position_into_account (it
);
23891 if (it
->ascent
< 0)
23893 if (it
->descent
< 0)
23897 append_composite_glyph (it
);
23899 else if (it
->what
== IT_GLYPHLESS
)
23900 produce_glyphless_glyph (it
, 0, Qnil
);
23901 else if (it
->what
== IT_IMAGE
)
23902 produce_image_glyph (it
);
23903 else if (it
->what
== IT_STRETCH
)
23904 produce_stretch_glyph (it
);
23907 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23908 because this isn't true for images with `:ascent 100'. */
23909 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23910 if (it
->area
== TEXT_AREA
)
23911 it
->current_x
+= it
->pixel_width
;
23913 if (extra_line_spacing
> 0)
23915 it
->descent
+= extra_line_spacing
;
23916 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23917 it
->max_extra_line_spacing
= extra_line_spacing
;
23920 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23921 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23922 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23923 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23927 Output LEN glyphs starting at START at the nominal cursor position.
23928 Advance the nominal cursor over the text. The global variable
23929 updated_window contains the window being updated, updated_row is
23930 the glyph row being updated, and updated_area is the area of that
23931 row being updated. */
23934 x_write_glyphs (struct glyph
*start
, int len
)
23938 xassert (updated_window
&& updated_row
);
23941 /* Write glyphs. */
23943 hpos
= start
- updated_row
->glyphs
[updated_area
];
23944 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23945 updated_row
, updated_area
,
23947 DRAW_NORMAL_TEXT
, 0);
23949 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23950 if (updated_area
== TEXT_AREA
23951 && updated_window
->phys_cursor_on_p
23952 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23953 && updated_window
->phys_cursor
.hpos
>= hpos
23954 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23955 updated_window
->phys_cursor_on_p
= 0;
23959 /* Advance the output cursor. */
23960 output_cursor
.hpos
+= len
;
23961 output_cursor
.x
= x
;
23966 Insert LEN glyphs from START at the nominal cursor position. */
23969 x_insert_glyphs (struct glyph
*start
, int len
)
23973 int line_height
, shift_by_width
, shifted_region_width
;
23974 struct glyph_row
*row
;
23975 struct glyph
*glyph
;
23976 int frame_x
, frame_y
;
23979 xassert (updated_window
&& updated_row
);
23981 w
= updated_window
;
23982 f
= XFRAME (WINDOW_FRAME (w
));
23984 /* Get the height of the line we are in. */
23986 line_height
= row
->height
;
23988 /* Get the width of the glyphs to insert. */
23989 shift_by_width
= 0;
23990 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23991 shift_by_width
+= glyph
->pixel_width
;
23993 /* Get the width of the region to shift right. */
23994 shifted_region_width
= (window_box_width (w
, updated_area
)
23999 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24000 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24002 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24003 line_height
, shift_by_width
);
24005 /* Write the glyphs. */
24006 hpos
= start
- row
->glyphs
[updated_area
];
24007 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24009 DRAW_NORMAL_TEXT
, 0);
24011 /* Advance the output cursor. */
24012 output_cursor
.hpos
+= len
;
24013 output_cursor
.x
+= shift_by_width
;
24019 Erase the current text line from the nominal cursor position
24020 (inclusive) to pixel column TO_X (exclusive). The idea is that
24021 everything from TO_X onward is already erased.
24023 TO_X is a pixel position relative to updated_area of
24024 updated_window. TO_X == -1 means clear to the end of this area. */
24027 x_clear_end_of_line (int to_x
)
24030 struct window
*w
= updated_window
;
24031 int max_x
, min_y
, max_y
;
24032 int from_x
, from_y
, to_y
;
24034 xassert (updated_window
&& updated_row
);
24035 f
= XFRAME (w
->frame
);
24037 if (updated_row
->full_width_p
)
24038 max_x
= WINDOW_TOTAL_WIDTH (w
);
24040 max_x
= window_box_width (w
, updated_area
);
24041 max_y
= window_text_bottom_y (w
);
24043 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24044 of window. For TO_X > 0, truncate to end of drawing area. */
24050 to_x
= min (to_x
, max_x
);
24052 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24054 /* Notice if the cursor will be cleared by this operation. */
24055 if (!updated_row
->full_width_p
)
24056 notice_overwritten_cursor (w
, updated_area
,
24057 output_cursor
.x
, -1,
24059 MATRIX_ROW_BOTTOM_Y (updated_row
));
24061 from_x
= output_cursor
.x
;
24063 /* Translate to frame coordinates. */
24064 if (updated_row
->full_width_p
)
24066 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24067 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24071 int area_left
= window_box_left (w
, updated_area
);
24072 from_x
+= area_left
;
24076 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24077 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24078 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24080 /* Prevent inadvertently clearing to end of the X window. */
24081 if (to_x
> from_x
&& to_y
> from_y
)
24084 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24085 to_x
- from_x
, to_y
- from_y
);
24090 #endif /* HAVE_WINDOW_SYSTEM */
24094 /***********************************************************************
24096 ***********************************************************************/
24098 /* Value is the internal representation of the specified cursor type
24099 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24100 of the bar cursor. */
24102 static enum text_cursor_kinds
24103 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24105 enum text_cursor_kinds type
;
24110 if (EQ (arg
, Qbox
))
24111 return FILLED_BOX_CURSOR
;
24113 if (EQ (arg
, Qhollow
))
24114 return HOLLOW_BOX_CURSOR
;
24116 if (EQ (arg
, Qbar
))
24123 && EQ (XCAR (arg
), Qbar
)
24124 && INTEGERP (XCDR (arg
))
24125 && XINT (XCDR (arg
)) >= 0)
24127 *width
= XINT (XCDR (arg
));
24131 if (EQ (arg
, Qhbar
))
24134 return HBAR_CURSOR
;
24138 && EQ (XCAR (arg
), Qhbar
)
24139 && INTEGERP (XCDR (arg
))
24140 && XINT (XCDR (arg
)) >= 0)
24142 *width
= XINT (XCDR (arg
));
24143 return HBAR_CURSOR
;
24146 /* Treat anything unknown as "hollow box cursor".
24147 It was bad to signal an error; people have trouble fixing
24148 .Xdefaults with Emacs, when it has something bad in it. */
24149 type
= HOLLOW_BOX_CURSOR
;
24154 /* Set the default cursor types for specified frame. */
24156 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24161 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24162 FRAME_CURSOR_WIDTH (f
) = width
;
24164 /* By default, set up the blink-off state depending on the on-state. */
24166 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24169 FRAME_BLINK_OFF_CURSOR (f
)
24170 = get_specified_cursor_type (XCDR (tem
), &width
);
24171 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24174 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24178 #ifdef HAVE_WINDOW_SYSTEM
24180 /* Return the cursor we want to be displayed in window W. Return
24181 width of bar/hbar cursor through WIDTH arg. Return with
24182 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24183 (i.e. if the `system caret' should track this cursor).
24185 In a mini-buffer window, we want the cursor only to appear if we
24186 are reading input from this window. For the selected window, we
24187 want the cursor type given by the frame parameter or buffer local
24188 setting of cursor-type. If explicitly marked off, draw no cursor.
24189 In all other cases, we want a hollow box cursor. */
24191 static enum text_cursor_kinds
24192 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24193 int *active_cursor
)
24195 struct frame
*f
= XFRAME (w
->frame
);
24196 struct buffer
*b
= XBUFFER (w
->buffer
);
24197 int cursor_type
= DEFAULT_CURSOR
;
24198 Lisp_Object alt_cursor
;
24199 int non_selected
= 0;
24201 *active_cursor
= 1;
24204 if (cursor_in_echo_area
24205 && FRAME_HAS_MINIBUF_P (f
)
24206 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24208 if (w
== XWINDOW (echo_area_window
))
24210 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24212 *width
= FRAME_CURSOR_WIDTH (f
);
24213 return FRAME_DESIRED_CURSOR (f
);
24216 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24219 *active_cursor
= 0;
24223 /* Detect a nonselected window or nonselected frame. */
24224 else if (w
!= XWINDOW (f
->selected_window
)
24225 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24227 *active_cursor
= 0;
24229 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24235 /* Never display a cursor in a window in which cursor-type is nil. */
24236 if (NILP (BVAR (b
, cursor_type
)))
24239 /* Get the normal cursor type for this window. */
24240 if (EQ (BVAR (b
, cursor_type
), Qt
))
24242 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24243 *width
= FRAME_CURSOR_WIDTH (f
);
24246 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24248 /* Use cursor-in-non-selected-windows instead
24249 for non-selected window or frame. */
24252 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24253 if (!EQ (Qt
, alt_cursor
))
24254 return get_specified_cursor_type (alt_cursor
, width
);
24255 /* t means modify the normal cursor type. */
24256 if (cursor_type
== FILLED_BOX_CURSOR
)
24257 cursor_type
= HOLLOW_BOX_CURSOR
;
24258 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24260 return cursor_type
;
24263 /* Use normal cursor if not blinked off. */
24264 if (!w
->cursor_off_p
)
24266 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24268 if (cursor_type
== FILLED_BOX_CURSOR
)
24270 /* Using a block cursor on large images can be very annoying.
24271 So use a hollow cursor for "large" images.
24272 If image is not transparent (no mask), also use hollow cursor. */
24273 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24274 if (img
!= NULL
&& IMAGEP (img
->spec
))
24276 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24277 where N = size of default frame font size.
24278 This should cover most of the "tiny" icons people may use. */
24280 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24281 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24282 cursor_type
= HOLLOW_BOX_CURSOR
;
24285 else if (cursor_type
!= NO_CURSOR
)
24287 /* Display current only supports BOX and HOLLOW cursors for images.
24288 So for now, unconditionally use a HOLLOW cursor when cursor is
24289 not a solid box cursor. */
24290 cursor_type
= HOLLOW_BOX_CURSOR
;
24293 return cursor_type
;
24296 /* Cursor is blinked off, so determine how to "toggle" it. */
24298 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24299 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24300 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24302 /* Then see if frame has specified a specific blink off cursor type. */
24303 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24305 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24306 return FRAME_BLINK_OFF_CURSOR (f
);
24310 /* Some people liked having a permanently visible blinking cursor,
24311 while others had very strong opinions against it. So it was
24312 decided to remove it. KFS 2003-09-03 */
24314 /* Finally perform built-in cursor blinking:
24315 filled box <-> hollow box
24316 wide [h]bar <-> narrow [h]bar
24317 narrow [h]bar <-> no cursor
24318 other type <-> no cursor */
24320 if (cursor_type
== FILLED_BOX_CURSOR
)
24321 return HOLLOW_BOX_CURSOR
;
24323 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24326 return cursor_type
;
24334 /* Notice when the text cursor of window W has been completely
24335 overwritten by a drawing operation that outputs glyphs in AREA
24336 starting at X0 and ending at X1 in the line starting at Y0 and
24337 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24338 the rest of the line after X0 has been written. Y coordinates
24339 are window-relative. */
24342 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24343 int x0
, int x1
, int y0
, int y1
)
24345 int cx0
, cx1
, cy0
, cy1
;
24346 struct glyph_row
*row
;
24348 if (!w
->phys_cursor_on_p
)
24350 if (area
!= TEXT_AREA
)
24353 if (w
->phys_cursor
.vpos
< 0
24354 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24355 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24356 !(row
->enabled_p
&& row
->displays_text_p
)))
24359 if (row
->cursor_in_fringe_p
)
24361 row
->cursor_in_fringe_p
= 0;
24362 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24363 w
->phys_cursor_on_p
= 0;
24367 cx0
= w
->phys_cursor
.x
;
24368 cx1
= cx0
+ w
->phys_cursor_width
;
24369 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24372 /* The cursor image will be completely removed from the
24373 screen if the output area intersects the cursor area in
24374 y-direction. When we draw in [y0 y1[, and some part of
24375 the cursor is at y < y0, that part must have been drawn
24376 before. When scrolling, the cursor is erased before
24377 actually scrolling, so we don't come here. When not
24378 scrolling, the rows above the old cursor row must have
24379 changed, and in this case these rows must have written
24380 over the cursor image.
24382 Likewise if part of the cursor is below y1, with the
24383 exception of the cursor being in the first blank row at
24384 the buffer and window end because update_text_area
24385 doesn't draw that row. (Except when it does, but
24386 that's handled in update_text_area.) */
24388 cy0
= w
->phys_cursor
.y
;
24389 cy1
= cy0
+ w
->phys_cursor_height
;
24390 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24393 w
->phys_cursor_on_p
= 0;
24396 #endif /* HAVE_WINDOW_SYSTEM */
24399 /************************************************************************
24401 ************************************************************************/
24403 #ifdef HAVE_WINDOW_SYSTEM
24406 Fix the display of area AREA of overlapping row ROW in window W
24407 with respect to the overlapping part OVERLAPS. */
24410 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24411 enum glyph_row_area area
, int overlaps
)
24418 for (i
= 0; i
< row
->used
[area
];)
24420 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24422 int start
= i
, start_x
= x
;
24426 x
+= row
->glyphs
[area
][i
].pixel_width
;
24429 while (i
< row
->used
[area
]
24430 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24432 draw_glyphs (w
, start_x
, row
, area
,
24434 DRAW_NORMAL_TEXT
, overlaps
);
24438 x
+= row
->glyphs
[area
][i
].pixel_width
;
24448 Draw the cursor glyph of window W in glyph row ROW. See the
24449 comment of draw_glyphs for the meaning of HL. */
24452 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24453 enum draw_glyphs_face hl
)
24455 /* If cursor hpos is out of bounds, don't draw garbage. This can
24456 happen in mini-buffer windows when switching between echo area
24457 glyphs and mini-buffer. */
24458 if ((row
->reversed_p
24459 ? (w
->phys_cursor
.hpos
>= 0)
24460 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24462 int on_p
= w
->phys_cursor_on_p
;
24464 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24465 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24467 w
->phys_cursor_on_p
= on_p
;
24469 if (hl
== DRAW_CURSOR
)
24470 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24471 /* When we erase the cursor, and ROW is overlapped by other
24472 rows, make sure that these overlapping parts of other rows
24474 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24476 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24478 if (row
> w
->current_matrix
->rows
24479 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24480 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24481 OVERLAPS_ERASED_CURSOR
);
24483 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24484 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24485 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24486 OVERLAPS_ERASED_CURSOR
);
24493 Erase the image of a cursor of window W from the screen. */
24496 erase_phys_cursor (struct window
*w
)
24498 struct frame
*f
= XFRAME (w
->frame
);
24499 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24500 int hpos
= w
->phys_cursor
.hpos
;
24501 int vpos
= w
->phys_cursor
.vpos
;
24502 int mouse_face_here_p
= 0;
24503 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24504 struct glyph_row
*cursor_row
;
24505 struct glyph
*cursor_glyph
;
24506 enum draw_glyphs_face hl
;
24508 /* No cursor displayed or row invalidated => nothing to do on the
24510 if (w
->phys_cursor_type
== NO_CURSOR
)
24511 goto mark_cursor_off
;
24513 /* VPOS >= active_glyphs->nrows means that window has been resized.
24514 Don't bother to erase the cursor. */
24515 if (vpos
>= active_glyphs
->nrows
)
24516 goto mark_cursor_off
;
24518 /* If row containing cursor is marked invalid, there is nothing we
24520 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24521 if (!cursor_row
->enabled_p
)
24522 goto mark_cursor_off
;
24524 /* If line spacing is > 0, old cursor may only be partially visible in
24525 window after split-window. So adjust visible height. */
24526 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24527 window_text_bottom_y (w
) - cursor_row
->y
);
24529 /* If row is completely invisible, don't attempt to delete a cursor which
24530 isn't there. This can happen if cursor is at top of a window, and
24531 we switch to a buffer with a header line in that window. */
24532 if (cursor_row
->visible_height
<= 0)
24533 goto mark_cursor_off
;
24535 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24536 if (cursor_row
->cursor_in_fringe_p
)
24538 cursor_row
->cursor_in_fringe_p
= 0;
24539 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24540 goto mark_cursor_off
;
24543 /* This can happen when the new row is shorter than the old one.
24544 In this case, either draw_glyphs or clear_end_of_line
24545 should have cleared the cursor. Note that we wouldn't be
24546 able to erase the cursor in this case because we don't have a
24547 cursor glyph at hand. */
24548 if ((cursor_row
->reversed_p
24549 ? (w
->phys_cursor
.hpos
< 0)
24550 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24551 goto mark_cursor_off
;
24553 /* If the cursor is in the mouse face area, redisplay that when
24554 we clear the cursor. */
24555 if (! NILP (hlinfo
->mouse_face_window
)
24556 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24557 /* Don't redraw the cursor's spot in mouse face if it is at the
24558 end of a line (on a newline). The cursor appears there, but
24559 mouse highlighting does not. */
24560 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24561 mouse_face_here_p
= 1;
24563 /* Maybe clear the display under the cursor. */
24564 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24567 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24570 cursor_glyph
= get_phys_cursor_glyph (w
);
24571 if (cursor_glyph
== NULL
)
24572 goto mark_cursor_off
;
24574 width
= cursor_glyph
->pixel_width
;
24575 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24576 x
= w
->phys_cursor
.x
;
24578 width
-= left_x
- x
;
24579 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24580 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24581 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24584 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24587 /* Erase the cursor by redrawing the character underneath it. */
24588 if (mouse_face_here_p
)
24589 hl
= DRAW_MOUSE_FACE
;
24591 hl
= DRAW_NORMAL_TEXT
;
24592 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24595 w
->phys_cursor_on_p
= 0;
24596 w
->phys_cursor_type
= NO_CURSOR
;
24601 Display or clear cursor of window W. If ON is zero, clear the
24602 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24603 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24606 display_and_set_cursor (struct window
*w
, int on
,
24607 int hpos
, int vpos
, int x
, int y
)
24609 struct frame
*f
= XFRAME (w
->frame
);
24610 int new_cursor_type
;
24611 int new_cursor_width
;
24613 struct glyph_row
*glyph_row
;
24614 struct glyph
*glyph
;
24616 /* This is pointless on invisible frames, and dangerous on garbaged
24617 windows and frames; in the latter case, the frame or window may
24618 be in the midst of changing its size, and x and y may be off the
24620 if (! FRAME_VISIBLE_P (f
)
24621 || FRAME_GARBAGED_P (f
)
24622 || vpos
>= w
->current_matrix
->nrows
24623 || hpos
>= w
->current_matrix
->matrix_w
)
24626 /* If cursor is off and we want it off, return quickly. */
24627 if (!on
&& !w
->phys_cursor_on_p
)
24630 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24631 /* If cursor row is not enabled, we don't really know where to
24632 display the cursor. */
24633 if (!glyph_row
->enabled_p
)
24635 w
->phys_cursor_on_p
= 0;
24640 if (!glyph_row
->exact_window_width_line_p
24641 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24642 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24644 xassert (interrupt_input_blocked
);
24646 /* Set new_cursor_type to the cursor we want to be displayed. */
24647 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24648 &new_cursor_width
, &active_cursor
);
24650 /* If cursor is currently being shown and we don't want it to be or
24651 it is in the wrong place, or the cursor type is not what we want,
24653 if (w
->phys_cursor_on_p
24655 || w
->phys_cursor
.x
!= x
24656 || w
->phys_cursor
.y
!= y
24657 || new_cursor_type
!= w
->phys_cursor_type
24658 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24659 && new_cursor_width
!= w
->phys_cursor_width
)))
24660 erase_phys_cursor (w
);
24662 /* Don't check phys_cursor_on_p here because that flag is only set
24663 to zero in some cases where we know that the cursor has been
24664 completely erased, to avoid the extra work of erasing the cursor
24665 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24666 still not be visible, or it has only been partly erased. */
24669 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24670 w
->phys_cursor_height
= glyph_row
->height
;
24672 /* Set phys_cursor_.* before x_draw_.* is called because some
24673 of them may need the information. */
24674 w
->phys_cursor
.x
= x
;
24675 w
->phys_cursor
.y
= glyph_row
->y
;
24676 w
->phys_cursor
.hpos
= hpos
;
24677 w
->phys_cursor
.vpos
= vpos
;
24680 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24681 new_cursor_type
, new_cursor_width
,
24682 on
, active_cursor
);
24686 /* Switch the display of W's cursor on or off, according to the value
24690 update_window_cursor (struct window
*w
, int on
)
24692 /* Don't update cursor in windows whose frame is in the process
24693 of being deleted. */
24694 if (w
->current_matrix
)
24697 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24698 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24704 /* Call update_window_cursor with parameter ON_P on all leaf windows
24705 in the window tree rooted at W. */
24708 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24712 if (!NILP (w
->hchild
))
24713 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24714 else if (!NILP (w
->vchild
))
24715 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24717 update_window_cursor (w
, on_p
);
24719 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24725 Display the cursor on window W, or clear it, according to ON_P.
24726 Don't change the cursor's position. */
24729 x_update_cursor (struct frame
*f
, int on_p
)
24731 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24736 Clear the cursor of window W to background color, and mark the
24737 cursor as not shown. This is used when the text where the cursor
24738 is about to be rewritten. */
24741 x_clear_cursor (struct window
*w
)
24743 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24744 update_window_cursor (w
, 0);
24747 #endif /* HAVE_WINDOW_SYSTEM */
24749 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24752 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24753 int start_hpos
, int end_hpos
,
24754 enum draw_glyphs_face draw
)
24756 #ifdef HAVE_WINDOW_SYSTEM
24757 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24759 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24763 #if defined (HAVE_GPM) || defined (MSDOS)
24764 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24768 /* Display the active region described by mouse_face_* according to DRAW. */
24771 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24773 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24774 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24776 if (/* If window is in the process of being destroyed, don't bother
24778 w
->current_matrix
!= NULL
24779 /* Don't update mouse highlight if hidden */
24780 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24781 /* Recognize when we are called to operate on rows that don't exist
24782 anymore. This can happen when a window is split. */
24783 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24785 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24786 struct glyph_row
*row
, *first
, *last
;
24788 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24789 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24791 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24793 int start_hpos
, end_hpos
, start_x
;
24795 /* For all but the first row, the highlight starts at column 0. */
24798 /* R2L rows have BEG and END in reversed order, but the
24799 screen drawing geometry is always left to right. So
24800 we need to mirror the beginning and end of the
24801 highlighted area in R2L rows. */
24802 if (!row
->reversed_p
)
24804 start_hpos
= hlinfo
->mouse_face_beg_col
;
24805 start_x
= hlinfo
->mouse_face_beg_x
;
24807 else if (row
== last
)
24809 start_hpos
= hlinfo
->mouse_face_end_col
;
24810 start_x
= hlinfo
->mouse_face_end_x
;
24818 else if (row
->reversed_p
&& row
== last
)
24820 start_hpos
= hlinfo
->mouse_face_end_col
;
24821 start_x
= hlinfo
->mouse_face_end_x
;
24831 if (!row
->reversed_p
)
24832 end_hpos
= hlinfo
->mouse_face_end_col
;
24833 else if (row
== first
)
24834 end_hpos
= hlinfo
->mouse_face_beg_col
;
24837 end_hpos
= row
->used
[TEXT_AREA
];
24838 if (draw
== DRAW_NORMAL_TEXT
)
24839 row
->fill_line_p
= 1; /* Clear to end of line */
24842 else if (row
->reversed_p
&& row
== first
)
24843 end_hpos
= hlinfo
->mouse_face_beg_col
;
24846 end_hpos
= row
->used
[TEXT_AREA
];
24847 if (draw
== DRAW_NORMAL_TEXT
)
24848 row
->fill_line_p
= 1; /* Clear to end of line */
24851 if (end_hpos
> start_hpos
)
24853 draw_row_with_mouse_face (w
, start_x
, row
,
24854 start_hpos
, end_hpos
, draw
);
24857 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24861 #ifdef HAVE_WINDOW_SYSTEM
24862 /* When we've written over the cursor, arrange for it to
24863 be displayed again. */
24864 if (FRAME_WINDOW_P (f
)
24865 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24868 display_and_set_cursor (w
, 1,
24869 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24870 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24873 #endif /* HAVE_WINDOW_SYSTEM */
24876 #ifdef HAVE_WINDOW_SYSTEM
24877 /* Change the mouse cursor. */
24878 if (FRAME_WINDOW_P (f
))
24880 if (draw
== DRAW_NORMAL_TEXT
24881 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24882 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24883 else if (draw
== DRAW_MOUSE_FACE
)
24884 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24886 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24888 #endif /* HAVE_WINDOW_SYSTEM */
24892 Clear out the mouse-highlighted active region.
24893 Redraw it un-highlighted first. Value is non-zero if mouse
24894 face was actually drawn unhighlighted. */
24897 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24901 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24903 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24907 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24908 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24909 hlinfo
->mouse_face_window
= Qnil
;
24910 hlinfo
->mouse_face_overlay
= Qnil
;
24914 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24915 within the mouse face on that window. */
24917 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24919 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24921 /* Quickly resolve the easy cases. */
24922 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24923 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24925 if (vpos
< hlinfo
->mouse_face_beg_row
24926 || vpos
> hlinfo
->mouse_face_end_row
)
24928 if (vpos
> hlinfo
->mouse_face_beg_row
24929 && vpos
< hlinfo
->mouse_face_end_row
)
24932 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24934 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24936 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24939 else if ((vpos
== hlinfo
->mouse_face_beg_row
24940 && hpos
>= hlinfo
->mouse_face_beg_col
)
24941 || (vpos
== hlinfo
->mouse_face_end_row
24942 && hpos
< hlinfo
->mouse_face_end_col
))
24947 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24949 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24952 else if ((vpos
== hlinfo
->mouse_face_beg_row
24953 && hpos
<= hlinfo
->mouse_face_beg_col
)
24954 || (vpos
== hlinfo
->mouse_face_end_row
24955 && hpos
> hlinfo
->mouse_face_end_col
))
24963 Non-zero if physical cursor of window W is within mouse face. */
24966 cursor_in_mouse_face_p (struct window
*w
)
24968 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24973 /* Find the glyph rows START_ROW and END_ROW of window W that display
24974 characters between buffer positions START_CHARPOS and END_CHARPOS
24975 (excluding END_CHARPOS). This is similar to row_containing_pos,
24976 but is more accurate when bidi reordering makes buffer positions
24977 change non-linearly with glyph rows. */
24979 rows_from_pos_range (struct window
*w
,
24980 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24981 struct glyph_row
**start
, struct glyph_row
**end
)
24983 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24984 int last_y
= window_text_bottom_y (w
);
24985 struct glyph_row
*row
;
24990 while (!first
->enabled_p
24991 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24994 /* Find the START row. */
24996 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24999 /* A row can potentially be the START row if the range of the
25000 characters it displays intersects the range
25001 [START_CHARPOS..END_CHARPOS). */
25002 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25003 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25004 /* See the commentary in row_containing_pos, for the
25005 explanation of the complicated way to check whether
25006 some position is beyond the end of the characters
25007 displayed by a row. */
25008 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25009 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25010 && !row
->ends_at_zv_p
25011 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25012 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25013 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25014 && !row
->ends_at_zv_p
25015 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25017 /* Found a candidate row. Now make sure at least one of the
25018 glyphs it displays has a charpos from the range
25019 [START_CHARPOS..END_CHARPOS).
25021 This is not obvious because bidi reordering could make
25022 buffer positions of a row be 1,2,3,102,101,100, and if we
25023 want to highlight characters in [50..60), we don't want
25024 this row, even though [50..60) does intersect [1..103),
25025 the range of character positions given by the row's start
25026 and end positions. */
25027 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25028 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25032 if (BUFFERP (g
->object
)
25033 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25042 /* Find the END row. */
25044 /* If the last row is partially visible, start looking for END
25045 from that row, instead of starting from FIRST. */
25046 && !(row
->enabled_p
25047 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25049 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25051 struct glyph_row
*next
= row
+ 1;
25053 if (!next
->enabled_p
25054 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25055 /* The first row >= START whose range of displayed characters
25056 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25057 is the row END + 1. */
25058 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25059 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25060 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25061 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25062 && !next
->ends_at_zv_p
25063 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25064 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25065 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25066 && !next
->ends_at_zv_p
25067 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25074 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25075 but none of the characters it displays are in the range, it is
25077 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25078 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25082 if (BUFFERP (g
->object
)
25083 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25096 /* This function sets the mouse_face_* elements of HLINFO, assuming
25097 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25098 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25099 for the overlay or run of text properties specifying the mouse
25100 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25101 before-string and after-string that must also be highlighted.
25102 COVER_STRING, if non-nil, is a display string that may cover some
25103 or all of the highlighted text. */
25106 mouse_face_from_buffer_pos (Lisp_Object window
,
25107 Mouse_HLInfo
*hlinfo
,
25108 EMACS_INT mouse_charpos
,
25109 EMACS_INT start_charpos
,
25110 EMACS_INT end_charpos
,
25111 Lisp_Object before_string
,
25112 Lisp_Object after_string
,
25113 Lisp_Object cover_string
)
25115 struct window
*w
= XWINDOW (window
);
25116 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25117 struct glyph_row
*r1
, *r2
;
25118 struct glyph
*glyph
, *end
;
25119 EMACS_INT ignore
, pos
;
25122 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25123 xassert (NILP (before_string
) || STRINGP (before_string
));
25124 xassert (NILP (after_string
) || STRINGP (after_string
));
25126 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25127 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25129 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25130 /* If the before-string or display-string contains newlines,
25131 rows_from_pos_range skips to its last row. Move back. */
25132 if (!NILP (before_string
) || !NILP (cover_string
))
25134 struct glyph_row
*prev
;
25135 while ((prev
= r1
- 1, prev
>= first
)
25136 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25137 && prev
->used
[TEXT_AREA
] > 0)
25139 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25140 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25141 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25143 || !(EQ (glyph
->object
, before_string
)
25144 || EQ (glyph
->object
, cover_string
)))
25151 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25152 hlinfo
->mouse_face_past_end
= 1;
25154 else if (!NILP (after_string
))
25156 /* If the after-string has newlines, advance to its last row. */
25157 struct glyph_row
*next
;
25158 struct glyph_row
*last
25159 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25161 for (next
= r2
+ 1;
25163 && next
->used
[TEXT_AREA
] > 0
25164 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25168 /* The rest of the display engine assumes that mouse_face_beg_row is
25169 either above below mouse_face_end_row or identical to it. But
25170 with bidi-reordered continued lines, the row for START_CHARPOS
25171 could be below the row for END_CHARPOS. If so, swap the rows and
25172 store them in correct order. */
25175 struct glyph_row
*tem
= r2
;
25181 hlinfo
->mouse_face_beg_y
= r1
->y
;
25182 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25183 hlinfo
->mouse_face_end_y
= r2
->y
;
25184 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25186 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25187 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25188 could be anywhere in the row and in any order. The strategy
25189 below is to find the leftmost and the rightmost glyph that
25190 belongs to either of these 3 strings, or whose position is
25191 between START_CHARPOS and END_CHARPOS, and highlight all the
25192 glyphs between those two. This may cover more than just the text
25193 between START_CHARPOS and END_CHARPOS if the range of characters
25194 strides the bidi level boundary, e.g. if the beginning is in R2L
25195 text while the end is in L2R text or vice versa. */
25196 if (!r1
->reversed_p
)
25198 /* This row is in a left to right paragraph. Scan it left to
25200 glyph
= r1
->glyphs
[TEXT_AREA
];
25201 end
= glyph
+ r1
->used
[TEXT_AREA
];
25204 /* Skip truncation glyphs at the start of the glyph row. */
25205 if (r1
->displays_text_p
)
25207 && INTEGERP (glyph
->object
)
25208 && glyph
->charpos
< 0;
25210 x
+= glyph
->pixel_width
;
25212 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25213 or COVER_STRING, and the first glyph from buffer whose
25214 position is between START_CHARPOS and END_CHARPOS. */
25216 && !INTEGERP (glyph
->object
)
25217 && !EQ (glyph
->object
, cover_string
)
25218 && !(BUFFERP (glyph
->object
)
25219 && (glyph
->charpos
>= start_charpos
25220 && glyph
->charpos
< end_charpos
));
25223 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25224 are present at buffer positions between START_CHARPOS and
25225 END_CHARPOS, or if they come from an overlay. */
25226 if (EQ (glyph
->object
, before_string
))
25228 pos
= string_buffer_position (before_string
,
25230 /* If pos == 0, it means before_string came from an
25231 overlay, not from a buffer position. */
25232 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25235 else if (EQ (glyph
->object
, after_string
))
25237 pos
= string_buffer_position (after_string
, end_charpos
);
25238 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25241 x
+= glyph
->pixel_width
;
25243 hlinfo
->mouse_face_beg_x
= x
;
25244 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25248 /* This row is in a right to left paragraph. Scan it right to
25252 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25253 glyph
= end
+ r1
->used
[TEXT_AREA
];
25255 /* Skip truncation glyphs at the start of the glyph row. */
25256 if (r1
->displays_text_p
)
25258 && INTEGERP (glyph
->object
)
25259 && glyph
->charpos
< 0;
25263 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25264 or COVER_STRING, and the first glyph from buffer whose
25265 position is between START_CHARPOS and END_CHARPOS. */
25267 && !INTEGERP (glyph
->object
)
25268 && !EQ (glyph
->object
, cover_string
)
25269 && !(BUFFERP (glyph
->object
)
25270 && (glyph
->charpos
>= start_charpos
25271 && glyph
->charpos
< end_charpos
));
25274 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25275 are present at buffer positions between START_CHARPOS and
25276 END_CHARPOS, or if they come from an overlay. */
25277 if (EQ (glyph
->object
, before_string
))
25279 pos
= string_buffer_position (before_string
, start_charpos
);
25280 /* If pos == 0, it means before_string came from an
25281 overlay, not from a buffer position. */
25282 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25285 else if (EQ (glyph
->object
, after_string
))
25287 pos
= string_buffer_position (after_string
, end_charpos
);
25288 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25293 glyph
++; /* first glyph to the right of the highlighted area */
25294 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25295 x
+= g
->pixel_width
;
25296 hlinfo
->mouse_face_beg_x
= x
;
25297 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25300 /* If the highlight ends in a different row, compute GLYPH and END
25301 for the end row. Otherwise, reuse the values computed above for
25302 the row where the highlight begins. */
25305 if (!r2
->reversed_p
)
25307 glyph
= r2
->glyphs
[TEXT_AREA
];
25308 end
= glyph
+ r2
->used
[TEXT_AREA
];
25313 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25314 glyph
= end
+ r2
->used
[TEXT_AREA
];
25318 if (!r2
->reversed_p
)
25320 /* Skip truncation and continuation glyphs near the end of the
25321 row, and also blanks and stretch glyphs inserted by
25322 extend_face_to_end_of_line. */
25324 && INTEGERP ((end
- 1)->object
)
25325 && (end
- 1)->charpos
<= 0)
25327 /* Scan the rest of the glyph row from the end, looking for the
25328 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25329 COVER_STRING, or whose position is between START_CHARPOS
25333 && !INTEGERP (end
->object
)
25334 && !EQ (end
->object
, cover_string
)
25335 && !(BUFFERP (end
->object
)
25336 && (end
->charpos
>= start_charpos
25337 && end
->charpos
< end_charpos
));
25340 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25341 are present at buffer positions between START_CHARPOS and
25342 END_CHARPOS, or if they come from an overlay. */
25343 if (EQ (end
->object
, before_string
))
25345 pos
= string_buffer_position (before_string
, start_charpos
);
25346 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25349 else if (EQ (end
->object
, after_string
))
25351 pos
= string_buffer_position (after_string
, end_charpos
);
25352 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25356 /* Find the X coordinate of the last glyph to be highlighted. */
25357 for (; glyph
<= end
; ++glyph
)
25358 x
+= glyph
->pixel_width
;
25360 hlinfo
->mouse_face_end_x
= x
;
25361 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25365 /* Skip truncation and continuation glyphs near the end of the
25366 row, and also blanks and stretch glyphs inserted by
25367 extend_face_to_end_of_line. */
25371 && INTEGERP (end
->object
)
25372 && end
->charpos
<= 0)
25374 x
+= end
->pixel_width
;
25377 /* Scan the rest of the glyph row from the end, looking for the
25378 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25379 COVER_STRING, or whose position is between START_CHARPOS
25383 && !INTEGERP (end
->object
)
25384 && !EQ (end
->object
, cover_string
)
25385 && !(BUFFERP (end
->object
)
25386 && (end
->charpos
>= start_charpos
25387 && end
->charpos
< end_charpos
));
25390 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25391 are present at buffer positions between START_CHARPOS and
25392 END_CHARPOS, or if they come from an overlay. */
25393 if (EQ (end
->object
, before_string
))
25395 pos
= string_buffer_position (before_string
, start_charpos
);
25396 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25399 else if (EQ (end
->object
, after_string
))
25401 pos
= string_buffer_position (after_string
, end_charpos
);
25402 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25405 x
+= end
->pixel_width
;
25407 hlinfo
->mouse_face_end_x
= x
;
25408 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25411 hlinfo
->mouse_face_window
= window
;
25412 hlinfo
->mouse_face_face_id
25413 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25415 !hlinfo
->mouse_face_hidden
, -1);
25416 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25419 /* The following function is not used anymore (replaced with
25420 mouse_face_from_string_pos), but I leave it here for the time
25421 being, in case someone would. */
25423 #if 0 /* not used */
25425 /* Find the position of the glyph for position POS in OBJECT in
25426 window W's current matrix, and return in *X, *Y the pixel
25427 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25429 RIGHT_P non-zero means return the position of the right edge of the
25430 glyph, RIGHT_P zero means return the left edge position.
25432 If no glyph for POS exists in the matrix, return the position of
25433 the glyph with the next smaller position that is in the matrix, if
25434 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25435 exists in the matrix, return the position of the glyph with the
25436 next larger position in OBJECT.
25438 Value is non-zero if a glyph was found. */
25441 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25442 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25444 int yb
= window_text_bottom_y (w
);
25445 struct glyph_row
*r
;
25446 struct glyph
*best_glyph
= NULL
;
25447 struct glyph_row
*best_row
= NULL
;
25450 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25451 r
->enabled_p
&& r
->y
< yb
;
25454 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25455 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25458 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25459 if (EQ (g
->object
, object
))
25461 if (g
->charpos
== pos
)
25468 else if (best_glyph
== NULL
25469 || ((eabs (g
->charpos
- pos
)
25470 < eabs (best_glyph
->charpos
- pos
))
25473 : g
->charpos
> pos
)))
25487 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25491 *x
+= best_glyph
->pixel_width
;
25496 *vpos
= best_row
- w
->current_matrix
->rows
;
25499 return best_glyph
!= NULL
;
25501 #endif /* not used */
25503 /* Find the positions of the first and the last glyphs in window W's
25504 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25505 (assumed to be a string), and return in HLINFO's mouse_face_*
25506 members the pixel and column/row coordinates of those glyphs. */
25509 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25510 Lisp_Object object
,
25511 EMACS_INT startpos
, EMACS_INT endpos
)
25513 int yb
= window_text_bottom_y (w
);
25514 struct glyph_row
*r
;
25515 struct glyph
*g
, *e
;
25519 /* Find the glyph row with at least one position in the range
25520 [STARTPOS..ENDPOS], and the first glyph in that row whose
25521 position belongs to that range. */
25522 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25523 r
->enabled_p
&& r
->y
< yb
;
25526 if (!r
->reversed_p
)
25528 g
= r
->glyphs
[TEXT_AREA
];
25529 e
= g
+ r
->used
[TEXT_AREA
];
25530 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25531 if (EQ (g
->object
, object
)
25532 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25534 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25535 hlinfo
->mouse_face_beg_y
= r
->y
;
25536 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25537 hlinfo
->mouse_face_beg_x
= gx
;
25546 e
= r
->glyphs
[TEXT_AREA
];
25547 g
= e
+ r
->used
[TEXT_AREA
];
25548 for ( ; g
> e
; --g
)
25549 if (EQ ((g
-1)->object
, object
)
25550 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25552 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25553 hlinfo
->mouse_face_beg_y
= r
->y
;
25554 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25555 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25556 gx
+= g1
->pixel_width
;
25557 hlinfo
->mouse_face_beg_x
= gx
;
25569 /* Starting with the next row, look for the first row which does NOT
25570 include any glyphs whose positions are in the range. */
25571 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25573 g
= r
->glyphs
[TEXT_AREA
];
25574 e
= g
+ r
->used
[TEXT_AREA
];
25576 for ( ; g
< e
; ++g
)
25577 if (EQ (g
->object
, object
)
25578 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25587 /* The highlighted region ends on the previous row. */
25590 /* Set the end row and its vertical pixel coordinate. */
25591 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25592 hlinfo
->mouse_face_end_y
= r
->y
;
25594 /* Compute and set the end column and the end column's horizontal
25595 pixel coordinate. */
25596 if (!r
->reversed_p
)
25598 g
= r
->glyphs
[TEXT_AREA
];
25599 e
= g
+ r
->used
[TEXT_AREA
];
25600 for ( ; e
> g
; --e
)
25601 if (EQ ((e
-1)->object
, object
)
25602 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25604 hlinfo
->mouse_face_end_col
= e
- g
;
25606 for (gx
= r
->x
; g
< e
; ++g
)
25607 gx
+= g
->pixel_width
;
25608 hlinfo
->mouse_face_end_x
= gx
;
25612 e
= r
->glyphs
[TEXT_AREA
];
25613 g
= e
+ r
->used
[TEXT_AREA
];
25614 for (gx
= r
->x
; e
< g
; ++e
)
25616 if (EQ (e
->object
, object
)
25617 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25619 gx
+= e
->pixel_width
;
25621 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25622 hlinfo
->mouse_face_end_x
= gx
;
25626 #ifdef HAVE_WINDOW_SYSTEM
25628 /* See if position X, Y is within a hot-spot of an image. */
25631 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25633 if (!CONSP (hot_spot
))
25636 if (EQ (XCAR (hot_spot
), Qrect
))
25638 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25639 Lisp_Object rect
= XCDR (hot_spot
);
25643 if (!CONSP (XCAR (rect
)))
25645 if (!CONSP (XCDR (rect
)))
25647 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25649 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25651 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25653 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25657 else if (EQ (XCAR (hot_spot
), Qcircle
))
25659 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25660 Lisp_Object circ
= XCDR (hot_spot
);
25661 Lisp_Object lr
, lx0
, ly0
;
25663 && CONSP (XCAR (circ
))
25664 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25665 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25666 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25668 double r
= XFLOATINT (lr
);
25669 double dx
= XINT (lx0
) - x
;
25670 double dy
= XINT (ly0
) - y
;
25671 return (dx
* dx
+ dy
* dy
<= r
* r
);
25674 else if (EQ (XCAR (hot_spot
), Qpoly
))
25676 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25677 if (VECTORP (XCDR (hot_spot
)))
25679 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25680 Lisp_Object
*poly
= v
->contents
;
25681 int n
= v
->header
.size
;
25684 Lisp_Object lx
, ly
;
25687 /* Need an even number of coordinates, and at least 3 edges. */
25688 if (n
< 6 || n
& 1)
25691 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25692 If count is odd, we are inside polygon. Pixels on edges
25693 may or may not be included depending on actual geometry of the
25695 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25696 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25698 x0
= XINT (lx
), y0
= XINT (ly
);
25699 for (i
= 0; i
< n
; i
+= 2)
25701 int x1
= x0
, y1
= y0
;
25702 if ((lx
= poly
[i
], !INTEGERP (lx
))
25703 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25705 x0
= XINT (lx
), y0
= XINT (ly
);
25707 /* Does this segment cross the X line? */
25715 if (y
> y0
&& y
> y1
)
25717 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25727 find_hot_spot (Lisp_Object map
, int x
, int y
)
25729 while (CONSP (map
))
25731 if (CONSP (XCAR (map
))
25732 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25740 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25742 doc
: /* Lookup in image map MAP coordinates X and Y.
25743 An image map is an alist where each element has the format (AREA ID PLIST).
25744 An AREA is specified as either a rectangle, a circle, or a polygon:
25745 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25746 pixel coordinates of the upper left and bottom right corners.
25747 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25748 and the radius of the circle; r may be a float or integer.
25749 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25750 vector describes one corner in the polygon.
25751 Returns the alist element for the first matching AREA in MAP. */)
25752 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25760 return find_hot_spot (map
, XINT (x
), XINT (y
));
25764 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25766 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25768 /* Do not change cursor shape while dragging mouse. */
25769 if (!NILP (do_mouse_tracking
))
25772 if (!NILP (pointer
))
25774 if (EQ (pointer
, Qarrow
))
25775 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25776 else if (EQ (pointer
, Qhand
))
25777 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25778 else if (EQ (pointer
, Qtext
))
25779 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25780 else if (EQ (pointer
, intern ("hdrag")))
25781 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25782 #ifdef HAVE_X_WINDOWS
25783 else if (EQ (pointer
, intern ("vdrag")))
25784 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25786 else if (EQ (pointer
, intern ("hourglass")))
25787 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25788 else if (EQ (pointer
, Qmodeline
))
25789 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25791 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25794 if (cursor
!= No_Cursor
)
25795 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25798 #endif /* HAVE_WINDOW_SYSTEM */
25800 /* Take proper action when mouse has moved to the mode or header line
25801 or marginal area AREA of window W, x-position X and y-position Y.
25802 X is relative to the start of the text display area of W, so the
25803 width of bitmap areas and scroll bars must be subtracted to get a
25804 position relative to the start of the mode line. */
25807 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25808 enum window_part area
)
25810 struct window
*w
= XWINDOW (window
);
25811 struct frame
*f
= XFRAME (w
->frame
);
25812 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25813 #ifdef HAVE_WINDOW_SYSTEM
25814 Display_Info
*dpyinfo
;
25816 Cursor cursor
= No_Cursor
;
25817 Lisp_Object pointer
= Qnil
;
25818 int dx
, dy
, width
, height
;
25820 Lisp_Object string
, object
= Qnil
;
25821 Lisp_Object pos
, help
;
25823 Lisp_Object mouse_face
;
25824 int original_x_pixel
= x
;
25825 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25826 struct glyph_row
*row
;
25828 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25833 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25834 returns them in row/column units! */
25835 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25836 &object
, &dx
, &dy
, &width
, &height
);
25838 row
= (area
== ON_MODE_LINE
25839 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25840 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25842 /* Find the glyph under the mouse pointer. */
25843 if (row
->mode_line_p
&& row
->enabled_p
)
25845 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25846 end
= glyph
+ row
->used
[TEXT_AREA
];
25848 for (x0
= original_x_pixel
;
25849 glyph
< end
&& x0
>= glyph
->pixel_width
;
25851 x0
-= glyph
->pixel_width
;
25859 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25860 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25861 returns them in row/column units! */
25862 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25863 &object
, &dx
, &dy
, &width
, &height
);
25868 #ifdef HAVE_WINDOW_SYSTEM
25869 if (IMAGEP (object
))
25871 Lisp_Object image_map
, hotspot
;
25872 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25874 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25876 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25880 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25881 If so, we could look for mouse-enter, mouse-leave
25882 properties in PLIST (and do something...). */
25883 hotspot
= XCDR (hotspot
);
25884 if (CONSP (hotspot
)
25885 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25887 pointer
= Fplist_get (plist
, Qpointer
);
25888 if (NILP (pointer
))
25890 help
= Fplist_get (plist
, Qhelp_echo
);
25893 help_echo_string
= help
;
25894 /* Is this correct? ++kfs */
25895 XSETWINDOW (help_echo_window
, w
);
25896 help_echo_object
= w
->buffer
;
25897 help_echo_pos
= charpos
;
25901 if (NILP (pointer
))
25902 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25904 #endif /* HAVE_WINDOW_SYSTEM */
25906 if (STRINGP (string
))
25908 pos
= make_number (charpos
);
25909 /* If we're on a string with `help-echo' text property, arrange
25910 for the help to be displayed. This is done by setting the
25911 global variable help_echo_string to the help string. */
25914 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25917 help_echo_string
= help
;
25918 XSETWINDOW (help_echo_window
, w
);
25919 help_echo_object
= string
;
25920 help_echo_pos
= charpos
;
25924 #ifdef HAVE_WINDOW_SYSTEM
25925 if (FRAME_WINDOW_P (f
))
25927 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25928 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25929 if (NILP (pointer
))
25930 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25932 /* Change the mouse pointer according to what is under X/Y. */
25934 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25937 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25938 if (!KEYMAPP (map
))
25939 map
= Fget_text_property (pos
, Qkeymap
, string
);
25940 if (!KEYMAPP (map
))
25941 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25946 /* Change the mouse face according to what is under X/Y. */
25947 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25948 if (!NILP (mouse_face
)
25949 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25954 struct glyph
* tmp_glyph
;
25958 int total_pixel_width
;
25959 EMACS_INT begpos
, endpos
, ignore
;
25963 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25964 Qmouse_face
, string
, Qnil
);
25970 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25972 endpos
= SCHARS (string
);
25976 /* Calculate the glyph position GPOS of GLYPH in the
25977 displayed string, relative to the beginning of the
25978 highlighted part of the string.
25980 Note: GPOS is different from CHARPOS. CHARPOS is the
25981 position of GLYPH in the internal string object. A mode
25982 line string format has structures which are converted to
25983 a flattened string by the Emacs Lisp interpreter. The
25984 internal string is an element of those structures. The
25985 displayed string is the flattened string. */
25986 tmp_glyph
= row_start_glyph
;
25987 while (tmp_glyph
< glyph
25988 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25989 && begpos
<= tmp_glyph
->charpos
25990 && tmp_glyph
->charpos
< endpos
)))
25992 gpos
= glyph
- tmp_glyph
;
25994 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25995 the highlighted part of the displayed string to which
25996 GLYPH belongs. Note: GSEQ_LENGTH is different from
25997 SCHARS (STRING), because the latter returns the length of
25998 the internal string. */
25999 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26001 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26002 && begpos
<= tmp_glyph
->charpos
26003 && tmp_glyph
->charpos
< endpos
));
26006 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26008 /* Calculate the total pixel width of all the glyphs between
26009 the beginning of the highlighted area and GLYPH. */
26010 total_pixel_width
= 0;
26011 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26012 total_pixel_width
+= tmp_glyph
->pixel_width
;
26014 /* Pre calculation of re-rendering position. Note: X is in
26015 column units here, after the call to mode_line_string or
26016 marginal_area_string. */
26018 vpos
= (area
== ON_MODE_LINE
26019 ? (w
->current_matrix
)->nrows
- 1
26022 /* If GLYPH's position is included in the region that is
26023 already drawn in mouse face, we have nothing to do. */
26024 if ( EQ (window
, hlinfo
->mouse_face_window
)
26025 && (!row
->reversed_p
26026 ? (hlinfo
->mouse_face_beg_col
<= hpos
26027 && hpos
< hlinfo
->mouse_face_end_col
)
26028 /* In R2L rows we swap BEG and END, see below. */
26029 : (hlinfo
->mouse_face_end_col
<= hpos
26030 && hpos
< hlinfo
->mouse_face_beg_col
))
26031 && hlinfo
->mouse_face_beg_row
== vpos
)
26034 if (clear_mouse_face (hlinfo
))
26035 cursor
= No_Cursor
;
26037 if (!row
->reversed_p
)
26039 hlinfo
->mouse_face_beg_col
= hpos
;
26040 hlinfo
->mouse_face_beg_x
= original_x_pixel
26041 - (total_pixel_width
+ dx
);
26042 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26043 hlinfo
->mouse_face_end_x
= 0;
26047 /* In R2L rows, show_mouse_face expects BEG and END
26048 coordinates to be swapped. */
26049 hlinfo
->mouse_face_end_col
= hpos
;
26050 hlinfo
->mouse_face_end_x
= original_x_pixel
26051 - (total_pixel_width
+ dx
);
26052 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26053 hlinfo
->mouse_face_beg_x
= 0;
26056 hlinfo
->mouse_face_beg_row
= vpos
;
26057 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26058 hlinfo
->mouse_face_beg_y
= 0;
26059 hlinfo
->mouse_face_end_y
= 0;
26060 hlinfo
->mouse_face_past_end
= 0;
26061 hlinfo
->mouse_face_window
= window
;
26063 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26069 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26071 if (NILP (pointer
))
26074 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26075 clear_mouse_face (hlinfo
);
26077 #ifdef HAVE_WINDOW_SYSTEM
26078 if (FRAME_WINDOW_P (f
))
26079 define_frame_cursor1 (f
, cursor
, pointer
);
26085 Take proper action when the mouse has moved to position X, Y on
26086 frame F as regards highlighting characters that have mouse-face
26087 properties. Also de-highlighting chars where the mouse was before.
26088 X and Y can be negative or out of range. */
26091 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26093 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26094 enum window_part part
;
26095 Lisp_Object window
;
26097 Cursor cursor
= No_Cursor
;
26098 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26101 /* When a menu is active, don't highlight because this looks odd. */
26102 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26103 if (popup_activated ())
26107 if (NILP (Vmouse_highlight
)
26108 || !f
->glyphs_initialized_p
26109 || f
->pointer_invisible
)
26112 hlinfo
->mouse_face_mouse_x
= x
;
26113 hlinfo
->mouse_face_mouse_y
= y
;
26114 hlinfo
->mouse_face_mouse_frame
= f
;
26116 if (hlinfo
->mouse_face_defer
)
26119 if (gc_in_progress
)
26121 hlinfo
->mouse_face_deferred_gc
= 1;
26125 /* Which window is that in? */
26126 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26128 /* If we were displaying active text in another window, clear that.
26129 Also clear if we move out of text area in same window. */
26130 if (! EQ (window
, hlinfo
->mouse_face_window
)
26131 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26132 && !NILP (hlinfo
->mouse_face_window
)))
26133 clear_mouse_face (hlinfo
);
26135 /* Not on a window -> return. */
26136 if (!WINDOWP (window
))
26139 /* Reset help_echo_string. It will get recomputed below. */
26140 help_echo_string
= Qnil
;
26142 /* Convert to window-relative pixel coordinates. */
26143 w
= XWINDOW (window
);
26144 frame_to_window_pixel_xy (w
, &x
, &y
);
26146 #ifdef HAVE_WINDOW_SYSTEM
26147 /* Handle tool-bar window differently since it doesn't display a
26149 if (EQ (window
, f
->tool_bar_window
))
26151 note_tool_bar_highlight (f
, x
, y
);
26156 /* Mouse is on the mode, header line or margin? */
26157 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26158 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26160 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26164 #ifdef HAVE_WINDOW_SYSTEM
26165 if (part
== ON_VERTICAL_BORDER
)
26167 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26168 help_echo_string
= build_string ("drag-mouse-1: resize");
26170 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26171 || part
== ON_SCROLL_BAR
)
26172 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26174 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26177 /* Are we in a window whose display is up to date?
26178 And verify the buffer's text has not changed. */
26179 b
= XBUFFER (w
->buffer
);
26180 if (part
== ON_TEXT
26181 && EQ (w
->window_end_valid
, w
->buffer
)
26182 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26183 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26185 int hpos
, vpos
, dx
, dy
, area
;
26187 struct glyph
*glyph
;
26188 Lisp_Object object
;
26189 Lisp_Object mouse_face
= Qnil
, position
;
26190 Lisp_Object
*overlay_vec
= NULL
;
26191 ptrdiff_t i
, noverlays
;
26192 struct buffer
*obuf
;
26193 EMACS_INT obegv
, ozv
;
26196 /* Find the glyph under X/Y. */
26197 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26199 #ifdef HAVE_WINDOW_SYSTEM
26200 /* Look for :pointer property on image. */
26201 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26203 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26204 if (img
!= NULL
&& IMAGEP (img
->spec
))
26206 Lisp_Object image_map
, hotspot
;
26207 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26209 && (hotspot
= find_hot_spot (image_map
,
26210 glyph
->slice
.img
.x
+ dx
,
26211 glyph
->slice
.img
.y
+ dy
),
26213 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26217 /* Could check XCAR (hotspot) to see if we enter/leave
26219 If so, we could look for mouse-enter, mouse-leave
26220 properties in PLIST (and do something...). */
26221 hotspot
= XCDR (hotspot
);
26222 if (CONSP (hotspot
)
26223 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26225 pointer
= Fplist_get (plist
, Qpointer
);
26226 if (NILP (pointer
))
26228 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26229 if (!NILP (help_echo_string
))
26231 help_echo_window
= window
;
26232 help_echo_object
= glyph
->object
;
26233 help_echo_pos
= glyph
->charpos
;
26237 if (NILP (pointer
))
26238 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26241 #endif /* HAVE_WINDOW_SYSTEM */
26243 /* Clear mouse face if X/Y not over text. */
26245 || area
!= TEXT_AREA
26246 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26247 /* Glyph's OBJECT is an integer for glyphs inserted by the
26248 display engine for its internal purposes, like truncation
26249 and continuation glyphs and blanks beyond the end of
26250 line's text on text terminals. If we are over such a
26251 glyph, we are not over any text. */
26252 || INTEGERP (glyph
->object
)
26253 /* R2L rows have a stretch glyph at their front, which
26254 stands for no text, whereas L2R rows have no glyphs at
26255 all beyond the end of text. Treat such stretch glyphs
26256 like we do with NULL glyphs in L2R rows. */
26257 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26258 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26259 && glyph
->type
== STRETCH_GLYPH
26260 && glyph
->avoid_cursor_p
))
26262 if (clear_mouse_face (hlinfo
))
26263 cursor
= No_Cursor
;
26264 #ifdef HAVE_WINDOW_SYSTEM
26265 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26267 if (area
!= TEXT_AREA
)
26268 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26270 pointer
= Vvoid_text_area_pointer
;
26276 pos
= glyph
->charpos
;
26277 object
= glyph
->object
;
26278 if (!STRINGP (object
) && !BUFFERP (object
))
26281 /* If we get an out-of-range value, return now; avoid an error. */
26282 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26285 /* Make the window's buffer temporarily current for
26286 overlays_at and compute_char_face. */
26287 obuf
= current_buffer
;
26288 current_buffer
= b
;
26294 /* Is this char mouse-active or does it have help-echo? */
26295 position
= make_number (pos
);
26297 if (BUFFERP (object
))
26299 /* Put all the overlays we want in a vector in overlay_vec. */
26300 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26301 /* Sort overlays into increasing priority order. */
26302 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26307 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26310 cursor
= No_Cursor
;
26312 /* Check mouse-face highlighting. */
26314 /* If there exists an overlay with mouse-face overlapping
26315 the one we are currently highlighting, we have to
26316 check if we enter the overlapping overlay, and then
26317 highlight only that. */
26318 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26319 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26321 /* Find the highest priority overlay with a mouse-face. */
26322 Lisp_Object overlay
= Qnil
;
26323 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26325 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26326 if (!NILP (mouse_face
))
26327 overlay
= overlay_vec
[i
];
26330 /* If we're highlighting the same overlay as before, there's
26331 no need to do that again. */
26332 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26333 goto check_help_echo
;
26334 hlinfo
->mouse_face_overlay
= overlay
;
26336 /* Clear the display of the old active region, if any. */
26337 if (clear_mouse_face (hlinfo
))
26338 cursor
= No_Cursor
;
26340 /* If no overlay applies, get a text property. */
26341 if (NILP (overlay
))
26342 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26344 /* Next, compute the bounds of the mouse highlighting and
26346 if (!NILP (mouse_face
) && STRINGP (object
))
26348 /* The mouse-highlighting comes from a display string
26349 with a mouse-face. */
26353 s
= Fprevious_single_property_change
26354 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26355 e
= Fnext_single_property_change
26356 (position
, Qmouse_face
, object
, Qnil
);
26358 s
= make_number (0);
26360 e
= make_number (SCHARS (object
) - 1);
26361 mouse_face_from_string_pos (w
, hlinfo
, object
,
26362 XINT (s
), XINT (e
));
26363 hlinfo
->mouse_face_past_end
= 0;
26364 hlinfo
->mouse_face_window
= window
;
26365 hlinfo
->mouse_face_face_id
26366 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26367 glyph
->face_id
, 1);
26368 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26369 cursor
= No_Cursor
;
26373 /* The mouse-highlighting, if any, comes from an overlay
26374 or text property in the buffer. */
26375 Lisp_Object buffer
IF_LINT (= Qnil
);
26376 Lisp_Object cover_string
IF_LINT (= Qnil
);
26378 if (STRINGP (object
))
26380 /* If we are on a display string with no mouse-face,
26381 check if the text under it has one. */
26382 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26383 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26384 pos
= string_buffer_position (object
, start
);
26387 mouse_face
= get_char_property_and_overlay
26388 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26389 buffer
= w
->buffer
;
26390 cover_string
= object
;
26396 cover_string
= Qnil
;
26399 if (!NILP (mouse_face
))
26401 Lisp_Object before
, after
;
26402 Lisp_Object before_string
, after_string
;
26403 /* To correctly find the limits of mouse highlight
26404 in a bidi-reordered buffer, we must not use the
26405 optimization of limiting the search in
26406 previous-single-property-change and
26407 next-single-property-change, because
26408 rows_from_pos_range needs the real start and end
26409 positions to DTRT in this case. That's because
26410 the first row visible in a window does not
26411 necessarily display the character whose position
26412 is the smallest. */
26414 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26415 ? Fmarker_position (w
->start
)
26418 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26419 ? make_number (BUF_Z (XBUFFER (buffer
))
26420 - XFASTINT (w
->window_end_pos
))
26423 if (NILP (overlay
))
26425 /* Handle the text property case. */
26426 before
= Fprevious_single_property_change
26427 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26428 after
= Fnext_single_property_change
26429 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26430 before_string
= after_string
= Qnil
;
26434 /* Handle the overlay case. */
26435 before
= Foverlay_start (overlay
);
26436 after
= Foverlay_end (overlay
);
26437 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26438 after_string
= Foverlay_get (overlay
, Qafter_string
);
26440 if (!STRINGP (before_string
)) before_string
= Qnil
;
26441 if (!STRINGP (after_string
)) after_string
= Qnil
;
26444 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26447 before_string
, after_string
,
26449 cursor
= No_Cursor
;
26456 /* Look for a `help-echo' property. */
26457 if (NILP (help_echo_string
)) {
26458 Lisp_Object help
, overlay
;
26460 /* Check overlays first. */
26461 help
= overlay
= Qnil
;
26462 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26464 overlay
= overlay_vec
[i
];
26465 help
= Foverlay_get (overlay
, Qhelp_echo
);
26470 help_echo_string
= help
;
26471 help_echo_window
= window
;
26472 help_echo_object
= overlay
;
26473 help_echo_pos
= pos
;
26477 Lisp_Object obj
= glyph
->object
;
26478 EMACS_INT charpos
= glyph
->charpos
;
26480 /* Try text properties. */
26483 && charpos
< SCHARS (obj
))
26485 help
= Fget_text_property (make_number (charpos
),
26489 /* If the string itself doesn't specify a help-echo,
26490 see if the buffer text ``under'' it does. */
26491 struct glyph_row
*r
26492 = MATRIX_ROW (w
->current_matrix
, vpos
);
26493 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26494 EMACS_INT p
= string_buffer_position (obj
, start
);
26497 help
= Fget_char_property (make_number (p
),
26498 Qhelp_echo
, w
->buffer
);
26507 else if (BUFFERP (obj
)
26510 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26515 help_echo_string
= help
;
26516 help_echo_window
= window
;
26517 help_echo_object
= obj
;
26518 help_echo_pos
= charpos
;
26523 #ifdef HAVE_WINDOW_SYSTEM
26524 /* Look for a `pointer' property. */
26525 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26527 /* Check overlays first. */
26528 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26529 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26531 if (NILP (pointer
))
26533 Lisp_Object obj
= glyph
->object
;
26534 EMACS_INT charpos
= glyph
->charpos
;
26536 /* Try text properties. */
26539 && charpos
< SCHARS (obj
))
26541 pointer
= Fget_text_property (make_number (charpos
),
26543 if (NILP (pointer
))
26545 /* If the string itself doesn't specify a pointer,
26546 see if the buffer text ``under'' it does. */
26547 struct glyph_row
*r
26548 = MATRIX_ROW (w
->current_matrix
, vpos
);
26549 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26550 EMACS_INT p
= string_buffer_position (obj
, start
);
26552 pointer
= Fget_char_property (make_number (p
),
26553 Qpointer
, w
->buffer
);
26556 else if (BUFFERP (obj
)
26559 pointer
= Fget_text_property (make_number (charpos
),
26563 #endif /* HAVE_WINDOW_SYSTEM */
26567 current_buffer
= obuf
;
26572 #ifdef HAVE_WINDOW_SYSTEM
26573 if (FRAME_WINDOW_P (f
))
26574 define_frame_cursor1 (f
, cursor
, pointer
);
26576 /* This is here to prevent a compiler error, about "label at end of
26577 compound statement". */
26584 Clear any mouse-face on window W. This function is part of the
26585 redisplay interface, and is called from try_window_id and similar
26586 functions to ensure the mouse-highlight is off. */
26589 x_clear_window_mouse_face (struct window
*w
)
26591 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26592 Lisp_Object window
;
26595 XSETWINDOW (window
, w
);
26596 if (EQ (window
, hlinfo
->mouse_face_window
))
26597 clear_mouse_face (hlinfo
);
26603 Just discard the mouse face information for frame F, if any.
26604 This is used when the size of F is changed. */
26607 cancel_mouse_face (struct frame
*f
)
26609 Lisp_Object window
;
26610 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26612 window
= hlinfo
->mouse_face_window
;
26613 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26615 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26616 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26617 hlinfo
->mouse_face_window
= Qnil
;
26623 /***********************************************************************
26625 ***********************************************************************/
26627 #ifdef HAVE_WINDOW_SYSTEM
26629 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26630 which intersects rectangle R. R is in window-relative coordinates. */
26633 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26634 enum glyph_row_area area
)
26636 struct glyph
*first
= row
->glyphs
[area
];
26637 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26638 struct glyph
*last
;
26639 int first_x
, start_x
, x
;
26641 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26642 /* If row extends face to end of line write the whole line. */
26643 draw_glyphs (w
, 0, row
, area
,
26644 0, row
->used
[area
],
26645 DRAW_NORMAL_TEXT
, 0);
26648 /* Set START_X to the window-relative start position for drawing glyphs of
26649 AREA. The first glyph of the text area can be partially visible.
26650 The first glyphs of other areas cannot. */
26651 start_x
= window_box_left_offset (w
, area
);
26653 if (area
== TEXT_AREA
)
26656 /* Find the first glyph that must be redrawn. */
26658 && x
+ first
->pixel_width
< r
->x
)
26660 x
+= first
->pixel_width
;
26664 /* Find the last one. */
26668 && x
< r
->x
+ r
->width
)
26670 x
+= last
->pixel_width
;
26676 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26677 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26678 DRAW_NORMAL_TEXT
, 0);
26683 /* Redraw the parts of the glyph row ROW on window W intersecting
26684 rectangle R. R is in window-relative coordinates. Value is
26685 non-zero if mouse-face was overwritten. */
26688 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26690 xassert (row
->enabled_p
);
26692 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26693 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26694 0, row
->used
[TEXT_AREA
],
26695 DRAW_NORMAL_TEXT
, 0);
26698 if (row
->used
[LEFT_MARGIN_AREA
])
26699 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26700 if (row
->used
[TEXT_AREA
])
26701 expose_area (w
, row
, r
, TEXT_AREA
);
26702 if (row
->used
[RIGHT_MARGIN_AREA
])
26703 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26704 draw_row_fringe_bitmaps (w
, row
);
26707 return row
->mouse_face_p
;
26711 /* Redraw those parts of glyphs rows during expose event handling that
26712 overlap other rows. Redrawing of an exposed line writes over parts
26713 of lines overlapping that exposed line; this function fixes that.
26715 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26716 row in W's current matrix that is exposed and overlaps other rows.
26717 LAST_OVERLAPPING_ROW is the last such row. */
26720 expose_overlaps (struct window
*w
,
26721 struct glyph_row
*first_overlapping_row
,
26722 struct glyph_row
*last_overlapping_row
,
26725 struct glyph_row
*row
;
26727 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26728 if (row
->overlapping_p
)
26730 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26733 if (row
->used
[LEFT_MARGIN_AREA
])
26734 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26736 if (row
->used
[TEXT_AREA
])
26737 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26739 if (row
->used
[RIGHT_MARGIN_AREA
])
26740 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26746 /* Return non-zero if W's cursor intersects rectangle R. */
26749 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26751 XRectangle cr
, result
;
26752 struct glyph
*cursor_glyph
;
26753 struct glyph_row
*row
;
26755 if (w
->phys_cursor
.vpos
>= 0
26756 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26757 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26759 && row
->cursor_in_fringe_p
)
26761 /* Cursor is in the fringe. */
26762 cr
.x
= window_box_right_offset (w
,
26763 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26764 ? RIGHT_MARGIN_AREA
26767 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26768 cr
.height
= row
->height
;
26769 return x_intersect_rectangles (&cr
, r
, &result
);
26772 cursor_glyph
= get_phys_cursor_glyph (w
);
26775 /* r is relative to W's box, but w->phys_cursor.x is relative
26776 to left edge of W's TEXT area. Adjust it. */
26777 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26778 cr
.y
= w
->phys_cursor
.y
;
26779 cr
.width
= cursor_glyph
->pixel_width
;
26780 cr
.height
= w
->phys_cursor_height
;
26781 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26782 I assume the effect is the same -- and this is portable. */
26783 return x_intersect_rectangles (&cr
, r
, &result
);
26785 /* If we don't understand the format, pretend we're not in the hot-spot. */
26791 Draw a vertical window border to the right of window W if W doesn't
26792 have vertical scroll bars. */
26795 x_draw_vertical_border (struct window
*w
)
26797 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26799 /* We could do better, if we knew what type of scroll-bar the adjacent
26800 windows (on either side) have... But we don't :-(
26801 However, I think this works ok. ++KFS 2003-04-25 */
26803 /* Redraw borders between horizontally adjacent windows. Don't
26804 do it for frames with vertical scroll bars because either the
26805 right scroll bar of a window, or the left scroll bar of its
26806 neighbor will suffice as a border. */
26807 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26810 if (!WINDOW_RIGHTMOST_P (w
)
26811 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26813 int x0
, x1
, y0
, y1
;
26815 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26818 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26821 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26823 else if (!WINDOW_LEFTMOST_P (w
)
26824 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26826 int x0
, x1
, y0
, y1
;
26828 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26831 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26834 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26839 /* Redraw the part of window W intersection rectangle FR. Pixel
26840 coordinates in FR are frame-relative. Call this function with
26841 input blocked. Value is non-zero if the exposure overwrites
26845 expose_window (struct window
*w
, XRectangle
*fr
)
26847 struct frame
*f
= XFRAME (w
->frame
);
26849 int mouse_face_overwritten_p
= 0;
26851 /* If window is not yet fully initialized, do nothing. This can
26852 happen when toolkit scroll bars are used and a window is split.
26853 Reconfiguring the scroll bar will generate an expose for a newly
26855 if (w
->current_matrix
== NULL
)
26858 /* When we're currently updating the window, display and current
26859 matrix usually don't agree. Arrange for a thorough display
26861 if (w
== updated_window
)
26863 SET_FRAME_GARBAGED (f
);
26867 /* Frame-relative pixel rectangle of W. */
26868 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26869 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26870 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26871 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26873 if (x_intersect_rectangles (fr
, &wr
, &r
))
26875 int yb
= window_text_bottom_y (w
);
26876 struct glyph_row
*row
;
26877 int cursor_cleared_p
;
26878 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26880 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26881 r
.x
, r
.y
, r
.width
, r
.height
));
26883 /* Convert to window coordinates. */
26884 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26885 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26887 /* Turn off the cursor. */
26888 if (!w
->pseudo_window_p
26889 && phys_cursor_in_rect_p (w
, &r
))
26891 x_clear_cursor (w
);
26892 cursor_cleared_p
= 1;
26895 cursor_cleared_p
= 0;
26897 /* Update lines intersecting rectangle R. */
26898 first_overlapping_row
= last_overlapping_row
= NULL
;
26899 for (row
= w
->current_matrix
->rows
;
26904 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26906 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26907 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26908 || (r
.y
>= y0
&& r
.y
< y1
)
26909 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26911 /* A header line may be overlapping, but there is no need
26912 to fix overlapping areas for them. KFS 2005-02-12 */
26913 if (row
->overlapping_p
&& !row
->mode_line_p
)
26915 if (first_overlapping_row
== NULL
)
26916 first_overlapping_row
= row
;
26917 last_overlapping_row
= row
;
26921 if (expose_line (w
, row
, &r
))
26922 mouse_face_overwritten_p
= 1;
26925 else if (row
->overlapping_p
)
26927 /* We must redraw a row overlapping the exposed area. */
26929 ? y0
+ row
->phys_height
> r
.y
26930 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26932 if (first_overlapping_row
== NULL
)
26933 first_overlapping_row
= row
;
26934 last_overlapping_row
= row
;
26942 /* Display the mode line if there is one. */
26943 if (WINDOW_WANTS_MODELINE_P (w
)
26944 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26946 && row
->y
< r
.y
+ r
.height
)
26948 if (expose_line (w
, row
, &r
))
26949 mouse_face_overwritten_p
= 1;
26952 if (!w
->pseudo_window_p
)
26954 /* Fix the display of overlapping rows. */
26955 if (first_overlapping_row
)
26956 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26959 /* Draw border between windows. */
26960 x_draw_vertical_border (w
);
26962 /* Turn the cursor on again. */
26963 if (cursor_cleared_p
)
26964 update_window_cursor (w
, 1);
26968 return mouse_face_overwritten_p
;
26973 /* Redraw (parts) of all windows in the window tree rooted at W that
26974 intersect R. R contains frame pixel coordinates. Value is
26975 non-zero if the exposure overwrites mouse-face. */
26978 expose_window_tree (struct window
*w
, XRectangle
*r
)
26980 struct frame
*f
= XFRAME (w
->frame
);
26981 int mouse_face_overwritten_p
= 0;
26983 while (w
&& !FRAME_GARBAGED_P (f
))
26985 if (!NILP (w
->hchild
))
26986 mouse_face_overwritten_p
26987 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26988 else if (!NILP (w
->vchild
))
26989 mouse_face_overwritten_p
26990 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26992 mouse_face_overwritten_p
|= expose_window (w
, r
);
26994 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26997 return mouse_face_overwritten_p
;
27002 Redisplay an exposed area of frame F. X and Y are the upper-left
27003 corner of the exposed rectangle. W and H are width and height of
27004 the exposed area. All are pixel values. W or H zero means redraw
27005 the entire frame. */
27008 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27011 int mouse_face_overwritten_p
= 0;
27013 TRACE ((stderr
, "expose_frame "));
27015 /* No need to redraw if frame will be redrawn soon. */
27016 if (FRAME_GARBAGED_P (f
))
27018 TRACE ((stderr
, " garbaged\n"));
27022 /* If basic faces haven't been realized yet, there is no point in
27023 trying to redraw anything. This can happen when we get an expose
27024 event while Emacs is starting, e.g. by moving another window. */
27025 if (FRAME_FACE_CACHE (f
) == NULL
27026 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27028 TRACE ((stderr
, " no faces\n"));
27032 if (w
== 0 || h
== 0)
27035 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27036 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27046 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27047 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27049 if (WINDOWP (f
->tool_bar_window
))
27050 mouse_face_overwritten_p
27051 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27053 #ifdef HAVE_X_WINDOWS
27055 #ifndef USE_X_TOOLKIT
27056 if (WINDOWP (f
->menu_bar_window
))
27057 mouse_face_overwritten_p
27058 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27059 #endif /* not USE_X_TOOLKIT */
27063 /* Some window managers support a focus-follows-mouse style with
27064 delayed raising of frames. Imagine a partially obscured frame,
27065 and moving the mouse into partially obscured mouse-face on that
27066 frame. The visible part of the mouse-face will be highlighted,
27067 then the WM raises the obscured frame. With at least one WM, KDE
27068 2.1, Emacs is not getting any event for the raising of the frame
27069 (even tried with SubstructureRedirectMask), only Expose events.
27070 These expose events will draw text normally, i.e. not
27071 highlighted. Which means we must redo the highlight here.
27072 Subsume it under ``we love X''. --gerd 2001-08-15 */
27073 /* Included in Windows version because Windows most likely does not
27074 do the right thing if any third party tool offers
27075 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27076 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27078 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27079 if (f
== hlinfo
->mouse_face_mouse_frame
)
27081 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27082 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27083 clear_mouse_face (hlinfo
);
27084 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27091 Determine the intersection of two rectangles R1 and R2. Return
27092 the intersection in *RESULT. Value is non-zero if RESULT is not
27096 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27098 XRectangle
*left
, *right
;
27099 XRectangle
*upper
, *lower
;
27100 int intersection_p
= 0;
27102 /* Rearrange so that R1 is the left-most rectangle. */
27104 left
= r1
, right
= r2
;
27106 left
= r2
, right
= r1
;
27108 /* X0 of the intersection is right.x0, if this is inside R1,
27109 otherwise there is no intersection. */
27110 if (right
->x
<= left
->x
+ left
->width
)
27112 result
->x
= right
->x
;
27114 /* The right end of the intersection is the minimum of
27115 the right ends of left and right. */
27116 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27119 /* Same game for Y. */
27121 upper
= r1
, lower
= r2
;
27123 upper
= r2
, lower
= r1
;
27125 /* The upper end of the intersection is lower.y0, if this is inside
27126 of upper. Otherwise, there is no intersection. */
27127 if (lower
->y
<= upper
->y
+ upper
->height
)
27129 result
->y
= lower
->y
;
27131 /* The lower end of the intersection is the minimum of the lower
27132 ends of upper and lower. */
27133 result
->height
= (min (lower
->y
+ lower
->height
,
27134 upper
->y
+ upper
->height
)
27136 intersection_p
= 1;
27140 return intersection_p
;
27143 #endif /* HAVE_WINDOW_SYSTEM */
27146 /***********************************************************************
27148 ***********************************************************************/
27151 syms_of_xdisp (void)
27153 Vwith_echo_area_save_vector
= Qnil
;
27154 staticpro (&Vwith_echo_area_save_vector
);
27156 Vmessage_stack
= Qnil
;
27157 staticpro (&Vmessage_stack
);
27159 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27161 message_dolog_marker1
= Fmake_marker ();
27162 staticpro (&message_dolog_marker1
);
27163 message_dolog_marker2
= Fmake_marker ();
27164 staticpro (&message_dolog_marker2
);
27165 message_dolog_marker3
= Fmake_marker ();
27166 staticpro (&message_dolog_marker3
);
27169 defsubr (&Sdump_frame_glyph_matrix
);
27170 defsubr (&Sdump_glyph_matrix
);
27171 defsubr (&Sdump_glyph_row
);
27172 defsubr (&Sdump_tool_bar_row
);
27173 defsubr (&Strace_redisplay
);
27174 defsubr (&Strace_to_stderr
);
27176 #ifdef HAVE_WINDOW_SYSTEM
27177 defsubr (&Stool_bar_lines_needed
);
27178 defsubr (&Slookup_image_map
);
27180 defsubr (&Sformat_mode_line
);
27181 defsubr (&Sinvisible_p
);
27182 defsubr (&Scurrent_bidi_paragraph_direction
);
27184 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27185 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27186 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27187 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27188 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27189 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27190 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27191 DEFSYM (Qeval
, "eval");
27192 DEFSYM (QCdata
, ":data");
27193 DEFSYM (Qdisplay
, "display");
27194 DEFSYM (Qspace_width
, "space-width");
27195 DEFSYM (Qraise
, "raise");
27196 DEFSYM (Qslice
, "slice");
27197 DEFSYM (Qspace
, "space");
27198 DEFSYM (Qmargin
, "margin");
27199 DEFSYM (Qpointer
, "pointer");
27200 DEFSYM (Qleft_margin
, "left-margin");
27201 DEFSYM (Qright_margin
, "right-margin");
27202 DEFSYM (Qcenter
, "center");
27203 DEFSYM (Qline_height
, "line-height");
27204 DEFSYM (QCalign_to
, ":align-to");
27205 DEFSYM (QCrelative_width
, ":relative-width");
27206 DEFSYM (QCrelative_height
, ":relative-height");
27207 DEFSYM (QCeval
, ":eval");
27208 DEFSYM (QCpropertize
, ":propertize");
27209 DEFSYM (QCfile
, ":file");
27210 DEFSYM (Qfontified
, "fontified");
27211 DEFSYM (Qfontification_functions
, "fontification-functions");
27212 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27213 DEFSYM (Qescape_glyph
, "escape-glyph");
27214 DEFSYM (Qnobreak_space
, "nobreak-space");
27215 DEFSYM (Qimage
, "image");
27216 DEFSYM (Qtext
, "text");
27217 DEFSYM (Qboth
, "both");
27218 DEFSYM (Qboth_horiz
, "both-horiz");
27219 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27220 DEFSYM (QCmap
, ":map");
27221 DEFSYM (QCpointer
, ":pointer");
27222 DEFSYM (Qrect
, "rect");
27223 DEFSYM (Qcircle
, "circle");
27224 DEFSYM (Qpoly
, "poly");
27225 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27226 DEFSYM (Qgrow_only
, "grow-only");
27227 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27228 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27229 DEFSYM (Qposition
, "position");
27230 DEFSYM (Qbuffer_position
, "buffer-position");
27231 DEFSYM (Qobject
, "object");
27232 DEFSYM (Qbar
, "bar");
27233 DEFSYM (Qhbar
, "hbar");
27234 DEFSYM (Qbox
, "box");
27235 DEFSYM (Qhollow
, "hollow");
27236 DEFSYM (Qhand
, "hand");
27237 DEFSYM (Qarrow
, "arrow");
27238 DEFSYM (Qtext
, "text");
27239 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27241 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27242 Fcons (intern_c_string ("void-variable"), Qnil
)),
27244 staticpro (&list_of_error
);
27246 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27247 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27248 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27249 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27251 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27252 staticpro (&echo_buffer
[0]);
27253 staticpro (&echo_buffer
[1]);
27255 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27256 staticpro (&echo_area_buffer
[0]);
27257 staticpro (&echo_area_buffer
[1]);
27259 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27260 staticpro (&Vmessages_buffer_name
);
27262 mode_line_proptrans_alist
= Qnil
;
27263 staticpro (&mode_line_proptrans_alist
);
27264 mode_line_string_list
= Qnil
;
27265 staticpro (&mode_line_string_list
);
27266 mode_line_string_face
= Qnil
;
27267 staticpro (&mode_line_string_face
);
27268 mode_line_string_face_prop
= Qnil
;
27269 staticpro (&mode_line_string_face_prop
);
27270 Vmode_line_unwind_vector
= Qnil
;
27271 staticpro (&Vmode_line_unwind_vector
);
27273 help_echo_string
= Qnil
;
27274 staticpro (&help_echo_string
);
27275 help_echo_object
= Qnil
;
27276 staticpro (&help_echo_object
);
27277 help_echo_window
= Qnil
;
27278 staticpro (&help_echo_window
);
27279 previous_help_echo_string
= Qnil
;
27280 staticpro (&previous_help_echo_string
);
27281 help_echo_pos
= -1;
27283 DEFSYM (Qright_to_left
, "right-to-left");
27284 DEFSYM (Qleft_to_right
, "left-to-right");
27286 #ifdef HAVE_WINDOW_SYSTEM
27287 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27288 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27289 For example, if a block cursor is over a tab, it will be drawn as
27290 wide as that tab on the display. */);
27291 x_stretch_cursor_p
= 0;
27294 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27295 doc
: /* *Non-nil means highlight trailing whitespace.
27296 The face used for trailing whitespace is `trailing-whitespace'. */);
27297 Vshow_trailing_whitespace
= Qnil
;
27299 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27300 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27301 A value of t means highlight the character itself (for nobreak space,
27302 use face `nobreak-space').
27303 A value of nil means no highlighting.
27304 Other values mean display the escape glyph followed by an ordinary
27305 space or ordinary hyphen. */);
27306 Vnobreak_char_display
= Qt
;
27308 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27309 doc
: /* *The pointer shape to show in void text areas.
27310 A value of nil means to show the text pointer. Other options are `arrow',
27311 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27312 Vvoid_text_area_pointer
= Qarrow
;
27314 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27315 doc
: /* Non-nil means don't actually do any redisplay.
27316 This is used for internal purposes. */);
27317 Vinhibit_redisplay
= Qnil
;
27319 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27320 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27321 Vglobal_mode_string
= Qnil
;
27323 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27324 doc
: /* Marker for where to display an arrow on top of the buffer text.
27325 This must be the beginning of a line in order to work.
27326 See also `overlay-arrow-string'. */);
27327 Voverlay_arrow_position
= Qnil
;
27329 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27330 doc
: /* String to display as an arrow in non-window frames.
27331 See also `overlay-arrow-position'. */);
27332 Voverlay_arrow_string
= make_pure_c_string ("=>");
27334 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27335 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27336 The symbols on this list are examined during redisplay to determine
27337 where to display overlay arrows. */);
27338 Voverlay_arrow_variable_list
27339 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27341 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27342 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27343 If that fails to bring point back on frame, point is centered instead.
27344 If this is zero, point is always centered after it moves off frame.
27345 If you want scrolling to always be a line at a time, you should set
27346 `scroll-conservatively' to a large value rather than set this to 1. */);
27348 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27349 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27350 If point moves off-screen, redisplay will scroll by up to
27351 `scroll-conservatively' lines in order to bring point just barely
27352 onto the screen again. If that cannot be done, then redisplay
27353 recenters point as usual.
27355 If the value is greater than 100, redisplay will never recenter point,
27356 but will always scroll just enough text to bring point into view, even
27357 if you move far away.
27359 A value of zero means always recenter point if it moves off screen. */);
27360 scroll_conservatively
= 0;
27362 DEFVAR_INT ("scroll-margin", scroll_margin
,
27363 doc
: /* *Number of lines of margin at the top and bottom of a window.
27364 Recenter the window whenever point gets within this many lines
27365 of the top or bottom of the window. */);
27368 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27369 doc
: /* Pixels per inch value for non-window system displays.
27370 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27371 Vdisplay_pixels_per_inch
= make_float (72.0);
27374 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27377 DEFVAR_LISP ("truncate-partial-width-windows",
27378 Vtruncate_partial_width_windows
,
27379 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27380 For an integer value, truncate lines in each window narrower than the
27381 full frame width, provided the window width is less than that integer;
27382 otherwise, respect the value of `truncate-lines'.
27384 For any other non-nil value, truncate lines in all windows that do
27385 not span the full frame width.
27387 A value of nil means to respect the value of `truncate-lines'.
27389 If `word-wrap' is enabled, you might want to reduce this. */);
27390 Vtruncate_partial_width_windows
= make_number (50);
27392 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27393 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27394 Any other value means to use the appropriate face, `mode-line',
27395 `header-line', or `menu' respectively. */);
27396 mode_line_inverse_video
= 1;
27398 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27399 doc
: /* *Maximum buffer size for which line number should be displayed.
27400 If the buffer is bigger than this, the line number does not appear
27401 in the mode line. A value of nil means no limit. */);
27402 Vline_number_display_limit
= Qnil
;
27404 DEFVAR_INT ("line-number-display-limit-width",
27405 line_number_display_limit_width
,
27406 doc
: /* *Maximum line width (in characters) for line number display.
27407 If the average length of the lines near point is bigger than this, then the
27408 line number may be omitted from the mode line. */);
27409 line_number_display_limit_width
= 200;
27411 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27412 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27413 highlight_nonselected_windows
= 0;
27415 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27416 doc
: /* Non-nil if more than one frame is visible on this display.
27417 Minibuffer-only frames don't count, but iconified frames do.
27418 This variable is not guaranteed to be accurate except while processing
27419 `frame-title-format' and `icon-title-format'. */);
27421 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27422 doc
: /* Template for displaying the title bar of visible frames.
27423 \(Assuming the window manager supports this feature.)
27425 This variable has the same structure as `mode-line-format', except that
27426 the %c and %l constructs are ignored. It is used only on frames for
27427 which no explicit name has been set \(see `modify-frame-parameters'). */);
27429 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27430 doc
: /* Template for displaying the title bar of an iconified frame.
27431 \(Assuming the window manager supports this feature.)
27432 This variable has the same structure as `mode-line-format' (which see),
27433 and is used only on frames for which no explicit name has been set
27434 \(see `modify-frame-parameters'). */);
27436 = Vframe_title_format
27437 = pure_cons (intern_c_string ("multiple-frames"),
27438 pure_cons (make_pure_c_string ("%b"),
27439 pure_cons (pure_cons (empty_unibyte_string
,
27440 pure_cons (intern_c_string ("invocation-name"),
27441 pure_cons (make_pure_c_string ("@"),
27442 pure_cons (intern_c_string ("system-name"),
27446 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27447 doc
: /* Maximum number of lines to keep in the message log buffer.
27448 If nil, disable message logging. If t, log messages but don't truncate
27449 the buffer when it becomes large. */);
27450 Vmessage_log_max
= make_number (100);
27452 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27453 doc
: /* Functions called before redisplay, if window sizes have changed.
27454 The value should be a list of functions that take one argument.
27455 Just before redisplay, for each frame, if any of its windows have changed
27456 size since the last redisplay, or have been split or deleted,
27457 all the functions in the list are called, with the frame as argument. */);
27458 Vwindow_size_change_functions
= Qnil
;
27460 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27461 doc
: /* List of functions to call before redisplaying a window with scrolling.
27462 Each function is called with two arguments, the window and its new
27463 display-start position. Note that these functions are also called by
27464 `set-window-buffer'. Also note that the value of `window-end' is not
27465 valid when these functions are called. */);
27466 Vwindow_scroll_functions
= Qnil
;
27468 DEFVAR_LISP ("window-text-change-functions",
27469 Vwindow_text_change_functions
,
27470 doc
: /* Functions to call in redisplay when text in the window might change. */);
27471 Vwindow_text_change_functions
= Qnil
;
27473 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27474 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27475 Each function is called with two arguments, the window and the end trigger value.
27476 See `set-window-redisplay-end-trigger'. */);
27477 Vredisplay_end_trigger_functions
= Qnil
;
27479 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27480 doc
: /* *Non-nil means autoselect window with mouse pointer.
27481 If nil, do not autoselect windows.
27482 A positive number means delay autoselection by that many seconds: a
27483 window is autoselected only after the mouse has remained in that
27484 window for the duration of the delay.
27485 A negative number has a similar effect, but causes windows to be
27486 autoselected only after the mouse has stopped moving. \(Because of
27487 the way Emacs compares mouse events, you will occasionally wait twice
27488 that time before the window gets selected.\)
27489 Any other value means to autoselect window instantaneously when the
27490 mouse pointer enters it.
27492 Autoselection selects the minibuffer only if it is active, and never
27493 unselects the minibuffer if it is active.
27495 When customizing this variable make sure that the actual value of
27496 `focus-follows-mouse' matches the behavior of your window manager. */);
27497 Vmouse_autoselect_window
= Qnil
;
27499 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27500 doc
: /* *Non-nil means automatically resize tool-bars.
27501 This dynamically changes the tool-bar's height to the minimum height
27502 that is needed to make all tool-bar items visible.
27503 If value is `grow-only', the tool-bar's height is only increased
27504 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27505 Vauto_resize_tool_bars
= Qt
;
27507 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27508 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27509 auto_raise_tool_bar_buttons_p
= 1;
27511 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27512 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27513 make_cursor_line_fully_visible_p
= 1;
27515 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27516 doc
: /* *Border below tool-bar in pixels.
27517 If an integer, use it as the height of the border.
27518 If it is one of `internal-border-width' or `border-width', use the
27519 value of the corresponding frame parameter.
27520 Otherwise, no border is added below the tool-bar. */);
27521 Vtool_bar_border
= Qinternal_border_width
;
27523 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27524 doc
: /* *Margin around tool-bar buttons in pixels.
27525 If an integer, use that for both horizontal and vertical margins.
27526 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27527 HORZ specifying the horizontal margin, and VERT specifying the
27528 vertical margin. */);
27529 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27531 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27532 doc
: /* *Relief thickness of tool-bar buttons. */);
27533 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27535 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27536 doc
: /* Tool bar style to use.
27538 image - show images only
27539 text - show text only
27540 both - show both, text below image
27541 both-horiz - show text to the right of the image
27542 text-image-horiz - show text to the left of the image
27543 any other - use system default or image if no system default. */);
27544 Vtool_bar_style
= Qnil
;
27546 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27547 doc
: /* *Maximum number of characters a label can have to be shown.
27548 The tool bar style must also show labels for this to have any effect, see
27549 `tool-bar-style'. */);
27550 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27552 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27553 doc
: /* List of functions to call to fontify regions of text.
27554 Each function is called with one argument POS. Functions must
27555 fontify a region starting at POS in the current buffer, and give
27556 fontified regions the property `fontified'. */);
27557 Vfontification_functions
= Qnil
;
27558 Fmake_variable_buffer_local (Qfontification_functions
);
27560 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27561 unibyte_display_via_language_environment
,
27562 doc
: /* *Non-nil means display unibyte text according to language environment.
27563 Specifically, this means that raw bytes in the range 160-255 decimal
27564 are displayed by converting them to the equivalent multibyte characters
27565 according to the current language environment. As a result, they are
27566 displayed according to the current fontset.
27568 Note that this variable affects only how these bytes are displayed,
27569 but does not change the fact they are interpreted as raw bytes. */);
27570 unibyte_display_via_language_environment
= 0;
27572 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27573 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27574 If a float, it specifies a fraction of the mini-window frame's height.
27575 If an integer, it specifies a number of lines. */);
27576 Vmax_mini_window_height
= make_float (0.25);
27578 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27579 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27580 A value of nil means don't automatically resize mini-windows.
27581 A value of t means resize them to fit the text displayed in them.
27582 A value of `grow-only', the default, means let mini-windows grow only;
27583 they return to their normal size when the minibuffer is closed, or the
27584 echo area becomes empty. */);
27585 Vresize_mini_windows
= Qgrow_only
;
27587 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27588 doc
: /* Alist specifying how to blink the cursor off.
27589 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27590 `cursor-type' frame-parameter or variable equals ON-STATE,
27591 comparing using `equal', Emacs uses OFF-STATE to specify
27592 how to blink it off. ON-STATE and OFF-STATE are values for
27593 the `cursor-type' frame parameter.
27595 If a frame's ON-STATE has no entry in this list,
27596 the frame's other specifications determine how to blink the cursor off. */);
27597 Vblink_cursor_alist
= Qnil
;
27599 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27600 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27601 If non-nil, windows are automatically scrolled horizontally to make
27602 point visible. */);
27603 automatic_hscrolling_p
= 1;
27604 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27606 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27607 doc
: /* *How many columns away from the window edge point is allowed to get
27608 before automatic hscrolling will horizontally scroll the window. */);
27609 hscroll_margin
= 5;
27611 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27612 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27613 When point is less than `hscroll-margin' columns from the window
27614 edge, automatic hscrolling will scroll the window by the amount of columns
27615 determined by this variable. If its value is a positive integer, scroll that
27616 many columns. If it's a positive floating-point number, it specifies the
27617 fraction of the window's width to scroll. If it's nil or zero, point will be
27618 centered horizontally after the scroll. Any other value, including negative
27619 numbers, are treated as if the value were zero.
27621 Automatic hscrolling always moves point outside the scroll margin, so if
27622 point was more than scroll step columns inside the margin, the window will
27623 scroll more than the value given by the scroll step.
27625 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27626 and `scroll-right' overrides this variable's effect. */);
27627 Vhscroll_step
= make_number (0);
27629 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27630 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27631 Bind this around calls to `message' to let it take effect. */);
27632 message_truncate_lines
= 0;
27634 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27635 doc
: /* Normal hook run to update the menu bar definitions.
27636 Redisplay runs this hook before it redisplays the menu bar.
27637 This is used to update submenus such as Buffers,
27638 whose contents depend on various data. */);
27639 Vmenu_bar_update_hook
= Qnil
;
27641 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27642 doc
: /* Frame for which we are updating a menu.
27643 The enable predicate for a menu binding should check this variable. */);
27644 Vmenu_updating_frame
= Qnil
;
27646 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27647 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27648 inhibit_menubar_update
= 0;
27650 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27651 doc
: /* Prefix prepended to all continuation lines at display time.
27652 The value may be a string, an image, or a stretch-glyph; it is
27653 interpreted in the same way as the value of a `display' text property.
27655 This variable is overridden by any `wrap-prefix' text or overlay
27658 To add a prefix to non-continuation lines, use `line-prefix'. */);
27659 Vwrap_prefix
= Qnil
;
27660 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27661 Fmake_variable_buffer_local (Qwrap_prefix
);
27663 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27664 doc
: /* Prefix prepended to all non-continuation lines at display time.
27665 The value may be a string, an image, or a stretch-glyph; it is
27666 interpreted in the same way as the value of a `display' text property.
27668 This variable is overridden by any `line-prefix' text or overlay
27671 To add a prefix to continuation lines, use `wrap-prefix'. */);
27672 Vline_prefix
= Qnil
;
27673 DEFSYM (Qline_prefix
, "line-prefix");
27674 Fmake_variable_buffer_local (Qline_prefix
);
27676 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27677 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27678 inhibit_eval_during_redisplay
= 0;
27680 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27681 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27682 inhibit_free_realized_faces
= 0;
27685 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27686 doc
: /* Inhibit try_window_id display optimization. */);
27687 inhibit_try_window_id
= 0;
27689 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27690 doc
: /* Inhibit try_window_reusing display optimization. */);
27691 inhibit_try_window_reusing
= 0;
27693 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27694 doc
: /* Inhibit try_cursor_movement display optimization. */);
27695 inhibit_try_cursor_movement
= 0;
27696 #endif /* GLYPH_DEBUG */
27698 DEFVAR_INT ("overline-margin", overline_margin
,
27699 doc
: /* *Space between overline and text, in pixels.
27700 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27701 margin to the caracter height. */);
27702 overline_margin
= 2;
27704 DEFVAR_INT ("underline-minimum-offset",
27705 underline_minimum_offset
,
27706 doc
: /* Minimum distance between baseline and underline.
27707 This can improve legibility of underlined text at small font sizes,
27708 particularly when using variable `x-use-underline-position-properties'
27709 with fonts that specify an UNDERLINE_POSITION relatively close to the
27710 baseline. The default value is 1. */);
27711 underline_minimum_offset
= 1;
27713 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27714 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27715 This feature only works when on a window system that can change
27716 cursor shapes. */);
27717 display_hourglass_p
= 1;
27719 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27720 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27721 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27723 hourglass_atimer
= NULL
;
27724 hourglass_shown_p
= 0;
27726 DEFSYM (Qglyphless_char
, "glyphless-char");
27727 DEFSYM (Qhex_code
, "hex-code");
27728 DEFSYM (Qempty_box
, "empty-box");
27729 DEFSYM (Qthin_space
, "thin-space");
27730 DEFSYM (Qzero_width
, "zero-width");
27732 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27733 /* Intern this now in case it isn't already done.
27734 Setting this variable twice is harmless.
27735 But don't staticpro it here--that is done in alloc.c. */
27736 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27737 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27739 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27740 doc
: /* Char-table defining glyphless characters.
27741 Each element, if non-nil, should be one of the following:
27742 an ASCII acronym string: display this string in a box
27743 `hex-code': display the hexadecimal code of a character in a box
27744 `empty-box': display as an empty box
27745 `thin-space': display as 1-pixel width space
27746 `zero-width': don't display
27747 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27748 display method for graphical terminals and text terminals respectively.
27749 GRAPHICAL and TEXT should each have one of the values listed above.
27751 The char-table has one extra slot to control the display of a character for
27752 which no font is found. This slot only takes effect on graphical terminals.
27753 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27754 `thin-space'. The default is `empty-box'. */);
27755 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27756 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27761 /* Initialize this module when Emacs starts. */
27766 current_header_line_height
= current_mode_line_height
= -1;
27768 CHARPOS (this_line_start_pos
) = 0;
27770 if (!noninteractive
)
27772 struct window
*m
= XWINDOW (minibuf_window
);
27773 Lisp_Object frame
= m
->frame
;
27774 struct frame
*f
= XFRAME (frame
);
27775 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27776 struct window
*r
= XWINDOW (root
);
27779 echo_area_window
= minibuf_window
;
27781 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27782 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27783 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27784 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27785 XSETFASTINT (m
->total_lines
, 1);
27786 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27788 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27789 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27790 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27792 /* The default ellipsis glyphs `...'. */
27793 for (i
= 0; i
< 3; ++i
)
27794 default_invis_vector
[i
] = make_number ('.');
27798 /* Allocate the buffer for frame titles.
27799 Also used for `format-mode-line'. */
27801 mode_line_noprop_buf
= (char *) xmalloc (size
);
27802 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27803 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27804 mode_line_target
= MODE_LINE_DISPLAY
;
27807 help_echo_showing_p
= 0;
27810 /* Since w32 does not support atimers, it defines its own implementation of
27811 the following three functions in w32fns.c. */
27814 /* Platform-independent portion of hourglass implementation. */
27816 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27818 hourglass_started (void)
27820 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27823 /* Cancel a currently active hourglass timer, and start a new one. */
27825 start_hourglass (void)
27827 #if defined (HAVE_WINDOW_SYSTEM)
27829 int secs
, usecs
= 0;
27831 cancel_hourglass ();
27833 if (INTEGERP (Vhourglass_delay
)
27834 && XINT (Vhourglass_delay
) > 0)
27835 secs
= XFASTINT (Vhourglass_delay
);
27836 else if (FLOATP (Vhourglass_delay
)
27837 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27840 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27841 secs
= XFASTINT (tem
);
27842 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27845 secs
= DEFAULT_HOURGLASS_DELAY
;
27847 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27848 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27849 show_hourglass
, NULL
);
27854 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27857 cancel_hourglass (void)
27859 #if defined (HAVE_WINDOW_SYSTEM)
27860 if (hourglass_atimer
)
27862 cancel_atimer (hourglass_atimer
);
27863 hourglass_atimer
= NULL
;
27866 if (hourglass_shown_p
)
27870 #endif /* ! WINDOWSNT */