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 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2483 /* Are lines in the display truncated? */
2484 if (base_face_id
!= DEFAULT_FACE_ID
2485 || XINT (it
->w
->hscroll
)
2486 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2487 && ((!NILP (Vtruncate_partial_width_windows
)
2488 && !INTEGERP (Vtruncate_partial_width_windows
))
2489 || (INTEGERP (Vtruncate_partial_width_windows
)
2490 && (WINDOW_TOTAL_COLS (it
->w
)
2491 < XINT (Vtruncate_partial_width_windows
))))))
2492 it
->line_wrap
= TRUNCATE
;
2493 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2494 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2495 ? WINDOW_WRAP
: WORD_WRAP
;
2497 it
->line_wrap
= TRUNCATE
;
2499 /* Get dimensions of truncation and continuation glyphs. These are
2500 displayed as fringe bitmaps under X, so we don't need them for such
2502 if (!FRAME_WINDOW_P (it
->f
))
2504 if (it
->line_wrap
== TRUNCATE
)
2506 /* We will need the truncation glyph. */
2507 xassert (it
->glyph_row
== NULL
);
2508 produce_special_glyphs (it
, IT_TRUNCATION
);
2509 it
->truncation_pixel_width
= it
->pixel_width
;
2513 /* We will need the continuation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_CONTINUATION
);
2516 it
->continuation_pixel_width
= it
->pixel_width
;
2519 /* Reset these values to zero because the produce_special_glyphs
2520 above has changed them. */
2521 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2522 it
->phys_ascent
= it
->phys_descent
= 0;
2525 /* Set this after getting the dimensions of truncation and
2526 continuation glyphs, so that we don't produce glyphs when calling
2527 produce_special_glyphs, above. */
2528 it
->glyph_row
= row
;
2529 it
->area
= TEXT_AREA
;
2531 /* Forget any previous info about this row being reversed. */
2533 it
->glyph_row
->reversed_p
= 0;
2535 /* Get the dimensions of the display area. The display area
2536 consists of the visible window area plus a horizontally scrolled
2537 part to the left of the window. All x-values are relative to the
2538 start of this total display area. */
2539 if (base_face_id
!= DEFAULT_FACE_ID
)
2541 /* Mode lines, menu bar in terminal frames. */
2542 it
->first_visible_x
= 0;
2543 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2548 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2549 it
->last_visible_x
= (it
->first_visible_x
2550 + window_box_width (w
, TEXT_AREA
));
2552 /* If we truncate lines, leave room for the truncator glyph(s) at
2553 the right margin. Otherwise, leave room for the continuation
2554 glyph(s). Truncation and continuation glyphs are not inserted
2555 for window-based redisplay. */
2556 if (!FRAME_WINDOW_P (it
->f
))
2558 if (it
->line_wrap
== TRUNCATE
)
2559 it
->last_visible_x
-= it
->truncation_pixel_width
;
2561 it
->last_visible_x
-= it
->continuation_pixel_width
;
2564 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2565 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2568 /* Leave room for a border glyph. */
2569 if (!FRAME_WINDOW_P (it
->f
)
2570 && !WINDOW_RIGHTMOST_P (it
->w
))
2571 it
->last_visible_x
-= 1;
2573 it
->last_visible_y
= window_text_bottom_y (w
);
2575 /* For mode lines and alike, arrange for the first glyph having a
2576 left box line if the face specifies a box. */
2577 if (base_face_id
!= DEFAULT_FACE_ID
)
2581 it
->face_id
= remapped_base_face_id
;
2583 /* If we have a boxed mode line, make the first character appear
2584 with a left box line. */
2585 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2586 if (face
->box
!= FACE_NO_BOX
)
2587 it
->start_of_box_run_p
= 1;
2590 /* If a buffer position was specified, set the iterator there,
2591 getting overlays and face properties from that position. */
2592 if (charpos
>= BUF_BEG (current_buffer
))
2594 it
->end_charpos
= ZV
;
2596 IT_CHARPOS (*it
) = charpos
;
2598 /* Compute byte position if not specified. */
2599 if (bytepos
< charpos
)
2600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2602 IT_BYTEPOS (*it
) = bytepos
;
2604 it
->start
= it
->current
;
2605 /* Do we need to reorder bidirectional text? Not if this is a
2606 unibyte buffer: by definition, none of the single-byte
2607 characters are strong R2L, so no reordering is needed. And
2608 bidi.c doesn't support unibyte buffers anyway. */
2610 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2613 /* If we are to reorder bidirectional text, init the bidi
2617 /* Note the paragraph direction that this buffer wants to
2619 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2621 it
->paragraph_embedding
= L2R
;
2622 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= R2L
;
2626 it
->paragraph_embedding
= NEUTRAL_DIR
;
2627 bidi_unshelve_cache (NULL
);
2628 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2632 /* Compute faces etc. */
2633 reseat (it
, it
->current
.pos
, 1);
2640 /* Initialize IT for the display of window W with window start POS. */
2643 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2645 struct glyph_row
*row
;
2646 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2648 row
= w
->desired_matrix
->rows
+ first_vpos
;
2649 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2650 it
->first_vpos
= first_vpos
;
2652 /* Don't reseat to previous visible line start if current start
2653 position is in a string or image. */
2654 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2656 int start_at_line_beg_p
;
2657 int first_y
= it
->current_y
;
2659 /* If window start is not at a line start, skip forward to POS to
2660 get the correct continuation lines width. */
2661 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2662 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2663 if (!start_at_line_beg_p
)
2667 reseat_at_previous_visible_line_start (it
);
2668 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2670 new_x
= it
->current_x
+ it
->pixel_width
;
2672 /* If lines are continued, this line may end in the middle
2673 of a multi-glyph character (e.g. a control character
2674 displayed as \003, or in the middle of an overlay
2675 string). In this case move_it_to above will not have
2676 taken us to the start of the continuation line but to the
2677 end of the continued line. */
2678 if (it
->current_x
> 0
2679 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2680 && (/* And glyph doesn't fit on the line. */
2681 new_x
> it
->last_visible_x
2682 /* Or it fits exactly and we're on a window
2684 || (new_x
== it
->last_visible_x
2685 && FRAME_WINDOW_P (it
->f
))))
2687 if (it
->current
.dpvec_index
>= 0
2688 || it
->current
.overlay_string_index
>= 0)
2690 set_iterator_to_next (it
, 1);
2691 move_it_in_display_line_to (it
, -1, -1, 0);
2694 it
->continuation_lines_width
+= it
->current_x
;
2697 /* We're starting a new display line, not affected by the
2698 height of the continued line, so clear the appropriate
2699 fields in the iterator structure. */
2700 it
->max_ascent
= it
->max_descent
= 0;
2701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2703 it
->current_y
= first_y
;
2705 it
->current_x
= it
->hpos
= 0;
2711 /* Return 1 if POS is a position in ellipses displayed for invisible
2712 text. W is the window we display, for text property lookup. */
2715 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2717 Lisp_Object prop
, window
;
2719 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2721 /* If POS specifies a position in a display vector, this might
2722 be for an ellipsis displayed for invisible text. We won't
2723 get the iterator set up for delivering that ellipsis unless
2724 we make sure that it gets aware of the invisible text. */
2725 if (pos
->dpvec_index
>= 0
2726 && pos
->overlay_string_index
< 0
2727 && CHARPOS (pos
->string_pos
) < 0
2729 && (XSETWINDOW (window
, w
),
2730 prop
= Fget_char_property (make_number (charpos
),
2731 Qinvisible
, window
),
2732 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2734 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2736 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2743 /* Initialize IT for stepping through current_buffer in window W,
2744 starting at position POS that includes overlay string and display
2745 vector/ control character translation position information. Value
2746 is zero if there are overlay strings with newlines at POS. */
2749 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2751 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2752 int i
, overlay_strings_with_newlines
= 0;
2754 /* If POS specifies a position in a display vector, this might
2755 be for an ellipsis displayed for invisible text. We won't
2756 get the iterator set up for delivering that ellipsis unless
2757 we make sure that it gets aware of the invisible text. */
2758 if (in_ellipses_for_invisible_text_p (pos
, w
))
2764 /* Keep in mind: the call to reseat in init_iterator skips invisible
2765 text, so we might end up at a position different from POS. This
2766 is only a problem when POS is a row start after a newline and an
2767 overlay starts there with an after-string, and the overlay has an
2768 invisible property. Since we don't skip invisible text in
2769 display_line and elsewhere immediately after consuming the
2770 newline before the row start, such a POS will not be in a string,
2771 but the call to init_iterator below will move us to the
2773 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2775 /* This only scans the current chunk -- it should scan all chunks.
2776 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2777 to 16 in 22.1 to make this a lesser problem. */
2778 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2780 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2781 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2783 while (s
< e
&& *s
!= '\n')
2788 overlay_strings_with_newlines
= 1;
2793 /* If position is within an overlay string, set up IT to the right
2795 if (pos
->overlay_string_index
>= 0)
2799 /* If the first overlay string happens to have a `display'
2800 property for an image, the iterator will be set up for that
2801 image, and we have to undo that setup first before we can
2802 correct the overlay string index. */
2803 if (it
->method
== GET_FROM_IMAGE
)
2806 /* We already have the first chunk of overlay strings in
2807 IT->overlay_strings. Load more until the one for
2808 pos->overlay_string_index is in IT->overlay_strings. */
2809 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2811 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2812 it
->current
.overlay_string_index
= 0;
2815 load_overlay_strings (it
, 0);
2816 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2821 relative_index
= (it
->current
.overlay_string_index
2822 % OVERLAY_STRING_CHUNK_SIZE
);
2823 it
->string
= it
->overlay_strings
[relative_index
];
2824 xassert (STRINGP (it
->string
));
2825 it
->current
.string_pos
= pos
->string_pos
;
2826 it
->method
= GET_FROM_STRING
;
2829 if (CHARPOS (pos
->string_pos
) >= 0)
2831 /* Recorded position is not in an overlay string, but in another
2832 string. This can only be a string from a `display' property.
2833 IT should already be filled with that string. */
2834 it
->current
.string_pos
= pos
->string_pos
;
2835 xassert (STRINGP (it
->string
));
2838 /* Restore position in display vector translations, control
2839 character translations or ellipses. */
2840 if (pos
->dpvec_index
>= 0)
2842 if (it
->dpvec
== NULL
)
2843 get_next_display_element (it
);
2844 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2845 it
->current
.dpvec_index
= pos
->dpvec_index
;
2849 return !overlay_strings_with_newlines
;
2853 /* Initialize IT for stepping through current_buffer in window W
2854 starting at ROW->start. */
2857 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2859 init_from_display_pos (it
, w
, &row
->start
);
2860 it
->start
= row
->start
;
2861 it
->continuation_lines_width
= row
->continuation_lines_width
;
2866 /* Initialize IT for stepping through current_buffer in window W
2867 starting in the line following ROW, i.e. starting at ROW->end.
2868 Value is zero if there are overlay strings with newlines at ROW's
2872 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2876 if (init_from_display_pos (it
, w
, &row
->end
))
2878 if (row
->continued_p
)
2879 it
->continuation_lines_width
2880 = row
->continuation_lines_width
+ row
->pixel_width
;
2891 /***********************************************************************
2893 ***********************************************************************/
2895 /* Called when IT reaches IT->stop_charpos. Handle text property and
2896 overlay changes. Set IT->stop_charpos to the next position where
2900 handle_stop (struct it
*it
)
2902 enum prop_handled handled
;
2903 int handle_overlay_change_p
;
2907 it
->current
.dpvec_index
= -1;
2908 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2909 it
->ignore_overlay_strings_at_pos_p
= 0;
2912 /* Use face of preceding text for ellipsis (if invisible) */
2913 if (it
->selective_display_ellipsis_p
)
2914 it
->saved_face_id
= it
->face_id
;
2918 handled
= HANDLED_NORMALLY
;
2920 /* Call text property handlers. */
2921 for (p
= it_props
; p
->handler
; ++p
)
2923 handled
= p
->handler (it
);
2925 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2927 else if (handled
== HANDLED_RETURN
)
2929 /* We still want to show before and after strings from
2930 overlays even if the actual buffer text is replaced. */
2931 if (!handle_overlay_change_p
2933 || !get_overlay_strings_1 (it
, 0, 0))
2936 setup_for_ellipsis (it
, 0);
2937 /* When handling a display spec, we might load an
2938 empty string. In that case, discard it here. We
2939 used to discard it in handle_single_display_spec,
2940 but that causes get_overlay_strings_1, above, to
2941 ignore overlay strings that we must check. */
2942 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2950 it
->ignore_overlay_strings_at_pos_p
= 1;
2951 it
->string_from_display_prop_p
= 0;
2952 it
->from_disp_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3112 ptrdiff_t i
, noverlays
;
3114 Lisp_Object
*overlays
;
3116 /* Get all overlays at the given position. */
3117 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3119 /* If any of these overlays ends before endpos,
3120 use its ending point instead. */
3121 for (i
= 0; i
< noverlays
; ++i
)
3126 oend
= OVERLAY_END (overlays
[i
]);
3127 oendpos
= OVERLAY_POSITION (oend
);
3128 endpos
= min (endpos
, oendpos
);
3134 /* Return the character position of a display string at or after
3135 position specified by POSITION. If no display string exists at or
3136 after POSITION, return ZV. A display string is either an overlay
3137 with `display' property whose value is a string, or a `display'
3138 text property whose value is a string. STRING is data about the
3139 string to iterate; if STRING->lstring is nil, we are iterating a
3140 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3143 compute_display_string_pos (struct text_pos
*position
,
3144 struct bidi_string_data
*string
, int frame_window_p
)
3146 /* OBJECT = nil means current buffer. */
3147 Lisp_Object object
=
3148 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3149 Lisp_Object pos
, spec
;
3150 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3151 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3152 EMACS_INT begb
= string_p
? 0 : BEGV
;
3153 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3154 struct text_pos tpos
;
3157 /* We don't support display properties whose values are strings
3158 that have display string properties. */
3159 || string
->from_disp_str
3160 /* C strings cannot have display properties. */
3161 || (string
->s
&& !STRINGP (object
)))
3164 /* If the character at CHARPOS is where the display string begins,
3166 pos
= make_number (charpos
);
3167 if (STRINGP (object
))
3168 bufpos
= string
->bufpos
;
3172 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3174 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3177 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3181 /* Look forward for the first character with a `display' property
3182 that will replace the underlying text when displayed. */
3184 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3185 CHARPOS (tpos
) = XFASTINT (pos
);
3186 if (STRINGP (object
))
3187 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3189 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3190 if (CHARPOS (tpos
) >= eob
)
3192 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3193 if (!STRINGP (object
))
3194 bufpos
= CHARPOS (tpos
);
3195 } while (NILP (spec
)
3196 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3199 return CHARPOS (tpos
);
3202 /* Return the character position of the end of the display string that
3203 started at CHARPOS. A display string is either an overlay with
3204 `display' property whose value is a string or a `display' text
3205 property whose value is a string. */
3207 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3209 /* OBJECT = nil means current buffer. */
3210 Lisp_Object object
=
3211 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3212 Lisp_Object pos
= make_number (charpos
);
3214 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3216 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3219 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3222 /* Look forward for the first character where the `display' property
3224 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3226 return XFASTINT (pos
);
3231 /***********************************************************************
3233 ***********************************************************************/
3235 /* Handle changes in the `fontified' property of the current buffer by
3236 calling hook functions from Qfontification_functions to fontify
3239 static enum prop_handled
3240 handle_fontified_prop (struct it
*it
)
3242 Lisp_Object prop
, pos
;
3243 enum prop_handled handled
= HANDLED_NORMALLY
;
3245 if (!NILP (Vmemory_full
))
3248 /* Get the value of the `fontified' property at IT's current buffer
3249 position. (The `fontified' property doesn't have a special
3250 meaning in strings.) If the value is nil, call functions from
3251 Qfontification_functions. */
3252 if (!STRINGP (it
->string
)
3254 && !NILP (Vfontification_functions
)
3255 && !NILP (Vrun_hooks
)
3256 && (pos
= make_number (IT_CHARPOS (*it
)),
3257 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3258 /* Ignore the special cased nil value always present at EOB since
3259 no amount of fontifying will be able to change it. */
3260 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3262 int count
= SPECPDL_INDEX ();
3264 struct buffer
*obuf
= current_buffer
;
3265 int begv
= BEGV
, zv
= ZV
;
3266 int old_clip_changed
= current_buffer
->clip_changed
;
3268 val
= Vfontification_functions
;
3269 specbind (Qfontification_functions
, Qnil
);
3271 xassert (it
->end_charpos
== ZV
);
3273 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3274 safe_call1 (val
, pos
);
3277 Lisp_Object fns
, fn
;
3278 struct gcpro gcpro1
, gcpro2
;
3283 for (; CONSP (val
); val
= XCDR (val
))
3289 /* A value of t indicates this hook has a local
3290 binding; it means to run the global binding too.
3291 In a global value, t should not occur. If it
3292 does, we must ignore it to avoid an endless
3294 for (fns
= Fdefault_value (Qfontification_functions
);
3300 safe_call1 (fn
, pos
);
3304 safe_call1 (fn
, pos
);
3310 unbind_to (count
, Qnil
);
3312 /* Fontification functions routinely call `save-restriction'.
3313 Normally, this tags clip_changed, which can confuse redisplay
3314 (see discussion in Bug#6671). Since we don't perform any
3315 special handling of fontification changes in the case where
3316 `save-restriction' isn't called, there's no point doing so in
3317 this case either. So, if the buffer's restrictions are
3318 actually left unchanged, reset clip_changed. */
3319 if (obuf
== current_buffer
)
3321 if (begv
== BEGV
&& zv
== ZV
)
3322 current_buffer
->clip_changed
= old_clip_changed
;
3324 /* There isn't much we can reasonably do to protect against
3325 misbehaving fontification, but here's a fig leaf. */
3326 else if (!NILP (BVAR (obuf
, name
)))
3327 set_buffer_internal_1 (obuf
);
3329 /* The fontification code may have added/removed text.
3330 It could do even a lot worse, but let's at least protect against
3331 the most obvious case where only the text past `pos' gets changed',
3332 as is/was done in grep.el where some escapes sequences are turned
3333 into face properties (bug#7876). */
3334 it
->end_charpos
= ZV
;
3336 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3337 something. This avoids an endless loop if they failed to
3338 fontify the text for which reason ever. */
3339 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3340 handled
= HANDLED_RECOMPUTE_PROPS
;
3348 /***********************************************************************
3350 ***********************************************************************/
3352 /* Set up iterator IT from face properties at its current position.
3353 Called from handle_stop. */
3355 static enum prop_handled
3356 handle_face_prop (struct it
*it
)
3359 EMACS_INT next_stop
;
3361 if (!STRINGP (it
->string
))
3364 = face_at_buffer_position (it
->w
,
3366 it
->region_beg_charpos
,
3367 it
->region_end_charpos
,
3370 + TEXT_PROP_DISTANCE_LIMIT
),
3371 0, it
->base_face_id
);
3373 /* Is this a start of a run of characters with box face?
3374 Caveat: this can be called for a freshly initialized
3375 iterator; face_id is -1 in this case. We know that the new
3376 face will not change until limit, i.e. if the new face has a
3377 box, all characters up to limit will have one. But, as
3378 usual, we don't know whether limit is really the end. */
3379 if (new_face_id
!= it
->face_id
)
3381 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3383 /* If new face has a box but old face has not, this is
3384 the start of a run of characters with box, i.e. it has
3385 a shadow on the left side. The value of face_id of the
3386 iterator will be -1 if this is the initial call that gets
3387 the face. In this case, we have to look in front of IT's
3388 position and see whether there is a face != new_face_id. */
3389 it
->start_of_box_run_p
3390 = (new_face
->box
!= FACE_NO_BOX
3391 && (it
->face_id
>= 0
3392 || IT_CHARPOS (*it
) == BEG
3393 || new_face_id
!= face_before_it_pos (it
)));
3394 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3402 Lisp_Object from_overlay
3403 = (it
->current
.overlay_string_index
>= 0
3404 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3407 /* See if we got to this string directly or indirectly from
3408 an overlay property. That includes the before-string or
3409 after-string of an overlay, strings in display properties
3410 provided by an overlay, their text properties, etc.
3412 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3413 if (! NILP (from_overlay
))
3414 for (i
= it
->sp
- 1; i
>= 0; i
--)
3416 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3418 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3419 else if (! NILP (it
->stack
[i
].from_overlay
))
3420 from_overlay
= it
->stack
[i
].from_overlay
;
3422 if (!NILP (from_overlay
))
3426 if (! NILP (from_overlay
))
3428 bufpos
= IT_CHARPOS (*it
);
3429 /* For a string from an overlay, the base face depends
3430 only on text properties and ignores overlays. */
3432 = face_for_overlay_string (it
->w
,
3434 it
->region_beg_charpos
,
3435 it
->region_end_charpos
,
3438 + TEXT_PROP_DISTANCE_LIMIT
),
3446 /* For strings from a `display' property, use the face at
3447 IT's current buffer position as the base face to merge
3448 with, so that overlay strings appear in the same face as
3449 surrounding text, unless they specify their own
3451 base_face_id
= underlying_face_id (it
);
3454 new_face_id
= face_at_string_position (it
->w
,
3456 IT_STRING_CHARPOS (*it
),
3458 it
->region_beg_charpos
,
3459 it
->region_end_charpos
,
3463 /* Is this a start of a run of characters with box? Caveat:
3464 this can be called for a freshly allocated iterator; face_id
3465 is -1 is this case. We know that the new face will not
3466 change until the next check pos, i.e. if the new face has a
3467 box, all characters up to that position will have a
3468 box. But, as usual, we don't know whether that position
3469 is really the end. */
3470 if (new_face_id
!= it
->face_id
)
3472 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3473 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3475 /* If new face has a box but old face hasn't, this is the
3476 start of a run of characters with box, i.e. it has a
3477 shadow on the left side. */
3478 it
->start_of_box_run_p
3479 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3480 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3484 it
->face_id
= new_face_id
;
3485 return HANDLED_NORMALLY
;
3489 /* Return the ID of the face ``underlying'' IT's current position,
3490 which is in a string. If the iterator is associated with a
3491 buffer, return the face at IT's current buffer position.
3492 Otherwise, use the iterator's base_face_id. */
3495 underlying_face_id (struct it
*it
)
3497 int face_id
= it
->base_face_id
, i
;
3499 xassert (STRINGP (it
->string
));
3501 for (i
= it
->sp
- 1; i
>= 0; --i
)
3502 if (NILP (it
->stack
[i
].string
))
3503 face_id
= it
->stack
[i
].face_id
;
3509 /* Compute the face one character before or after the current position
3510 of IT, in the visual order. BEFORE_P non-zero means get the face
3511 in front (to the left in L2R paragraphs, to the right in R2L
3512 paragraphs) of IT's screen position. Value is the ID of the face. */
3515 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3518 EMACS_INT next_check_charpos
;
3520 void *it_copy_data
= NULL
;
3522 xassert (it
->s
== NULL
);
3524 if (STRINGP (it
->string
))
3526 EMACS_INT bufpos
, charpos
;
3529 /* No face change past the end of the string (for the case
3530 we are padding with spaces). No face change before the
3532 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3533 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3538 /* Set charpos to the position before or after IT's current
3539 position, in the logical order, which in the non-bidi
3540 case is the same as the visual order. */
3542 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3543 else if (it
->what
== IT_COMPOSITION
)
3544 /* For composition, we must check the character after the
3546 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3548 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3554 /* With bidi iteration, the character before the current
3555 in the visual order cannot be found by simple
3556 iteration, because "reverse" reordering is not
3557 supported. Instead, we need to use the move_it_*
3558 family of functions. */
3559 /* Ignore face changes before the first visible
3560 character on this display line. */
3561 if (it
->current_x
<= it
->first_visible_x
)
3563 SAVE_IT (it_copy
, *it
, it_copy_data
);
3564 /* Implementation note: Since move_it_in_display_line
3565 works in the iterator geometry, and thinks the first
3566 character is always the leftmost, even in R2L lines,
3567 we don't need to distinguish between the R2L and L2R
3569 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3570 it_copy
.current_x
- 1, MOVE_TO_X
);
3571 charpos
= IT_STRING_CHARPOS (it_copy
);
3572 RESTORE_IT (it
, it
, it_copy_data
);
3576 /* Set charpos to the string position of the character
3577 that comes after IT's current position in the visual
3579 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3583 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3585 charpos
= it_copy
.bidi_it
.charpos
;
3588 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3590 if (it
->current
.overlay_string_index
>= 0)
3591 bufpos
= IT_CHARPOS (*it
);
3595 base_face_id
= underlying_face_id (it
);
3597 /* Get the face for ASCII, or unibyte. */
3598 face_id
= face_at_string_position (it
->w
,
3602 it
->region_beg_charpos
,
3603 it
->region_end_charpos
,
3604 &next_check_charpos
,
3607 /* Correct the face for charsets different from ASCII. Do it
3608 for the multibyte case only. The face returned above is
3609 suitable for unibyte text if IT->string is unibyte. */
3610 if (STRING_MULTIBYTE (it
->string
))
3612 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3613 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3615 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3617 c
= string_char_and_length (p
, &len
);
3618 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3623 struct text_pos pos
;
3625 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3626 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3629 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3630 pos
= it
->current
.pos
;
3635 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3638 if (it
->what
== IT_COMPOSITION
)
3640 /* For composition, we must check the position after
3642 pos
.charpos
+= it
->cmp_it
.nchars
;
3643 pos
.bytepos
+= it
->len
;
3646 INC_TEXT_POS (pos
, it
->multibyte_p
);
3653 /* With bidi iteration, the character before the current
3654 in the visual order cannot be found by simple
3655 iteration, because "reverse" reordering is not
3656 supported. Instead, we need to use the move_it_*
3657 family of functions. */
3658 /* Ignore face changes before the first visible
3659 character on this display line. */
3660 if (it
->current_x
<= it
->first_visible_x
)
3662 SAVE_IT (it_copy
, *it
, it_copy_data
);
3663 /* Implementation note: Since move_it_in_display_line
3664 works in the iterator geometry, and thinks the first
3665 character is always the leftmost, even in R2L lines,
3666 we don't need to distinguish between the R2L and L2R
3668 move_it_in_display_line (&it_copy
, ZV
,
3669 it_copy
.current_x
- 1, MOVE_TO_X
);
3670 pos
= it_copy
.current
.pos
;
3671 RESTORE_IT (it
, it
, it_copy_data
);
3675 /* Set charpos to the buffer position of the character
3676 that comes after IT's current position in the visual
3678 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3682 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3685 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3688 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3690 /* Determine face for CHARSET_ASCII, or unibyte. */
3691 face_id
= face_at_buffer_position (it
->w
,
3693 it
->region_beg_charpos
,
3694 it
->region_end_charpos
,
3695 &next_check_charpos
,
3698 /* Correct the face for charsets different from ASCII. Do it
3699 for the multibyte case only. The face returned above is
3700 suitable for unibyte text if current_buffer is unibyte. */
3701 if (it
->multibyte_p
)
3703 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3704 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3705 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3714 /***********************************************************************
3716 ***********************************************************************/
3718 /* Set up iterator IT from invisible properties at its current
3719 position. Called from handle_stop. */
3721 static enum prop_handled
3722 handle_invisible_prop (struct it
*it
)
3724 enum prop_handled handled
= HANDLED_NORMALLY
;
3726 if (STRINGP (it
->string
))
3728 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3730 /* Get the value of the invisible text property at the
3731 current position. Value will be nil if there is no such
3733 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3734 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3737 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3741 handled
= HANDLED_RECOMPUTE_PROPS
;
3743 /* Get the position at which the next change of the
3744 invisible text property can be found in IT->string.
3745 Value will be nil if the property value is the same for
3746 all the rest of IT->string. */
3747 XSETINT (limit
, SCHARS (it
->string
));
3748 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3751 /* Text at current position is invisible. The next
3752 change in the property is at position end_charpos.
3753 Move IT's current position to that position. */
3754 if (INTEGERP (end_charpos
)
3755 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3757 struct text_pos old
;
3760 old
= it
->current
.string_pos
;
3761 oldpos
= CHARPOS (old
);
3764 if (it
->bidi_it
.first_elt
3765 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3766 bidi_paragraph_init (it
->paragraph_embedding
,
3768 /* Bidi-iterate out of the invisible text. */
3771 bidi_move_to_visually_next (&it
->bidi_it
);
3773 while (oldpos
<= it
->bidi_it
.charpos
3774 && it
->bidi_it
.charpos
< endpos
);
3776 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3777 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3778 if (IT_CHARPOS (*it
) >= endpos
)
3779 it
->prev_stop
= endpos
;
3783 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3784 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3789 /* The rest of the string is invisible. If this is an
3790 overlay string, proceed with the next overlay string
3791 or whatever comes and return a character from there. */
3792 if (it
->current
.overlay_string_index
>= 0)
3794 next_overlay_string (it
);
3795 /* Don't check for overlay strings when we just
3796 finished processing them. */
3797 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3801 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3802 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3810 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3811 Lisp_Object pos
, prop
, overlay
;
3813 /* First of all, is there invisible text at this position? */
3814 tem
= start_charpos
= IT_CHARPOS (*it
);
3815 pos
= make_number (tem
);
3816 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3818 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3820 /* If we are on invisible text, skip over it. */
3821 if (invis_p
&& start_charpos
< it
->end_charpos
)
3823 /* Record whether we have to display an ellipsis for the
3825 int display_ellipsis_p
= invis_p
== 2;
3827 handled
= HANDLED_RECOMPUTE_PROPS
;
3829 /* Loop skipping over invisible text. The loop is left at
3830 ZV or with IT on the first char being visible again. */
3833 /* Try to skip some invisible text. Return value is the
3834 position reached which can be equal to where we start
3835 if there is nothing invisible there. This skips both
3836 over invisible text properties and overlays with
3837 invisible property. */
3838 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3840 /* If we skipped nothing at all we weren't at invisible
3841 text in the first place. If everything to the end of
3842 the buffer was skipped, end the loop. */
3843 if (newpos
== tem
|| newpos
>= ZV
)
3847 /* We skipped some characters but not necessarily
3848 all there are. Check if we ended up on visible
3849 text. Fget_char_property returns the property of
3850 the char before the given position, i.e. if we
3851 get invis_p = 0, this means that the char at
3852 newpos is visible. */
3853 pos
= make_number (newpos
);
3854 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3855 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3858 /* If we ended up on invisible text, proceed to
3859 skip starting with next_stop. */
3863 /* If there are adjacent invisible texts, don't lose the
3864 second one's ellipsis. */
3866 display_ellipsis_p
= 1;
3870 /* The position newpos is now either ZV or on visible text. */
3871 if (it
->bidi_p
&& newpos
< ZV
)
3873 /* With bidi iteration, the region of invisible text
3874 could start and/or end in the middle of a non-base
3875 embedding level. Therefore, we need to skip
3876 invisible text using the bidi iterator, starting at
3877 IT's current position, until we find ourselves
3878 outside the invisible text. Skipping invisible text
3879 _after_ bidi iteration avoids affecting the visual
3880 order of the displayed text when invisible properties
3881 are added or removed. */
3882 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3884 /* If we were `reseat'ed to a new paragraph,
3885 determine the paragraph base direction. We need
3886 to do it now because next_element_from_buffer may
3887 not have a chance to do it, if we are going to
3888 skip any text at the beginning, which resets the
3890 bidi_paragraph_init (it
->paragraph_embedding
,
3895 bidi_move_to_visually_next (&it
->bidi_it
);
3897 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3898 && it
->bidi_it
.charpos
< newpos
);
3899 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3900 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3901 /* If we overstepped NEWPOS, record its position in the
3902 iterator, so that we skip invisible text if later the
3903 bidi iteration lands us in the invisible region
3905 if (IT_CHARPOS (*it
) >= newpos
)
3906 it
->prev_stop
= newpos
;
3910 IT_CHARPOS (*it
) = newpos
;
3911 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3914 /* If there are before-strings at the start of invisible
3915 text, and the text is invisible because of a text
3916 property, arrange to show before-strings because 20.x did
3917 it that way. (If the text is invisible because of an
3918 overlay property instead of a text property, this is
3919 already handled in the overlay code.) */
3921 && get_overlay_strings (it
, it
->stop_charpos
))
3923 handled
= HANDLED_RECOMPUTE_PROPS
;
3924 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3926 else if (display_ellipsis_p
)
3928 /* Make sure that the glyphs of the ellipsis will get
3929 correct `charpos' values. If we would not update
3930 it->position here, the glyphs would belong to the
3931 last visible character _before_ the invisible
3932 text, which confuses `set_cursor_from_row'.
3934 We use the last invisible position instead of the
3935 first because this way the cursor is always drawn on
3936 the first "." of the ellipsis, whenever PT is inside
3937 the invisible text. Otherwise the cursor would be
3938 placed _after_ the ellipsis when the point is after the
3939 first invisible character. */
3940 if (!STRINGP (it
->object
))
3942 it
->position
.charpos
= newpos
- 1;
3943 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3946 /* Let the ellipsis display before
3947 considering any properties of the following char.
3948 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3949 handled
= HANDLED_RETURN
;
3958 /* Make iterator IT return `...' next.
3959 Replaces LEN characters from buffer. */
3962 setup_for_ellipsis (struct it
*it
, int len
)
3964 /* Use the display table definition for `...'. Invalid glyphs
3965 will be handled by the method returning elements from dpvec. */
3966 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3968 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3969 it
->dpvec
= v
->contents
;
3970 it
->dpend
= v
->contents
+ v
->header
.size
;
3974 /* Default `...'. */
3975 it
->dpvec
= default_invis_vector
;
3976 it
->dpend
= default_invis_vector
+ 3;
3979 it
->dpvec_char_len
= len
;
3980 it
->current
.dpvec_index
= 0;
3981 it
->dpvec_face_id
= -1;
3983 /* Remember the current face id in case glyphs specify faces.
3984 IT's face is restored in set_iterator_to_next.
3985 saved_face_id was set to preceding char's face in handle_stop. */
3986 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3987 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3989 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3995 /***********************************************************************
3997 ***********************************************************************/
3999 /* Set up iterator IT from `display' property at its current position.
4000 Called from handle_stop.
4001 We return HANDLED_RETURN if some part of the display property
4002 overrides the display of the buffer text itself.
4003 Otherwise we return HANDLED_NORMALLY. */
4005 static enum prop_handled
4006 handle_display_prop (struct it
*it
)
4008 Lisp_Object propval
, object
, overlay
;
4009 struct text_pos
*position
;
4011 /* Nonzero if some property replaces the display of the text itself. */
4012 int display_replaced_p
= 0;
4014 if (STRINGP (it
->string
))
4016 object
= it
->string
;
4017 position
= &it
->current
.string_pos
;
4018 bufpos
= CHARPOS (it
->current
.pos
);
4022 XSETWINDOW (object
, it
->w
);
4023 position
= &it
->current
.pos
;
4024 bufpos
= CHARPOS (*position
);
4027 /* Reset those iterator values set from display property values. */
4028 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4029 it
->space_width
= Qnil
;
4030 it
->font_height
= Qnil
;
4033 /* We don't support recursive `display' properties, i.e. string
4034 values that have a string `display' property, that have a string
4035 `display' property etc. */
4036 if (!it
->string_from_display_prop_p
)
4037 it
->area
= TEXT_AREA
;
4039 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4040 Qdisplay
, object
, &overlay
);
4042 return HANDLED_NORMALLY
;
4043 /* Now OVERLAY is the overlay that gave us this property, or nil
4044 if it was a text property. */
4046 if (!STRINGP (it
->string
))
4047 object
= it
->w
->buffer
;
4049 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4051 FRAME_WINDOW_P (it
->f
));
4053 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4056 /* Subroutine of handle_display_prop. Returns non-zero if the display
4057 specification in SPEC is a replacing specification, i.e. it would
4058 replace the text covered by `display' property with something else,
4059 such as an image or a display string.
4061 See handle_single_display_spec for documentation of arguments.
4062 frame_window_p is non-zero if the window being redisplayed is on a
4063 GUI frame; this argument is used only if IT is NULL, see below.
4065 IT can be NULL, if this is called by the bidi reordering code
4066 through compute_display_string_pos, which see. In that case, this
4067 function only examines SPEC, but does not otherwise "handle" it, in
4068 the sense that it doesn't set up members of IT from the display
4071 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4072 Lisp_Object overlay
, struct text_pos
*position
,
4073 EMACS_INT bufpos
, int frame_window_p
)
4075 int replacing_p
= 0;
4078 /* Simple specerties. */
4079 && !EQ (XCAR (spec
), Qimage
)
4080 && !EQ (XCAR (spec
), Qspace
)
4081 && !EQ (XCAR (spec
), Qwhen
)
4082 && !EQ (XCAR (spec
), Qslice
)
4083 && !EQ (XCAR (spec
), Qspace_width
)
4084 && !EQ (XCAR (spec
), Qheight
)
4085 && !EQ (XCAR (spec
), Qraise
)
4086 /* Marginal area specifications. */
4087 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4088 && !EQ (XCAR (spec
), Qleft_fringe
)
4089 && !EQ (XCAR (spec
), Qright_fringe
)
4090 && !NILP (XCAR (spec
)))
4092 for (; CONSP (spec
); spec
= XCDR (spec
))
4094 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4095 position
, bufpos
, replacing_p
,
4099 /* If some text in a string is replaced, `position' no
4100 longer points to the position of `object'. */
4101 if (!it
|| STRINGP (object
))
4106 else if (VECTORP (spec
))
4109 for (i
= 0; i
< ASIZE (spec
); ++i
)
4110 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4111 position
, bufpos
, replacing_p
,
4115 /* If some text in a string is replaced, `position' no
4116 longer points to the position of `object'. */
4117 if (!it
|| STRINGP (object
))
4123 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4124 position
, bufpos
, 0, frame_window_p
))
4131 /* Value is the position of the end of the `display' property starting
4132 at START_POS in OBJECT. */
4134 static struct text_pos
4135 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4138 struct text_pos end_pos
;
4140 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4141 Qdisplay
, object
, Qnil
);
4142 CHARPOS (end_pos
) = XFASTINT (end
);
4143 if (STRINGP (object
))
4144 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4146 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4152 /* Set up IT from a single `display' property specification SPEC. OBJECT
4153 is the object in which the `display' property was found. *POSITION
4154 is the position in OBJECT at which the `display' property was found.
4155 BUFPOS is the buffer position of OBJECT (different from POSITION if
4156 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4157 previously saw a display specification which already replaced text
4158 display with something else, for example an image; we ignore such
4159 properties after the first one has been processed.
4161 OVERLAY is the overlay this `display' property came from,
4162 or nil if it was a text property.
4164 If SPEC is a `space' or `image' specification, and in some other
4165 cases too, set *POSITION to the position where the `display'
4168 If IT is NULL, only examine the property specification in SPEC, but
4169 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4170 is intended to be displayed in a window on a GUI frame.
4172 Value is non-zero if something was found which replaces the display
4173 of buffer or string text. */
4176 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4177 Lisp_Object overlay
, struct text_pos
*position
,
4178 EMACS_INT bufpos
, int display_replaced_p
,
4182 Lisp_Object location
, value
;
4183 struct text_pos start_pos
= *position
;
4186 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4187 If the result is non-nil, use VALUE instead of SPEC. */
4189 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4198 if (!NILP (form
) && !EQ (form
, Qt
))
4200 int count
= SPECPDL_INDEX ();
4201 struct gcpro gcpro1
;
4203 /* Bind `object' to the object having the `display' property, a
4204 buffer or string. Bind `position' to the position in the
4205 object where the property was found, and `buffer-position'
4206 to the current position in the buffer. */
4209 XSETBUFFER (object
, current_buffer
);
4210 specbind (Qobject
, object
);
4211 specbind (Qposition
, make_number (CHARPOS (*position
)));
4212 specbind (Qbuffer_position
, make_number (bufpos
));
4214 form
= safe_eval (form
);
4216 unbind_to (count
, Qnil
);
4222 /* Handle `(height HEIGHT)' specifications. */
4224 && EQ (XCAR (spec
), Qheight
)
4225 && CONSP (XCDR (spec
)))
4229 if (!FRAME_WINDOW_P (it
->f
))
4232 it
->font_height
= XCAR (XCDR (spec
));
4233 if (!NILP (it
->font_height
))
4235 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4236 int new_height
= -1;
4238 if (CONSP (it
->font_height
)
4239 && (EQ (XCAR (it
->font_height
), Qplus
)
4240 || EQ (XCAR (it
->font_height
), Qminus
))
4241 && CONSP (XCDR (it
->font_height
))
4242 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4244 /* `(+ N)' or `(- N)' where N is an integer. */
4245 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4246 if (EQ (XCAR (it
->font_height
), Qplus
))
4248 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4250 else if (FUNCTIONP (it
->font_height
))
4252 /* Call function with current height as argument.
4253 Value is the new height. */
4255 height
= safe_call1 (it
->font_height
,
4256 face
->lface
[LFACE_HEIGHT_INDEX
]);
4257 if (NUMBERP (height
))
4258 new_height
= XFLOATINT (height
);
4260 else if (NUMBERP (it
->font_height
))
4262 /* Value is a multiple of the canonical char height. */
4265 f
= FACE_FROM_ID (it
->f
,
4266 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4267 new_height
= (XFLOATINT (it
->font_height
)
4268 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4272 /* Evaluate IT->font_height with `height' bound to the
4273 current specified height to get the new height. */
4274 int count
= SPECPDL_INDEX ();
4276 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4277 value
= safe_eval (it
->font_height
);
4278 unbind_to (count
, Qnil
);
4280 if (NUMBERP (value
))
4281 new_height
= XFLOATINT (value
);
4285 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4292 /* Handle `(space-width WIDTH)'. */
4294 && EQ (XCAR (spec
), Qspace_width
)
4295 && CONSP (XCDR (spec
)))
4299 if (!FRAME_WINDOW_P (it
->f
))
4302 value
= XCAR (XCDR (spec
));
4303 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4304 it
->space_width
= value
;
4310 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4312 && EQ (XCAR (spec
), Qslice
))
4318 if (!FRAME_WINDOW_P (it
->f
))
4321 if (tem
= XCDR (spec
), CONSP (tem
))
4323 it
->slice
.x
= XCAR (tem
);
4324 if (tem
= XCDR (tem
), CONSP (tem
))
4326 it
->slice
.y
= XCAR (tem
);
4327 if (tem
= XCDR (tem
), CONSP (tem
))
4329 it
->slice
.width
= XCAR (tem
);
4330 if (tem
= XCDR (tem
), CONSP (tem
))
4331 it
->slice
.height
= XCAR (tem
);
4340 /* Handle `(raise FACTOR)'. */
4342 && EQ (XCAR (spec
), Qraise
)
4343 && CONSP (XCDR (spec
)))
4347 if (!FRAME_WINDOW_P (it
->f
))
4350 #ifdef HAVE_WINDOW_SYSTEM
4351 value
= XCAR (XCDR (spec
));
4352 if (NUMBERP (value
))
4354 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4355 it
->voffset
= - (XFLOATINT (value
)
4356 * (FONT_HEIGHT (face
->font
)));
4358 #endif /* HAVE_WINDOW_SYSTEM */
4364 /* Don't handle the other kinds of display specifications
4365 inside a string that we got from a `display' property. */
4366 if (it
&& it
->string_from_display_prop_p
)
4369 /* Characters having this form of property are not displayed, so
4370 we have to find the end of the property. */
4373 start_pos
= *position
;
4374 *position
= display_prop_end (it
, object
, start_pos
);
4378 /* Stop the scan at that end position--we assume that all
4379 text properties change there. */
4381 it
->stop_charpos
= position
->charpos
;
4383 /* Handle `(left-fringe BITMAP [FACE])'
4384 and `(right-fringe BITMAP [FACE])'. */
4386 && (EQ (XCAR (spec
), Qleft_fringe
)
4387 || EQ (XCAR (spec
), Qright_fringe
))
4388 && CONSP (XCDR (spec
)))
4394 if (!FRAME_WINDOW_P (it
->f
))
4395 /* If we return here, POSITION has been advanced
4396 across the text with this property. */
4399 else if (!frame_window_p
)
4402 #ifdef HAVE_WINDOW_SYSTEM
4403 value
= XCAR (XCDR (spec
));
4404 if (!SYMBOLP (value
)
4405 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4406 /* If we return here, POSITION has been advanced
4407 across the text with this property. */
4412 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4414 if (CONSP (XCDR (XCDR (spec
))))
4416 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4417 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4423 /* Save current settings of IT so that we can restore them
4424 when we are finished with the glyph property value. */
4425 push_it (it
, position
);
4427 it
->area
= TEXT_AREA
;
4428 it
->what
= IT_IMAGE
;
4429 it
->image_id
= -1; /* no image */
4430 it
->position
= start_pos
;
4431 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4432 it
->method
= GET_FROM_IMAGE
;
4433 it
->from_overlay
= Qnil
;
4434 it
->face_id
= face_id
;
4435 it
->from_disp_prop_p
= 1;
4437 /* Say that we haven't consumed the characters with
4438 `display' property yet. The call to pop_it in
4439 set_iterator_to_next will clean this up. */
4440 *position
= start_pos
;
4442 if (EQ (XCAR (spec
), Qleft_fringe
))
4444 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4445 it
->left_user_fringe_face_id
= face_id
;
4449 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4450 it
->right_user_fringe_face_id
= face_id
;
4453 #endif /* HAVE_WINDOW_SYSTEM */
4457 /* Prepare to handle `((margin left-margin) ...)',
4458 `((margin right-margin) ...)' and `((margin nil) ...)'
4459 prefixes for display specifications. */
4460 location
= Qunbound
;
4461 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4465 value
= XCDR (spec
);
4467 value
= XCAR (value
);
4470 if (EQ (XCAR (tem
), Qmargin
)
4471 && (tem
= XCDR (tem
),
4472 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4474 || EQ (tem
, Qleft_margin
)
4475 || EQ (tem
, Qright_margin
))))
4479 if (EQ (location
, Qunbound
))
4485 /* After this point, VALUE is the property after any
4486 margin prefix has been stripped. It must be a string,
4487 an image specification, or `(space ...)'.
4489 LOCATION specifies where to display: `left-margin',
4490 `right-margin' or nil. */
4492 valid_p
= (STRINGP (value
)
4493 #ifdef HAVE_WINDOW_SYSTEM
4494 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4495 && valid_image_p (value
))
4496 #endif /* not HAVE_WINDOW_SYSTEM */
4497 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4499 if (valid_p
&& !display_replaced_p
)
4504 /* Save current settings of IT so that we can restore them
4505 when we are finished with the glyph property value. */
4506 push_it (it
, position
);
4507 it
->from_overlay
= overlay
;
4508 it
->from_disp_prop_p
= 1;
4510 if (NILP (location
))
4511 it
->area
= TEXT_AREA
;
4512 else if (EQ (location
, Qleft_margin
))
4513 it
->area
= LEFT_MARGIN_AREA
;
4515 it
->area
= RIGHT_MARGIN_AREA
;
4517 if (STRINGP (value
))
4520 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4521 it
->current
.overlay_string_index
= -1;
4522 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4523 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4524 it
->method
= GET_FROM_STRING
;
4525 it
->stop_charpos
= 0;
4527 it
->base_level_stop
= 0;
4528 it
->string_from_display_prop_p
= 1;
4529 /* Say that we haven't consumed the characters with
4530 `display' property yet. The call to pop_it in
4531 set_iterator_to_next will clean this up. */
4532 if (BUFFERP (object
))
4533 *position
= start_pos
;
4535 /* Force paragraph direction to be that of the parent
4536 object. If the parent object's paragraph direction is
4537 not yet determined, default to L2R. */
4538 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4539 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4541 it
->paragraph_embedding
= L2R
;
4543 /* Set up the bidi iterator for this display string. */
4546 it
->bidi_it
.string
.lstring
= it
->string
;
4547 it
->bidi_it
.string
.s
= NULL
;
4548 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4549 it
->bidi_it
.string
.bufpos
= bufpos
;
4550 it
->bidi_it
.string
.from_disp_str
= 1;
4551 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4552 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4555 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4557 it
->method
= GET_FROM_STRETCH
;
4559 *position
= it
->position
= start_pos
;
4561 #ifdef HAVE_WINDOW_SYSTEM
4564 it
->what
= IT_IMAGE
;
4565 it
->image_id
= lookup_image (it
->f
, value
);
4566 it
->position
= start_pos
;
4567 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4568 it
->method
= GET_FROM_IMAGE
;
4570 /* Say that we haven't consumed the characters with
4571 `display' property yet. The call to pop_it in
4572 set_iterator_to_next will clean this up. */
4573 *position
= start_pos
;
4575 #endif /* HAVE_WINDOW_SYSTEM */
4580 /* Invalid property or property not supported. Restore
4581 POSITION to what it was before. */
4582 *position
= start_pos
;
4586 /* Check if PROP is a display property value whose text should be
4587 treated as intangible. OVERLAY is the overlay from which PROP
4588 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4589 specify the buffer position covered by PROP. */
4592 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4593 EMACS_INT charpos
, EMACS_INT bytepos
)
4595 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4596 struct text_pos position
;
4598 SET_TEXT_POS (position
, charpos
, bytepos
);
4599 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4600 &position
, charpos
, frame_window_p
);
4604 /* Return 1 if PROP is a display sub-property value containing STRING.
4606 Implementation note: this and the following function are really
4607 special cases of handle_display_spec and
4608 handle_single_display_spec, and should ideally use the same code.
4609 Until they do, these two pairs must be consistent and must be
4610 modified in sync. */
4613 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4615 if (EQ (string
, prop
))
4618 /* Skip over `when FORM'. */
4619 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4624 /* Actually, the condition following `when' should be eval'ed,
4625 like handle_single_display_spec does, and we should return
4626 zero if it evaluates to nil. However, this function is
4627 called only when the buffer was already displayed and some
4628 glyph in the glyph matrix was found to come from a display
4629 string. Therefore, the condition was already evaluated, and
4630 the result was non-nil, otherwise the display string wouldn't
4631 have been displayed and we would have never been called for
4632 this property. Thus, we can skip the evaluation and assume
4633 its result is non-nil. */
4638 /* Skip over `margin LOCATION'. */
4639 if (EQ (XCAR (prop
), Qmargin
))
4650 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4654 /* Return 1 if STRING appears in the `display' property PROP. */
4657 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4660 && !EQ (XCAR (prop
), Qwhen
)
4661 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4663 /* A list of sub-properties. */
4664 while (CONSP (prop
))
4666 if (single_display_spec_string_p (XCAR (prop
), string
))
4671 else if (VECTORP (prop
))
4673 /* A vector of sub-properties. */
4675 for (i
= 0; i
< ASIZE (prop
); ++i
)
4676 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4680 return single_display_spec_string_p (prop
, string
);
4685 /* Look for STRING in overlays and text properties in the current
4686 buffer, between character positions FROM and TO (excluding TO).
4687 BACK_P non-zero means look back (in this case, TO is supposed to be
4689 Value is the first character position where STRING was found, or
4690 zero if it wasn't found before hitting TO.
4692 This function may only use code that doesn't eval because it is
4693 called asynchronously from note_mouse_highlight. */
4696 string_buffer_position_lim (Lisp_Object string
,
4697 EMACS_INT from
, EMACS_INT to
, int back_p
)
4699 Lisp_Object limit
, prop
, pos
;
4702 pos
= make_number (from
);
4704 if (!back_p
) /* looking forward */
4706 limit
= make_number (min (to
, ZV
));
4707 while (!found
&& !EQ (pos
, limit
))
4709 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4710 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4713 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4717 else /* looking back */
4719 limit
= make_number (max (to
, BEGV
));
4720 while (!found
&& !EQ (pos
, limit
))
4722 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4723 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4726 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4731 return found
? XINT (pos
) : 0;
4734 /* Determine which buffer position in current buffer STRING comes from.
4735 AROUND_CHARPOS is an approximate position where it could come from.
4736 Value is the buffer position or 0 if it couldn't be determined.
4738 This function is necessary because we don't record buffer positions
4739 in glyphs generated from strings (to keep struct glyph small).
4740 This function may only use code that doesn't eval because it is
4741 called asynchronously from note_mouse_highlight. */
4744 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4746 const int MAX_DISTANCE
= 1000;
4747 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4748 around_charpos
+ MAX_DISTANCE
,
4752 found
= string_buffer_position_lim (string
, around_charpos
,
4753 around_charpos
- MAX_DISTANCE
, 1);
4759 /***********************************************************************
4760 `composition' property
4761 ***********************************************************************/
4763 /* Set up iterator IT from `composition' property at its current
4764 position. Called from handle_stop. */
4766 static enum prop_handled
4767 handle_composition_prop (struct it
*it
)
4769 Lisp_Object prop
, string
;
4770 EMACS_INT pos
, pos_byte
, start
, end
;
4772 if (STRINGP (it
->string
))
4776 pos
= IT_STRING_CHARPOS (*it
);
4777 pos_byte
= IT_STRING_BYTEPOS (*it
);
4778 string
= it
->string
;
4779 s
= SDATA (string
) + pos_byte
;
4780 it
->c
= STRING_CHAR (s
);
4784 pos
= IT_CHARPOS (*it
);
4785 pos_byte
= IT_BYTEPOS (*it
);
4787 it
->c
= FETCH_CHAR (pos_byte
);
4790 /* If there's a valid composition and point is not inside of the
4791 composition (in the case that the composition is from the current
4792 buffer), draw a glyph composed from the composition components. */
4793 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4794 && COMPOSITION_VALID_P (start
, end
, prop
)
4795 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4798 /* As we can't handle this situation (perhaps font-lock added
4799 a new composition), we just return here hoping that next
4800 redisplay will detect this composition much earlier. */
4801 return HANDLED_NORMALLY
;
4804 if (STRINGP (it
->string
))
4805 pos_byte
= string_char_to_byte (it
->string
, start
);
4807 pos_byte
= CHAR_TO_BYTE (start
);
4809 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4812 if (it
->cmp_it
.id
>= 0)
4815 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4816 it
->cmp_it
.nglyphs
= -1;
4820 return HANDLED_NORMALLY
;
4825 /***********************************************************************
4827 ***********************************************************************/
4829 /* The following structure is used to record overlay strings for
4830 later sorting in load_overlay_strings. */
4832 struct overlay_entry
4834 Lisp_Object overlay
;
4841 /* Set up iterator IT from overlay strings at its current position.
4842 Called from handle_stop. */
4844 static enum prop_handled
4845 handle_overlay_change (struct it
*it
)
4847 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4848 return HANDLED_RECOMPUTE_PROPS
;
4850 return HANDLED_NORMALLY
;
4854 /* Set up the next overlay string for delivery by IT, if there is an
4855 overlay string to deliver. Called by set_iterator_to_next when the
4856 end of the current overlay string is reached. If there are more
4857 overlay strings to display, IT->string and
4858 IT->current.overlay_string_index are set appropriately here.
4859 Otherwise IT->string is set to nil. */
4862 next_overlay_string (struct it
*it
)
4864 ++it
->current
.overlay_string_index
;
4865 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4867 /* No more overlay strings. Restore IT's settings to what
4868 they were before overlay strings were processed, and
4869 continue to deliver from current_buffer. */
4871 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4874 || (NILP (it
->string
)
4875 && it
->method
== GET_FROM_BUFFER
4876 && it
->stop_charpos
>= BEGV
4877 && it
->stop_charpos
<= it
->end_charpos
));
4878 it
->current
.overlay_string_index
= -1;
4879 it
->n_overlay_strings
= 0;
4880 it
->overlay_strings_charpos
= -1;
4882 /* If we're at the end of the buffer, record that we have
4883 processed the overlay strings there already, so that
4884 next_element_from_buffer doesn't try it again. */
4885 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4886 it
->overlay_strings_at_end_processed_p
= 1;
4890 /* There are more overlay strings to process. If
4891 IT->current.overlay_string_index has advanced to a position
4892 where we must load IT->overlay_strings with more strings, do
4893 it. We must load at the IT->overlay_strings_charpos where
4894 IT->n_overlay_strings was originally computed; when invisible
4895 text is present, this might not be IT_CHARPOS (Bug#7016). */
4896 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4898 if (it
->current
.overlay_string_index
&& i
== 0)
4899 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4901 /* Initialize IT to deliver display elements from the overlay
4903 it
->string
= it
->overlay_strings
[i
];
4904 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4905 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4906 it
->method
= GET_FROM_STRING
;
4907 it
->stop_charpos
= 0;
4908 if (it
->cmp_it
.stop_pos
>= 0)
4909 it
->cmp_it
.stop_pos
= 0;
4911 it
->base_level_stop
= 0;
4913 /* Set up the bidi iterator for this overlay string. */
4916 it
->bidi_it
.string
.lstring
= it
->string
;
4917 it
->bidi_it
.string
.s
= NULL
;
4918 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4919 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4920 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4921 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4922 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4930 /* Compare two overlay_entry structures E1 and E2. Used as a
4931 comparison function for qsort in load_overlay_strings. Overlay
4932 strings for the same position are sorted so that
4934 1. All after-strings come in front of before-strings, except
4935 when they come from the same overlay.
4937 2. Within after-strings, strings are sorted so that overlay strings
4938 from overlays with higher priorities come first.
4940 2. Within before-strings, strings are sorted so that overlay
4941 strings from overlays with higher priorities come last.
4943 Value is analogous to strcmp. */
4947 compare_overlay_entries (const void *e1
, const void *e2
)
4949 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4950 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4953 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4955 /* Let after-strings appear in front of before-strings if
4956 they come from different overlays. */
4957 if (EQ (entry1
->overlay
, entry2
->overlay
))
4958 result
= entry1
->after_string_p
? 1 : -1;
4960 result
= entry1
->after_string_p
? -1 : 1;
4962 else if (entry1
->after_string_p
)
4963 /* After-strings sorted in order of decreasing priority. */
4964 result
= entry2
->priority
- entry1
->priority
;
4966 /* Before-strings sorted in order of increasing priority. */
4967 result
= entry1
->priority
- entry2
->priority
;
4973 /* Load the vector IT->overlay_strings with overlay strings from IT's
4974 current buffer position, or from CHARPOS if that is > 0. Set
4975 IT->n_overlays to the total number of overlay strings found.
4977 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4978 a time. On entry into load_overlay_strings,
4979 IT->current.overlay_string_index gives the number of overlay
4980 strings that have already been loaded by previous calls to this
4983 IT->add_overlay_start contains an additional overlay start
4984 position to consider for taking overlay strings from, if non-zero.
4985 This position comes into play when the overlay has an `invisible'
4986 property, and both before and after-strings. When we've skipped to
4987 the end of the overlay, because of its `invisible' property, we
4988 nevertheless want its before-string to appear.
4989 IT->add_overlay_start will contain the overlay start position
4992 Overlay strings are sorted so that after-string strings come in
4993 front of before-string strings. Within before and after-strings,
4994 strings are sorted by overlay priority. See also function
4995 compare_overlay_entries. */
4998 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5000 Lisp_Object overlay
, window
, str
, invisible
;
5001 struct Lisp_Overlay
*ov
;
5002 EMACS_INT start
, end
;
5004 int n
= 0, i
, j
, invis_p
;
5005 struct overlay_entry
*entries
5006 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5009 charpos
= IT_CHARPOS (*it
);
5011 /* Append the overlay string STRING of overlay OVERLAY to vector
5012 `entries' which has size `size' and currently contains `n'
5013 elements. AFTER_P non-zero means STRING is an after-string of
5015 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5018 Lisp_Object priority; \
5022 int new_size = 2 * size; \
5023 struct overlay_entry *old = entries; \
5025 (struct overlay_entry *) alloca (new_size \
5026 * sizeof *entries); \
5027 memcpy (entries, old, size * sizeof *entries); \
5031 entries[n].string = (STRING); \
5032 entries[n].overlay = (OVERLAY); \
5033 priority = Foverlay_get ((OVERLAY), Qpriority); \
5034 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5035 entries[n].after_string_p = (AFTER_P); \
5040 /* Process overlay before the overlay center. */
5041 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5043 XSETMISC (overlay
, ov
);
5044 xassert (OVERLAYP (overlay
));
5045 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5046 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5051 /* Skip this overlay if it doesn't start or end at IT's current
5053 if (end
!= charpos
&& start
!= charpos
)
5056 /* Skip this overlay if it doesn't apply to IT->w. */
5057 window
= Foverlay_get (overlay
, Qwindow
);
5058 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5061 /* If the text ``under'' the overlay is invisible, both before-
5062 and after-strings from this overlay are visible; start and
5063 end position are indistinguishable. */
5064 invisible
= Foverlay_get (overlay
, Qinvisible
);
5065 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5067 /* If overlay has a non-empty before-string, record it. */
5068 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5069 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5071 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5073 /* If overlay has a non-empty after-string, record it. */
5074 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5075 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5077 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5080 /* Process overlays after the overlay center. */
5081 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5083 XSETMISC (overlay
, ov
);
5084 xassert (OVERLAYP (overlay
));
5085 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5086 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5088 if (start
> charpos
)
5091 /* Skip this overlay if it doesn't start or end at IT's current
5093 if (end
!= charpos
&& start
!= charpos
)
5096 /* Skip this overlay if it doesn't apply to IT->w. */
5097 window
= Foverlay_get (overlay
, Qwindow
);
5098 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5101 /* If the text ``under'' the overlay is invisible, it has a zero
5102 dimension, and both before- and after-strings apply. */
5103 invisible
= Foverlay_get (overlay
, Qinvisible
);
5104 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5106 /* If overlay has a non-empty before-string, record it. */
5107 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5108 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5110 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5112 /* If overlay has a non-empty after-string, record it. */
5113 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5114 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5116 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5119 #undef RECORD_OVERLAY_STRING
5123 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5125 /* Record number of overlay strings, and where we computed it. */
5126 it
->n_overlay_strings
= n
;
5127 it
->overlay_strings_charpos
= charpos
;
5129 /* IT->current.overlay_string_index is the number of overlay strings
5130 that have already been consumed by IT. Copy some of the
5131 remaining overlay strings to IT->overlay_strings. */
5133 j
= it
->current
.overlay_string_index
;
5134 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5136 it
->overlay_strings
[i
] = entries
[j
].string
;
5137 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5144 /* Get the first chunk of overlay strings at IT's current buffer
5145 position, or at CHARPOS if that is > 0. Value is non-zero if at
5146 least one overlay string was found. */
5149 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5151 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5152 process. This fills IT->overlay_strings with strings, and sets
5153 IT->n_overlay_strings to the total number of strings to process.
5154 IT->pos.overlay_string_index has to be set temporarily to zero
5155 because load_overlay_strings needs this; it must be set to -1
5156 when no overlay strings are found because a zero value would
5157 indicate a position in the first overlay string. */
5158 it
->current
.overlay_string_index
= 0;
5159 load_overlay_strings (it
, charpos
);
5161 /* If we found overlay strings, set up IT to deliver display
5162 elements from the first one. Otherwise set up IT to deliver
5163 from current_buffer. */
5164 if (it
->n_overlay_strings
)
5166 /* Make sure we know settings in current_buffer, so that we can
5167 restore meaningful values when we're done with the overlay
5170 compute_stop_pos (it
);
5171 xassert (it
->face_id
>= 0);
5173 /* Save IT's settings. They are restored after all overlay
5174 strings have been processed. */
5175 xassert (!compute_stop_p
|| it
->sp
== 0);
5177 /* When called from handle_stop, there might be an empty display
5178 string loaded. In that case, don't bother saving it. */
5179 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5182 /* Set up IT to deliver display elements from the first overlay
5184 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5185 it
->string
= it
->overlay_strings
[0];
5186 it
->from_overlay
= Qnil
;
5187 it
->stop_charpos
= 0;
5188 xassert (STRINGP (it
->string
));
5189 it
->end_charpos
= SCHARS (it
->string
);
5191 it
->base_level_stop
= 0;
5192 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5193 it
->method
= GET_FROM_STRING
;
5194 it
->from_disp_prop_p
= 0;
5196 /* Force paragraph direction to be that of the parent
5198 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5199 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5201 it
->paragraph_embedding
= L2R
;
5203 /* Set up the bidi iterator for this overlay string. */
5206 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5208 it
->bidi_it
.string
.lstring
= it
->string
;
5209 it
->bidi_it
.string
.s
= NULL
;
5210 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5211 it
->bidi_it
.string
.bufpos
= pos
;
5212 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5213 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5214 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5219 it
->current
.overlay_string_index
= -1;
5224 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5227 it
->method
= GET_FROM_BUFFER
;
5229 (void) get_overlay_strings_1 (it
, charpos
, 1);
5233 /* Value is non-zero if we found at least one overlay string. */
5234 return STRINGP (it
->string
);
5239 /***********************************************************************
5240 Saving and restoring state
5241 ***********************************************************************/
5243 /* Save current settings of IT on IT->stack. Called, for example,
5244 before setting up IT for an overlay string, to be able to restore
5245 IT's settings to what they were after the overlay string has been
5246 processed. If POSITION is non-NULL, it is the position to save on
5247 the stack instead of IT->position. */
5250 push_it (struct it
*it
, struct text_pos
*position
)
5252 struct iterator_stack_entry
*p
;
5254 xassert (it
->sp
< IT_STACK_SIZE
);
5255 p
= it
->stack
+ it
->sp
;
5257 p
->stop_charpos
= it
->stop_charpos
;
5258 p
->prev_stop
= it
->prev_stop
;
5259 p
->base_level_stop
= it
->base_level_stop
;
5260 p
->cmp_it
= it
->cmp_it
;
5261 xassert (it
->face_id
>= 0);
5262 p
->face_id
= it
->face_id
;
5263 p
->string
= it
->string
;
5264 p
->method
= it
->method
;
5265 p
->from_overlay
= it
->from_overlay
;
5268 case GET_FROM_IMAGE
:
5269 p
->u
.image
.object
= it
->object
;
5270 p
->u
.image
.image_id
= it
->image_id
;
5271 p
->u
.image
.slice
= it
->slice
;
5273 case GET_FROM_STRETCH
:
5274 p
->u
.stretch
.object
= it
->object
;
5277 p
->position
= position
? *position
: it
->position
;
5278 p
->current
= it
->current
;
5279 p
->end_charpos
= it
->end_charpos
;
5280 p
->string_nchars
= it
->string_nchars
;
5282 p
->multibyte_p
= it
->multibyte_p
;
5283 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5284 p
->space_width
= it
->space_width
;
5285 p
->font_height
= it
->font_height
;
5286 p
->voffset
= it
->voffset
;
5287 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5288 p
->display_ellipsis_p
= 0;
5289 p
->line_wrap
= it
->line_wrap
;
5290 p
->bidi_p
= it
->bidi_p
;
5291 p
->paragraph_embedding
= it
->paragraph_embedding
;
5292 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5295 /* Save the state of the bidi iterator as well. */
5297 bidi_push_it (&it
->bidi_it
);
5301 iterate_out_of_display_property (struct it
*it
)
5303 int buffer_p
= BUFFERP (it
->object
);
5304 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5305 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5307 /* Maybe initialize paragraph direction. If we are at the beginning
5308 of a new paragraph, next_element_from_buffer may not have a
5309 chance to do that. */
5310 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5311 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5312 /* prev_stop can be zero, so check against BEGV as well. */
5313 while (it
->bidi_it
.charpos
>= bob
5314 && it
->prev_stop
<= it
->bidi_it
.charpos
5315 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5316 bidi_move_to_visually_next (&it
->bidi_it
);
5317 /* Record the stop_pos we just crossed, for when we cross it
5319 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5320 it
->prev_stop
= CHARPOS (it
->position
);
5321 /* If we ended up not where pop_it put us, resync IT's
5322 positional members with the bidi iterator. */
5323 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5325 SET_TEXT_POS (it
->position
,
5326 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5328 it
->current
.pos
= it
->position
;
5330 it
->current
.string_pos
= it
->position
;
5334 /* Restore IT's settings from IT->stack. Called, for example, when no
5335 more overlay strings must be processed, and we return to delivering
5336 display elements from a buffer, or when the end of a string from a
5337 `display' property is reached and we return to delivering display
5338 elements from an overlay string, or from a buffer. */
5341 pop_it (struct it
*it
)
5343 struct iterator_stack_entry
*p
;
5344 int from_display_prop
= it
->from_disp_prop_p
;
5346 xassert (it
->sp
> 0);
5348 p
= it
->stack
+ it
->sp
;
5349 it
->stop_charpos
= p
->stop_charpos
;
5350 it
->prev_stop
= p
->prev_stop
;
5351 it
->base_level_stop
= p
->base_level_stop
;
5352 it
->cmp_it
= p
->cmp_it
;
5353 it
->face_id
= p
->face_id
;
5354 it
->current
= p
->current
;
5355 it
->position
= p
->position
;
5356 it
->string
= p
->string
;
5357 it
->from_overlay
= p
->from_overlay
;
5358 if (NILP (it
->string
))
5359 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5360 it
->method
= p
->method
;
5363 case GET_FROM_IMAGE
:
5364 it
->image_id
= p
->u
.image
.image_id
;
5365 it
->object
= p
->u
.image
.object
;
5366 it
->slice
= p
->u
.image
.slice
;
5368 case GET_FROM_STRETCH
:
5369 it
->object
= p
->u
.stretch
.object
;
5371 case GET_FROM_BUFFER
:
5372 it
->object
= it
->w
->buffer
;
5374 case GET_FROM_STRING
:
5375 it
->object
= it
->string
;
5377 case GET_FROM_DISPLAY_VECTOR
:
5379 it
->method
= GET_FROM_C_STRING
;
5380 else if (STRINGP (it
->string
))
5381 it
->method
= GET_FROM_STRING
;
5384 it
->method
= GET_FROM_BUFFER
;
5385 it
->object
= it
->w
->buffer
;
5388 it
->end_charpos
= p
->end_charpos
;
5389 it
->string_nchars
= p
->string_nchars
;
5391 it
->multibyte_p
= p
->multibyte_p
;
5392 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5393 it
->space_width
= p
->space_width
;
5394 it
->font_height
= p
->font_height
;
5395 it
->voffset
= p
->voffset
;
5396 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5397 it
->line_wrap
= p
->line_wrap
;
5398 it
->bidi_p
= p
->bidi_p
;
5399 it
->paragraph_embedding
= p
->paragraph_embedding
;
5400 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5403 bidi_pop_it (&it
->bidi_it
);
5404 /* Bidi-iterate until we get out of the portion of text, if any,
5405 covered by a `display' text property or by an overlay with
5406 `display' property. (We cannot just jump there, because the
5407 internal coherency of the bidi iterator state can not be
5408 preserved across such jumps.) We also must determine the
5409 paragraph base direction if the overlay we just processed is
5410 at the beginning of a new paragraph. */
5411 if (from_display_prop
5412 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5413 iterate_out_of_display_property (it
);
5415 xassert ((BUFFERP (it
->object
)
5416 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5417 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5418 || (STRINGP (it
->object
)
5419 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5420 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5426 /***********************************************************************
5428 ***********************************************************************/
5430 /* Set IT's current position to the previous line start. */
5433 back_to_previous_line_start (struct it
*it
)
5435 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5436 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5440 /* Move IT to the next line start.
5442 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5443 we skipped over part of the text (as opposed to moving the iterator
5444 continuously over the text). Otherwise, don't change the value
5447 Newlines may come from buffer text, overlay strings, or strings
5448 displayed via the `display' property. That's the reason we can't
5449 simply use find_next_newline_no_quit.
5451 Note that this function may not skip over invisible text that is so
5452 because of text properties and immediately follows a newline. If
5453 it would, function reseat_at_next_visible_line_start, when called
5454 from set_iterator_to_next, would effectively make invisible
5455 characters following a newline part of the wrong glyph row, which
5456 leads to wrong cursor motion. */
5459 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5461 EMACS_INT old_selective
;
5462 int newline_found_p
, n
;
5463 const int MAX_NEWLINE_DISTANCE
= 500;
5465 /* If already on a newline, just consume it to avoid unintended
5466 skipping over invisible text below. */
5467 if (it
->what
== IT_CHARACTER
5469 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5471 set_iterator_to_next (it
, 0);
5476 /* Don't handle selective display in the following. It's (a)
5477 unnecessary because it's done by the caller, and (b) leads to an
5478 infinite recursion because next_element_from_ellipsis indirectly
5479 calls this function. */
5480 old_selective
= it
->selective
;
5483 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5484 from buffer text. */
5485 for (n
= newline_found_p
= 0;
5486 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5487 n
+= STRINGP (it
->string
) ? 0 : 1)
5489 if (!get_next_display_element (it
))
5491 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5492 set_iterator_to_next (it
, 0);
5495 /* If we didn't find a newline near enough, see if we can use a
5497 if (!newline_found_p
)
5499 EMACS_INT start
= IT_CHARPOS (*it
);
5500 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5503 xassert (!STRINGP (it
->string
));
5505 /* If we are not bidi-reordering, and there isn't any `display'
5506 property in sight, and no overlays, we can just use the
5507 position of the newline in buffer text. */
5509 && (it
->stop_charpos
>= limit
5510 || ((pos
= Fnext_single_property_change (make_number (start
),
5512 make_number (limit
)),
5514 && next_overlay_change (start
) == ZV
)))
5516 IT_CHARPOS (*it
) = limit
;
5517 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5518 *skipped_p
= newline_found_p
= 1;
5522 while (get_next_display_element (it
)
5523 && !newline_found_p
)
5525 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5526 set_iterator_to_next (it
, 0);
5531 it
->selective
= old_selective
;
5532 return newline_found_p
;
5536 /* Set IT's current position to the previous visible line start. Skip
5537 invisible text that is so either due to text properties or due to
5538 selective display. Caution: this does not change IT->current_x and
5542 back_to_previous_visible_line_start (struct it
*it
)
5544 while (IT_CHARPOS (*it
) > BEGV
)
5546 back_to_previous_line_start (it
);
5548 if (IT_CHARPOS (*it
) <= BEGV
)
5551 /* If selective > 0, then lines indented more than its value are
5553 if (it
->selective
> 0
5554 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5558 /* Check the newline before point for invisibility. */
5561 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5562 Qinvisible
, it
->window
);
5563 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5567 if (IT_CHARPOS (*it
) <= BEGV
)
5572 void *it2data
= NULL
;
5575 Lisp_Object val
, overlay
;
5577 SAVE_IT (it2
, *it
, it2data
);
5579 /* If newline is part of a composition, continue from start of composition */
5580 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5581 && beg
< IT_CHARPOS (*it
))
5584 /* If newline is replaced by a display property, find start of overlay
5585 or interval and continue search from that point. */
5586 pos
= --IT_CHARPOS (it2
);
5589 bidi_unshelve_cache (NULL
);
5590 it2
.string_from_display_prop_p
= 0;
5591 it2
.from_disp_prop_p
= 0;
5592 if (handle_display_prop (&it2
) == HANDLED_RETURN
5593 && !NILP (val
= get_char_property_and_overlay
5594 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5595 && (OVERLAYP (overlay
)
5596 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5597 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5599 RESTORE_IT (it
, it
, it2data
);
5603 /* Newline is not replaced by anything -- so we are done. */
5604 RESTORE_IT (it
, it
, it2data
);
5610 IT_CHARPOS (*it
) = beg
;
5611 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5615 it
->continuation_lines_width
= 0;
5617 xassert (IT_CHARPOS (*it
) >= BEGV
);
5618 xassert (IT_CHARPOS (*it
) == BEGV
5619 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5624 /* Reseat iterator IT at the previous visible line start. Skip
5625 invisible text that is so either due to text properties or due to
5626 selective display. At the end, update IT's overlay information,
5627 face information etc. */
5630 reseat_at_previous_visible_line_start (struct it
*it
)
5632 back_to_previous_visible_line_start (it
);
5633 reseat (it
, it
->current
.pos
, 1);
5638 /* Reseat iterator IT on the next visible line start in the current
5639 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5640 preceding the line start. Skip over invisible text that is so
5641 because of selective display. Compute faces, overlays etc at the
5642 new position. Note that this function does not skip over text that
5643 is invisible because of text properties. */
5646 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5648 int newline_found_p
, skipped_p
= 0;
5650 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5652 /* Skip over lines that are invisible because they are indented
5653 more than the value of IT->selective. */
5654 if (it
->selective
> 0)
5655 while (IT_CHARPOS (*it
) < ZV
5656 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5659 xassert (IT_BYTEPOS (*it
) == BEGV
5660 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5661 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5664 /* Position on the newline if that's what's requested. */
5665 if (on_newline_p
&& newline_found_p
)
5667 if (STRINGP (it
->string
))
5669 if (IT_STRING_CHARPOS (*it
) > 0)
5673 --IT_STRING_CHARPOS (*it
);
5674 --IT_STRING_BYTEPOS (*it
);
5677 /* Setting this flag will cause
5678 bidi_move_to_visually_next not to advance, but
5679 instead deliver the current character (newline),
5680 which is what the ON_NEWLINE_P flag wants. */
5681 it
->bidi_it
.first_elt
= 1;
5684 else if (IT_CHARPOS (*it
) > BEGV
)
5691 /* With bidi iteration, the call to `reseat' will cause
5692 bidi_move_to_visually_next deliver the current character,
5693 the newline, instead of advancing. */
5694 reseat (it
, it
->current
.pos
, 0);
5698 reseat (it
, it
->current
.pos
, 0);
5705 /***********************************************************************
5706 Changing an iterator's position
5707 ***********************************************************************/
5709 /* Change IT's current position to POS in current_buffer. If FORCE_P
5710 is non-zero, always check for text properties at the new position.
5711 Otherwise, text properties are only looked up if POS >=
5712 IT->check_charpos of a property. */
5715 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5717 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5719 reseat_1 (it
, pos
, 0);
5721 /* Determine where to check text properties. Avoid doing it
5722 where possible because text property lookup is very expensive. */
5724 || CHARPOS (pos
) > it
->stop_charpos
5725 || CHARPOS (pos
) < original_pos
)
5729 /* For bidi iteration, we need to prime prev_stop and
5730 base_level_stop with our best estimations. */
5731 if (CHARPOS (pos
) < it
->prev_stop
)
5733 handle_stop_backwards (it
, BEGV
);
5734 if (CHARPOS (pos
) < it
->base_level_stop
)
5735 it
->base_level_stop
= 0;
5737 else if (CHARPOS (pos
) > it
->stop_charpos
5738 && it
->stop_charpos
>= BEGV
)
5739 handle_stop_backwards (it
, it
->stop_charpos
);
5746 it
->prev_stop
= it
->base_level_stop
= 0;
5755 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5756 IT->stop_pos to POS, also. */
5759 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5761 /* Don't call this function when scanning a C string. */
5762 xassert (it
->s
== NULL
);
5764 /* POS must be a reasonable value. */
5765 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5767 it
->current
.pos
= it
->position
= pos
;
5768 it
->end_charpos
= ZV
;
5770 it
->current
.dpvec_index
= -1;
5771 it
->current
.overlay_string_index
= -1;
5772 IT_STRING_CHARPOS (*it
) = -1;
5773 IT_STRING_BYTEPOS (*it
) = -1;
5775 it
->method
= GET_FROM_BUFFER
;
5776 it
->object
= it
->w
->buffer
;
5777 it
->area
= TEXT_AREA
;
5778 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5780 it
->string_from_display_prop_p
= 0;
5781 it
->from_disp_prop_p
= 0;
5782 it
->face_before_selective_p
= 0;
5785 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5787 bidi_unshelve_cache (NULL
);
5788 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5789 it
->bidi_it
.string
.s
= NULL
;
5790 it
->bidi_it
.string
.lstring
= Qnil
;
5791 it
->bidi_it
.string
.bufpos
= 0;
5792 it
->bidi_it
.string
.unibyte
= 0;
5797 it
->stop_charpos
= CHARPOS (pos
);
5798 it
->base_level_stop
= CHARPOS (pos
);
5803 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5804 If S is non-null, it is a C string to iterate over. Otherwise,
5805 STRING gives a Lisp string to iterate over.
5807 If PRECISION > 0, don't return more then PRECISION number of
5808 characters from the string.
5810 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5811 characters have been returned. FIELD_WIDTH < 0 means an infinite
5814 MULTIBYTE = 0 means disable processing of multibyte characters,
5815 MULTIBYTE > 0 means enable it,
5816 MULTIBYTE < 0 means use IT->multibyte_p.
5818 IT must be initialized via a prior call to init_iterator before
5819 calling this function. */
5822 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5823 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5826 /* No region in strings. */
5827 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5829 /* No text property checks performed by default, but see below. */
5830 it
->stop_charpos
= -1;
5832 /* Set iterator position and end position. */
5833 memset (&it
->current
, 0, sizeof it
->current
);
5834 it
->current
.overlay_string_index
= -1;
5835 it
->current
.dpvec_index
= -1;
5836 xassert (charpos
>= 0);
5838 /* If STRING is specified, use its multibyteness, otherwise use the
5839 setting of MULTIBYTE, if specified. */
5841 it
->multibyte_p
= multibyte
> 0;
5843 /* Bidirectional reordering of strings is controlled by the default
5844 value of bidi-display-reordering. */
5845 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5849 xassert (STRINGP (string
));
5850 it
->string
= string
;
5852 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5853 it
->method
= GET_FROM_STRING
;
5854 it
->current
.string_pos
= string_pos (charpos
, string
);
5858 it
->bidi_it
.string
.lstring
= string
;
5859 it
->bidi_it
.string
.s
= NULL
;
5860 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5861 it
->bidi_it
.string
.bufpos
= 0;
5862 it
->bidi_it
.string
.from_disp_str
= 0;
5863 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5864 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5865 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5870 it
->s
= (const unsigned char *) s
;
5873 /* Note that we use IT->current.pos, not it->current.string_pos,
5874 for displaying C strings. */
5875 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5876 if (it
->multibyte_p
)
5878 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5879 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5883 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5884 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5889 it
->bidi_it
.string
.lstring
= Qnil
;
5890 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5891 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5892 it
->bidi_it
.string
.bufpos
= 0;
5893 it
->bidi_it
.string
.from_disp_str
= 0;
5894 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5895 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5898 it
->method
= GET_FROM_C_STRING
;
5901 /* PRECISION > 0 means don't return more than PRECISION characters
5903 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5905 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5907 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5910 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5911 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5912 FIELD_WIDTH < 0 means infinite field width. This is useful for
5913 padding with `-' at the end of a mode line. */
5914 if (field_width
< 0)
5915 field_width
= INFINITY
;
5916 /* Implementation note: We deliberately don't enlarge
5917 it->bidi_it.string.schars here to fit it->end_charpos, because
5918 the bidi iterator cannot produce characters out of thin air. */
5919 if (field_width
> it
->end_charpos
- charpos
)
5920 it
->end_charpos
= charpos
+ field_width
;
5922 /* Use the standard display table for displaying strings. */
5923 if (DISP_TABLE_P (Vstandard_display_table
))
5924 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5926 it
->stop_charpos
= charpos
;
5927 it
->prev_stop
= charpos
;
5928 it
->base_level_stop
= 0;
5931 it
->bidi_it
.first_elt
= 1;
5932 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5933 it
->bidi_it
.disp_pos
= -1;
5935 if (s
== NULL
&& it
->multibyte_p
)
5937 EMACS_INT endpos
= SCHARS (it
->string
);
5938 if (endpos
> it
->end_charpos
)
5939 endpos
= it
->end_charpos
;
5940 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5948 /***********************************************************************
5950 ***********************************************************************/
5952 /* Map enum it_method value to corresponding next_element_from_* function. */
5954 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5956 next_element_from_buffer
,
5957 next_element_from_display_vector
,
5958 next_element_from_string
,
5959 next_element_from_c_string
,
5960 next_element_from_image
,
5961 next_element_from_stretch
5964 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5967 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5968 (possibly with the following characters). */
5970 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5971 ((IT)->cmp_it.id >= 0 \
5972 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5973 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5974 END_CHARPOS, (IT)->w, \
5975 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5979 /* Lookup the char-table Vglyphless_char_display for character C (-1
5980 if we want information for no-font case), and return the display
5981 method symbol. By side-effect, update it->what and
5982 it->glyphless_method. This function is called from
5983 get_next_display_element for each character element, and from
5984 x_produce_glyphs when no suitable font was found. */
5987 lookup_glyphless_char_display (int c
, struct it
*it
)
5989 Lisp_Object glyphless_method
= Qnil
;
5991 if (CHAR_TABLE_P (Vglyphless_char_display
)
5992 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5996 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5997 if (CONSP (glyphless_method
))
5998 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5999 ? XCAR (glyphless_method
)
6000 : XCDR (glyphless_method
);
6003 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6007 if (NILP (glyphless_method
))
6010 /* The default is to display the character by a proper font. */
6012 /* The default for the no-font case is to display an empty box. */
6013 glyphless_method
= Qempty_box
;
6015 if (EQ (glyphless_method
, Qzero_width
))
6018 return glyphless_method
;
6019 /* This method can't be used for the no-font case. */
6020 glyphless_method
= Qempty_box
;
6022 if (EQ (glyphless_method
, Qthin_space
))
6023 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6024 else if (EQ (glyphless_method
, Qempty_box
))
6025 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6026 else if (EQ (glyphless_method
, Qhex_code
))
6027 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6028 else if (STRINGP (glyphless_method
))
6029 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6032 /* Invalid value. We use the default method. */
6033 glyphless_method
= Qnil
;
6036 it
->what
= IT_GLYPHLESS
;
6037 return glyphless_method
;
6040 /* Load IT's display element fields with information about the next
6041 display element from the current position of IT. Value is zero if
6042 end of buffer (or C string) is reached. */
6044 static struct frame
*last_escape_glyph_frame
= NULL
;
6045 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6046 static int last_escape_glyph_merged_face_id
= 0;
6048 struct frame
*last_glyphless_glyph_frame
= NULL
;
6049 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6050 int last_glyphless_glyph_merged_face_id
= 0;
6053 get_next_display_element (struct it
*it
)
6055 /* Non-zero means that we found a display element. Zero means that
6056 we hit the end of what we iterate over. Performance note: the
6057 function pointer `method' used here turns out to be faster than
6058 using a sequence of if-statements. */
6062 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6064 if (it
->what
== IT_CHARACTER
)
6066 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6067 and only if (a) the resolved directionality of that character
6069 /* FIXME: Do we need an exception for characters from display
6071 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6072 it
->c
= bidi_mirror_char (it
->c
);
6073 /* Map via display table or translate control characters.
6074 IT->c, IT->len etc. have been set to the next character by
6075 the function call above. If we have a display table, and it
6076 contains an entry for IT->c, translate it. Don't do this if
6077 IT->c itself comes from a display table, otherwise we could
6078 end up in an infinite recursion. (An alternative could be to
6079 count the recursion depth of this function and signal an
6080 error when a certain maximum depth is reached.) Is it worth
6082 if (success_p
&& it
->dpvec
== NULL
)
6085 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6086 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6087 nbsp_or_shy
= char_is_other
;
6088 int c
= it
->c
; /* This is the character to display. */
6090 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6092 xassert (SINGLE_BYTE_CHAR_P (c
));
6093 if (unibyte_display_via_language_environment
)
6095 c
= DECODE_CHAR (unibyte
, c
);
6097 c
= BYTE8_TO_CHAR (it
->c
);
6100 c
= BYTE8_TO_CHAR (it
->c
);
6104 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6107 struct Lisp_Vector
*v
= XVECTOR (dv
);
6109 /* Return the first character from the display table
6110 entry, if not empty. If empty, don't display the
6111 current character. */
6114 it
->dpvec_char_len
= it
->len
;
6115 it
->dpvec
= v
->contents
;
6116 it
->dpend
= v
->contents
+ v
->header
.size
;
6117 it
->current
.dpvec_index
= 0;
6118 it
->dpvec_face_id
= -1;
6119 it
->saved_face_id
= it
->face_id
;
6120 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6125 set_iterator_to_next (it
, 0);
6130 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6132 if (it
->what
== IT_GLYPHLESS
)
6134 /* Don't display this character. */
6135 set_iterator_to_next (it
, 0);
6139 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6140 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6141 : c
== 0xAD ? char_is_soft_hyphen
6144 /* Translate control characters into `\003' or `^C' form.
6145 Control characters coming from a display table entry are
6146 currently not translated because we use IT->dpvec to hold
6147 the translation. This could easily be changed but I
6148 don't believe that it is worth doing.
6150 NBSP and SOFT-HYPEN are property translated too.
6152 Non-printable characters and raw-byte characters are also
6153 translated to octal form. */
6154 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6155 ? (it
->area
!= TEXT_AREA
6156 /* In mode line, treat \n, \t like other crl chars. */
6159 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6160 || (c
!= '\n' && c
!= '\t'))
6163 || ! CHAR_PRINTABLE_P (c
))))
6165 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6166 or a non-printable character which must be displayed
6167 either as '\003' or as `^C' where the '\\' and '^'
6168 can be defined in the display table. Fill
6169 IT->ctl_chars with glyphs for what we have to
6170 display. Then, set IT->dpvec to these glyphs. */
6174 EMACS_INT lface_id
= 0;
6177 /* Handle control characters with ^. */
6179 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6183 g
= '^'; /* default glyph for Control */
6184 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6186 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6187 && GLYPH_CODE_CHAR_VALID_P (gc
))
6189 g
= GLYPH_CODE_CHAR (gc
);
6190 lface_id
= GLYPH_CODE_FACE (gc
);
6194 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6196 else if (it
->f
== last_escape_glyph_frame
6197 && it
->face_id
== last_escape_glyph_face_id
)
6199 face_id
= last_escape_glyph_merged_face_id
;
6203 /* Merge the escape-glyph face into the current face. */
6204 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6206 last_escape_glyph_frame
= it
->f
;
6207 last_escape_glyph_face_id
= it
->face_id
;
6208 last_escape_glyph_merged_face_id
= face_id
;
6211 XSETINT (it
->ctl_chars
[0], g
);
6212 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6214 goto display_control
;
6217 /* Handle non-break space in the mode where it only gets
6220 if (EQ (Vnobreak_char_display
, Qt
)
6221 && nbsp_or_shy
== char_is_nbsp
)
6223 /* Merge the no-break-space face into the current face. */
6224 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6228 XSETINT (it
->ctl_chars
[0], ' ');
6230 goto display_control
;
6233 /* Handle sequences that start with the "escape glyph". */
6235 /* the default escape glyph is \. */
6236 escape_glyph
= '\\';
6239 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6240 && GLYPH_CODE_CHAR_VALID_P (gc
))
6242 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6243 lface_id
= GLYPH_CODE_FACE (gc
);
6247 /* The display table specified a face.
6248 Merge it into face_id and also into escape_glyph. */
6249 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6252 else if (it
->f
== last_escape_glyph_frame
6253 && it
->face_id
== last_escape_glyph_face_id
)
6255 face_id
= last_escape_glyph_merged_face_id
;
6259 /* Merge the escape-glyph face into the current face. */
6260 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6262 last_escape_glyph_frame
= it
->f
;
6263 last_escape_glyph_face_id
= it
->face_id
;
6264 last_escape_glyph_merged_face_id
= face_id
;
6267 /* Handle soft hyphens in the mode where they only get
6270 if (EQ (Vnobreak_char_display
, Qt
)
6271 && nbsp_or_shy
== char_is_soft_hyphen
)
6273 XSETINT (it
->ctl_chars
[0], '-');
6275 goto display_control
;
6278 /* Handle non-break space and soft hyphen
6279 with the escape glyph. */
6283 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6284 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6285 XSETINT (it
->ctl_chars
[1], c
);
6287 goto display_control
;
6294 if (CHAR_BYTE8_P (c
))
6295 /* Display \200 instead of \17777600. */
6296 c
= CHAR_TO_BYTE8 (c
);
6297 len
= sprintf (str
, "%03o", c
);
6299 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6300 for (i
= 0; i
< len
; i
++)
6301 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6306 /* Set up IT->dpvec and return first character from it. */
6307 it
->dpvec_char_len
= it
->len
;
6308 it
->dpvec
= it
->ctl_chars
;
6309 it
->dpend
= it
->dpvec
+ ctl_len
;
6310 it
->current
.dpvec_index
= 0;
6311 it
->dpvec_face_id
= face_id
;
6312 it
->saved_face_id
= it
->face_id
;
6313 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6317 it
->char_to_display
= c
;
6321 it
->char_to_display
= it
->c
;
6325 /* Adjust face id for a multibyte character. There are no multibyte
6326 character in unibyte text. */
6327 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6330 && FRAME_WINDOW_P (it
->f
))
6332 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6334 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6336 /* Automatic composition with glyph-string. */
6337 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6339 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6343 EMACS_INT pos
= (it
->s
? -1
6344 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6345 : IT_CHARPOS (*it
));
6348 if (it
->what
== IT_CHARACTER
)
6349 c
= it
->char_to_display
;
6352 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6356 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6357 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6360 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6365 /* Is this character the last one of a run of characters with
6366 box? If yes, set IT->end_of_box_run_p to 1. */
6370 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6372 int face_id
= underlying_face_id (it
);
6373 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6377 if (face
->box
== FACE_NO_BOX
)
6379 /* If the box comes from face properties in a
6380 display string, check faces in that string. */
6381 int string_face_id
= face_after_it_pos (it
);
6382 it
->end_of_box_run_p
6383 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6386 /* Otherwise, the box comes from the underlying face.
6387 If this is the last string character displayed, check
6388 the next buffer location. */
6389 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6390 && (it
->current
.overlay_string_index
6391 == it
->n_overlay_strings
- 1))
6395 struct text_pos pos
= it
->current
.pos
;
6396 INC_TEXT_POS (pos
, it
->multibyte_p
);
6398 next_face_id
= face_at_buffer_position
6399 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6400 it
->region_end_charpos
, &ignore
,
6401 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6403 it
->end_of_box_run_p
6404 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6411 int face_id
= face_after_it_pos (it
);
6412 it
->end_of_box_run_p
6413 = (face_id
!= it
->face_id
6414 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6418 /* Value is 0 if end of buffer or string reached. */
6423 /* Move IT to the next display element.
6425 RESEAT_P non-zero means if called on a newline in buffer text,
6426 skip to the next visible line start.
6428 Functions get_next_display_element and set_iterator_to_next are
6429 separate because I find this arrangement easier to handle than a
6430 get_next_display_element function that also increments IT's
6431 position. The way it is we can first look at an iterator's current
6432 display element, decide whether it fits on a line, and if it does,
6433 increment the iterator position. The other way around we probably
6434 would either need a flag indicating whether the iterator has to be
6435 incremented the next time, or we would have to implement a
6436 decrement position function which would not be easy to write. */
6439 set_iterator_to_next (struct it
*it
, int reseat_p
)
6441 /* Reset flags indicating start and end of a sequence of characters
6442 with box. Reset them at the start of this function because
6443 moving the iterator to a new position might set them. */
6444 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6448 case GET_FROM_BUFFER
:
6449 /* The current display element of IT is a character from
6450 current_buffer. Advance in the buffer, and maybe skip over
6451 invisible lines that are so because of selective display. */
6452 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6453 reseat_at_next_visible_line_start (it
, 0);
6454 else if (it
->cmp_it
.id
>= 0)
6456 /* We are currently getting glyphs from a composition. */
6461 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6462 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6463 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6465 it
->cmp_it
.from
= it
->cmp_it
.to
;
6470 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6472 it
->end_charpos
, Qnil
);
6475 else if (! it
->cmp_it
.reversed_p
)
6477 /* Composition created while scanning forward. */
6478 /* Update IT's char/byte positions to point to the first
6479 character of the next grapheme cluster, or to the
6480 character visually after the current composition. */
6481 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6482 bidi_move_to_visually_next (&it
->bidi_it
);
6483 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6484 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6486 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6488 /* Proceed to the next grapheme cluster. */
6489 it
->cmp_it
.from
= it
->cmp_it
.to
;
6493 /* No more grapheme clusters in this composition.
6494 Find the next stop position. */
6495 EMACS_INT stop
= it
->end_charpos
;
6496 if (it
->bidi_it
.scan_dir
< 0)
6497 /* Now we are scanning backward and don't know
6500 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6501 IT_BYTEPOS (*it
), stop
, Qnil
);
6506 /* Composition created while scanning backward. */
6507 /* Update IT's char/byte positions to point to the last
6508 character of the previous grapheme cluster, or the
6509 character visually after the current composition. */
6510 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6511 bidi_move_to_visually_next (&it
->bidi_it
);
6512 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6513 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6514 if (it
->cmp_it
.from
> 0)
6516 /* Proceed to the previous grapheme cluster. */
6517 it
->cmp_it
.to
= it
->cmp_it
.from
;
6521 /* No more grapheme clusters in this composition.
6522 Find the next stop position. */
6523 EMACS_INT stop
= it
->end_charpos
;
6524 if (it
->bidi_it
.scan_dir
< 0)
6525 /* Now we are scanning backward and don't know
6528 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6529 IT_BYTEPOS (*it
), stop
, Qnil
);
6535 xassert (it
->len
!= 0);
6539 IT_BYTEPOS (*it
) += it
->len
;
6540 IT_CHARPOS (*it
) += 1;
6544 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6545 /* If this is a new paragraph, determine its base
6546 direction (a.k.a. its base embedding level). */
6547 if (it
->bidi_it
.new_paragraph
)
6548 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6549 bidi_move_to_visually_next (&it
->bidi_it
);
6550 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6551 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6552 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6554 /* As the scan direction was changed, we must
6555 re-compute the stop position for composition. */
6556 EMACS_INT stop
= it
->end_charpos
;
6557 if (it
->bidi_it
.scan_dir
< 0)
6559 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6560 IT_BYTEPOS (*it
), stop
, Qnil
);
6563 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6567 case GET_FROM_C_STRING
:
6568 /* Current display element of IT is from a C string. */
6570 /* If the string position is beyond string's end, it means
6571 next_element_from_c_string is padding the string with
6572 blanks, in which case we bypass the bidi iterator,
6573 because it cannot deal with such virtual characters. */
6574 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6576 IT_BYTEPOS (*it
) += it
->len
;
6577 IT_CHARPOS (*it
) += 1;
6581 bidi_move_to_visually_next (&it
->bidi_it
);
6582 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6583 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6587 case GET_FROM_DISPLAY_VECTOR
:
6588 /* Current display element of IT is from a display table entry.
6589 Advance in the display table definition. Reset it to null if
6590 end reached, and continue with characters from buffers/
6592 ++it
->current
.dpvec_index
;
6594 /* Restore face of the iterator to what they were before the
6595 display vector entry (these entries may contain faces). */
6596 it
->face_id
= it
->saved_face_id
;
6598 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6600 int recheck_faces
= it
->ellipsis_p
;
6603 it
->method
= GET_FROM_C_STRING
;
6604 else if (STRINGP (it
->string
))
6605 it
->method
= GET_FROM_STRING
;
6608 it
->method
= GET_FROM_BUFFER
;
6609 it
->object
= it
->w
->buffer
;
6613 it
->current
.dpvec_index
= -1;
6615 /* Skip over characters which were displayed via IT->dpvec. */
6616 if (it
->dpvec_char_len
< 0)
6617 reseat_at_next_visible_line_start (it
, 1);
6618 else if (it
->dpvec_char_len
> 0)
6620 if (it
->method
== GET_FROM_STRING
6621 && it
->n_overlay_strings
> 0)
6622 it
->ignore_overlay_strings_at_pos_p
= 1;
6623 it
->len
= it
->dpvec_char_len
;
6624 set_iterator_to_next (it
, reseat_p
);
6627 /* Maybe recheck faces after display vector */
6629 it
->stop_charpos
= IT_CHARPOS (*it
);
6633 case GET_FROM_STRING
:
6634 /* Current display element is a character from a Lisp string. */
6635 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6636 if (it
->cmp_it
.id
>= 0)
6642 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6643 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6644 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6645 it
->cmp_it
.from
= it
->cmp_it
.to
;
6649 composition_compute_stop_pos (&it
->cmp_it
,
6650 IT_STRING_CHARPOS (*it
),
6651 IT_STRING_BYTEPOS (*it
),
6652 it
->end_charpos
, it
->string
);
6655 else if (! it
->cmp_it
.reversed_p
)
6657 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6658 bidi_move_to_visually_next (&it
->bidi_it
);
6659 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6660 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6662 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6663 it
->cmp_it
.from
= it
->cmp_it
.to
;
6666 EMACS_INT stop
= it
->end_charpos
;
6667 if (it
->bidi_it
.scan_dir
< 0)
6669 composition_compute_stop_pos (&it
->cmp_it
,
6670 IT_STRING_CHARPOS (*it
),
6671 IT_STRING_BYTEPOS (*it
), stop
,
6677 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6678 bidi_move_to_visually_next (&it
->bidi_it
);
6679 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6680 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6681 if (it
->cmp_it
.from
> 0)
6682 it
->cmp_it
.to
= it
->cmp_it
.from
;
6685 EMACS_INT stop
= it
->end_charpos
;
6686 if (it
->bidi_it
.scan_dir
< 0)
6688 composition_compute_stop_pos (&it
->cmp_it
,
6689 IT_STRING_CHARPOS (*it
),
6690 IT_STRING_BYTEPOS (*it
), stop
,
6698 /* If the string position is beyond string's end, it
6699 means next_element_from_string is padding the string
6700 with blanks, in which case we bypass the bidi
6701 iterator, because it cannot deal with such virtual
6703 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6705 IT_STRING_BYTEPOS (*it
) += it
->len
;
6706 IT_STRING_CHARPOS (*it
) += 1;
6710 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6712 bidi_move_to_visually_next (&it
->bidi_it
);
6713 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6714 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6715 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6717 EMACS_INT stop
= it
->end_charpos
;
6719 if (it
->bidi_it
.scan_dir
< 0)
6721 composition_compute_stop_pos (&it
->cmp_it
,
6722 IT_STRING_CHARPOS (*it
),
6723 IT_STRING_BYTEPOS (*it
), stop
,
6729 consider_string_end
:
6731 if (it
->current
.overlay_string_index
>= 0)
6733 /* IT->string is an overlay string. Advance to the
6734 next, if there is one. */
6735 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6738 next_overlay_string (it
);
6740 setup_for_ellipsis (it
, 0);
6745 /* IT->string is not an overlay string. If we reached
6746 its end, and there is something on IT->stack, proceed
6747 with what is on the stack. This can be either another
6748 string, this time an overlay string, or a buffer. */
6749 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6753 if (it
->method
== GET_FROM_STRING
)
6754 goto consider_string_end
;
6759 case GET_FROM_IMAGE
:
6760 case GET_FROM_STRETCH
:
6761 /* The position etc with which we have to proceed are on
6762 the stack. The position may be at the end of a string,
6763 if the `display' property takes up the whole string. */
6764 xassert (it
->sp
> 0);
6766 if (it
->method
== GET_FROM_STRING
)
6767 goto consider_string_end
;
6771 /* There are no other methods defined, so this should be a bug. */
6775 xassert (it
->method
!= GET_FROM_STRING
6776 || (STRINGP (it
->string
)
6777 && IT_STRING_CHARPOS (*it
) >= 0));
6780 /* Load IT's display element fields with information about the next
6781 display element which comes from a display table entry or from the
6782 result of translating a control character to one of the forms `^C'
6785 IT->dpvec holds the glyphs to return as characters.
6786 IT->saved_face_id holds the face id before the display vector--it
6787 is restored into IT->face_id in set_iterator_to_next. */
6790 next_element_from_display_vector (struct it
*it
)
6795 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6797 it
->face_id
= it
->saved_face_id
;
6799 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6800 That seemed totally bogus - so I changed it... */
6801 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6803 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6805 it
->c
= GLYPH_CODE_CHAR (gc
);
6806 it
->len
= CHAR_BYTES (it
->c
);
6808 /* The entry may contain a face id to use. Such a face id is
6809 the id of a Lisp face, not a realized face. A face id of
6810 zero means no face is specified. */
6811 if (it
->dpvec_face_id
>= 0)
6812 it
->face_id
= it
->dpvec_face_id
;
6815 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6817 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6822 /* Display table entry is invalid. Return a space. */
6823 it
->c
= ' ', it
->len
= 1;
6825 /* Don't change position and object of the iterator here. They are
6826 still the values of the character that had this display table
6827 entry or was translated, and that's what we want. */
6828 it
->what
= IT_CHARACTER
;
6832 /* Get the first element of string/buffer in the visual order, after
6833 being reseated to a new position in a string or a buffer. */
6835 get_visually_first_element (struct it
*it
)
6837 int string_p
= STRINGP (it
->string
) || it
->s
;
6838 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6839 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6841 if (STRINGP (it
->string
))
6843 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6844 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6848 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6849 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6852 if (it
->bidi_it
.charpos
== eob
)
6854 /* Nothing to do, but reset the FIRST_ELT flag, like
6855 bidi_paragraph_init does, because we are not going to
6857 it
->bidi_it
.first_elt
= 0;
6859 else if (it
->bidi_it
.charpos
== bob
6861 /* FIXME: Should support all Unicode line separators. */
6862 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6863 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6865 /* If we are at the beginning of a line/string, we can produce
6866 the next element right away. */
6867 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6868 bidi_move_to_visually_next (&it
->bidi_it
);
6872 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6874 /* We need to prime the bidi iterator starting at the line's or
6875 string's beginning, before we will be able to produce the
6878 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6881 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6883 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6885 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6888 /* Now return to buffer/string position where we were asked
6889 to get the next display element, and produce that. */
6890 bidi_move_to_visually_next (&it
->bidi_it
);
6892 while (it
->bidi_it
.bytepos
!= orig_bytepos
6893 && it
->bidi_it
.charpos
< eob
);
6896 /* Adjust IT's position information to where we ended up. */
6897 if (STRINGP (it
->string
))
6899 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6900 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6904 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6905 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6908 if (STRINGP (it
->string
) || !it
->s
)
6910 EMACS_INT stop
, charpos
, bytepos
;
6912 if (STRINGP (it
->string
))
6915 stop
= SCHARS (it
->string
);
6916 if (stop
> it
->end_charpos
)
6917 stop
= it
->end_charpos
;
6918 charpos
= IT_STRING_CHARPOS (*it
);
6919 bytepos
= IT_STRING_BYTEPOS (*it
);
6923 stop
= it
->end_charpos
;
6924 charpos
= IT_CHARPOS (*it
);
6925 bytepos
= IT_BYTEPOS (*it
);
6927 if (it
->bidi_it
.scan_dir
< 0)
6929 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6934 /* Load IT with the next display element from Lisp string IT->string.
6935 IT->current.string_pos is the current position within the string.
6936 If IT->current.overlay_string_index >= 0, the Lisp string is an
6940 next_element_from_string (struct it
*it
)
6942 struct text_pos position
;
6944 xassert (STRINGP (it
->string
));
6945 xassert (!it
->bidi_p
|| it
->string
== it
->bidi_it
.string
.lstring
);
6946 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6947 position
= it
->current
.string_pos
;
6949 /* With bidi reordering, the character to display might not be the
6950 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6951 that we were reseat()ed to a new string, whose paragraph
6952 direction is not known. */
6953 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6955 get_visually_first_element (it
);
6956 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
6959 /* Time to check for invisible text? */
6960 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
6962 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
6965 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6966 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
6968 /* With bidi non-linear iteration, we could find
6969 ourselves far beyond the last computed stop_charpos,
6970 with several other stop positions in between that we
6971 missed. Scan them all now, in buffer's logical
6972 order, until we find and handle the last stop_charpos
6973 that precedes our current position. */
6974 handle_stop_backwards (it
, it
->stop_charpos
);
6975 return GET_NEXT_DISPLAY_ELEMENT (it
);
6981 /* Take note of the stop position we just moved
6982 across, for when we will move back across it. */
6983 it
->prev_stop
= it
->stop_charpos
;
6984 /* If we are at base paragraph embedding level, take
6985 note of the last stop position seen at this
6987 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6988 it
->base_level_stop
= it
->stop_charpos
;
6992 /* Since a handler may have changed IT->method, we must
6994 return GET_NEXT_DISPLAY_ELEMENT (it
);
6998 /* If we are before prev_stop, we may have overstepped
6999 on our way backwards a stop_pos, and if so, we need
7000 to handle that stop_pos. */
7001 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7002 /* We can sometimes back up for reasons that have nothing
7003 to do with bidi reordering. E.g., compositions. The
7004 code below is only needed when we are above the base
7005 embedding level, so test for that explicitly. */
7006 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7008 /* If we lost track of base_level_stop, we have no better place
7009 for handle_stop_backwards to start from than BEGV. This
7010 happens, e.g., when we were reseated to the previous
7011 screenful of text by vertical-motion. */
7012 if (it
->base_level_stop
<= 0
7013 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7014 it
->base_level_stop
= 0;
7015 handle_stop_backwards (it
, it
->base_level_stop
);
7016 return GET_NEXT_DISPLAY_ELEMENT (it
);
7020 if (it
->current
.overlay_string_index
>= 0)
7022 /* Get the next character from an overlay string. In overlay
7023 strings, There is no field width or padding with spaces to
7025 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7030 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7031 IT_STRING_BYTEPOS (*it
),
7032 it
->bidi_it
.scan_dir
< 0
7034 : SCHARS (it
->string
))
7035 && next_element_from_composition (it
))
7039 else if (STRING_MULTIBYTE (it
->string
))
7041 const unsigned char *s
= (SDATA (it
->string
)
7042 + IT_STRING_BYTEPOS (*it
));
7043 it
->c
= string_char_and_length (s
, &it
->len
);
7047 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7053 /* Get the next character from a Lisp string that is not an
7054 overlay string. Such strings come from the mode line, for
7055 example. We may have to pad with spaces, or truncate the
7056 string. See also next_element_from_c_string. */
7057 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7062 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7064 /* Pad with spaces. */
7065 it
->c
= ' ', it
->len
= 1;
7066 CHARPOS (position
) = BYTEPOS (position
) = -1;
7068 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7069 IT_STRING_BYTEPOS (*it
),
7070 it
->bidi_it
.scan_dir
< 0
7072 : it
->string_nchars
)
7073 && next_element_from_composition (it
))
7077 else if (STRING_MULTIBYTE (it
->string
))
7079 const unsigned char *s
= (SDATA (it
->string
)
7080 + IT_STRING_BYTEPOS (*it
));
7081 it
->c
= string_char_and_length (s
, &it
->len
);
7085 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7090 /* Record what we have and where it came from. */
7091 it
->what
= IT_CHARACTER
;
7092 it
->object
= it
->string
;
7093 it
->position
= position
;
7098 /* Load IT with next display element from C string IT->s.
7099 IT->string_nchars is the maximum number of characters to return
7100 from the string. IT->end_charpos may be greater than
7101 IT->string_nchars when this function is called, in which case we
7102 may have to return padding spaces. Value is zero if end of string
7103 reached, including padding spaces. */
7106 next_element_from_c_string (struct it
*it
)
7111 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7112 it
->what
= IT_CHARACTER
;
7113 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7116 /* With bidi reordering, the character to display might not be the
7117 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7118 we were reseated to a new string, whose paragraph direction is
7120 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7121 get_visually_first_element (it
);
7123 /* IT's position can be greater than IT->string_nchars in case a
7124 field width or precision has been specified when the iterator was
7126 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7128 /* End of the game. */
7132 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7134 /* Pad with spaces. */
7135 it
->c
= ' ', it
->len
= 1;
7136 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7138 else if (it
->multibyte_p
)
7139 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7141 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7147 /* Set up IT to return characters from an ellipsis, if appropriate.
7148 The definition of the ellipsis glyphs may come from a display table
7149 entry. This function fills IT with the first glyph from the
7150 ellipsis if an ellipsis is to be displayed. */
7153 next_element_from_ellipsis (struct it
*it
)
7155 if (it
->selective_display_ellipsis_p
)
7156 setup_for_ellipsis (it
, it
->len
);
7159 /* The face at the current position may be different from the
7160 face we find after the invisible text. Remember what it
7161 was in IT->saved_face_id, and signal that it's there by
7162 setting face_before_selective_p. */
7163 it
->saved_face_id
= it
->face_id
;
7164 it
->method
= GET_FROM_BUFFER
;
7165 it
->object
= it
->w
->buffer
;
7166 reseat_at_next_visible_line_start (it
, 1);
7167 it
->face_before_selective_p
= 1;
7170 return GET_NEXT_DISPLAY_ELEMENT (it
);
7174 /* Deliver an image display element. The iterator IT is already
7175 filled with image information (done in handle_display_prop). Value
7180 next_element_from_image (struct it
*it
)
7182 it
->what
= IT_IMAGE
;
7183 it
->ignore_overlay_strings_at_pos_p
= 0;
7188 /* Fill iterator IT with next display element from a stretch glyph
7189 property. IT->object is the value of the text property. Value is
7193 next_element_from_stretch (struct it
*it
)
7195 it
->what
= IT_STRETCH
;
7199 /* Scan forward from CHARPOS in the current buffer/string, until we
7200 find a stop position > current IT's position. Then handle the stop
7201 position before that. This is called when we bump into a stop
7202 position while reordering bidirectional text. CHARPOS should be
7203 the last previously processed stop_pos (or BEGV/0, if none were
7204 processed yet) whose position is less that IT's current
7208 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7210 int bufp
= !STRINGP (it
->string
);
7211 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7212 struct display_pos save_current
= it
->current
;
7213 struct text_pos save_position
= it
->position
;
7214 struct text_pos pos1
;
7215 EMACS_INT next_stop
;
7217 /* Scan in strict logical order. */
7221 it
->prev_stop
= charpos
;
7224 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7225 reseat_1 (it
, pos1
, 0);
7228 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7229 compute_stop_pos (it
);
7230 /* We must advance forward, right? */
7231 if (it
->stop_charpos
<= it
->prev_stop
)
7233 charpos
= it
->stop_charpos
;
7235 while (charpos
<= where_we_are
);
7237 next_stop
= it
->stop_charpos
;
7238 it
->stop_charpos
= it
->prev_stop
;
7240 it
->current
= save_current
;
7241 it
->position
= save_position
;
7243 it
->stop_charpos
= next_stop
;
7246 /* Load IT with the next display element from current_buffer. Value
7247 is zero if end of buffer reached. IT->stop_charpos is the next
7248 position at which to stop and check for text properties or buffer
7252 next_element_from_buffer (struct it
*it
)
7256 xassert (IT_CHARPOS (*it
) >= BEGV
);
7257 xassert (NILP (it
->string
) && !it
->s
);
7258 xassert (!it
->bidi_p
7259 || (it
->bidi_it
.string
.lstring
== Qnil
7260 && it
->bidi_it
.string
.s
== NULL
));
7262 /* With bidi reordering, the character to display might not be the
7263 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7264 we were reseat()ed to a new buffer position, which is potentially
7265 a different paragraph. */
7266 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7268 get_visually_first_element (it
);
7269 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7272 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7274 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7276 int overlay_strings_follow_p
;
7278 /* End of the game, except when overlay strings follow that
7279 haven't been returned yet. */
7280 if (it
->overlay_strings_at_end_processed_p
)
7281 overlay_strings_follow_p
= 0;
7284 it
->overlay_strings_at_end_processed_p
= 1;
7285 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7288 if (overlay_strings_follow_p
)
7289 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7293 it
->position
= it
->current
.pos
;
7297 else if (!(!it
->bidi_p
7298 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7299 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7301 /* With bidi non-linear iteration, we could find ourselves
7302 far beyond the last computed stop_charpos, with several
7303 other stop positions in between that we missed. Scan
7304 them all now, in buffer's logical order, until we find
7305 and handle the last stop_charpos that precedes our
7306 current position. */
7307 handle_stop_backwards (it
, it
->stop_charpos
);
7308 return GET_NEXT_DISPLAY_ELEMENT (it
);
7314 /* Take note of the stop position we just moved across,
7315 for when we will move back across it. */
7316 it
->prev_stop
= it
->stop_charpos
;
7317 /* If we are at base paragraph embedding level, take
7318 note of the last stop position seen at this
7320 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7321 it
->base_level_stop
= it
->stop_charpos
;
7324 return GET_NEXT_DISPLAY_ELEMENT (it
);
7328 /* If we are before prev_stop, we may have overstepped on
7329 our way backwards a stop_pos, and if so, we need to
7330 handle that stop_pos. */
7331 && IT_CHARPOS (*it
) < it
->prev_stop
7332 /* We can sometimes back up for reasons that have nothing
7333 to do with bidi reordering. E.g., compositions. The
7334 code below is only needed when we are above the base
7335 embedding level, so test for that explicitly. */
7336 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7338 /* If we lost track of base_level_stop, we have no better place
7339 for handle_stop_backwards to start from than BEGV. This
7340 happens, e.g., when we were reseated to the previous
7341 screenful of text by vertical-motion. */
7342 if (it
->base_level_stop
<= 0
7343 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7344 it
->base_level_stop
= BEGV
;
7345 handle_stop_backwards (it
, it
->base_level_stop
);
7346 return GET_NEXT_DISPLAY_ELEMENT (it
);
7350 /* No face changes, overlays etc. in sight, so just return a
7351 character from current_buffer. */
7355 /* Maybe run the redisplay end trigger hook. Performance note:
7356 This doesn't seem to cost measurable time. */
7357 if (it
->redisplay_end_trigger_charpos
7359 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7360 run_redisplay_end_trigger_hook (it
);
7362 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7363 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7365 && next_element_from_composition (it
))
7370 /* Get the next character, maybe multibyte. */
7371 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7372 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7373 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7375 it
->c
= *p
, it
->len
= 1;
7377 /* Record what we have and where it came from. */
7378 it
->what
= IT_CHARACTER
;
7379 it
->object
= it
->w
->buffer
;
7380 it
->position
= it
->current
.pos
;
7382 /* Normally we return the character found above, except when we
7383 really want to return an ellipsis for selective display. */
7388 /* A value of selective > 0 means hide lines indented more
7389 than that number of columns. */
7390 if (it
->selective
> 0
7391 && IT_CHARPOS (*it
) + 1 < ZV
7392 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7393 IT_BYTEPOS (*it
) + 1,
7396 success_p
= next_element_from_ellipsis (it
);
7397 it
->dpvec_char_len
= -1;
7400 else if (it
->c
== '\r' && it
->selective
== -1)
7402 /* A value of selective == -1 means that everything from the
7403 CR to the end of the line is invisible, with maybe an
7404 ellipsis displayed for it. */
7405 success_p
= next_element_from_ellipsis (it
);
7406 it
->dpvec_char_len
= -1;
7411 /* Value is zero if end of buffer reached. */
7412 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7417 /* Run the redisplay end trigger hook for IT. */
7420 run_redisplay_end_trigger_hook (struct it
*it
)
7422 Lisp_Object args
[3];
7424 /* IT->glyph_row should be non-null, i.e. we should be actually
7425 displaying something, or otherwise we should not run the hook. */
7426 xassert (it
->glyph_row
);
7428 /* Set up hook arguments. */
7429 args
[0] = Qredisplay_end_trigger_functions
;
7430 args
[1] = it
->window
;
7431 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7432 it
->redisplay_end_trigger_charpos
= 0;
7434 /* Since we are *trying* to run these functions, don't try to run
7435 them again, even if they get an error. */
7436 it
->w
->redisplay_end_trigger
= Qnil
;
7437 Frun_hook_with_args (3, args
);
7439 /* Notice if it changed the face of the character we are on. */
7440 handle_face_prop (it
);
7444 /* Deliver a composition display element. Unlike the other
7445 next_element_from_XXX, this function is not registered in the array
7446 get_next_element[]. It is called from next_element_from_buffer and
7447 next_element_from_string when necessary. */
7450 next_element_from_composition (struct it
*it
)
7452 it
->what
= IT_COMPOSITION
;
7453 it
->len
= it
->cmp_it
.nbytes
;
7454 if (STRINGP (it
->string
))
7458 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7459 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7462 it
->position
= it
->current
.string_pos
;
7463 it
->object
= it
->string
;
7464 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7465 IT_STRING_BYTEPOS (*it
), it
->string
);
7471 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7472 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7475 if (it
->bidi_it
.new_paragraph
)
7476 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7477 /* Resync the bidi iterator with IT's new position.
7478 FIXME: this doesn't support bidirectional text. */
7479 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7480 bidi_move_to_visually_next (&it
->bidi_it
);
7484 it
->position
= it
->current
.pos
;
7485 it
->object
= it
->w
->buffer
;
7486 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7487 IT_BYTEPOS (*it
), Qnil
);
7494 /***********************************************************************
7495 Moving an iterator without producing glyphs
7496 ***********************************************************************/
7498 /* Check if iterator is at a position corresponding to a valid buffer
7499 position after some move_it_ call. */
7501 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7502 ((it)->method == GET_FROM_STRING \
7503 ? IT_STRING_CHARPOS (*it) == 0 \
7507 /* Move iterator IT to a specified buffer or X position within one
7508 line on the display without producing glyphs.
7510 OP should be a bit mask including some or all of these bits:
7511 MOVE_TO_X: Stop upon reaching x-position TO_X.
7512 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7513 Regardless of OP's value, stop upon reaching the end of the display line.
7515 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7516 This means, in particular, that TO_X includes window's horizontal
7519 The return value has several possible values that
7520 say what condition caused the scan to stop:
7522 MOVE_POS_MATCH_OR_ZV
7523 - when TO_POS or ZV was reached.
7526 -when TO_X was reached before TO_POS or ZV were reached.
7529 - when we reached the end of the display area and the line must
7533 - when we reached the end of the display area and the line is
7537 - when we stopped at a line end, i.e. a newline or a CR and selective
7540 static enum move_it_result
7541 move_it_in_display_line_to (struct it
*it
,
7542 EMACS_INT to_charpos
, int to_x
,
7543 enum move_operation_enum op
)
7545 enum move_it_result result
= MOVE_UNDEFINED
;
7546 struct glyph_row
*saved_glyph_row
;
7547 struct it wrap_it
, atpos_it
, atx_it
;
7548 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7550 enum it_method prev_method
= it
->method
;
7551 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7552 int saw_smaller_pos
= prev_pos
< to_charpos
;
7554 /* Don't produce glyphs in produce_glyphs. */
7555 saved_glyph_row
= it
->glyph_row
;
7556 it
->glyph_row
= NULL
;
7558 /* Use wrap_it to save a copy of IT wherever a word wrap could
7559 occur. Use atpos_it to save a copy of IT at the desired buffer
7560 position, if found, so that we can scan ahead and check if the
7561 word later overshoots the window edge. Use atx_it similarly, for
7567 #define BUFFER_POS_REACHED_P() \
7568 ((op & MOVE_TO_POS) != 0 \
7569 && BUFFERP (it->object) \
7570 && (IT_CHARPOS (*it) == to_charpos \
7571 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7572 && (it->method == GET_FROM_BUFFER \
7573 || (it->method == GET_FROM_DISPLAY_VECTOR \
7574 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7576 /* If there's a line-/wrap-prefix, handle it. */
7577 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7578 && it
->current_y
< it
->last_visible_y
)
7579 handle_line_prefix (it
);
7581 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7582 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7586 int x
, i
, ascent
= 0, descent
= 0;
7588 /* Utility macro to reset an iterator with x, ascent, and descent. */
7589 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7590 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7591 (IT)->max_descent = descent)
7593 /* Stop if we move beyond TO_CHARPOS (after an image or a
7594 display string or stretch glyph). */
7595 if ((op
& MOVE_TO_POS
) != 0
7596 && BUFFERP (it
->object
)
7597 && it
->method
== GET_FROM_BUFFER
7598 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7600 && (prev_method
== GET_FROM_IMAGE
7601 || prev_method
== GET_FROM_STRETCH
7602 || prev_method
== GET_FROM_STRING
)
7603 /* Passed TO_CHARPOS from left to right. */
7604 && ((prev_pos
< to_charpos
7605 && IT_CHARPOS (*it
) > to_charpos
)
7606 /* Passed TO_CHARPOS from right to left. */
7607 || (prev_pos
> to_charpos
7608 && IT_CHARPOS (*it
) < to_charpos
)))))
7610 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7612 result
= MOVE_POS_MATCH_OR_ZV
;
7615 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7616 /* If wrap_it is valid, the current position might be in a
7617 word that is wrapped. So, save the iterator in
7618 atpos_it and continue to see if wrapping happens. */
7619 SAVE_IT (atpos_it
, *it
, atpos_data
);
7622 /* Stop when ZV reached.
7623 We used to stop here when TO_CHARPOS reached as well, but that is
7624 too soon if this glyph does not fit on this line. So we handle it
7625 explicitly below. */
7626 if (!get_next_display_element (it
))
7628 result
= MOVE_POS_MATCH_OR_ZV
;
7632 if (it
->line_wrap
== TRUNCATE
)
7634 if (BUFFER_POS_REACHED_P ())
7636 result
= MOVE_POS_MATCH_OR_ZV
;
7642 if (it
->line_wrap
== WORD_WRAP
)
7644 if (IT_DISPLAYING_WHITESPACE (it
))
7648 /* We have reached a glyph that follows one or more
7649 whitespace characters. If the position is
7650 already found, we are done. */
7651 if (atpos_it
.sp
>= 0)
7653 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7654 result
= MOVE_POS_MATCH_OR_ZV
;
7659 RESTORE_IT (it
, &atx_it
, atx_data
);
7660 result
= MOVE_X_REACHED
;
7663 /* Otherwise, we can wrap here. */
7664 SAVE_IT (wrap_it
, *it
, wrap_data
);
7670 /* Remember the line height for the current line, in case
7671 the next element doesn't fit on the line. */
7672 ascent
= it
->max_ascent
;
7673 descent
= it
->max_descent
;
7675 /* The call to produce_glyphs will get the metrics of the
7676 display element IT is loaded with. Record the x-position
7677 before this display element, in case it doesn't fit on the
7681 PRODUCE_GLYPHS (it
);
7683 if (it
->area
!= TEXT_AREA
)
7685 prev_method
= it
->method
;
7686 if (it
->method
== GET_FROM_BUFFER
)
7687 prev_pos
= IT_CHARPOS (*it
);
7688 set_iterator_to_next (it
, 1);
7689 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7690 SET_TEXT_POS (this_line_min_pos
,
7691 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7695 /* The number of glyphs we get back in IT->nglyphs will normally
7696 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7697 character on a terminal frame, or (iii) a line end. For the
7698 second case, IT->nglyphs - 1 padding glyphs will be present.
7699 (On X frames, there is only one glyph produced for a
7700 composite character.)
7702 The behavior implemented below means, for continuation lines,
7703 that as many spaces of a TAB as fit on the current line are
7704 displayed there. For terminal frames, as many glyphs of a
7705 multi-glyph character are displayed in the current line, too.
7706 This is what the old redisplay code did, and we keep it that
7707 way. Under X, the whole shape of a complex character must
7708 fit on the line or it will be completely displayed in the
7711 Note that both for tabs and padding glyphs, all glyphs have
7715 /* More than one glyph or glyph doesn't fit on line. All
7716 glyphs have the same width. */
7717 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7719 int x_before_this_char
= x
;
7720 int hpos_before_this_char
= it
->hpos
;
7722 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7724 new_x
= x
+ single_glyph_width
;
7726 /* We want to leave anything reaching TO_X to the caller. */
7727 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7729 if (BUFFER_POS_REACHED_P ())
7731 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7732 goto buffer_pos_reached
;
7733 if (atpos_it
.sp
< 0)
7735 SAVE_IT (atpos_it
, *it
, atpos_data
);
7736 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7741 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7744 result
= MOVE_X_REACHED
;
7749 SAVE_IT (atx_it
, *it
, atx_data
);
7750 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7755 if (/* Lines are continued. */
7756 it
->line_wrap
!= TRUNCATE
7757 && (/* And glyph doesn't fit on the line. */
7758 new_x
> it
->last_visible_x
7759 /* Or it fits exactly and we're on a window
7761 || (new_x
== it
->last_visible_x
7762 && FRAME_WINDOW_P (it
->f
))))
7764 if (/* IT->hpos == 0 means the very first glyph
7765 doesn't fit on the line, e.g. a wide image. */
7767 || (new_x
== it
->last_visible_x
7768 && FRAME_WINDOW_P (it
->f
)))
7771 it
->current_x
= new_x
;
7773 /* The character's last glyph just barely fits
7775 if (i
== it
->nglyphs
- 1)
7777 /* If this is the destination position,
7778 return a position *before* it in this row,
7779 now that we know it fits in this row. */
7780 if (BUFFER_POS_REACHED_P ())
7782 if (it
->line_wrap
!= WORD_WRAP
7785 it
->hpos
= hpos_before_this_char
;
7786 it
->current_x
= x_before_this_char
;
7787 result
= MOVE_POS_MATCH_OR_ZV
;
7790 if (it
->line_wrap
== WORD_WRAP
7793 SAVE_IT (atpos_it
, *it
, atpos_data
);
7794 atpos_it
.current_x
= x_before_this_char
;
7795 atpos_it
.hpos
= hpos_before_this_char
;
7799 prev_method
= it
->method
;
7800 if (it
->method
== GET_FROM_BUFFER
)
7801 prev_pos
= IT_CHARPOS (*it
);
7802 set_iterator_to_next (it
, 1);
7803 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7804 SET_TEXT_POS (this_line_min_pos
,
7805 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7806 /* On graphical terminals, newlines may
7807 "overflow" into the fringe if
7808 overflow-newline-into-fringe is non-nil.
7809 On text-only terminals, newlines may
7810 overflow into the last glyph on the
7812 if (!FRAME_WINDOW_P (it
->f
)
7813 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7815 if (!get_next_display_element (it
))
7817 result
= MOVE_POS_MATCH_OR_ZV
;
7820 if (BUFFER_POS_REACHED_P ())
7822 if (ITERATOR_AT_END_OF_LINE_P (it
))
7823 result
= MOVE_POS_MATCH_OR_ZV
;
7825 result
= MOVE_LINE_CONTINUED
;
7828 if (ITERATOR_AT_END_OF_LINE_P (it
))
7830 result
= MOVE_NEWLINE_OR_CR
;
7837 IT_RESET_X_ASCENT_DESCENT (it
);
7839 if (wrap_it
.sp
>= 0)
7841 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7846 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7848 result
= MOVE_LINE_CONTINUED
;
7852 if (BUFFER_POS_REACHED_P ())
7854 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7855 goto buffer_pos_reached
;
7856 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7858 SAVE_IT (atpos_it
, *it
, atpos_data
);
7859 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7863 if (new_x
> it
->first_visible_x
)
7865 /* Glyph is visible. Increment number of glyphs that
7866 would be displayed. */
7871 if (result
!= MOVE_UNDEFINED
)
7874 else if (BUFFER_POS_REACHED_P ())
7877 IT_RESET_X_ASCENT_DESCENT (it
);
7878 result
= MOVE_POS_MATCH_OR_ZV
;
7881 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7883 /* Stop when TO_X specified and reached. This check is
7884 necessary here because of lines consisting of a line end,
7885 only. The line end will not produce any glyphs and we
7886 would never get MOVE_X_REACHED. */
7887 xassert (it
->nglyphs
== 0);
7888 result
= MOVE_X_REACHED
;
7892 /* Is this a line end? If yes, we're done. */
7893 if (ITERATOR_AT_END_OF_LINE_P (it
))
7895 /* If we are past TO_CHARPOS, but never saw any character
7896 positions smaller than TO_CHARPOS, return
7897 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
7899 if ((op
& MOVE_TO_POS
) != 0
7901 && IT_CHARPOS (*it
) > to_charpos
)
7902 result
= MOVE_POS_MATCH_OR_ZV
;
7904 result
= MOVE_NEWLINE_OR_CR
;
7908 prev_method
= it
->method
;
7909 if (it
->method
== GET_FROM_BUFFER
)
7910 prev_pos
= IT_CHARPOS (*it
);
7911 /* The current display element has been consumed. Advance
7913 set_iterator_to_next (it
, 1);
7914 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7915 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7916 if (IT_CHARPOS (*it
) < to_charpos
)
7917 saw_smaller_pos
= 1;
7919 /* Stop if lines are truncated and IT's current x-position is
7920 past the right edge of the window now. */
7921 if (it
->line_wrap
== TRUNCATE
7922 && it
->current_x
>= it
->last_visible_x
)
7924 if (!FRAME_WINDOW_P (it
->f
)
7925 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7927 if (!get_next_display_element (it
)
7928 || BUFFER_POS_REACHED_P ()
7929 /* If we are past TO_CHARPOS, but never saw any
7930 character positions smaller than TO_CHARPOS,
7931 return MOVE_POS_MATCH_OR_ZV, like the
7932 unidirectional display did. */
7933 || ((op
& MOVE_TO_POS
) != 0
7935 && IT_CHARPOS (*it
) > to_charpos
))
7937 result
= MOVE_POS_MATCH_OR_ZV
;
7940 if (ITERATOR_AT_END_OF_LINE_P (it
))
7942 result
= MOVE_NEWLINE_OR_CR
;
7946 else if ((op
& MOVE_TO_POS
) != 0
7948 && IT_CHARPOS (*it
) > to_charpos
)
7950 result
= MOVE_POS_MATCH_OR_ZV
;
7953 result
= MOVE_LINE_TRUNCATED
;
7956 #undef IT_RESET_X_ASCENT_DESCENT
7959 #undef BUFFER_POS_REACHED_P
7961 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7962 restore the saved iterator. */
7963 if (atpos_it
.sp
>= 0)
7964 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7965 else if (atx_it
.sp
>= 0)
7966 RESTORE_IT (it
, &atx_it
, atx_data
);
7977 /* Restore the iterator settings altered at the beginning of this
7979 it
->glyph_row
= saved_glyph_row
;
7983 /* For external use. */
7985 move_it_in_display_line (struct it
*it
,
7986 EMACS_INT to_charpos
, int to_x
,
7987 enum move_operation_enum op
)
7989 if (it
->line_wrap
== WORD_WRAP
7990 && (op
& MOVE_TO_X
))
7993 void *save_data
= NULL
;
7996 SAVE_IT (save_it
, *it
, save_data
);
7997 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7998 /* When word-wrap is on, TO_X may lie past the end
7999 of a wrapped line. Then it->current is the
8000 character on the next line, so backtrack to the
8001 space before the wrap point. */
8002 if (skip
== MOVE_LINE_CONTINUED
)
8004 int prev_x
= max (it
->current_x
- 1, 0);
8005 RESTORE_IT (it
, &save_it
, save_data
);
8006 move_it_in_display_line_to
8007 (it
, -1, prev_x
, MOVE_TO_X
);
8013 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8017 /* Move IT forward until it satisfies one or more of the criteria in
8018 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8020 OP is a bit-mask that specifies where to stop, and in particular,
8021 which of those four position arguments makes a difference. See the
8022 description of enum move_operation_enum.
8024 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8025 screen line, this function will set IT to the next position that is
8026 displayed to the right of TO_CHARPOS on the screen. */
8029 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8031 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8032 int line_height
, line_start_x
= 0, reached
= 0;
8033 void *backup_data
= NULL
;
8037 if (op
& MOVE_TO_VPOS
)
8039 /* If no TO_CHARPOS and no TO_X specified, stop at the
8040 start of the line TO_VPOS. */
8041 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8043 if (it
->vpos
== to_vpos
)
8049 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8053 /* TO_VPOS >= 0 means stop at TO_X in the line at
8054 TO_VPOS, or at TO_POS, whichever comes first. */
8055 if (it
->vpos
== to_vpos
)
8061 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8063 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8068 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8070 /* We have reached TO_X but not in the line we want. */
8071 skip
= move_it_in_display_line_to (it
, to_charpos
,
8073 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8081 else if (op
& MOVE_TO_Y
)
8083 struct it it_backup
;
8085 if (it
->line_wrap
== WORD_WRAP
)
8086 SAVE_IT (it_backup
, *it
, backup_data
);
8088 /* TO_Y specified means stop at TO_X in the line containing
8089 TO_Y---or at TO_CHARPOS if this is reached first. The
8090 problem is that we can't really tell whether the line
8091 contains TO_Y before we have completely scanned it, and
8092 this may skip past TO_X. What we do is to first scan to
8095 If TO_X is not specified, use a TO_X of zero. The reason
8096 is to make the outcome of this function more predictable.
8097 If we didn't use TO_X == 0, we would stop at the end of
8098 the line which is probably not what a caller would expect
8100 skip
= move_it_in_display_line_to
8101 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8102 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8104 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8105 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8107 else if (skip
== MOVE_X_REACHED
)
8109 /* If TO_X was reached, we want to know whether TO_Y is
8110 in the line. We know this is the case if the already
8111 scanned glyphs make the line tall enough. Otherwise,
8112 we must check by scanning the rest of the line. */
8113 line_height
= it
->max_ascent
+ it
->max_descent
;
8114 if (to_y
>= it
->current_y
8115 && to_y
< it
->current_y
+ line_height
)
8120 SAVE_IT (it_backup
, *it
, backup_data
);
8121 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8122 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8124 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8125 line_height
= it
->max_ascent
+ it
->max_descent
;
8126 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8128 if (to_y
>= it
->current_y
8129 && to_y
< it
->current_y
+ line_height
)
8131 /* If TO_Y is in this line and TO_X was reached
8132 above, we scanned too far. We have to restore
8133 IT's settings to the ones before skipping. */
8134 RESTORE_IT (it
, &it_backup
, backup_data
);
8140 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8146 /* Check whether TO_Y is in this line. */
8147 line_height
= it
->max_ascent
+ it
->max_descent
;
8148 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8150 if (to_y
>= it
->current_y
8151 && to_y
< it
->current_y
+ line_height
)
8153 /* When word-wrap is on, TO_X may lie past the end
8154 of a wrapped line. Then it->current is the
8155 character on the next line, so backtrack to the
8156 space before the wrap point. */
8157 if (skip
== MOVE_LINE_CONTINUED
8158 && it
->line_wrap
== WORD_WRAP
)
8160 int prev_x
= max (it
->current_x
- 1, 0);
8161 RESTORE_IT (it
, &it_backup
, backup_data
);
8162 skip
= move_it_in_display_line_to
8163 (it
, -1, prev_x
, MOVE_TO_X
);
8172 else if (BUFFERP (it
->object
)
8173 && (it
->method
== GET_FROM_BUFFER
8174 || it
->method
== GET_FROM_STRETCH
)
8175 && IT_CHARPOS (*it
) >= to_charpos
)
8176 skip
= MOVE_POS_MATCH_OR_ZV
;
8178 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8182 case MOVE_POS_MATCH_OR_ZV
:
8186 case MOVE_NEWLINE_OR_CR
:
8187 set_iterator_to_next (it
, 1);
8188 it
->continuation_lines_width
= 0;
8191 case MOVE_LINE_TRUNCATED
:
8192 it
->continuation_lines_width
= 0;
8193 reseat_at_next_visible_line_start (it
, 0);
8194 if ((op
& MOVE_TO_POS
) != 0
8195 && IT_CHARPOS (*it
) > to_charpos
)
8202 case MOVE_LINE_CONTINUED
:
8203 /* For continued lines ending in a tab, some of the glyphs
8204 associated with the tab are displayed on the current
8205 line. Since it->current_x does not include these glyphs,
8206 we use it->last_visible_x instead. */
8209 it
->continuation_lines_width
+= it
->last_visible_x
;
8210 /* When moving by vpos, ensure that the iterator really
8211 advances to the next line (bug#847, bug#969). Fixme:
8212 do we need to do this in other circumstances? */
8213 if (it
->current_x
!= it
->last_visible_x
8214 && (op
& MOVE_TO_VPOS
)
8215 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8217 line_start_x
= it
->current_x
+ it
->pixel_width
8218 - it
->last_visible_x
;
8219 set_iterator_to_next (it
, 0);
8223 it
->continuation_lines_width
+= it
->current_x
;
8230 /* Reset/increment for the next run. */
8231 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8232 it
->current_x
= line_start_x
;
8235 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8237 last_height
= it
->max_ascent
+ it
->max_descent
;
8238 last_max_ascent
= it
->max_ascent
;
8239 it
->max_ascent
= it
->max_descent
= 0;
8244 /* On text terminals, we may stop at the end of a line in the middle
8245 of a multi-character glyph. If the glyph itself is continued,
8246 i.e. it is actually displayed on the next line, don't treat this
8247 stopping point as valid; move to the next line instead (unless
8248 that brings us offscreen). */
8249 if (!FRAME_WINDOW_P (it
->f
)
8251 && IT_CHARPOS (*it
) == to_charpos
8252 && it
->what
== IT_CHARACTER
8254 && it
->line_wrap
== WINDOW_WRAP
8255 && it
->current_x
== it
->last_visible_x
- 1
8258 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8260 it
->continuation_lines_width
+= it
->current_x
;
8261 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8262 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8264 last_height
= it
->max_ascent
+ it
->max_descent
;
8265 last_max_ascent
= it
->max_ascent
;
8269 xfree (backup_data
);
8271 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8275 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8277 If DY > 0, move IT backward at least that many pixels. DY = 0
8278 means move IT backward to the preceding line start or BEGV. This
8279 function may move over more than DY pixels if IT->current_y - DY
8280 ends up in the middle of a line; in this case IT->current_y will be
8281 set to the top of the line moved to. */
8284 move_it_vertically_backward (struct it
*it
, int dy
)
8288 void *it2data
= NULL
, *it3data
= NULL
;
8289 EMACS_INT start_pos
;
8294 start_pos
= IT_CHARPOS (*it
);
8296 /* Estimate how many newlines we must move back. */
8297 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8299 /* Set the iterator's position that many lines back. */
8300 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8301 back_to_previous_visible_line_start (it
);
8303 /* Reseat the iterator here. When moving backward, we don't want
8304 reseat to skip forward over invisible text, set up the iterator
8305 to deliver from overlay strings at the new position etc. So,
8306 use reseat_1 here. */
8307 reseat_1 (it
, it
->current
.pos
, 1);
8309 /* We are now surely at a line start. */
8310 it
->current_x
= it
->hpos
= 0;
8311 it
->continuation_lines_width
= 0;
8313 /* Move forward and see what y-distance we moved. First move to the
8314 start of the next line so that we get its height. We need this
8315 height to be able to tell whether we reached the specified
8317 SAVE_IT (it2
, *it
, it2data
);
8318 it2
.max_ascent
= it2
.max_descent
= 0;
8321 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8322 MOVE_TO_POS
| MOVE_TO_VPOS
);
8324 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8325 xassert (IT_CHARPOS (*it
) >= BEGV
);
8326 SAVE_IT (it3
, it2
, it3data
);
8328 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8329 xassert (IT_CHARPOS (*it
) >= BEGV
);
8330 /* H is the actual vertical distance from the position in *IT
8331 and the starting position. */
8332 h
= it2
.current_y
- it
->current_y
;
8333 /* NLINES is the distance in number of lines. */
8334 nlines
= it2
.vpos
- it
->vpos
;
8336 /* Correct IT's y and vpos position
8337 so that they are relative to the starting point. */
8343 /* DY == 0 means move to the start of the screen line. The
8344 value of nlines is > 0 if continuation lines were involved. */
8345 RESTORE_IT (it
, it
, it2data
);
8347 move_it_by_lines (it
, nlines
);
8352 /* The y-position we try to reach, relative to *IT.
8353 Note that H has been subtracted in front of the if-statement. */
8354 int target_y
= it
->current_y
+ h
- dy
;
8355 int y0
= it3
.current_y
;
8359 RESTORE_IT (&it3
, &it3
, it3data
);
8360 y1
= line_bottom_y (&it3
);
8361 line_height
= y1
- y0
;
8362 RESTORE_IT (it
, it
, it2data
);
8363 /* If we did not reach target_y, try to move further backward if
8364 we can. If we moved too far backward, try to move forward. */
8365 if (target_y
< it
->current_y
8366 /* This is heuristic. In a window that's 3 lines high, with
8367 a line height of 13 pixels each, recentering with point
8368 on the bottom line will try to move -39/2 = 19 pixels
8369 backward. Try to avoid moving into the first line. */
8370 && (it
->current_y
- target_y
8371 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8372 && IT_CHARPOS (*it
) > BEGV
)
8374 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8375 target_y
- it
->current_y
));
8376 dy
= it
->current_y
- target_y
;
8377 goto move_further_back
;
8379 else if (target_y
>= it
->current_y
+ line_height
8380 && IT_CHARPOS (*it
) < ZV
)
8382 /* Should move forward by at least one line, maybe more.
8384 Note: Calling move_it_by_lines can be expensive on
8385 terminal frames, where compute_motion is used (via
8386 vmotion) to do the job, when there are very long lines
8387 and truncate-lines is nil. That's the reason for
8388 treating terminal frames specially here. */
8390 if (!FRAME_WINDOW_P (it
->f
))
8391 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8396 move_it_by_lines (it
, 1);
8398 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8405 /* Move IT by a specified amount of pixel lines DY. DY negative means
8406 move backwards. DY = 0 means move to start of screen line. At the
8407 end, IT will be on the start of a screen line. */
8410 move_it_vertically (struct it
*it
, int dy
)
8413 move_it_vertically_backward (it
, -dy
);
8416 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8417 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8418 MOVE_TO_POS
| MOVE_TO_Y
);
8419 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8421 /* If buffer ends in ZV without a newline, move to the start of
8422 the line to satisfy the post-condition. */
8423 if (IT_CHARPOS (*it
) == ZV
8425 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8426 move_it_by_lines (it
, 0);
8431 /* Move iterator IT past the end of the text line it is in. */
8434 move_it_past_eol (struct it
*it
)
8436 enum move_it_result rc
;
8438 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8439 if (rc
== MOVE_NEWLINE_OR_CR
)
8440 set_iterator_to_next (it
, 0);
8444 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8445 negative means move up. DVPOS == 0 means move to the start of the
8448 Optimization idea: If we would know that IT->f doesn't use
8449 a face with proportional font, we could be faster for
8450 truncate-lines nil. */
8453 move_it_by_lines (struct it
*it
, int dvpos
)
8456 /* The commented-out optimization uses vmotion on terminals. This
8457 gives bad results, because elements like it->what, on which
8458 callers such as pos_visible_p rely, aren't updated. */
8459 /* struct position pos;
8460 if (!FRAME_WINDOW_P (it->f))
8462 struct text_pos textpos;
8464 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8465 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8466 reseat (it, textpos, 1);
8467 it->vpos += pos.vpos;
8468 it->current_y += pos.vpos;
8474 /* DVPOS == 0 means move to the start of the screen line. */
8475 move_it_vertically_backward (it
, 0);
8476 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8477 /* Let next call to line_bottom_y calculate real line height */
8482 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8483 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8484 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8489 void *it2data
= NULL
;
8490 EMACS_INT start_charpos
, i
;
8492 /* Start at the beginning of the screen line containing IT's
8493 position. This may actually move vertically backwards,
8494 in case of overlays, so adjust dvpos accordingly. */
8496 move_it_vertically_backward (it
, 0);
8499 /* Go back -DVPOS visible lines and reseat the iterator there. */
8500 start_charpos
= IT_CHARPOS (*it
);
8501 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8502 back_to_previous_visible_line_start (it
);
8503 reseat (it
, it
->current
.pos
, 1);
8505 /* Move further back if we end up in a string or an image. */
8506 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8508 /* First try to move to start of display line. */
8510 move_it_vertically_backward (it
, 0);
8512 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8514 /* If start of line is still in string or image,
8515 move further back. */
8516 back_to_previous_visible_line_start (it
);
8517 reseat (it
, it
->current
.pos
, 1);
8521 it
->current_x
= it
->hpos
= 0;
8523 /* Above call may have moved too far if continuation lines
8524 are involved. Scan forward and see if it did. */
8525 SAVE_IT (it2
, *it
, it2data
);
8526 it2
.vpos
= it2
.current_y
= 0;
8527 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8528 it
->vpos
-= it2
.vpos
;
8529 it
->current_y
-= it2
.current_y
;
8530 it
->current_x
= it
->hpos
= 0;
8532 /* If we moved too far back, move IT some lines forward. */
8533 if (it2
.vpos
> -dvpos
)
8535 int delta
= it2
.vpos
+ dvpos
;
8537 RESTORE_IT (&it2
, &it2
, it2data
);
8538 SAVE_IT (it2
, *it
, it2data
);
8539 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8540 /* Move back again if we got too far ahead. */
8541 if (IT_CHARPOS (*it
) >= start_charpos
)
8542 RESTORE_IT (it
, &it2
, it2data
);
8547 RESTORE_IT (it
, it
, it2data
);
8551 /* Return 1 if IT points into the middle of a display vector. */
8554 in_display_vector_p (struct it
*it
)
8556 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8557 && it
->current
.dpvec_index
> 0
8558 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8562 /***********************************************************************
8564 ***********************************************************************/
8567 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8571 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8573 Lisp_Object args
[3];
8574 Lisp_Object msg
, fmt
;
8577 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8580 /* Do nothing if called asynchronously. Inserting text into
8581 a buffer may call after-change-functions and alike and
8582 that would means running Lisp asynchronously. */
8583 if (handling_signal
)
8587 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8589 args
[0] = fmt
= build_string (format
);
8592 msg
= Fformat (3, args
);
8594 len
= SBYTES (msg
) + 1;
8595 SAFE_ALLOCA (buffer
, char *, len
);
8596 memcpy (buffer
, SDATA (msg
), len
);
8598 message_dolog (buffer
, len
- 1, 1, 0);
8605 /* Output a newline in the *Messages* buffer if "needs" one. */
8608 message_log_maybe_newline (void)
8610 if (message_log_need_newline
)
8611 message_dolog ("", 0, 1, 0);
8615 /* Add a string M of length NBYTES to the message log, optionally
8616 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8617 nonzero, means interpret the contents of M as multibyte. This
8618 function calls low-level routines in order to bypass text property
8619 hooks, etc. which might not be safe to run.
8621 This may GC (insert may run before/after change hooks),
8622 so the buffer M must NOT point to a Lisp string. */
8625 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8627 const unsigned char *msg
= (const unsigned char *) m
;
8629 if (!NILP (Vmemory_full
))
8632 if (!NILP (Vmessage_log_max
))
8634 struct buffer
*oldbuf
;
8635 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8636 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8637 EMACS_INT point_at_end
= 0;
8638 EMACS_INT zv_at_end
= 0;
8639 Lisp_Object old_deactivate_mark
, tem
;
8640 struct gcpro gcpro1
;
8642 old_deactivate_mark
= Vdeactivate_mark
;
8643 oldbuf
= current_buffer
;
8644 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8645 BVAR (current_buffer
, undo_list
) = Qt
;
8647 oldpoint
= message_dolog_marker1
;
8648 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8649 oldbegv
= message_dolog_marker2
;
8650 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8651 oldzv
= message_dolog_marker3
;
8652 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8653 GCPRO1 (old_deactivate_mark
);
8661 BEGV_BYTE
= BEG_BYTE
;
8664 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8666 /* Insert the string--maybe converting multibyte to single byte
8667 or vice versa, so that all the text fits the buffer. */
8669 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8675 /* Convert a multibyte string to single-byte
8676 for the *Message* buffer. */
8677 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8679 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8680 work
[0] = (ASCII_CHAR_P (c
)
8682 : multibyte_char_to_unibyte (c
));
8683 insert_1_both (work
, 1, 1, 1, 0, 0);
8686 else if (! multibyte
8687 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8691 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8692 /* Convert a single-byte string to multibyte
8693 for the *Message* buffer. */
8694 for (i
= 0; i
< nbytes
; i
++)
8697 MAKE_CHAR_MULTIBYTE (c
);
8698 char_bytes
= CHAR_STRING (c
, str
);
8699 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8703 insert_1 (m
, nbytes
, 1, 0, 0);
8707 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8709 insert_1 ("\n", 1, 1, 0, 0);
8711 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8713 this_bol_byte
= PT_BYTE
;
8715 /* See if this line duplicates the previous one.
8716 If so, combine duplicates. */
8719 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8721 prev_bol_byte
= PT_BYTE
;
8723 dups
= message_log_check_duplicate (prev_bol_byte
,
8727 del_range_both (prev_bol
, prev_bol_byte
,
8728 this_bol
, this_bol_byte
, 0);
8731 char dupstr
[sizeof " [ times]"
8732 + INT_STRLEN_BOUND (printmax_t
)];
8735 /* If you change this format, don't forget to also
8736 change message_log_check_duplicate. */
8737 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8738 duplen
= strlen (dupstr
);
8739 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8740 insert_1 (dupstr
, duplen
, 1, 0, 1);
8745 /* If we have more than the desired maximum number of lines
8746 in the *Messages* buffer now, delete the oldest ones.
8747 This is safe because we don't have undo in this buffer. */
8749 if (NATNUMP (Vmessage_log_max
))
8751 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8752 -XFASTINT (Vmessage_log_max
) - 1, 0);
8753 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8756 BEGV
= XMARKER (oldbegv
)->charpos
;
8757 BEGV_BYTE
= marker_byte_position (oldbegv
);
8766 ZV
= XMARKER (oldzv
)->charpos
;
8767 ZV_BYTE
= marker_byte_position (oldzv
);
8771 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8773 /* We can't do Fgoto_char (oldpoint) because it will run some
8775 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8776 XMARKER (oldpoint
)->bytepos
);
8779 unchain_marker (XMARKER (oldpoint
));
8780 unchain_marker (XMARKER (oldbegv
));
8781 unchain_marker (XMARKER (oldzv
));
8783 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8784 set_buffer_internal (oldbuf
);
8786 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8787 message_log_need_newline
= !nlflag
;
8788 Vdeactivate_mark
= old_deactivate_mark
;
8793 /* We are at the end of the buffer after just having inserted a newline.
8794 (Note: We depend on the fact we won't be crossing the gap.)
8795 Check to see if the most recent message looks a lot like the previous one.
8796 Return 0 if different, 1 if the new one should just replace it, or a
8797 value N > 1 if we should also append " [N times]". */
8800 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8803 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8805 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8806 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8808 for (i
= 0; i
< len
; i
++)
8810 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8818 if (*p1
++ == ' ' && *p1
++ == '[')
8821 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8822 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8829 /* Display an echo area message M with a specified length of NBYTES
8830 bytes. The string may include null characters. If M is 0, clear
8831 out any existing message, and let the mini-buffer text show
8834 This may GC, so the buffer M must NOT point to a Lisp string. */
8837 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8839 /* First flush out any partial line written with print. */
8840 message_log_maybe_newline ();
8842 message_dolog (m
, nbytes
, 1, multibyte
);
8843 message2_nolog (m
, nbytes
, multibyte
);
8847 /* The non-logging counterpart of message2. */
8850 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8852 struct frame
*sf
= SELECTED_FRAME ();
8853 message_enable_multibyte
= multibyte
;
8855 if (FRAME_INITIAL_P (sf
))
8857 if (noninteractive_need_newline
)
8858 putc ('\n', stderr
);
8859 noninteractive_need_newline
= 0;
8861 fwrite (m
, nbytes
, 1, stderr
);
8862 if (cursor_in_echo_area
== 0)
8863 fprintf (stderr
, "\n");
8866 /* A null message buffer means that the frame hasn't really been
8867 initialized yet. Error messages get reported properly by
8868 cmd_error, so this must be just an informative message; toss it. */
8869 else if (INTERACTIVE
8870 && sf
->glyphs_initialized_p
8871 && FRAME_MESSAGE_BUF (sf
))
8873 Lisp_Object mini_window
;
8876 /* Get the frame containing the mini-buffer
8877 that the selected frame is using. */
8878 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8879 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8881 FRAME_SAMPLE_VISIBILITY (f
);
8882 if (FRAME_VISIBLE_P (sf
)
8883 && ! FRAME_VISIBLE_P (f
))
8884 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8888 set_message (m
, Qnil
, nbytes
, multibyte
);
8889 if (minibuffer_auto_raise
)
8890 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8893 clear_message (1, 1);
8895 do_pending_window_change (0);
8896 echo_area_display (1);
8897 do_pending_window_change (0);
8898 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8899 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8904 /* Display an echo area message M with a specified length of NBYTES
8905 bytes. The string may include null characters. If M is not a
8906 string, clear out any existing message, and let the mini-buffer
8909 This function cancels echoing. */
8912 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8914 struct gcpro gcpro1
;
8917 clear_message (1,1);
8920 /* First flush out any partial line written with print. */
8921 message_log_maybe_newline ();
8927 SAFE_ALLOCA (buffer
, char *, nbytes
);
8928 memcpy (buffer
, SDATA (m
), nbytes
);
8929 message_dolog (buffer
, nbytes
, 1, multibyte
);
8932 message3_nolog (m
, nbytes
, multibyte
);
8938 /* The non-logging version of message3.
8939 This does not cancel echoing, because it is used for echoing.
8940 Perhaps we need to make a separate function for echoing
8941 and make this cancel echoing. */
8944 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8946 struct frame
*sf
= SELECTED_FRAME ();
8947 message_enable_multibyte
= multibyte
;
8949 if (FRAME_INITIAL_P (sf
))
8951 if (noninteractive_need_newline
)
8952 putc ('\n', stderr
);
8953 noninteractive_need_newline
= 0;
8955 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8956 if (cursor_in_echo_area
== 0)
8957 fprintf (stderr
, "\n");
8960 /* A null message buffer means that the frame hasn't really been
8961 initialized yet. Error messages get reported properly by
8962 cmd_error, so this must be just an informative message; toss it. */
8963 else if (INTERACTIVE
8964 && sf
->glyphs_initialized_p
8965 && FRAME_MESSAGE_BUF (sf
))
8967 Lisp_Object mini_window
;
8971 /* Get the frame containing the mini-buffer
8972 that the selected frame is using. */
8973 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8974 frame
= XWINDOW (mini_window
)->frame
;
8977 FRAME_SAMPLE_VISIBILITY (f
);
8978 if (FRAME_VISIBLE_P (sf
)
8979 && !FRAME_VISIBLE_P (f
))
8980 Fmake_frame_visible (frame
);
8982 if (STRINGP (m
) && SCHARS (m
) > 0)
8984 set_message (NULL
, m
, nbytes
, multibyte
);
8985 if (minibuffer_auto_raise
)
8986 Fraise_frame (frame
);
8987 /* Assume we are not echoing.
8988 (If we are, echo_now will override this.) */
8989 echo_message_buffer
= Qnil
;
8992 clear_message (1, 1);
8994 do_pending_window_change (0);
8995 echo_area_display (1);
8996 do_pending_window_change (0);
8997 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8998 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9003 /* Display a null-terminated echo area message M. If M is 0, clear
9004 out any existing message, and let the mini-buffer text show through.
9006 The buffer M must continue to exist until after the echo area gets
9007 cleared or some other message gets displayed there. Do not pass
9008 text that is stored in a Lisp string. Do not pass text in a buffer
9009 that was alloca'd. */
9012 message1 (const char *m
)
9014 message2 (m
, (m
? strlen (m
) : 0), 0);
9018 /* The non-logging counterpart of message1. */
9021 message1_nolog (const char *m
)
9023 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9026 /* Display a message M which contains a single %s
9027 which gets replaced with STRING. */
9030 message_with_string (const char *m
, Lisp_Object string
, int log
)
9032 CHECK_STRING (string
);
9038 if (noninteractive_need_newline
)
9039 putc ('\n', stderr
);
9040 noninteractive_need_newline
= 0;
9041 fprintf (stderr
, m
, SDATA (string
));
9042 if (!cursor_in_echo_area
)
9043 fprintf (stderr
, "\n");
9047 else if (INTERACTIVE
)
9049 /* The frame whose minibuffer we're going to display the message on.
9050 It may be larger than the selected frame, so we need
9051 to use its buffer, not the selected frame's buffer. */
9052 Lisp_Object mini_window
;
9053 struct frame
*f
, *sf
= SELECTED_FRAME ();
9055 /* Get the frame containing the minibuffer
9056 that the selected frame is using. */
9057 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9058 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9060 /* A null message buffer means that the frame hasn't really been
9061 initialized yet. Error messages get reported properly by
9062 cmd_error, so this must be just an informative message; toss it. */
9063 if (FRAME_MESSAGE_BUF (f
))
9065 Lisp_Object args
[2], msg
;
9066 struct gcpro gcpro1
, gcpro2
;
9068 args
[0] = build_string (m
);
9069 args
[1] = msg
= string
;
9070 GCPRO2 (args
[0], msg
);
9073 msg
= Fformat (2, args
);
9076 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9078 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9082 /* Print should start at the beginning of the message
9083 buffer next time. */
9084 message_buf_print
= 0;
9090 /* Dump an informative message to the minibuf. If M is 0, clear out
9091 any existing message, and let the mini-buffer text show through. */
9094 vmessage (const char *m
, va_list ap
)
9100 if (noninteractive_need_newline
)
9101 putc ('\n', stderr
);
9102 noninteractive_need_newline
= 0;
9103 vfprintf (stderr
, m
, ap
);
9104 if (cursor_in_echo_area
== 0)
9105 fprintf (stderr
, "\n");
9109 else if (INTERACTIVE
)
9111 /* The frame whose mini-buffer we're going to display the message
9112 on. It may be larger than the selected frame, so we need to
9113 use its buffer, not the selected frame's buffer. */
9114 Lisp_Object mini_window
;
9115 struct frame
*f
, *sf
= SELECTED_FRAME ();
9117 /* Get the frame containing the mini-buffer
9118 that the selected frame is using. */
9119 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9120 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9122 /* A null message buffer means that the frame hasn't really been
9123 initialized yet. Error messages get reported properly by
9124 cmd_error, so this must be just an informative message; toss
9126 if (FRAME_MESSAGE_BUF (f
))
9132 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9133 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9135 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9140 /* Print should start at the beginning of the message
9141 buffer next time. */
9142 message_buf_print
= 0;
9148 message (const char *m
, ...)
9158 /* The non-logging version of message. */
9161 message_nolog (const char *m
, ...)
9163 Lisp_Object old_log_max
;
9166 old_log_max
= Vmessage_log_max
;
9167 Vmessage_log_max
= Qnil
;
9169 Vmessage_log_max
= old_log_max
;
9175 /* Display the current message in the current mini-buffer. This is
9176 only called from error handlers in process.c, and is not time
9180 update_echo_area (void)
9182 if (!NILP (echo_area_buffer
[0]))
9185 string
= Fcurrent_message ();
9186 message3 (string
, SBYTES (string
),
9187 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9192 /* Make sure echo area buffers in `echo_buffers' are live.
9193 If they aren't, make new ones. */
9196 ensure_echo_area_buffers (void)
9200 for (i
= 0; i
< 2; ++i
)
9201 if (!BUFFERP (echo_buffer
[i
])
9202 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9205 Lisp_Object old_buffer
;
9208 old_buffer
= echo_buffer
[i
];
9209 sprintf (name
, " *Echo Area %d*", i
);
9210 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9211 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9212 /* to force word wrap in echo area -
9213 it was decided to postpone this*/
9214 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9216 for (j
= 0; j
< 2; ++j
)
9217 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9218 echo_area_buffer
[j
] = echo_buffer
[i
];
9223 /* Call FN with args A1..A4 with either the current or last displayed
9224 echo_area_buffer as current buffer.
9226 WHICH zero means use the current message buffer
9227 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9228 from echo_buffer[] and clear it.
9230 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9231 suitable buffer from echo_buffer[] and clear it.
9233 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9234 that the current message becomes the last displayed one, make
9235 choose a suitable buffer for echo_area_buffer[0], and clear it.
9237 Value is what FN returns. */
9240 with_echo_area_buffer (struct window
*w
, int which
,
9241 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9242 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9245 int this_one
, the_other
, clear_buffer_p
, rc
;
9246 int count
= SPECPDL_INDEX ();
9248 /* If buffers aren't live, make new ones. */
9249 ensure_echo_area_buffers ();
9254 this_one
= 0, the_other
= 1;
9256 this_one
= 1, the_other
= 0;
9259 this_one
= 0, the_other
= 1;
9262 /* We need a fresh one in case the current echo buffer equals
9263 the one containing the last displayed echo area message. */
9264 if (!NILP (echo_area_buffer
[this_one
])
9265 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9266 echo_area_buffer
[this_one
] = Qnil
;
9269 /* Choose a suitable buffer from echo_buffer[] is we don't
9271 if (NILP (echo_area_buffer
[this_one
]))
9273 echo_area_buffer
[this_one
]
9274 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9275 ? echo_buffer
[the_other
]
9276 : echo_buffer
[this_one
]);
9280 buffer
= echo_area_buffer
[this_one
];
9282 /* Don't get confused by reusing the buffer used for echoing
9283 for a different purpose. */
9284 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9287 record_unwind_protect (unwind_with_echo_area_buffer
,
9288 with_echo_area_buffer_unwind_data (w
));
9290 /* Make the echo area buffer current. Note that for display
9291 purposes, it is not necessary that the displayed window's buffer
9292 == current_buffer, except for text property lookup. So, let's
9293 only set that buffer temporarily here without doing a full
9294 Fset_window_buffer. We must also change w->pointm, though,
9295 because otherwise an assertions in unshow_buffer fails, and Emacs
9297 set_buffer_internal_1 (XBUFFER (buffer
));
9301 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9304 BVAR (current_buffer
, undo_list
) = Qt
;
9305 BVAR (current_buffer
, read_only
) = Qnil
;
9306 specbind (Qinhibit_read_only
, Qt
);
9307 specbind (Qinhibit_modification_hooks
, Qt
);
9309 if (clear_buffer_p
&& Z
> BEG
)
9312 xassert (BEGV
>= BEG
);
9313 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9315 rc
= fn (a1
, a2
, a3
, a4
);
9317 xassert (BEGV
>= BEG
);
9318 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9320 unbind_to (count
, Qnil
);
9325 /* Save state that should be preserved around the call to the function
9326 FN called in with_echo_area_buffer. */
9329 with_echo_area_buffer_unwind_data (struct window
*w
)
9332 Lisp_Object vector
, tmp
;
9334 /* Reduce consing by keeping one vector in
9335 Vwith_echo_area_save_vector. */
9336 vector
= Vwith_echo_area_save_vector
;
9337 Vwith_echo_area_save_vector
= Qnil
;
9340 vector
= Fmake_vector (make_number (7), Qnil
);
9342 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9343 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9344 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9348 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9349 ASET (vector
, i
, w
->buffer
); ++i
;
9350 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9351 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9356 for (; i
< end
; ++i
)
9357 ASET (vector
, i
, Qnil
);
9360 xassert (i
== ASIZE (vector
));
9365 /* Restore global state from VECTOR which was created by
9366 with_echo_area_buffer_unwind_data. */
9369 unwind_with_echo_area_buffer (Lisp_Object vector
)
9371 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9372 Vdeactivate_mark
= AREF (vector
, 1);
9373 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9375 if (WINDOWP (AREF (vector
, 3)))
9378 Lisp_Object buffer
, charpos
, bytepos
;
9380 w
= XWINDOW (AREF (vector
, 3));
9381 buffer
= AREF (vector
, 4);
9382 charpos
= AREF (vector
, 5);
9383 bytepos
= AREF (vector
, 6);
9386 set_marker_both (w
->pointm
, buffer
,
9387 XFASTINT (charpos
), XFASTINT (bytepos
));
9390 Vwith_echo_area_save_vector
= vector
;
9395 /* Set up the echo area for use by print functions. MULTIBYTE_P
9396 non-zero means we will print multibyte. */
9399 setup_echo_area_for_printing (int multibyte_p
)
9401 /* If we can't find an echo area any more, exit. */
9402 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9405 ensure_echo_area_buffers ();
9407 if (!message_buf_print
)
9409 /* A message has been output since the last time we printed.
9410 Choose a fresh echo area buffer. */
9411 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9412 echo_area_buffer
[0] = echo_buffer
[1];
9414 echo_area_buffer
[0] = echo_buffer
[0];
9416 /* Switch to that buffer and clear it. */
9417 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9418 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9422 int count
= SPECPDL_INDEX ();
9423 specbind (Qinhibit_read_only
, Qt
);
9424 /* Note that undo recording is always disabled. */
9426 unbind_to (count
, Qnil
);
9428 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9430 /* Set up the buffer for the multibyteness we need. */
9432 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9433 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9435 /* Raise the frame containing the echo area. */
9436 if (minibuffer_auto_raise
)
9438 struct frame
*sf
= SELECTED_FRAME ();
9439 Lisp_Object mini_window
;
9440 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9441 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9444 message_log_maybe_newline ();
9445 message_buf_print
= 1;
9449 if (NILP (echo_area_buffer
[0]))
9451 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9452 echo_area_buffer
[0] = echo_buffer
[1];
9454 echo_area_buffer
[0] = echo_buffer
[0];
9457 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9459 /* Someone switched buffers between print requests. */
9460 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9461 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9467 /* Display an echo area message in window W. Value is non-zero if W's
9468 height is changed. If display_last_displayed_message_p is
9469 non-zero, display the message that was last displayed, otherwise
9470 display the current message. */
9473 display_echo_area (struct window
*w
)
9475 int i
, no_message_p
, window_height_changed_p
, count
;
9477 /* Temporarily disable garbage collections while displaying the echo
9478 area. This is done because a GC can print a message itself.
9479 That message would modify the echo area buffer's contents while a
9480 redisplay of the buffer is going on, and seriously confuse
9482 count
= inhibit_garbage_collection ();
9484 /* If there is no message, we must call display_echo_area_1
9485 nevertheless because it resizes the window. But we will have to
9486 reset the echo_area_buffer in question to nil at the end because
9487 with_echo_area_buffer will sets it to an empty buffer. */
9488 i
= display_last_displayed_message_p
? 1 : 0;
9489 no_message_p
= NILP (echo_area_buffer
[i
]);
9491 window_height_changed_p
9492 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9493 display_echo_area_1
,
9494 (intptr_t) w
, Qnil
, 0, 0);
9497 echo_area_buffer
[i
] = Qnil
;
9499 unbind_to (count
, Qnil
);
9500 return window_height_changed_p
;
9504 /* Helper for display_echo_area. Display the current buffer which
9505 contains the current echo area message in window W, a mini-window,
9506 a pointer to which is passed in A1. A2..A4 are currently not used.
9507 Change the height of W so that all of the message is displayed.
9508 Value is non-zero if height of W was changed. */
9511 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9514 struct window
*w
= (struct window
*) i1
;
9516 struct text_pos start
;
9517 int window_height_changed_p
= 0;
9519 /* Do this before displaying, so that we have a large enough glyph
9520 matrix for the display. If we can't get enough space for the
9521 whole text, display the last N lines. That works by setting w->start. */
9522 window_height_changed_p
= resize_mini_window (w
, 0);
9524 /* Use the starting position chosen by resize_mini_window. */
9525 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9528 clear_glyph_matrix (w
->desired_matrix
);
9529 XSETWINDOW (window
, w
);
9530 try_window (window
, start
, 0);
9532 return window_height_changed_p
;
9536 /* Resize the echo area window to exactly the size needed for the
9537 currently displayed message, if there is one. If a mini-buffer
9538 is active, don't shrink it. */
9541 resize_echo_area_exactly (void)
9543 if (BUFFERP (echo_area_buffer
[0])
9544 && WINDOWP (echo_area_window
))
9546 struct window
*w
= XWINDOW (echo_area_window
);
9548 Lisp_Object resize_exactly
;
9550 if (minibuf_level
== 0)
9551 resize_exactly
= Qt
;
9553 resize_exactly
= Qnil
;
9555 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9556 (intptr_t) w
, resize_exactly
,
9560 ++windows_or_buffers_changed
;
9561 ++update_mode_lines
;
9562 redisplay_internal ();
9568 /* Callback function for with_echo_area_buffer, when used from
9569 resize_echo_area_exactly. A1 contains a pointer to the window to
9570 resize, EXACTLY non-nil means resize the mini-window exactly to the
9571 size of the text displayed. A3 and A4 are not used. Value is what
9572 resize_mini_window returns. */
9575 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9578 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9582 /* Resize mini-window W to fit the size of its contents. EXACT_P
9583 means size the window exactly to the size needed. Otherwise, it's
9584 only enlarged until W's buffer is empty.
9586 Set W->start to the right place to begin display. If the whole
9587 contents fit, start at the beginning. Otherwise, start so as
9588 to make the end of the contents appear. This is particularly
9589 important for y-or-n-p, but seems desirable generally.
9591 Value is non-zero if the window height has been changed. */
9594 resize_mini_window (struct window
*w
, int exact_p
)
9596 struct frame
*f
= XFRAME (w
->frame
);
9597 int window_height_changed_p
= 0;
9599 xassert (MINI_WINDOW_P (w
));
9601 /* By default, start display at the beginning. */
9602 set_marker_both (w
->start
, w
->buffer
,
9603 BUF_BEGV (XBUFFER (w
->buffer
)),
9604 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9606 /* Don't resize windows while redisplaying a window; it would
9607 confuse redisplay functions when the size of the window they are
9608 displaying changes from under them. Such a resizing can happen,
9609 for instance, when which-func prints a long message while
9610 we are running fontification-functions. We're running these
9611 functions with safe_call which binds inhibit-redisplay to t. */
9612 if (!NILP (Vinhibit_redisplay
))
9615 /* Nil means don't try to resize. */
9616 if (NILP (Vresize_mini_windows
)
9617 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9620 if (!FRAME_MINIBUF_ONLY_P (f
))
9623 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9624 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9625 int height
, max_height
;
9626 int unit
= FRAME_LINE_HEIGHT (f
);
9627 struct text_pos start
;
9628 struct buffer
*old_current_buffer
= NULL
;
9630 if (current_buffer
!= XBUFFER (w
->buffer
))
9632 old_current_buffer
= current_buffer
;
9633 set_buffer_internal (XBUFFER (w
->buffer
));
9636 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9638 /* Compute the max. number of lines specified by the user. */
9639 if (FLOATP (Vmax_mini_window_height
))
9640 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9641 else if (INTEGERP (Vmax_mini_window_height
))
9642 max_height
= XINT (Vmax_mini_window_height
);
9644 max_height
= total_height
/ 4;
9646 /* Correct that max. height if it's bogus. */
9647 max_height
= max (1, max_height
);
9648 max_height
= min (total_height
, max_height
);
9650 /* Find out the height of the text in the window. */
9651 if (it
.line_wrap
== TRUNCATE
)
9656 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9657 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9658 height
= it
.current_y
+ last_height
;
9660 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9661 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9662 height
= (height
+ unit
- 1) / unit
;
9665 /* Compute a suitable window start. */
9666 if (height
> max_height
)
9668 height
= max_height
;
9669 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9670 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9671 start
= it
.current
.pos
;
9674 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9675 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9677 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9679 /* Let it grow only, until we display an empty message, in which
9680 case the window shrinks again. */
9681 if (height
> WINDOW_TOTAL_LINES (w
))
9683 int old_height
= WINDOW_TOTAL_LINES (w
);
9684 freeze_window_starts (f
, 1);
9685 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9686 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9688 else if (height
< WINDOW_TOTAL_LINES (w
)
9689 && (exact_p
|| BEGV
== ZV
))
9691 int old_height
= WINDOW_TOTAL_LINES (w
);
9692 freeze_window_starts (f
, 0);
9693 shrink_mini_window (w
);
9694 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9699 /* Always resize to exact size needed. */
9700 if (height
> WINDOW_TOTAL_LINES (w
))
9702 int old_height
= WINDOW_TOTAL_LINES (w
);
9703 freeze_window_starts (f
, 1);
9704 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9705 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9707 else if (height
< WINDOW_TOTAL_LINES (w
))
9709 int old_height
= WINDOW_TOTAL_LINES (w
);
9710 freeze_window_starts (f
, 0);
9711 shrink_mini_window (w
);
9715 freeze_window_starts (f
, 1);
9716 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9719 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9723 if (old_current_buffer
)
9724 set_buffer_internal (old_current_buffer
);
9727 return window_height_changed_p
;
9731 /* Value is the current message, a string, or nil if there is no
9735 current_message (void)
9739 if (!BUFFERP (echo_area_buffer
[0]))
9743 with_echo_area_buffer (0, 0, current_message_1
,
9744 (intptr_t) &msg
, Qnil
, 0, 0);
9746 echo_area_buffer
[0] = Qnil
;
9754 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9757 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9760 *msg
= make_buffer_string (BEG
, Z
, 1);
9767 /* Push the current message on Vmessage_stack for later restauration
9768 by restore_message. Value is non-zero if the current message isn't
9769 empty. This is a relatively infrequent operation, so it's not
9770 worth optimizing. */
9776 msg
= current_message ();
9777 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9778 return STRINGP (msg
);
9782 /* Restore message display from the top of Vmessage_stack. */
9785 restore_message (void)
9789 xassert (CONSP (Vmessage_stack
));
9790 msg
= XCAR (Vmessage_stack
);
9792 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9794 message3_nolog (msg
, 0, 0);
9798 /* Handler for record_unwind_protect calling pop_message. */
9801 pop_message_unwind (Lisp_Object dummy
)
9807 /* Pop the top-most entry off Vmessage_stack. */
9812 xassert (CONSP (Vmessage_stack
));
9813 Vmessage_stack
= XCDR (Vmessage_stack
);
9817 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9818 exits. If the stack is not empty, we have a missing pop_message
9822 check_message_stack (void)
9824 if (!NILP (Vmessage_stack
))
9829 /* Truncate to NCHARS what will be displayed in the echo area the next
9830 time we display it---but don't redisplay it now. */
9833 truncate_echo_area (EMACS_INT nchars
)
9836 echo_area_buffer
[0] = Qnil
;
9837 /* A null message buffer means that the frame hasn't really been
9838 initialized yet. Error messages get reported properly by
9839 cmd_error, so this must be just an informative message; toss it. */
9840 else if (!noninteractive
9842 && !NILP (echo_area_buffer
[0]))
9844 struct frame
*sf
= SELECTED_FRAME ();
9845 if (FRAME_MESSAGE_BUF (sf
))
9846 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9851 /* Helper function for truncate_echo_area. Truncate the current
9852 message to at most NCHARS characters. */
9855 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9857 if (BEG
+ nchars
< Z
)
9858 del_range (BEG
+ nchars
, Z
);
9860 echo_area_buffer
[0] = Qnil
;
9865 /* Set the current message to a substring of S or STRING.
9867 If STRING is a Lisp string, set the message to the first NBYTES
9868 bytes from STRING. NBYTES zero means use the whole string. If
9869 STRING is multibyte, the message will be displayed multibyte.
9871 If S is not null, set the message to the first LEN bytes of S. LEN
9872 zero means use the whole string. MULTIBYTE_P non-zero means S is
9873 multibyte. Display the message multibyte in that case.
9875 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9876 to t before calling set_message_1 (which calls insert).
9880 set_message (const char *s
, Lisp_Object string
,
9881 EMACS_INT nbytes
, int multibyte_p
)
9883 message_enable_multibyte
9884 = ((s
&& multibyte_p
)
9885 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9887 with_echo_area_buffer (0, -1, set_message_1
,
9888 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9889 message_buf_print
= 0;
9890 help_echo_showing_p
= 0;
9894 /* Helper function for set_message. Arguments have the same meaning
9895 as there, with A1 corresponding to S and A2 corresponding to STRING
9896 This function is called with the echo area buffer being
9900 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9903 const char *s
= (const char *) i1
;
9904 const unsigned char *msg
= (const unsigned char *) s
;
9905 Lisp_Object string
= a2
;
9907 /* Change multibyteness of the echo buffer appropriately. */
9908 if (message_enable_multibyte
9909 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9910 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9912 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9913 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9914 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9916 /* Insert new message at BEG. */
9917 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9919 if (STRINGP (string
))
9924 nbytes
= SBYTES (string
);
9925 nchars
= string_byte_to_char (string
, nbytes
);
9927 /* This function takes care of single/multibyte conversion. We
9928 just have to ensure that the echo area buffer has the right
9929 setting of enable_multibyte_characters. */
9930 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9935 nbytes
= strlen (s
);
9937 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9939 /* Convert from multi-byte to single-byte. */
9944 /* Convert a multibyte string to single-byte. */
9945 for (i
= 0; i
< nbytes
; i
+= n
)
9947 c
= string_char_and_length (msg
+ i
, &n
);
9948 work
[0] = (ASCII_CHAR_P (c
)
9950 : multibyte_char_to_unibyte (c
));
9951 insert_1_both (work
, 1, 1, 1, 0, 0);
9954 else if (!multibyte_p
9955 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9957 /* Convert from single-byte to multi-byte. */
9960 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9962 /* Convert a single-byte string to multibyte. */
9963 for (i
= 0; i
< nbytes
; i
++)
9966 MAKE_CHAR_MULTIBYTE (c
);
9967 n
= CHAR_STRING (c
, str
);
9968 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9972 insert_1 (s
, nbytes
, 1, 0, 0);
9979 /* Clear messages. CURRENT_P non-zero means clear the current
9980 message. LAST_DISPLAYED_P non-zero means clear the message
9984 clear_message (int current_p
, int last_displayed_p
)
9988 echo_area_buffer
[0] = Qnil
;
9989 message_cleared_p
= 1;
9992 if (last_displayed_p
)
9993 echo_area_buffer
[1] = Qnil
;
9995 message_buf_print
= 0;
9998 /* Clear garbaged frames.
10000 This function is used where the old redisplay called
10001 redraw_garbaged_frames which in turn called redraw_frame which in
10002 turn called clear_frame. The call to clear_frame was a source of
10003 flickering. I believe a clear_frame is not necessary. It should
10004 suffice in the new redisplay to invalidate all current matrices,
10005 and ensure a complete redisplay of all windows. */
10008 clear_garbaged_frames (void)
10010 if (frame_garbaged
)
10012 Lisp_Object tail
, frame
;
10013 int changed_count
= 0;
10015 FOR_EACH_FRAME (tail
, frame
)
10017 struct frame
*f
= XFRAME (frame
);
10019 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10023 Fredraw_frame (frame
);
10024 f
->force_flush_display_p
= 1;
10026 clear_current_matrices (f
);
10033 frame_garbaged
= 0;
10035 ++windows_or_buffers_changed
;
10040 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10041 is non-zero update selected_frame. Value is non-zero if the
10042 mini-windows height has been changed. */
10045 echo_area_display (int update_frame_p
)
10047 Lisp_Object mini_window
;
10050 int window_height_changed_p
= 0;
10051 struct frame
*sf
= SELECTED_FRAME ();
10053 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10054 w
= XWINDOW (mini_window
);
10055 f
= XFRAME (WINDOW_FRAME (w
));
10057 /* Don't display if frame is invisible or not yet initialized. */
10058 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10061 #ifdef HAVE_WINDOW_SYSTEM
10062 /* When Emacs starts, selected_frame may be the initial terminal
10063 frame. If we let this through, a message would be displayed on
10065 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10067 #endif /* HAVE_WINDOW_SYSTEM */
10069 /* Redraw garbaged frames. */
10070 if (frame_garbaged
)
10071 clear_garbaged_frames ();
10073 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10075 echo_area_window
= mini_window
;
10076 window_height_changed_p
= display_echo_area (w
);
10077 w
->must_be_updated_p
= 1;
10079 /* Update the display, unless called from redisplay_internal.
10080 Also don't update the screen during redisplay itself. The
10081 update will happen at the end of redisplay, and an update
10082 here could cause confusion. */
10083 if (update_frame_p
&& !redisplaying_p
)
10087 /* If the display update has been interrupted by pending
10088 input, update mode lines in the frame. Due to the
10089 pending input, it might have been that redisplay hasn't
10090 been called, so that mode lines above the echo area are
10091 garbaged. This looks odd, so we prevent it here. */
10092 if (!display_completed
)
10093 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10095 if (window_height_changed_p
10096 /* Don't do this if Emacs is shutting down. Redisplay
10097 needs to run hooks. */
10098 && !NILP (Vrun_hooks
))
10100 /* Must update other windows. Likewise as in other
10101 cases, don't let this update be interrupted by
10103 int count
= SPECPDL_INDEX ();
10104 specbind (Qredisplay_dont_pause
, Qt
);
10105 windows_or_buffers_changed
= 1;
10106 redisplay_internal ();
10107 unbind_to (count
, Qnil
);
10109 else if (FRAME_WINDOW_P (f
) && n
== 0)
10111 /* Window configuration is the same as before.
10112 Can do with a display update of the echo area,
10113 unless we displayed some mode lines. */
10114 update_single_window (w
, 1);
10115 FRAME_RIF (f
)->flush_display (f
);
10118 update_frame (f
, 1, 1);
10120 /* If cursor is in the echo area, make sure that the next
10121 redisplay displays the minibuffer, so that the cursor will
10122 be replaced with what the minibuffer wants. */
10123 if (cursor_in_echo_area
)
10124 ++windows_or_buffers_changed
;
10127 else if (!EQ (mini_window
, selected_window
))
10128 windows_or_buffers_changed
++;
10130 /* Last displayed message is now the current message. */
10131 echo_area_buffer
[1] = echo_area_buffer
[0];
10132 /* Inform read_char that we're not echoing. */
10133 echo_message_buffer
= Qnil
;
10135 /* Prevent redisplay optimization in redisplay_internal by resetting
10136 this_line_start_pos. This is done because the mini-buffer now
10137 displays the message instead of its buffer text. */
10138 if (EQ (mini_window
, selected_window
))
10139 CHARPOS (this_line_start_pos
) = 0;
10141 return window_height_changed_p
;
10146 /***********************************************************************
10147 Mode Lines and Frame Titles
10148 ***********************************************************************/
10150 /* A buffer for constructing non-propertized mode-line strings and
10151 frame titles in it; allocated from the heap in init_xdisp and
10152 resized as needed in store_mode_line_noprop_char. */
10154 static char *mode_line_noprop_buf
;
10156 /* The buffer's end, and a current output position in it. */
10158 static char *mode_line_noprop_buf_end
;
10159 static char *mode_line_noprop_ptr
;
10161 #define MODE_LINE_NOPROP_LEN(start) \
10162 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10165 MODE_LINE_DISPLAY
= 0,
10169 } mode_line_target
;
10171 /* Alist that caches the results of :propertize.
10172 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10173 static Lisp_Object mode_line_proptrans_alist
;
10175 /* List of strings making up the mode-line. */
10176 static Lisp_Object mode_line_string_list
;
10178 /* Base face property when building propertized mode line string. */
10179 static Lisp_Object mode_line_string_face
;
10180 static Lisp_Object mode_line_string_face_prop
;
10183 /* Unwind data for mode line strings */
10185 static Lisp_Object Vmode_line_unwind_vector
;
10188 format_mode_line_unwind_data (struct buffer
*obuf
,
10190 int save_proptrans
)
10192 Lisp_Object vector
, tmp
;
10194 /* Reduce consing by keeping one vector in
10195 Vwith_echo_area_save_vector. */
10196 vector
= Vmode_line_unwind_vector
;
10197 Vmode_line_unwind_vector
= Qnil
;
10200 vector
= Fmake_vector (make_number (8), Qnil
);
10202 ASET (vector
, 0, make_number (mode_line_target
));
10203 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10204 ASET (vector
, 2, mode_line_string_list
);
10205 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10206 ASET (vector
, 4, mode_line_string_face
);
10207 ASET (vector
, 5, mode_line_string_face_prop
);
10210 XSETBUFFER (tmp
, obuf
);
10213 ASET (vector
, 6, tmp
);
10214 ASET (vector
, 7, owin
);
10220 unwind_format_mode_line (Lisp_Object vector
)
10222 mode_line_target
= XINT (AREF (vector
, 0));
10223 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10224 mode_line_string_list
= AREF (vector
, 2);
10225 if (! EQ (AREF (vector
, 3), Qt
))
10226 mode_line_proptrans_alist
= AREF (vector
, 3);
10227 mode_line_string_face
= AREF (vector
, 4);
10228 mode_line_string_face_prop
= AREF (vector
, 5);
10230 if (!NILP (AREF (vector
, 7)))
10231 /* Select window before buffer, since it may change the buffer. */
10232 Fselect_window (AREF (vector
, 7), Qt
);
10234 if (!NILP (AREF (vector
, 6)))
10236 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10237 ASET (vector
, 6, Qnil
);
10240 Vmode_line_unwind_vector
= vector
;
10245 /* Store a single character C for the frame title in mode_line_noprop_buf.
10246 Re-allocate mode_line_noprop_buf if necessary. */
10249 store_mode_line_noprop_char (char c
)
10251 /* If output position has reached the end of the allocated buffer,
10252 double the buffer's size. */
10253 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10255 int len
= MODE_LINE_NOPROP_LEN (0);
10256 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10257 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10258 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10259 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10262 *mode_line_noprop_ptr
++ = c
;
10266 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10267 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10268 characters that yield more columns than PRECISION; PRECISION <= 0
10269 means copy the whole string. Pad with spaces until FIELD_WIDTH
10270 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10271 pad. Called from display_mode_element when it is used to build a
10275 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10277 const unsigned char *str
= (const unsigned char *) string
;
10279 EMACS_INT dummy
, nbytes
;
10281 /* Copy at most PRECISION chars from STR. */
10282 nbytes
= strlen (string
);
10283 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10285 store_mode_line_noprop_char (*str
++);
10287 /* Fill up with spaces until FIELD_WIDTH reached. */
10288 while (field_width
> 0
10289 && n
< field_width
)
10291 store_mode_line_noprop_char (' ');
10298 /***********************************************************************
10300 ***********************************************************************/
10302 #ifdef HAVE_WINDOW_SYSTEM
10304 /* Set the title of FRAME, if it has changed. The title format is
10305 Vicon_title_format if FRAME is iconified, otherwise it is
10306 frame_title_format. */
10309 x_consider_frame_title (Lisp_Object frame
)
10311 struct frame
*f
= XFRAME (frame
);
10313 if (FRAME_WINDOW_P (f
)
10314 || FRAME_MINIBUF_ONLY_P (f
)
10315 || f
->explicit_name
)
10317 /* Do we have more than one visible frame on this X display? */
10324 int count
= SPECPDL_INDEX ();
10326 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10328 Lisp_Object other_frame
= XCAR (tail
);
10329 struct frame
*tf
= XFRAME (other_frame
);
10332 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10333 && !FRAME_MINIBUF_ONLY_P (tf
)
10334 && !EQ (other_frame
, tip_frame
)
10335 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10339 /* Set global variable indicating that multiple frames exist. */
10340 multiple_frames
= CONSP (tail
);
10342 /* Switch to the buffer of selected window of the frame. Set up
10343 mode_line_target so that display_mode_element will output into
10344 mode_line_noprop_buf; then display the title. */
10345 record_unwind_protect (unwind_format_mode_line
,
10346 format_mode_line_unwind_data
10347 (current_buffer
, selected_window
, 0));
10349 Fselect_window (f
->selected_window
, Qt
);
10350 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10351 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10353 mode_line_target
= MODE_LINE_TITLE
;
10354 title_start
= MODE_LINE_NOPROP_LEN (0);
10355 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10356 NULL
, DEFAULT_FACE_ID
);
10357 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10358 len
= MODE_LINE_NOPROP_LEN (title_start
);
10359 title
= mode_line_noprop_buf
+ title_start
;
10360 unbind_to (count
, Qnil
);
10362 /* Set the title only if it's changed. This avoids consing in
10363 the common case where it hasn't. (If it turns out that we've
10364 already wasted too much time by walking through the list with
10365 display_mode_element, then we might need to optimize at a
10366 higher level than this.) */
10367 if (! STRINGP (f
->name
)
10368 || SBYTES (f
->name
) != len
10369 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10370 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10374 #endif /* not HAVE_WINDOW_SYSTEM */
10379 /***********************************************************************
10381 ***********************************************************************/
10384 /* Prepare for redisplay by updating menu-bar item lists when
10385 appropriate. This can call eval. */
10388 prepare_menu_bars (void)
10391 struct gcpro gcpro1
, gcpro2
;
10393 Lisp_Object tooltip_frame
;
10395 #ifdef HAVE_WINDOW_SYSTEM
10396 tooltip_frame
= tip_frame
;
10398 tooltip_frame
= Qnil
;
10401 /* Update all frame titles based on their buffer names, etc. We do
10402 this before the menu bars so that the buffer-menu will show the
10403 up-to-date frame titles. */
10404 #ifdef HAVE_WINDOW_SYSTEM
10405 if (windows_or_buffers_changed
|| update_mode_lines
)
10407 Lisp_Object tail
, frame
;
10409 FOR_EACH_FRAME (tail
, frame
)
10411 f
= XFRAME (frame
);
10412 if (!EQ (frame
, tooltip_frame
)
10413 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10414 x_consider_frame_title (frame
);
10417 #endif /* HAVE_WINDOW_SYSTEM */
10419 /* Update the menu bar item lists, if appropriate. This has to be
10420 done before any actual redisplay or generation of display lines. */
10421 all_windows
= (update_mode_lines
10422 || buffer_shared
> 1
10423 || windows_or_buffers_changed
);
10426 Lisp_Object tail
, frame
;
10427 int count
= SPECPDL_INDEX ();
10428 /* 1 means that update_menu_bar has run its hooks
10429 so any further calls to update_menu_bar shouldn't do so again. */
10430 int menu_bar_hooks_run
= 0;
10432 record_unwind_save_match_data ();
10434 FOR_EACH_FRAME (tail
, frame
)
10436 f
= XFRAME (frame
);
10438 /* Ignore tooltip frame. */
10439 if (EQ (frame
, tooltip_frame
))
10442 /* If a window on this frame changed size, report that to
10443 the user and clear the size-change flag. */
10444 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10446 Lisp_Object functions
;
10448 /* Clear flag first in case we get an error below. */
10449 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10450 functions
= Vwindow_size_change_functions
;
10451 GCPRO2 (tail
, functions
);
10453 while (CONSP (functions
))
10455 if (!EQ (XCAR (functions
), Qt
))
10456 call1 (XCAR (functions
), frame
);
10457 functions
= XCDR (functions
);
10463 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10464 #ifdef HAVE_WINDOW_SYSTEM
10465 update_tool_bar (f
, 0);
10468 if (windows_or_buffers_changed
10470 ns_set_doc_edited (f
, Fbuffer_modified_p
10471 (XWINDOW (f
->selected_window
)->buffer
));
10476 unbind_to (count
, Qnil
);
10480 struct frame
*sf
= SELECTED_FRAME ();
10481 update_menu_bar (sf
, 1, 0);
10482 #ifdef HAVE_WINDOW_SYSTEM
10483 update_tool_bar (sf
, 1);
10489 /* Update the menu bar item list for frame F. This has to be done
10490 before we start to fill in any display lines, because it can call
10493 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10495 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10496 already ran the menu bar hooks for this redisplay, so there
10497 is no need to run them again. The return value is the
10498 updated value of this flag, to pass to the next call. */
10501 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10503 Lisp_Object window
;
10504 register struct window
*w
;
10506 /* If called recursively during a menu update, do nothing. This can
10507 happen when, for instance, an activate-menubar-hook causes a
10509 if (inhibit_menubar_update
)
10512 window
= FRAME_SELECTED_WINDOW (f
);
10513 w
= XWINDOW (window
);
10515 if (FRAME_WINDOW_P (f
)
10517 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10518 || defined (HAVE_NS) || defined (USE_GTK)
10519 FRAME_EXTERNAL_MENU_BAR (f
)
10521 FRAME_MENU_BAR_LINES (f
) > 0
10523 : FRAME_MENU_BAR_LINES (f
) > 0)
10525 /* If the user has switched buffers or windows, we need to
10526 recompute to reflect the new bindings. But we'll
10527 recompute when update_mode_lines is set too; that means
10528 that people can use force-mode-line-update to request
10529 that the menu bar be recomputed. The adverse effect on
10530 the rest of the redisplay algorithm is about the same as
10531 windows_or_buffers_changed anyway. */
10532 if (windows_or_buffers_changed
10533 /* This used to test w->update_mode_line, but we believe
10534 there is no need to recompute the menu in that case. */
10535 || update_mode_lines
10536 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10537 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10538 != !NILP (w
->last_had_star
))
10539 || ((!NILP (Vtransient_mark_mode
)
10540 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10541 != !NILP (w
->region_showing
)))
10543 struct buffer
*prev
= current_buffer
;
10544 int count
= SPECPDL_INDEX ();
10546 specbind (Qinhibit_menubar_update
, Qt
);
10548 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10549 if (save_match_data
)
10550 record_unwind_save_match_data ();
10551 if (NILP (Voverriding_local_map_menu_flag
))
10553 specbind (Qoverriding_terminal_local_map
, Qnil
);
10554 specbind (Qoverriding_local_map
, Qnil
);
10559 /* Run the Lucid hook. */
10560 safe_run_hooks (Qactivate_menubar_hook
);
10562 /* If it has changed current-menubar from previous value,
10563 really recompute the menu-bar from the value. */
10564 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10565 call0 (Qrecompute_lucid_menubar
);
10567 safe_run_hooks (Qmenu_bar_update_hook
);
10572 XSETFRAME (Vmenu_updating_frame
, f
);
10573 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10575 /* Redisplay the menu bar in case we changed it. */
10576 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10577 || defined (HAVE_NS) || defined (USE_GTK)
10578 if (FRAME_WINDOW_P (f
))
10580 #if defined (HAVE_NS)
10581 /* All frames on Mac OS share the same menubar. So only
10582 the selected frame should be allowed to set it. */
10583 if (f
== SELECTED_FRAME ())
10585 set_frame_menubar (f
, 0, 0);
10588 /* On a terminal screen, the menu bar is an ordinary screen
10589 line, and this makes it get updated. */
10590 w
->update_mode_line
= Qt
;
10591 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10592 /* In the non-toolkit version, the menu bar is an ordinary screen
10593 line, and this makes it get updated. */
10594 w
->update_mode_line
= Qt
;
10595 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10597 unbind_to (count
, Qnil
);
10598 set_buffer_internal_1 (prev
);
10607 /***********************************************************************
10609 ***********************************************************************/
10611 #ifdef HAVE_WINDOW_SYSTEM
10614 Nominal cursor position -- where to draw output.
10615 HPOS and VPOS are window relative glyph matrix coordinates.
10616 X and Y are window relative pixel coordinates. */
10618 struct cursor_pos output_cursor
;
10622 Set the global variable output_cursor to CURSOR. All cursor
10623 positions are relative to updated_window. */
10626 set_output_cursor (struct cursor_pos
*cursor
)
10628 output_cursor
.hpos
= cursor
->hpos
;
10629 output_cursor
.vpos
= cursor
->vpos
;
10630 output_cursor
.x
= cursor
->x
;
10631 output_cursor
.y
= cursor
->y
;
10636 Set a nominal cursor position.
10638 HPOS and VPOS are column/row positions in a window glyph matrix. X
10639 and Y are window text area relative pixel positions.
10641 If this is done during an update, updated_window will contain the
10642 window that is being updated and the position is the future output
10643 cursor position for that window. If updated_window is null, use
10644 selected_window and display the cursor at the given position. */
10647 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10651 /* If updated_window is not set, work on selected_window. */
10652 if (updated_window
)
10653 w
= updated_window
;
10655 w
= XWINDOW (selected_window
);
10657 /* Set the output cursor. */
10658 output_cursor
.hpos
= hpos
;
10659 output_cursor
.vpos
= vpos
;
10660 output_cursor
.x
= x
;
10661 output_cursor
.y
= y
;
10663 /* If not called as part of an update, really display the cursor.
10664 This will also set the cursor position of W. */
10665 if (updated_window
== NULL
)
10668 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10669 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10670 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10675 #endif /* HAVE_WINDOW_SYSTEM */
10678 /***********************************************************************
10680 ***********************************************************************/
10682 #ifdef HAVE_WINDOW_SYSTEM
10684 /* Where the mouse was last time we reported a mouse event. */
10686 FRAME_PTR last_mouse_frame
;
10688 /* Tool-bar item index of the item on which a mouse button was pressed
10691 int last_tool_bar_item
;
10695 update_tool_bar_unwind (Lisp_Object frame
)
10697 selected_frame
= frame
;
10701 /* Update the tool-bar item list for frame F. This has to be done
10702 before we start to fill in any display lines. Called from
10703 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10704 and restore it here. */
10707 update_tool_bar (struct frame
*f
, int save_match_data
)
10709 #if defined (USE_GTK) || defined (HAVE_NS)
10710 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10712 int do_update
= WINDOWP (f
->tool_bar_window
)
10713 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10718 Lisp_Object window
;
10721 window
= FRAME_SELECTED_WINDOW (f
);
10722 w
= XWINDOW (window
);
10724 /* If the user has switched buffers or windows, we need to
10725 recompute to reflect the new bindings. But we'll
10726 recompute when update_mode_lines is set too; that means
10727 that people can use force-mode-line-update to request
10728 that the menu bar be recomputed. The adverse effect on
10729 the rest of the redisplay algorithm is about the same as
10730 windows_or_buffers_changed anyway. */
10731 if (windows_or_buffers_changed
10732 || !NILP (w
->update_mode_line
)
10733 || update_mode_lines
10734 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10735 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10736 != !NILP (w
->last_had_star
))
10737 || ((!NILP (Vtransient_mark_mode
)
10738 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10739 != !NILP (w
->region_showing
)))
10741 struct buffer
*prev
= current_buffer
;
10742 int count
= SPECPDL_INDEX ();
10743 Lisp_Object frame
, new_tool_bar
;
10744 int new_n_tool_bar
;
10745 struct gcpro gcpro1
;
10747 /* Set current_buffer to the buffer of the selected
10748 window of the frame, so that we get the right local
10750 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10752 /* Save match data, if we must. */
10753 if (save_match_data
)
10754 record_unwind_save_match_data ();
10756 /* Make sure that we don't accidentally use bogus keymaps. */
10757 if (NILP (Voverriding_local_map_menu_flag
))
10759 specbind (Qoverriding_terminal_local_map
, Qnil
);
10760 specbind (Qoverriding_local_map
, Qnil
);
10763 GCPRO1 (new_tool_bar
);
10765 /* We must temporarily set the selected frame to this frame
10766 before calling tool_bar_items, because the calculation of
10767 the tool-bar keymap uses the selected frame (see
10768 `tool-bar-make-keymap' in tool-bar.el). */
10769 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10770 XSETFRAME (frame
, f
);
10771 selected_frame
= frame
;
10773 /* Build desired tool-bar items from keymaps. */
10774 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10777 /* Redisplay the tool-bar if we changed it. */
10778 if (new_n_tool_bar
!= f
->n_tool_bar_items
10779 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10781 /* Redisplay that happens asynchronously due to an expose event
10782 may access f->tool_bar_items. Make sure we update both
10783 variables within BLOCK_INPUT so no such event interrupts. */
10785 f
->tool_bar_items
= new_tool_bar
;
10786 f
->n_tool_bar_items
= new_n_tool_bar
;
10787 w
->update_mode_line
= Qt
;
10793 unbind_to (count
, Qnil
);
10794 set_buffer_internal_1 (prev
);
10800 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10801 F's desired tool-bar contents. F->tool_bar_items must have
10802 been set up previously by calling prepare_menu_bars. */
10805 build_desired_tool_bar_string (struct frame
*f
)
10807 int i
, size
, size_needed
;
10808 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10809 Lisp_Object image
, plist
, props
;
10811 image
= plist
= props
= Qnil
;
10812 GCPRO3 (image
, plist
, props
);
10814 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10815 Otherwise, make a new string. */
10817 /* The size of the string we might be able to reuse. */
10818 size
= (STRINGP (f
->desired_tool_bar_string
)
10819 ? SCHARS (f
->desired_tool_bar_string
)
10822 /* We need one space in the string for each image. */
10823 size_needed
= f
->n_tool_bar_items
;
10825 /* Reuse f->desired_tool_bar_string, if possible. */
10826 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10827 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10828 make_number (' '));
10831 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10832 Fremove_text_properties (make_number (0), make_number (size
),
10833 props
, f
->desired_tool_bar_string
);
10836 /* Put a `display' property on the string for the images to display,
10837 put a `menu_item' property on tool-bar items with a value that
10838 is the index of the item in F's tool-bar item vector. */
10839 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10841 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10843 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10844 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10845 int hmargin
, vmargin
, relief
, idx
, end
;
10847 /* If image is a vector, choose the image according to the
10849 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10850 if (VECTORP (image
))
10854 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10855 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10858 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10859 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10861 xassert (ASIZE (image
) >= idx
);
10862 image
= AREF (image
, idx
);
10867 /* Ignore invalid image specifications. */
10868 if (!valid_image_p (image
))
10871 /* Display the tool-bar button pressed, or depressed. */
10872 plist
= Fcopy_sequence (XCDR (image
));
10874 /* Compute margin and relief to draw. */
10875 relief
= (tool_bar_button_relief
>= 0
10876 ? tool_bar_button_relief
10877 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10878 hmargin
= vmargin
= relief
;
10880 if (INTEGERP (Vtool_bar_button_margin
)
10881 && XINT (Vtool_bar_button_margin
) > 0)
10883 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10884 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10886 else if (CONSP (Vtool_bar_button_margin
))
10888 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10889 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10890 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10892 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10893 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10894 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10897 if (auto_raise_tool_bar_buttons_p
)
10899 /* Add a `:relief' property to the image spec if the item is
10903 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10910 /* If image is selected, display it pressed, i.e. with a
10911 negative relief. If it's not selected, display it with a
10913 plist
= Fplist_put (plist
, QCrelief
,
10915 ? make_number (-relief
)
10916 : make_number (relief
)));
10921 /* Put a margin around the image. */
10922 if (hmargin
|| vmargin
)
10924 if (hmargin
== vmargin
)
10925 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10927 plist
= Fplist_put (plist
, QCmargin
,
10928 Fcons (make_number (hmargin
),
10929 make_number (vmargin
)));
10932 /* If button is not enabled, and we don't have special images
10933 for the disabled state, make the image appear disabled by
10934 applying an appropriate algorithm to it. */
10935 if (!enabled_p
&& idx
< 0)
10936 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10938 /* Put a `display' text property on the string for the image to
10939 display. Put a `menu-item' property on the string that gives
10940 the start of this item's properties in the tool-bar items
10942 image
= Fcons (Qimage
, plist
);
10943 props
= list4 (Qdisplay
, image
,
10944 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10946 /* Let the last image hide all remaining spaces in the tool bar
10947 string. The string can be longer than needed when we reuse a
10948 previous string. */
10949 if (i
+ 1 == f
->n_tool_bar_items
)
10950 end
= SCHARS (f
->desired_tool_bar_string
);
10953 Fadd_text_properties (make_number (i
), make_number (end
),
10954 props
, f
->desired_tool_bar_string
);
10962 /* Display one line of the tool-bar of frame IT->f.
10964 HEIGHT specifies the desired height of the tool-bar line.
10965 If the actual height of the glyph row is less than HEIGHT, the
10966 row's height is increased to HEIGHT, and the icons are centered
10967 vertically in the new height.
10969 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10970 count a final empty row in case the tool-bar width exactly matches
10975 display_tool_bar_line (struct it
*it
, int height
)
10977 struct glyph_row
*row
= it
->glyph_row
;
10978 int max_x
= it
->last_visible_x
;
10979 struct glyph
*last
;
10981 prepare_desired_row (row
);
10982 row
->y
= it
->current_y
;
10984 /* Note that this isn't made use of if the face hasn't a box,
10985 so there's no need to check the face here. */
10986 it
->start_of_box_run_p
= 1;
10988 while (it
->current_x
< max_x
)
10990 int x
, n_glyphs_before
, i
, nglyphs
;
10991 struct it it_before
;
10993 /* Get the next display element. */
10994 if (!get_next_display_element (it
))
10996 /* Don't count empty row if we are counting needed tool-bar lines. */
10997 if (height
< 0 && !it
->hpos
)
11002 /* Produce glyphs. */
11003 n_glyphs_before
= row
->used
[TEXT_AREA
];
11006 PRODUCE_GLYPHS (it
);
11008 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11010 x
= it_before
.current_x
;
11011 while (i
< nglyphs
)
11013 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11015 if (x
+ glyph
->pixel_width
> max_x
)
11017 /* Glyph doesn't fit on line. Backtrack. */
11018 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11020 /* If this is the only glyph on this line, it will never fit on the
11021 tool-bar, so skip it. But ensure there is at least one glyph,
11022 so we don't accidentally disable the tool-bar. */
11023 if (n_glyphs_before
== 0
11024 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11030 x
+= glyph
->pixel_width
;
11034 /* Stop at line end. */
11035 if (ITERATOR_AT_END_OF_LINE_P (it
))
11038 set_iterator_to_next (it
, 1);
11043 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11045 /* Use default face for the border below the tool bar.
11047 FIXME: When auto-resize-tool-bars is grow-only, there is
11048 no additional border below the possibly empty tool-bar lines.
11049 So to make the extra empty lines look "normal", we have to
11050 use the tool-bar face for the border too. */
11051 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11052 it
->face_id
= DEFAULT_FACE_ID
;
11054 extend_face_to_end_of_line (it
);
11055 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11056 last
->right_box_line_p
= 1;
11057 if (last
== row
->glyphs
[TEXT_AREA
])
11058 last
->left_box_line_p
= 1;
11060 /* Make line the desired height and center it vertically. */
11061 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11063 /* Don't add more than one line height. */
11064 height
%= FRAME_LINE_HEIGHT (it
->f
);
11065 it
->max_ascent
+= height
/ 2;
11066 it
->max_descent
+= (height
+ 1) / 2;
11069 compute_line_metrics (it
);
11071 /* If line is empty, make it occupy the rest of the tool-bar. */
11072 if (!row
->displays_text_p
)
11074 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11075 row
->visible_height
= row
->height
;
11076 row
->ascent
= row
->phys_ascent
= 0;
11077 row
->extra_line_spacing
= 0;
11080 row
->full_width_p
= 1;
11081 row
->continued_p
= 0;
11082 row
->truncated_on_left_p
= 0;
11083 row
->truncated_on_right_p
= 0;
11085 it
->current_x
= it
->hpos
= 0;
11086 it
->current_y
+= row
->height
;
11092 /* Max tool-bar height. */
11094 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11095 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11097 /* Value is the number of screen lines needed to make all tool-bar
11098 items of frame F visible. The number of actual rows needed is
11099 returned in *N_ROWS if non-NULL. */
11102 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11104 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11106 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11107 the desired matrix, so use (unused) mode-line row as temporary row to
11108 avoid destroying the first tool-bar row. */
11109 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11111 /* Initialize an iterator for iteration over
11112 F->desired_tool_bar_string in the tool-bar window of frame F. */
11113 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11114 it
.first_visible_x
= 0;
11115 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11116 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11117 it
.paragraph_embedding
= L2R
;
11119 while (!ITERATOR_AT_END_P (&it
))
11121 clear_glyph_row (temp_row
);
11122 it
.glyph_row
= temp_row
;
11123 display_tool_bar_line (&it
, -1);
11125 clear_glyph_row (temp_row
);
11127 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11129 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11131 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11135 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11137 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11138 (Lisp_Object frame
)
11145 frame
= selected_frame
;
11147 CHECK_FRAME (frame
);
11148 f
= XFRAME (frame
);
11150 if (WINDOWP (f
->tool_bar_window
)
11151 && (w
= XWINDOW (f
->tool_bar_window
),
11152 WINDOW_TOTAL_LINES (w
) > 0))
11154 update_tool_bar (f
, 1);
11155 if (f
->n_tool_bar_items
)
11157 build_desired_tool_bar_string (f
);
11158 nlines
= tool_bar_lines_needed (f
, NULL
);
11162 return make_number (nlines
);
11166 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11167 height should be changed. */
11170 redisplay_tool_bar (struct frame
*f
)
11174 struct glyph_row
*row
;
11176 #if defined (USE_GTK) || defined (HAVE_NS)
11177 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11178 update_frame_tool_bar (f
);
11182 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11183 do anything. This means you must start with tool-bar-lines
11184 non-zero to get the auto-sizing effect. Or in other words, you
11185 can turn off tool-bars by specifying tool-bar-lines zero. */
11186 if (!WINDOWP (f
->tool_bar_window
)
11187 || (w
= XWINDOW (f
->tool_bar_window
),
11188 WINDOW_TOTAL_LINES (w
) == 0))
11191 /* Set up an iterator for the tool-bar window. */
11192 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11193 it
.first_visible_x
= 0;
11194 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11195 row
= it
.glyph_row
;
11197 /* Build a string that represents the contents of the tool-bar. */
11198 build_desired_tool_bar_string (f
);
11199 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11200 /* FIXME: This should be controlled by a user option. But it
11201 doesn't make sense to have an R2L tool bar if the menu bar cannot
11202 be drawn also R2L, and making the menu bar R2L is tricky due
11203 toolkit-specific code that implements it. If an R2L tool bar is
11204 ever supported, display_tool_bar_line should also be augmented to
11205 call unproduce_glyphs like display_line and display_string
11207 it
.paragraph_embedding
= L2R
;
11209 if (f
->n_tool_bar_rows
== 0)
11213 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11214 nlines
!= WINDOW_TOTAL_LINES (w
)))
11217 int old_height
= WINDOW_TOTAL_LINES (w
);
11219 XSETFRAME (frame
, f
);
11220 Fmodify_frame_parameters (frame
,
11221 Fcons (Fcons (Qtool_bar_lines
,
11222 make_number (nlines
)),
11224 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11226 clear_glyph_matrix (w
->desired_matrix
);
11227 fonts_changed_p
= 1;
11233 /* Display as many lines as needed to display all tool-bar items. */
11235 if (f
->n_tool_bar_rows
> 0)
11237 int border
, rows
, height
, extra
;
11239 if (INTEGERP (Vtool_bar_border
))
11240 border
= XINT (Vtool_bar_border
);
11241 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11242 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11243 else if (EQ (Vtool_bar_border
, Qborder_width
))
11244 border
= f
->border_width
;
11250 rows
= f
->n_tool_bar_rows
;
11251 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11252 extra
= it
.last_visible_y
- border
- height
* rows
;
11254 while (it
.current_y
< it
.last_visible_y
)
11257 if (extra
> 0 && rows
-- > 0)
11259 h
= (extra
+ rows
- 1) / rows
;
11262 display_tool_bar_line (&it
, height
+ h
);
11267 while (it
.current_y
< it
.last_visible_y
)
11268 display_tool_bar_line (&it
, 0);
11271 /* It doesn't make much sense to try scrolling in the tool-bar
11272 window, so don't do it. */
11273 w
->desired_matrix
->no_scrolling_p
= 1;
11274 w
->must_be_updated_p
= 1;
11276 if (!NILP (Vauto_resize_tool_bars
))
11278 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11279 int change_height_p
= 0;
11281 /* If we couldn't display everything, change the tool-bar's
11282 height if there is room for more. */
11283 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11284 && it
.current_y
< max_tool_bar_height
)
11285 change_height_p
= 1;
11287 row
= it
.glyph_row
- 1;
11289 /* If there are blank lines at the end, except for a partially
11290 visible blank line at the end that is smaller than
11291 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11292 if (!row
->displays_text_p
11293 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11294 change_height_p
= 1;
11296 /* If row displays tool-bar items, but is partially visible,
11297 change the tool-bar's height. */
11298 if (row
->displays_text_p
11299 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11300 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11301 change_height_p
= 1;
11303 /* Resize windows as needed by changing the `tool-bar-lines'
11304 frame parameter. */
11305 if (change_height_p
)
11308 int old_height
= WINDOW_TOTAL_LINES (w
);
11310 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11312 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11313 && !f
->minimize_tool_bar_window_p
)
11314 ? (nlines
> old_height
)
11315 : (nlines
!= old_height
));
11316 f
->minimize_tool_bar_window_p
= 0;
11318 if (change_height_p
)
11320 XSETFRAME (frame
, f
);
11321 Fmodify_frame_parameters (frame
,
11322 Fcons (Fcons (Qtool_bar_lines
,
11323 make_number (nlines
)),
11325 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11327 clear_glyph_matrix (w
->desired_matrix
);
11328 f
->n_tool_bar_rows
= nrows
;
11329 fonts_changed_p
= 1;
11336 f
->minimize_tool_bar_window_p
= 0;
11341 /* Get information about the tool-bar item which is displayed in GLYPH
11342 on frame F. Return in *PROP_IDX the index where tool-bar item
11343 properties start in F->tool_bar_items. Value is zero if
11344 GLYPH doesn't display a tool-bar item. */
11347 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11353 /* This function can be called asynchronously, which means we must
11354 exclude any possibility that Fget_text_property signals an
11356 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11357 charpos
= max (0, charpos
);
11359 /* Get the text property `menu-item' at pos. The value of that
11360 property is the start index of this item's properties in
11361 F->tool_bar_items. */
11362 prop
= Fget_text_property (make_number (charpos
),
11363 Qmenu_item
, f
->current_tool_bar_string
);
11364 if (INTEGERP (prop
))
11366 *prop_idx
= XINT (prop
);
11376 /* Get information about the tool-bar item at position X/Y on frame F.
11377 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11378 the current matrix of the tool-bar window of F, or NULL if not
11379 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11380 item in F->tool_bar_items. Value is
11382 -1 if X/Y is not on a tool-bar item
11383 0 if X/Y is on the same item that was highlighted before.
11387 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11388 int *hpos
, int *vpos
, int *prop_idx
)
11390 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11391 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11394 /* Find the glyph under X/Y. */
11395 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11396 if (*glyph
== NULL
)
11399 /* Get the start of this tool-bar item's properties in
11400 f->tool_bar_items. */
11401 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11404 /* Is mouse on the highlighted item? */
11405 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11406 && *vpos
>= hlinfo
->mouse_face_beg_row
11407 && *vpos
<= hlinfo
->mouse_face_end_row
11408 && (*vpos
> hlinfo
->mouse_face_beg_row
11409 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11410 && (*vpos
< hlinfo
->mouse_face_end_row
11411 || *hpos
< hlinfo
->mouse_face_end_col
11412 || hlinfo
->mouse_face_past_end
))
11420 Handle mouse button event on the tool-bar of frame F, at
11421 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11422 0 for button release. MODIFIERS is event modifiers for button
11426 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11427 unsigned int modifiers
)
11429 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11430 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11431 int hpos
, vpos
, prop_idx
;
11432 struct glyph
*glyph
;
11433 Lisp_Object enabled_p
;
11435 /* If not on the highlighted tool-bar item, return. */
11436 frame_to_window_pixel_xy (w
, &x
, &y
);
11437 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11440 /* If item is disabled, do nothing. */
11441 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11442 if (NILP (enabled_p
))
11447 /* Show item in pressed state. */
11448 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11449 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11450 last_tool_bar_item
= prop_idx
;
11454 Lisp_Object key
, frame
;
11455 struct input_event event
;
11456 EVENT_INIT (event
);
11458 /* Show item in released state. */
11459 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11460 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11462 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11464 XSETFRAME (frame
, f
);
11465 event
.kind
= TOOL_BAR_EVENT
;
11466 event
.frame_or_window
= frame
;
11468 kbd_buffer_store_event (&event
);
11470 event
.kind
= TOOL_BAR_EVENT
;
11471 event
.frame_or_window
= frame
;
11473 event
.modifiers
= modifiers
;
11474 kbd_buffer_store_event (&event
);
11475 last_tool_bar_item
= -1;
11480 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11481 tool-bar window-relative coordinates X/Y. Called from
11482 note_mouse_highlight. */
11485 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11487 Lisp_Object window
= f
->tool_bar_window
;
11488 struct window
*w
= XWINDOW (window
);
11489 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11490 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11492 struct glyph
*glyph
;
11493 struct glyph_row
*row
;
11495 Lisp_Object enabled_p
;
11497 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11498 int mouse_down_p
, rc
;
11500 /* Function note_mouse_highlight is called with negative X/Y
11501 values when mouse moves outside of the frame. */
11502 if (x
<= 0 || y
<= 0)
11504 clear_mouse_face (hlinfo
);
11508 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11511 /* Not on tool-bar item. */
11512 clear_mouse_face (hlinfo
);
11516 /* On same tool-bar item as before. */
11517 goto set_help_echo
;
11519 clear_mouse_face (hlinfo
);
11521 /* Mouse is down, but on different tool-bar item? */
11522 mouse_down_p
= (dpyinfo
->grabbed
11523 && f
== last_mouse_frame
11524 && FRAME_LIVE_P (f
));
11526 && last_tool_bar_item
!= prop_idx
)
11529 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11530 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11532 /* If tool-bar item is not enabled, don't highlight it. */
11533 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11534 if (!NILP (enabled_p
))
11536 /* Compute the x-position of the glyph. In front and past the
11537 image is a space. We include this in the highlighted area. */
11538 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11539 for (i
= x
= 0; i
< hpos
; ++i
)
11540 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11542 /* Record this as the current active region. */
11543 hlinfo
->mouse_face_beg_col
= hpos
;
11544 hlinfo
->mouse_face_beg_row
= vpos
;
11545 hlinfo
->mouse_face_beg_x
= x
;
11546 hlinfo
->mouse_face_beg_y
= row
->y
;
11547 hlinfo
->mouse_face_past_end
= 0;
11549 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11550 hlinfo
->mouse_face_end_row
= vpos
;
11551 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11552 hlinfo
->mouse_face_end_y
= row
->y
;
11553 hlinfo
->mouse_face_window
= window
;
11554 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11556 /* Display it as active. */
11557 show_mouse_face (hlinfo
, draw
);
11558 hlinfo
->mouse_face_image_state
= draw
;
11563 /* Set help_echo_string to a help string to display for this tool-bar item.
11564 XTread_socket does the rest. */
11565 help_echo_object
= help_echo_window
= Qnil
;
11566 help_echo_pos
= -1;
11567 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11568 if (NILP (help_echo_string
))
11569 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11572 #endif /* HAVE_WINDOW_SYSTEM */
11576 /************************************************************************
11577 Horizontal scrolling
11578 ************************************************************************/
11580 static int hscroll_window_tree (Lisp_Object
);
11581 static int hscroll_windows (Lisp_Object
);
11583 /* For all leaf windows in the window tree rooted at WINDOW, set their
11584 hscroll value so that PT is (i) visible in the window, and (ii) so
11585 that it is not within a certain margin at the window's left and
11586 right border. Value is non-zero if any window's hscroll has been
11590 hscroll_window_tree (Lisp_Object window
)
11592 int hscrolled_p
= 0;
11593 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11594 int hscroll_step_abs
= 0;
11595 double hscroll_step_rel
= 0;
11597 if (hscroll_relative_p
)
11599 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11600 if (hscroll_step_rel
< 0)
11602 hscroll_relative_p
= 0;
11603 hscroll_step_abs
= 0;
11606 else if (INTEGERP (Vhscroll_step
))
11608 hscroll_step_abs
= XINT (Vhscroll_step
);
11609 if (hscroll_step_abs
< 0)
11610 hscroll_step_abs
= 0;
11613 hscroll_step_abs
= 0;
11615 while (WINDOWP (window
))
11617 struct window
*w
= XWINDOW (window
);
11619 if (WINDOWP (w
->hchild
))
11620 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11621 else if (WINDOWP (w
->vchild
))
11622 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11623 else if (w
->cursor
.vpos
>= 0)
11626 int text_area_width
;
11627 struct glyph_row
*current_cursor_row
11628 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11629 struct glyph_row
*desired_cursor_row
11630 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11631 struct glyph_row
*cursor_row
11632 = (desired_cursor_row
->enabled_p
11633 ? desired_cursor_row
11634 : current_cursor_row
);
11636 text_area_width
= window_box_width (w
, TEXT_AREA
);
11638 /* Scroll when cursor is inside this scroll margin. */
11639 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11641 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11642 && ((XFASTINT (w
->hscroll
)
11643 && w
->cursor
.x
<= h_margin
)
11644 || (cursor_row
->enabled_p
11645 && cursor_row
->truncated_on_right_p
11646 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11650 struct buffer
*saved_current_buffer
;
11654 /* Find point in a display of infinite width. */
11655 saved_current_buffer
= current_buffer
;
11656 current_buffer
= XBUFFER (w
->buffer
);
11658 if (w
== XWINDOW (selected_window
))
11662 pt
= marker_position (w
->pointm
);
11663 pt
= max (BEGV
, pt
);
11667 /* Move iterator to pt starting at cursor_row->start in
11668 a line with infinite width. */
11669 init_to_row_start (&it
, w
, cursor_row
);
11670 it
.last_visible_x
= INFINITY
;
11671 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11672 current_buffer
= saved_current_buffer
;
11674 /* Position cursor in window. */
11675 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11676 hscroll
= max (0, (it
.current_x
11677 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11678 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11679 : (text_area_width
/ 2))))
11680 / FRAME_COLUMN_WIDTH (it
.f
);
11681 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11683 if (hscroll_relative_p
)
11684 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11687 wanted_x
= text_area_width
11688 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11691 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11695 if (hscroll_relative_p
)
11696 wanted_x
= text_area_width
* hscroll_step_rel
11699 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11702 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11704 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11706 /* Don't call Fset_window_hscroll if value hasn't
11707 changed because it will prevent redisplay
11709 if (XFASTINT (w
->hscroll
) != hscroll
)
11711 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11712 w
->hscroll
= make_number (hscroll
);
11721 /* Value is non-zero if hscroll of any leaf window has been changed. */
11722 return hscrolled_p
;
11726 /* Set hscroll so that cursor is visible and not inside horizontal
11727 scroll margins for all windows in the tree rooted at WINDOW. See
11728 also hscroll_window_tree above. Value is non-zero if any window's
11729 hscroll has been changed. If it has, desired matrices on the frame
11730 of WINDOW are cleared. */
11733 hscroll_windows (Lisp_Object window
)
11735 int hscrolled_p
= hscroll_window_tree (window
);
11737 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11738 return hscrolled_p
;
11743 /************************************************************************
11745 ************************************************************************/
11747 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11748 to a non-zero value. This is sometimes handy to have in a debugger
11753 /* First and last unchanged row for try_window_id. */
11755 static int debug_first_unchanged_at_end_vpos
;
11756 static int debug_last_unchanged_at_beg_vpos
;
11758 /* Delta vpos and y. */
11760 static int debug_dvpos
, debug_dy
;
11762 /* Delta in characters and bytes for try_window_id. */
11764 static EMACS_INT debug_delta
, debug_delta_bytes
;
11766 /* Values of window_end_pos and window_end_vpos at the end of
11769 static EMACS_INT debug_end_vpos
;
11771 /* Append a string to W->desired_matrix->method. FMT is a printf
11772 format string. If trace_redisplay_p is non-zero also printf the
11773 resulting string to stderr. */
11775 static void debug_method_add (struct window
*, char const *, ...)
11776 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11779 debug_method_add (struct window
*w
, char const *fmt
, ...)
11782 char *method
= w
->desired_matrix
->method
;
11783 int len
= strlen (method
);
11784 int size
= sizeof w
->desired_matrix
->method
;
11785 int remaining
= size
- len
- 1;
11788 va_start (ap
, fmt
);
11789 vsprintf (buffer
, fmt
, ap
);
11791 if (len
&& remaining
)
11794 --remaining
, ++len
;
11797 strncpy (method
+ len
, buffer
, remaining
);
11799 if (trace_redisplay_p
)
11800 fprintf (stderr
, "%p (%s): %s\n",
11802 ((BUFFERP (w
->buffer
)
11803 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11804 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11809 #endif /* GLYPH_DEBUG */
11812 /* Value is non-zero if all changes in window W, which displays
11813 current_buffer, are in the text between START and END. START is a
11814 buffer position, END is given as a distance from Z. Used in
11815 redisplay_internal for display optimization. */
11818 text_outside_line_unchanged_p (struct window
*w
,
11819 EMACS_INT start
, EMACS_INT end
)
11821 int unchanged_p
= 1;
11823 /* If text or overlays have changed, see where. */
11824 if (XFASTINT (w
->last_modified
) < MODIFF
11825 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11827 /* Gap in the line? */
11828 if (GPT
< start
|| Z
- GPT
< end
)
11831 /* Changes start in front of the line, or end after it? */
11833 && (BEG_UNCHANGED
< start
- 1
11834 || END_UNCHANGED
< end
))
11837 /* If selective display, can't optimize if changes start at the
11838 beginning of the line. */
11840 && INTEGERP (BVAR (current_buffer
, selective_display
))
11841 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11842 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11845 /* If there are overlays at the start or end of the line, these
11846 may have overlay strings with newlines in them. A change at
11847 START, for instance, may actually concern the display of such
11848 overlay strings as well, and they are displayed on different
11849 lines. So, quickly rule out this case. (For the future, it
11850 might be desirable to implement something more telling than
11851 just BEG/END_UNCHANGED.) */
11854 if (BEG
+ BEG_UNCHANGED
== start
11855 && overlay_touches_p (start
))
11857 if (END_UNCHANGED
== end
11858 && overlay_touches_p (Z
- end
))
11862 /* Under bidi reordering, adding or deleting a character in the
11863 beginning of a paragraph, before the first strong directional
11864 character, can change the base direction of the paragraph (unless
11865 the buffer specifies a fixed paragraph direction), which will
11866 require to redisplay the whole paragraph. It might be worthwhile
11867 to find the paragraph limits and widen the range of redisplayed
11868 lines to that, but for now just give up this optimization. */
11869 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11870 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11874 return unchanged_p
;
11878 /* Do a frame update, taking possible shortcuts into account. This is
11879 the main external entry point for redisplay.
11881 If the last redisplay displayed an echo area message and that message
11882 is no longer requested, we clear the echo area or bring back the
11883 mini-buffer if that is in use. */
11888 redisplay_internal ();
11893 overlay_arrow_string_or_property (Lisp_Object var
)
11897 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11900 return Voverlay_arrow_string
;
11903 /* Return 1 if there are any overlay-arrows in current_buffer. */
11905 overlay_arrow_in_current_buffer_p (void)
11909 for (vlist
= Voverlay_arrow_variable_list
;
11911 vlist
= XCDR (vlist
))
11913 Lisp_Object var
= XCAR (vlist
);
11916 if (!SYMBOLP (var
))
11918 val
= find_symbol_value (var
);
11920 && current_buffer
== XMARKER (val
)->buffer
)
11927 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11931 overlay_arrows_changed_p (void)
11935 for (vlist
= Voverlay_arrow_variable_list
;
11937 vlist
= XCDR (vlist
))
11939 Lisp_Object var
= XCAR (vlist
);
11940 Lisp_Object val
, pstr
;
11942 if (!SYMBOLP (var
))
11944 val
= find_symbol_value (var
);
11945 if (!MARKERP (val
))
11947 if (! EQ (COERCE_MARKER (val
),
11948 Fget (var
, Qlast_arrow_position
))
11949 || ! (pstr
= overlay_arrow_string_or_property (var
),
11950 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11956 /* Mark overlay arrows to be updated on next redisplay. */
11959 update_overlay_arrows (int up_to_date
)
11963 for (vlist
= Voverlay_arrow_variable_list
;
11965 vlist
= XCDR (vlist
))
11967 Lisp_Object var
= XCAR (vlist
);
11969 if (!SYMBOLP (var
))
11972 if (up_to_date
> 0)
11974 Lisp_Object val
= find_symbol_value (var
);
11975 Fput (var
, Qlast_arrow_position
,
11976 COERCE_MARKER (val
));
11977 Fput (var
, Qlast_arrow_string
,
11978 overlay_arrow_string_or_property (var
));
11980 else if (up_to_date
< 0
11981 || !NILP (Fget (var
, Qlast_arrow_position
)))
11983 Fput (var
, Qlast_arrow_position
, Qt
);
11984 Fput (var
, Qlast_arrow_string
, Qt
);
11990 /* Return overlay arrow string to display at row.
11991 Return integer (bitmap number) for arrow bitmap in left fringe.
11992 Return nil if no overlay arrow. */
11995 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11999 for (vlist
= Voverlay_arrow_variable_list
;
12001 vlist
= XCDR (vlist
))
12003 Lisp_Object var
= XCAR (vlist
);
12006 if (!SYMBOLP (var
))
12009 val
= find_symbol_value (var
);
12012 && current_buffer
== XMARKER (val
)->buffer
12013 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12015 if (FRAME_WINDOW_P (it
->f
)
12016 /* FIXME: if ROW->reversed_p is set, this should test
12017 the right fringe, not the left one. */
12018 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12020 #ifdef HAVE_WINDOW_SYSTEM
12021 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12024 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12025 return make_number (fringe_bitmap
);
12028 return make_number (-1); /* Use default arrow bitmap */
12030 return overlay_arrow_string_or_property (var
);
12037 /* Return 1 if point moved out of or into a composition. Otherwise
12038 return 0. PREV_BUF and PREV_PT are the last point buffer and
12039 position. BUF and PT are the current point buffer and position. */
12042 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12043 struct buffer
*buf
, EMACS_INT pt
)
12045 EMACS_INT start
, end
;
12047 Lisp_Object buffer
;
12049 XSETBUFFER (buffer
, buf
);
12050 /* Check a composition at the last point if point moved within the
12052 if (prev_buf
== buf
)
12055 /* Point didn't move. */
12058 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12059 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12060 && COMPOSITION_VALID_P (start
, end
, prop
)
12061 && start
< prev_pt
&& end
> prev_pt
)
12062 /* The last point was within the composition. Return 1 iff
12063 point moved out of the composition. */
12064 return (pt
<= start
|| pt
>= end
);
12067 /* Check a composition at the current point. */
12068 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12069 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12070 && COMPOSITION_VALID_P (start
, end
, prop
)
12071 && start
< pt
&& end
> pt
);
12075 /* Reconsider the setting of B->clip_changed which is displayed
12079 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12081 if (b
->clip_changed
12082 && !NILP (w
->window_end_valid
)
12083 && w
->current_matrix
->buffer
== b
12084 && w
->current_matrix
->zv
== BUF_ZV (b
)
12085 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12086 b
->clip_changed
= 0;
12088 /* If display wasn't paused, and W is not a tool bar window, see if
12089 point has been moved into or out of a composition. In that case,
12090 we set b->clip_changed to 1 to force updating the screen. If
12091 b->clip_changed has already been set to 1, we can skip this
12093 if (!b
->clip_changed
12094 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12098 if (w
== XWINDOW (selected_window
))
12101 pt
= marker_position (w
->pointm
);
12103 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12104 || pt
!= XINT (w
->last_point
))
12105 && check_point_in_composition (w
->current_matrix
->buffer
,
12106 XINT (w
->last_point
),
12107 XBUFFER (w
->buffer
), pt
))
12108 b
->clip_changed
= 1;
12113 /* Select FRAME to forward the values of frame-local variables into C
12114 variables so that the redisplay routines can access those values
12118 select_frame_for_redisplay (Lisp_Object frame
)
12120 Lisp_Object tail
, tem
;
12121 Lisp_Object old
= selected_frame
;
12122 struct Lisp_Symbol
*sym
;
12124 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12126 selected_frame
= frame
;
12129 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12130 if (CONSP (XCAR (tail
))
12131 && (tem
= XCAR (XCAR (tail
)),
12133 && (sym
= indirect_variable (XSYMBOL (tem
)),
12134 sym
->redirect
== SYMBOL_LOCALIZED
)
12135 && sym
->val
.blv
->frame_local
)
12136 /* Use find_symbol_value rather than Fsymbol_value
12137 to avoid an error if it is void. */
12138 find_symbol_value (tem
);
12139 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12143 #define STOP_POLLING \
12144 do { if (! polling_stopped_here) stop_polling (); \
12145 polling_stopped_here = 1; } while (0)
12147 #define RESUME_POLLING \
12148 do { if (polling_stopped_here) start_polling (); \
12149 polling_stopped_here = 0; } while (0)
12152 /* Perhaps in the future avoid recentering windows if it
12153 is not necessary; currently that causes some problems. */
12156 redisplay_internal (void)
12158 struct window
*w
= XWINDOW (selected_window
);
12162 int must_finish
= 0;
12163 struct text_pos tlbufpos
, tlendpos
;
12164 int number_of_visible_frames
;
12167 int polling_stopped_here
= 0;
12168 Lisp_Object old_frame
= selected_frame
;
12170 /* Non-zero means redisplay has to consider all windows on all
12171 frames. Zero means, only selected_window is considered. */
12172 int consider_all_windows_p
;
12174 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12176 /* No redisplay if running in batch mode or frame is not yet fully
12177 initialized, or redisplay is explicitly turned off by setting
12178 Vinhibit_redisplay. */
12179 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12180 || !NILP (Vinhibit_redisplay
))
12183 /* Don't examine these until after testing Vinhibit_redisplay.
12184 When Emacs is shutting down, perhaps because its connection to
12185 X has dropped, we should not look at them at all. */
12186 fr
= XFRAME (w
->frame
);
12187 sf
= SELECTED_FRAME ();
12189 if (!fr
->glyphs_initialized_p
)
12192 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12193 if (popup_activated ())
12197 /* I don't think this happens but let's be paranoid. */
12198 if (redisplaying_p
)
12201 /* Record a function that resets redisplaying_p to its old value
12202 when we leave this function. */
12203 count
= SPECPDL_INDEX ();
12204 record_unwind_protect (unwind_redisplay
,
12205 Fcons (make_number (redisplaying_p
), selected_frame
));
12207 specbind (Qinhibit_free_realized_faces
, Qnil
);
12210 Lisp_Object tail
, frame
;
12212 FOR_EACH_FRAME (tail
, frame
)
12214 struct frame
*f
= XFRAME (frame
);
12215 f
->already_hscrolled_p
= 0;
12220 /* Remember the currently selected window. */
12223 if (!EQ (old_frame
, selected_frame
)
12224 && FRAME_LIVE_P (XFRAME (old_frame
)))
12225 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12226 selected_frame and selected_window to be temporarily out-of-sync so
12227 when we come back here via `goto retry', we need to resync because we
12228 may need to run Elisp code (via prepare_menu_bars). */
12229 select_frame_for_redisplay (old_frame
);
12232 reconsider_clip_changes (w
, current_buffer
);
12233 last_escape_glyph_frame
= NULL
;
12234 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12235 last_glyphless_glyph_frame
= NULL
;
12236 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12238 /* If new fonts have been loaded that make a glyph matrix adjustment
12239 necessary, do it. */
12240 if (fonts_changed_p
)
12242 adjust_glyphs (NULL
);
12243 ++windows_or_buffers_changed
;
12244 fonts_changed_p
= 0;
12247 /* If face_change_count is non-zero, init_iterator will free all
12248 realized faces, which includes the faces referenced from current
12249 matrices. So, we can't reuse current matrices in this case. */
12250 if (face_change_count
)
12251 ++windows_or_buffers_changed
;
12253 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12254 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12256 /* Since frames on a single ASCII terminal share the same
12257 display area, displaying a different frame means redisplay
12258 the whole thing. */
12259 windows_or_buffers_changed
++;
12260 SET_FRAME_GARBAGED (sf
);
12262 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12264 FRAME_TTY (sf
)->previous_frame
= sf
;
12267 /* Set the visible flags for all frames. Do this before checking
12268 for resized or garbaged frames; they want to know if their frames
12269 are visible. See the comment in frame.h for
12270 FRAME_SAMPLE_VISIBILITY. */
12272 Lisp_Object tail
, frame
;
12274 number_of_visible_frames
= 0;
12276 FOR_EACH_FRAME (tail
, frame
)
12278 struct frame
*f
= XFRAME (frame
);
12280 FRAME_SAMPLE_VISIBILITY (f
);
12281 if (FRAME_VISIBLE_P (f
))
12282 ++number_of_visible_frames
;
12283 clear_desired_matrices (f
);
12287 /* Notice any pending interrupt request to change frame size. */
12288 do_pending_window_change (1);
12290 /* do_pending_window_change could change the selected_window due to
12291 frame resizing which makes the selected window too small. */
12292 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12295 reconsider_clip_changes (w
, current_buffer
);
12298 /* Clear frames marked as garbaged. */
12299 if (frame_garbaged
)
12300 clear_garbaged_frames ();
12302 /* Build menubar and tool-bar items. */
12303 if (NILP (Vmemory_full
))
12304 prepare_menu_bars ();
12306 if (windows_or_buffers_changed
)
12307 update_mode_lines
++;
12309 /* Detect case that we need to write or remove a star in the mode line. */
12310 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12312 w
->update_mode_line
= Qt
;
12313 if (buffer_shared
> 1)
12314 update_mode_lines
++;
12317 /* Avoid invocation of point motion hooks by `current_column' below. */
12318 count1
= SPECPDL_INDEX ();
12319 specbind (Qinhibit_point_motion_hooks
, Qt
);
12321 /* If %c is in the mode line, update it if needed. */
12322 if (!NILP (w
->column_number_displayed
)
12323 /* This alternative quickly identifies a common case
12324 where no change is needed. */
12325 && !(PT
== XFASTINT (w
->last_point
)
12326 && XFASTINT (w
->last_modified
) >= MODIFF
12327 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12328 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12329 w
->update_mode_line
= Qt
;
12331 unbind_to (count1
, Qnil
);
12333 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12335 /* The variable buffer_shared is set in redisplay_window and
12336 indicates that we redisplay a buffer in different windows. See
12338 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12339 || cursor_type_changed
);
12341 /* If specs for an arrow have changed, do thorough redisplay
12342 to ensure we remove any arrow that should no longer exist. */
12343 if (overlay_arrows_changed_p ())
12344 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12346 /* Normally the message* functions will have already displayed and
12347 updated the echo area, but the frame may have been trashed, or
12348 the update may have been preempted, so display the echo area
12349 again here. Checking message_cleared_p captures the case that
12350 the echo area should be cleared. */
12351 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12352 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12353 || (message_cleared_p
12354 && minibuf_level
== 0
12355 /* If the mini-window is currently selected, this means the
12356 echo-area doesn't show through. */
12357 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12359 int window_height_changed_p
= echo_area_display (0);
12362 /* If we don't display the current message, don't clear the
12363 message_cleared_p flag, because, if we did, we wouldn't clear
12364 the echo area in the next redisplay which doesn't preserve
12366 if (!display_last_displayed_message_p
)
12367 message_cleared_p
= 0;
12369 if (fonts_changed_p
)
12371 else if (window_height_changed_p
)
12373 consider_all_windows_p
= 1;
12374 ++update_mode_lines
;
12375 ++windows_or_buffers_changed
;
12377 /* If window configuration was changed, frames may have been
12378 marked garbaged. Clear them or we will experience
12379 surprises wrt scrolling. */
12380 if (frame_garbaged
)
12381 clear_garbaged_frames ();
12384 else if (EQ (selected_window
, minibuf_window
)
12385 && (current_buffer
->clip_changed
12386 || XFASTINT (w
->last_modified
) < MODIFF
12387 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12388 && resize_mini_window (w
, 0))
12390 /* Resized active mini-window to fit the size of what it is
12391 showing if its contents might have changed. */
12393 /* FIXME: this causes all frames to be updated, which seems unnecessary
12394 since only the current frame needs to be considered. This function needs
12395 to be rewritten with two variables, consider_all_windows and
12396 consider_all_frames. */
12397 consider_all_windows_p
= 1;
12398 ++windows_or_buffers_changed
;
12399 ++update_mode_lines
;
12401 /* If window configuration was changed, frames may have been
12402 marked garbaged. Clear them or we will experience
12403 surprises wrt scrolling. */
12404 if (frame_garbaged
)
12405 clear_garbaged_frames ();
12409 /* If showing the region, and mark has changed, we must redisplay
12410 the whole window. The assignment to this_line_start_pos prevents
12411 the optimization directly below this if-statement. */
12412 if (((!NILP (Vtransient_mark_mode
)
12413 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12414 != !NILP (w
->region_showing
))
12415 || (!NILP (w
->region_showing
)
12416 && !EQ (w
->region_showing
,
12417 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12418 CHARPOS (this_line_start_pos
) = 0;
12420 /* Optimize the case that only the line containing the cursor in the
12421 selected window has changed. Variables starting with this_ are
12422 set in display_line and record information about the line
12423 containing the cursor. */
12424 tlbufpos
= this_line_start_pos
;
12425 tlendpos
= this_line_end_pos
;
12426 if (!consider_all_windows_p
12427 && CHARPOS (tlbufpos
) > 0
12428 && NILP (w
->update_mode_line
)
12429 && !current_buffer
->clip_changed
12430 && !current_buffer
->prevent_redisplay_optimizations_p
12431 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12432 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12433 /* Make sure recorded data applies to current buffer, etc. */
12434 && this_line_buffer
== current_buffer
12435 && current_buffer
== XBUFFER (w
->buffer
)
12436 && NILP (w
->force_start
)
12437 && NILP (w
->optional_new_start
)
12438 /* Point must be on the line that we have info recorded about. */
12439 && PT
>= CHARPOS (tlbufpos
)
12440 && PT
<= Z
- CHARPOS (tlendpos
)
12441 /* All text outside that line, including its final newline,
12442 must be unchanged. */
12443 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12444 CHARPOS (tlendpos
)))
12446 if (CHARPOS (tlbufpos
) > BEGV
12447 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12448 && (CHARPOS (tlbufpos
) == ZV
12449 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12450 /* Former continuation line has disappeared by becoming empty. */
12452 else if (XFASTINT (w
->last_modified
) < MODIFF
12453 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12454 || MINI_WINDOW_P (w
))
12456 /* We have to handle the case of continuation around a
12457 wide-column character (see the comment in indent.c around
12460 For instance, in the following case:
12462 -------- Insert --------
12463 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12464 J_I_ ==> J_I_ `^^' are cursors.
12468 As we have to redraw the line above, we cannot use this
12472 int line_height_before
= this_line_pixel_height
;
12474 /* Note that start_display will handle the case that the
12475 line starting at tlbufpos is a continuation line. */
12476 start_display (&it
, w
, tlbufpos
);
12478 /* Implementation note: It this still necessary? */
12479 if (it
.current_x
!= this_line_start_x
)
12482 TRACE ((stderr
, "trying display optimization 1\n"));
12483 w
->cursor
.vpos
= -1;
12484 overlay_arrow_seen
= 0;
12485 it
.vpos
= this_line_vpos
;
12486 it
.current_y
= this_line_y
;
12487 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12488 display_line (&it
);
12490 /* If line contains point, is not continued,
12491 and ends at same distance from eob as before, we win. */
12492 if (w
->cursor
.vpos
>= 0
12493 /* Line is not continued, otherwise this_line_start_pos
12494 would have been set to 0 in display_line. */
12495 && CHARPOS (this_line_start_pos
)
12496 /* Line ends as before. */
12497 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12498 /* Line has same height as before. Otherwise other lines
12499 would have to be shifted up or down. */
12500 && this_line_pixel_height
== line_height_before
)
12502 /* If this is not the window's last line, we must adjust
12503 the charstarts of the lines below. */
12504 if (it
.current_y
< it
.last_visible_y
)
12506 struct glyph_row
*row
12507 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12508 EMACS_INT delta
, delta_bytes
;
12510 /* We used to distinguish between two cases here,
12511 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12512 when the line ends in a newline or the end of the
12513 buffer's accessible portion. But both cases did
12514 the same, so they were collapsed. */
12516 - CHARPOS (tlendpos
)
12517 - MATRIX_ROW_START_CHARPOS (row
));
12518 delta_bytes
= (Z_BYTE
12519 - BYTEPOS (tlendpos
)
12520 - MATRIX_ROW_START_BYTEPOS (row
));
12522 increment_matrix_positions (w
->current_matrix
,
12523 this_line_vpos
+ 1,
12524 w
->current_matrix
->nrows
,
12525 delta
, delta_bytes
);
12528 /* If this row displays text now but previously didn't,
12529 or vice versa, w->window_end_vpos may have to be
12531 if ((it
.glyph_row
- 1)->displays_text_p
)
12533 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12534 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12536 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12537 && this_line_vpos
> 0)
12538 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12539 w
->window_end_valid
= Qnil
;
12541 /* Update hint: No need to try to scroll in update_window. */
12542 w
->desired_matrix
->no_scrolling_p
= 1;
12545 *w
->desired_matrix
->method
= 0;
12546 debug_method_add (w
, "optimization 1");
12548 #ifdef HAVE_WINDOW_SYSTEM
12549 update_window_fringes (w
, 0);
12556 else if (/* Cursor position hasn't changed. */
12557 PT
== XFASTINT (w
->last_point
)
12558 /* Make sure the cursor was last displayed
12559 in this window. Otherwise we have to reposition it. */
12560 && 0 <= w
->cursor
.vpos
12561 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12565 do_pending_window_change (1);
12566 /* If selected_window changed, redisplay again. */
12567 if (WINDOWP (selected_window
)
12568 && (w
= XWINDOW (selected_window
)) != sw
)
12571 /* We used to always goto end_of_redisplay here, but this
12572 isn't enough if we have a blinking cursor. */
12573 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12574 goto end_of_redisplay
;
12578 /* If highlighting the region, or if the cursor is in the echo area,
12579 then we can't just move the cursor. */
12580 else if (! (!NILP (Vtransient_mark_mode
)
12581 && !NILP (BVAR (current_buffer
, mark_active
)))
12582 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12583 || highlight_nonselected_windows
)
12584 && NILP (w
->region_showing
)
12585 && NILP (Vshow_trailing_whitespace
)
12586 && !cursor_in_echo_area
)
12589 struct glyph_row
*row
;
12591 /* Skip from tlbufpos to PT and see where it is. Note that
12592 PT may be in invisible text. If so, we will end at the
12593 next visible position. */
12594 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12595 NULL
, DEFAULT_FACE_ID
);
12596 it
.current_x
= this_line_start_x
;
12597 it
.current_y
= this_line_y
;
12598 it
.vpos
= this_line_vpos
;
12600 /* The call to move_it_to stops in front of PT, but
12601 moves over before-strings. */
12602 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12604 if (it
.vpos
== this_line_vpos
12605 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12608 xassert (this_line_vpos
== it
.vpos
);
12609 xassert (this_line_y
== it
.current_y
);
12610 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12612 *w
->desired_matrix
->method
= 0;
12613 debug_method_add (w
, "optimization 3");
12622 /* Text changed drastically or point moved off of line. */
12623 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12626 CHARPOS (this_line_start_pos
) = 0;
12627 consider_all_windows_p
|= buffer_shared
> 1;
12628 ++clear_face_cache_count
;
12629 #ifdef HAVE_WINDOW_SYSTEM
12630 ++clear_image_cache_count
;
12633 /* Build desired matrices, and update the display. If
12634 consider_all_windows_p is non-zero, do it for all windows on all
12635 frames. Otherwise do it for selected_window, only. */
12637 if (consider_all_windows_p
)
12639 Lisp_Object tail
, frame
;
12641 FOR_EACH_FRAME (tail
, frame
)
12642 XFRAME (frame
)->updated_p
= 0;
12644 /* Recompute # windows showing selected buffer. This will be
12645 incremented each time such a window is displayed. */
12648 FOR_EACH_FRAME (tail
, frame
)
12650 struct frame
*f
= XFRAME (frame
);
12652 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12654 if (! EQ (frame
, selected_frame
))
12655 /* Select the frame, for the sake of frame-local
12657 select_frame_for_redisplay (frame
);
12659 /* Mark all the scroll bars to be removed; we'll redeem
12660 the ones we want when we redisplay their windows. */
12661 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12662 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12664 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12665 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12667 /* The X error handler may have deleted that frame. */
12668 if (!FRAME_LIVE_P (f
))
12671 /* Any scroll bars which redisplay_windows should have
12672 nuked should now go away. */
12673 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12674 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12676 /* If fonts changed, display again. */
12677 /* ??? rms: I suspect it is a mistake to jump all the way
12678 back to retry here. It should just retry this frame. */
12679 if (fonts_changed_p
)
12682 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12684 /* See if we have to hscroll. */
12685 if (!f
->already_hscrolled_p
)
12687 f
->already_hscrolled_p
= 1;
12688 if (hscroll_windows (f
->root_window
))
12692 /* Prevent various kinds of signals during display
12693 update. stdio is not robust about handling
12694 signals, which can cause an apparent I/O
12696 if (interrupt_input
)
12697 unrequest_sigio ();
12700 /* Update the display. */
12701 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12702 pending
|= update_frame (f
, 0, 0);
12708 if (!EQ (old_frame
, selected_frame
)
12709 && FRAME_LIVE_P (XFRAME (old_frame
)))
12710 /* We played a bit fast-and-loose above and allowed selected_frame
12711 and selected_window to be temporarily out-of-sync but let's make
12712 sure this stays contained. */
12713 select_frame_for_redisplay (old_frame
);
12714 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12718 /* Do the mark_window_display_accurate after all windows have
12719 been redisplayed because this call resets flags in buffers
12720 which are needed for proper redisplay. */
12721 FOR_EACH_FRAME (tail
, frame
)
12723 struct frame
*f
= XFRAME (frame
);
12726 mark_window_display_accurate (f
->root_window
, 1);
12727 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12728 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12733 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12735 Lisp_Object mini_window
;
12736 struct frame
*mini_frame
;
12738 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12739 /* Use list_of_error, not Qerror, so that
12740 we catch only errors and don't run the debugger. */
12741 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12743 redisplay_window_error
);
12745 /* Compare desired and current matrices, perform output. */
12748 /* If fonts changed, display again. */
12749 if (fonts_changed_p
)
12752 /* Prevent various kinds of signals during display update.
12753 stdio is not robust about handling signals,
12754 which can cause an apparent I/O error. */
12755 if (interrupt_input
)
12756 unrequest_sigio ();
12759 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12761 if (hscroll_windows (selected_window
))
12764 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12765 pending
= update_frame (sf
, 0, 0);
12768 /* We may have called echo_area_display at the top of this
12769 function. If the echo area is on another frame, that may
12770 have put text on a frame other than the selected one, so the
12771 above call to update_frame would not have caught it. Catch
12773 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12774 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12776 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12778 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12779 pending
|= update_frame (mini_frame
, 0, 0);
12780 if (!pending
&& hscroll_windows (mini_window
))
12785 /* If display was paused because of pending input, make sure we do a
12786 thorough update the next time. */
12789 /* Prevent the optimization at the beginning of
12790 redisplay_internal that tries a single-line update of the
12791 line containing the cursor in the selected window. */
12792 CHARPOS (this_line_start_pos
) = 0;
12794 /* Let the overlay arrow be updated the next time. */
12795 update_overlay_arrows (0);
12797 /* If we pause after scrolling, some rows in the current
12798 matrices of some windows are not valid. */
12799 if (!WINDOW_FULL_WIDTH_P (w
)
12800 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12801 update_mode_lines
= 1;
12805 if (!consider_all_windows_p
)
12807 /* This has already been done above if
12808 consider_all_windows_p is set. */
12809 mark_window_display_accurate_1 (w
, 1);
12811 /* Say overlay arrows are up to date. */
12812 update_overlay_arrows (1);
12814 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12815 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12818 update_mode_lines
= 0;
12819 windows_or_buffers_changed
= 0;
12820 cursor_type_changed
= 0;
12823 /* Start SIGIO interrupts coming again. Having them off during the
12824 code above makes it less likely one will discard output, but not
12825 impossible, since there might be stuff in the system buffer here.
12826 But it is much hairier to try to do anything about that. */
12827 if (interrupt_input
)
12831 /* If a frame has become visible which was not before, redisplay
12832 again, so that we display it. Expose events for such a frame
12833 (which it gets when becoming visible) don't call the parts of
12834 redisplay constructing glyphs, so simply exposing a frame won't
12835 display anything in this case. So, we have to display these
12836 frames here explicitly. */
12839 Lisp_Object tail
, frame
;
12842 FOR_EACH_FRAME (tail
, frame
)
12844 int this_is_visible
= 0;
12846 if (XFRAME (frame
)->visible
)
12847 this_is_visible
= 1;
12848 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12849 if (XFRAME (frame
)->visible
)
12850 this_is_visible
= 1;
12852 if (this_is_visible
)
12856 if (new_count
!= number_of_visible_frames
)
12857 windows_or_buffers_changed
++;
12860 /* Change frame size now if a change is pending. */
12861 do_pending_window_change (1);
12863 /* If we just did a pending size change, or have additional
12864 visible frames, or selected_window changed, redisplay again. */
12865 if ((windows_or_buffers_changed
&& !pending
)
12866 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12869 /* Clear the face and image caches.
12871 We used to do this only if consider_all_windows_p. But the cache
12872 needs to be cleared if a timer creates images in the current
12873 buffer (e.g. the test case in Bug#6230). */
12875 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12877 clear_face_cache (0);
12878 clear_face_cache_count
= 0;
12881 #ifdef HAVE_WINDOW_SYSTEM
12882 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12884 clear_image_caches (Qnil
);
12885 clear_image_cache_count
= 0;
12887 #endif /* HAVE_WINDOW_SYSTEM */
12890 unbind_to (count
, Qnil
);
12895 /* Redisplay, but leave alone any recent echo area message unless
12896 another message has been requested in its place.
12898 This is useful in situations where you need to redisplay but no
12899 user action has occurred, making it inappropriate for the message
12900 area to be cleared. See tracking_off and
12901 wait_reading_process_output for examples of these situations.
12903 FROM_WHERE is an integer saying from where this function was
12904 called. This is useful for debugging. */
12907 redisplay_preserve_echo_area (int from_where
)
12909 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12911 if (!NILP (echo_area_buffer
[1]))
12913 /* We have a previously displayed message, but no current
12914 message. Redisplay the previous message. */
12915 display_last_displayed_message_p
= 1;
12916 redisplay_internal ();
12917 display_last_displayed_message_p
= 0;
12920 redisplay_internal ();
12922 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12923 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12924 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12928 /* Function registered with record_unwind_protect in
12929 redisplay_internal. Reset redisplaying_p to the value it had
12930 before redisplay_internal was called, and clear
12931 prevent_freeing_realized_faces_p. It also selects the previously
12932 selected frame, unless it has been deleted (by an X connection
12933 failure during redisplay, for example). */
12936 unwind_redisplay (Lisp_Object val
)
12938 Lisp_Object old_redisplaying_p
, old_frame
;
12940 old_redisplaying_p
= XCAR (val
);
12941 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12942 old_frame
= XCDR (val
);
12943 if (! EQ (old_frame
, selected_frame
)
12944 && FRAME_LIVE_P (XFRAME (old_frame
)))
12945 select_frame_for_redisplay (old_frame
);
12950 /* Mark the display of window W as accurate or inaccurate. If
12951 ACCURATE_P is non-zero mark display of W as accurate. If
12952 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12953 redisplay_internal is called. */
12956 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12958 if (BUFFERP (w
->buffer
))
12960 struct buffer
*b
= XBUFFER (w
->buffer
);
12963 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12964 w
->last_overlay_modified
12965 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12967 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12971 b
->clip_changed
= 0;
12972 b
->prevent_redisplay_optimizations_p
= 0;
12974 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12975 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12976 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12977 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12979 w
->current_matrix
->buffer
= b
;
12980 w
->current_matrix
->begv
= BUF_BEGV (b
);
12981 w
->current_matrix
->zv
= BUF_ZV (b
);
12983 w
->last_cursor
= w
->cursor
;
12984 w
->last_cursor_off_p
= w
->cursor_off_p
;
12986 if (w
== XWINDOW (selected_window
))
12987 w
->last_point
= make_number (BUF_PT (b
));
12989 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12995 w
->window_end_valid
= w
->buffer
;
12996 w
->update_mode_line
= Qnil
;
13001 /* Mark the display of windows in the window tree rooted at WINDOW as
13002 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13003 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13004 be redisplayed the next time redisplay_internal is called. */
13007 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13011 for (; !NILP (window
); window
= w
->next
)
13013 w
= XWINDOW (window
);
13014 mark_window_display_accurate_1 (w
, accurate_p
);
13016 if (!NILP (w
->vchild
))
13017 mark_window_display_accurate (w
->vchild
, accurate_p
);
13018 if (!NILP (w
->hchild
))
13019 mark_window_display_accurate (w
->hchild
, accurate_p
);
13024 update_overlay_arrows (1);
13028 /* Force a thorough redisplay the next time by setting
13029 last_arrow_position and last_arrow_string to t, which is
13030 unequal to any useful value of Voverlay_arrow_... */
13031 update_overlay_arrows (-1);
13036 /* Return value in display table DP (Lisp_Char_Table *) for character
13037 C. Since a display table doesn't have any parent, we don't have to
13038 follow parent. Do not call this function directly but use the
13039 macro DISP_CHAR_VECTOR. */
13042 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13046 if (ASCII_CHAR_P (c
))
13049 if (SUB_CHAR_TABLE_P (val
))
13050 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13056 XSETCHAR_TABLE (table
, dp
);
13057 val
= char_table_ref (table
, c
);
13066 /***********************************************************************
13068 ***********************************************************************/
13070 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13073 redisplay_windows (Lisp_Object window
)
13075 while (!NILP (window
))
13077 struct window
*w
= XWINDOW (window
);
13079 if (!NILP (w
->hchild
))
13080 redisplay_windows (w
->hchild
);
13081 else if (!NILP (w
->vchild
))
13082 redisplay_windows (w
->vchild
);
13083 else if (!NILP (w
->buffer
))
13085 displayed_buffer
= XBUFFER (w
->buffer
);
13086 /* Use list_of_error, not Qerror, so that
13087 we catch only errors and don't run the debugger. */
13088 internal_condition_case_1 (redisplay_window_0
, window
,
13090 redisplay_window_error
);
13098 redisplay_window_error (Lisp_Object ignore
)
13100 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13105 redisplay_window_0 (Lisp_Object window
)
13107 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13108 redisplay_window (window
, 0);
13113 redisplay_window_1 (Lisp_Object window
)
13115 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13116 redisplay_window (window
, 1);
13121 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13122 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13123 which positions recorded in ROW differ from current buffer
13126 Return 0 if cursor is not on this row, 1 otherwise. */
13129 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13130 struct glyph_matrix
*matrix
,
13131 EMACS_INT delta
, EMACS_INT delta_bytes
,
13134 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13135 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13136 struct glyph
*cursor
= NULL
;
13137 /* The last known character position in row. */
13138 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13140 EMACS_INT pt_old
= PT
- delta
;
13141 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13142 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13143 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13144 /* A glyph beyond the edge of TEXT_AREA which we should never
13146 struct glyph
*glyphs_end
= end
;
13147 /* Non-zero means we've found a match for cursor position, but that
13148 glyph has the avoid_cursor_p flag set. */
13149 int match_with_avoid_cursor
= 0;
13150 /* Non-zero means we've seen at least one glyph that came from a
13152 int string_seen
= 0;
13153 /* Largest and smalles buffer positions seen so far during scan of
13155 EMACS_INT bpos_max
= pos_before
;
13156 EMACS_INT bpos_min
= pos_after
;
13157 /* Last buffer position covered by an overlay string with an integer
13158 `cursor' property. */
13159 EMACS_INT bpos_covered
= 0;
13161 /* Skip over glyphs not having an object at the start and the end of
13162 the row. These are special glyphs like truncation marks on
13163 terminal frames. */
13164 if (row
->displays_text_p
)
13166 if (!row
->reversed_p
)
13169 && INTEGERP (glyph
->object
)
13170 && glyph
->charpos
< 0)
13172 x
+= glyph
->pixel_width
;
13176 && INTEGERP ((end
- 1)->object
)
13177 /* CHARPOS is zero for blanks and stretch glyphs
13178 inserted by extend_face_to_end_of_line. */
13179 && (end
- 1)->charpos
<= 0)
13181 glyph_before
= glyph
- 1;
13188 /* If the glyph row is reversed, we need to process it from back
13189 to front, so swap the edge pointers. */
13190 glyphs_end
= end
= glyph
- 1;
13191 glyph
+= row
->used
[TEXT_AREA
] - 1;
13193 while (glyph
> end
+ 1
13194 && INTEGERP (glyph
->object
)
13195 && glyph
->charpos
< 0)
13198 x
-= glyph
->pixel_width
;
13200 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13202 /* By default, in reversed rows we put the cursor on the
13203 rightmost (first in the reading order) glyph. */
13204 for (g
= end
+ 1; g
< glyph
; g
++)
13205 x
+= g
->pixel_width
;
13207 && INTEGERP ((end
+ 1)->object
)
13208 && (end
+ 1)->charpos
<= 0)
13210 glyph_before
= glyph
+ 1;
13214 else if (row
->reversed_p
)
13216 /* In R2L rows that don't display text, put the cursor on the
13217 rightmost glyph. Case in point: an empty last line that is
13218 part of an R2L paragraph. */
13220 /* Avoid placing the cursor on the last glyph of the row, where
13221 on terminal frames we hold the vertical border between
13222 adjacent windows. */
13223 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13224 && !WINDOW_RIGHTMOST_P (w
)
13225 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13227 x
= -1; /* will be computed below, at label compute_x */
13230 /* Step 1: Try to find the glyph whose character position
13231 corresponds to point. If that's not possible, find 2 glyphs
13232 whose character positions are the closest to point, one before
13233 point, the other after it. */
13234 if (!row
->reversed_p
)
13235 while (/* not marched to end of glyph row */
13237 /* glyph was not inserted by redisplay for internal purposes */
13238 && !INTEGERP (glyph
->object
))
13240 if (BUFFERP (glyph
->object
))
13242 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13244 if (glyph
->charpos
> bpos_max
)
13245 bpos_max
= glyph
->charpos
;
13246 if (glyph
->charpos
< bpos_min
)
13247 bpos_min
= glyph
->charpos
;
13248 if (!glyph
->avoid_cursor_p
)
13250 /* If we hit point, we've found the glyph on which to
13251 display the cursor. */
13254 match_with_avoid_cursor
= 0;
13257 /* See if we've found a better approximation to
13258 POS_BEFORE or to POS_AFTER. Note that we want the
13259 first (leftmost) glyph of all those that are the
13260 closest from below, and the last (rightmost) of all
13261 those from above. */
13262 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13264 pos_before
= glyph
->charpos
;
13265 glyph_before
= glyph
;
13267 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13269 pos_after
= glyph
->charpos
;
13270 glyph_after
= glyph
;
13273 else if (dpos
== 0)
13274 match_with_avoid_cursor
= 1;
13276 else if (STRINGP (glyph
->object
))
13278 Lisp_Object chprop
;
13279 EMACS_INT glyph_pos
= glyph
->charpos
;
13281 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13283 if (INTEGERP (chprop
))
13285 bpos_covered
= bpos_max
+ XINT (chprop
);
13286 /* If the `cursor' property covers buffer positions up
13287 to and including point, we should display cursor on
13288 this glyph. Note that overlays and text properties
13289 with string values stop bidi reordering, so every
13290 buffer position to the left of the string is always
13291 smaller than any position to the right of the
13292 string. Therefore, if a `cursor' property on one
13293 of the string's characters has an integer value, we
13294 will break out of the loop below _before_ we get to
13295 the position match above. IOW, integer values of
13296 the `cursor' property override the "exact match for
13297 point" strategy of positioning the cursor. */
13298 /* Implementation note: bpos_max == pt_old when, e.g.,
13299 we are in an empty line, where bpos_max is set to
13300 MATRIX_ROW_START_CHARPOS, see above. */
13301 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13310 x
+= glyph
->pixel_width
;
13313 else if (glyph
> end
) /* row is reversed */
13314 while (!INTEGERP (glyph
->object
))
13316 if (BUFFERP (glyph
->object
))
13318 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13320 if (glyph
->charpos
> bpos_max
)
13321 bpos_max
= glyph
->charpos
;
13322 if (glyph
->charpos
< bpos_min
)
13323 bpos_min
= glyph
->charpos
;
13324 if (!glyph
->avoid_cursor_p
)
13328 match_with_avoid_cursor
= 0;
13331 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13333 pos_before
= glyph
->charpos
;
13334 glyph_before
= glyph
;
13336 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13338 pos_after
= glyph
->charpos
;
13339 glyph_after
= glyph
;
13342 else if (dpos
== 0)
13343 match_with_avoid_cursor
= 1;
13345 else if (STRINGP (glyph
->object
))
13347 Lisp_Object chprop
;
13348 EMACS_INT glyph_pos
= glyph
->charpos
;
13350 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13352 if (INTEGERP (chprop
))
13354 bpos_covered
= bpos_max
+ XINT (chprop
);
13355 /* If the `cursor' property covers buffer positions up
13356 to and including point, we should display cursor on
13358 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13367 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13369 x
--; /* can't use any pixel_width */
13372 x
-= glyph
->pixel_width
;
13375 /* Step 2: If we didn't find an exact match for point, we need to
13376 look for a proper place to put the cursor among glyphs between
13377 GLYPH_BEFORE and GLYPH_AFTER. */
13378 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13379 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13380 && bpos_covered
< pt_old
)
13382 /* An empty line has a single glyph whose OBJECT is zero and
13383 whose CHARPOS is the position of a newline on that line.
13384 Note that on a TTY, there are more glyphs after that, which
13385 were produced by extend_face_to_end_of_line, but their
13386 CHARPOS is zero or negative. */
13388 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13389 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13391 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13393 EMACS_INT ellipsis_pos
;
13395 /* Scan back over the ellipsis glyphs. */
13396 if (!row
->reversed_p
)
13398 ellipsis_pos
= (glyph
- 1)->charpos
;
13399 while (glyph
> row
->glyphs
[TEXT_AREA
]
13400 && (glyph
- 1)->charpos
== ellipsis_pos
)
13401 glyph
--, x
-= glyph
->pixel_width
;
13402 /* That loop always goes one position too far, including
13403 the glyph before the ellipsis. So scan forward over
13405 x
+= glyph
->pixel_width
;
13408 else /* row is reversed */
13410 ellipsis_pos
= (glyph
+ 1)->charpos
;
13411 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13412 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13413 glyph
++, x
+= glyph
->pixel_width
;
13414 x
-= glyph
->pixel_width
;
13418 else if (match_with_avoid_cursor
13419 /* A truncated row may not include PT among its
13420 character positions. Setting the cursor inside the
13421 scroll margin will trigger recalculation of hscroll
13422 in hscroll_window_tree. */
13423 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13424 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13425 /* Zero-width characters produce no glyphs. */
13428 && (row
->reversed_p
13429 ? glyph_after
> glyphs_end
13430 : glyph_after
< glyphs_end
)))
13432 cursor
= glyph_after
;
13435 else if (string_seen
)
13437 int incr
= row
->reversed_p
? -1 : +1;
13439 /* Need to find the glyph that came out of a string which is
13440 present at point. That glyph is somewhere between
13441 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13442 positioned between POS_BEFORE and POS_AFTER in the
13444 struct glyph
*start
, *stop
;
13445 EMACS_INT pos
= pos_before
;
13449 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13450 correspond to POS_BEFORE and POS_AFTER, respectively. We
13451 need START and STOP in the order that corresponds to the
13452 row's direction as given by its reversed_p flag. If the
13453 directionality of characters between POS_BEFORE and
13454 POS_AFTER is the opposite of the row's base direction,
13455 these characters will have been reordered for display,
13456 and we need to reverse START and STOP. */
13457 if (!row
->reversed_p
)
13459 start
= min (glyph_before
, glyph_after
);
13460 stop
= max (glyph_before
, glyph_after
);
13464 start
= max (glyph_before
, glyph_after
);
13465 stop
= min (glyph_before
, glyph_after
);
13467 for (glyph
= start
+ incr
;
13468 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13471 /* Any glyphs that come from the buffer are here because
13472 of bidi reordering. Skip them, and only pay
13473 attention to glyphs that came from some string. */
13474 if (STRINGP (glyph
->object
))
13479 str
= glyph
->object
;
13480 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13481 if (tem
== 0 /* from overlay */
13484 /* If the string from which this glyph came is
13485 found in the buffer at point, then we've
13486 found the glyph we've been looking for. If
13487 it comes from an overlay (tem == 0), and it
13488 has the `cursor' property on one of its
13489 glyphs, record that glyph as a candidate for
13490 displaying the cursor. (As in the
13491 unidirectional version, we will display the
13492 cursor on the last candidate we find.) */
13493 if (tem
== 0 || tem
== pt_old
)
13495 /* The glyphs from this string could have
13496 been reordered. Find the one with the
13497 smallest string position. Or there could
13498 be a character in the string with the
13499 `cursor' property, which means display
13500 cursor on that character's glyph. */
13501 EMACS_INT strpos
= glyph
->charpos
;
13506 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13507 && EQ (glyph
->object
, str
);
13511 EMACS_INT gpos
= glyph
->charpos
;
13513 cprop
= Fget_char_property (make_number (gpos
),
13521 if (tem
&& glyph
->charpos
< strpos
)
13523 strpos
= glyph
->charpos
;
13532 pos
= tem
+ 1; /* don't find previous instances */
13534 /* This string is not what we want; skip all of the
13535 glyphs that came from it. */
13536 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13537 && EQ (glyph
->object
, str
))
13544 /* If we reached the end of the line, and END was from a string,
13545 the cursor is not on this line. */
13547 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13548 && STRINGP (end
->object
)
13549 && row
->continued_p
)
13555 if (cursor
!= NULL
)
13561 /* Need to compute x that corresponds to GLYPH. */
13562 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13564 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13566 x
+= g
->pixel_width
;
13570 /* ROW could be part of a continued line, which, under bidi
13571 reordering, might have other rows whose start and end charpos
13572 occlude point. Only set w->cursor if we found a better
13573 approximation to the cursor position than we have from previously
13574 examined candidate rows belonging to the same continued line. */
13575 if (/* we already have a candidate row */
13576 w
->cursor
.vpos
>= 0
13577 /* that candidate is not the row we are processing */
13578 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13579 /* the row we are processing is part of a continued line */
13580 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13581 /* Make sure cursor.vpos specifies a row whose start and end
13582 charpos occlude point. This is because some callers of this
13583 function leave cursor.vpos at the row where the cursor was
13584 displayed during the last redisplay cycle. */
13585 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13586 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13589 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13591 /* Don't consider glyphs that are outside TEXT_AREA. */
13592 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13594 /* Keep the candidate whose buffer position is the closest to
13596 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13597 w
->cursor
.hpos
>= 0
13598 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13599 && BUFFERP (g1
->object
)
13600 && (g1
->charpos
== pt_old
/* an exact match always wins */
13601 || (BUFFERP (glyph
->object
)
13602 && eabs (g1
->charpos
- pt_old
)
13603 < eabs (glyph
->charpos
- pt_old
))))
13605 /* If this candidate gives an exact match, use that. */
13606 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13607 /* Otherwise, keep the candidate that comes from a row
13608 spanning less buffer positions. This may win when one or
13609 both candidate positions are on glyphs that came from
13610 display strings, for which we cannot compare buffer
13612 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13613 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13614 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13617 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13619 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13620 w
->cursor
.y
= row
->y
+ dy
;
13622 if (w
== XWINDOW (selected_window
))
13624 if (!row
->continued_p
13625 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13628 this_line_buffer
= XBUFFER (w
->buffer
);
13630 CHARPOS (this_line_start_pos
)
13631 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13632 BYTEPOS (this_line_start_pos
)
13633 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13635 CHARPOS (this_line_end_pos
)
13636 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13637 BYTEPOS (this_line_end_pos
)
13638 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13640 this_line_y
= w
->cursor
.y
;
13641 this_line_pixel_height
= row
->height
;
13642 this_line_vpos
= w
->cursor
.vpos
;
13643 this_line_start_x
= row
->x
;
13646 CHARPOS (this_line_start_pos
) = 0;
13653 /* Run window scroll functions, if any, for WINDOW with new window
13654 start STARTP. Sets the window start of WINDOW to that position.
13656 We assume that the window's buffer is really current. */
13658 static inline struct text_pos
13659 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13661 struct window
*w
= XWINDOW (window
);
13662 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13664 if (current_buffer
!= XBUFFER (w
->buffer
))
13667 if (!NILP (Vwindow_scroll_functions
))
13669 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13670 make_number (CHARPOS (startp
)));
13671 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13672 /* In case the hook functions switch buffers. */
13673 if (current_buffer
!= XBUFFER (w
->buffer
))
13674 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13681 /* Make sure the line containing the cursor is fully visible.
13682 A value of 1 means there is nothing to be done.
13683 (Either the line is fully visible, or it cannot be made so,
13684 or we cannot tell.)
13686 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13687 is higher than window.
13689 A value of 0 means the caller should do scrolling
13690 as if point had gone off the screen. */
13693 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13695 struct glyph_matrix
*matrix
;
13696 struct glyph_row
*row
;
13699 if (!make_cursor_line_fully_visible_p
)
13702 /* It's not always possible to find the cursor, e.g, when a window
13703 is full of overlay strings. Don't do anything in that case. */
13704 if (w
->cursor
.vpos
< 0)
13707 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13708 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13710 /* If the cursor row is not partially visible, there's nothing to do. */
13711 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13714 /* If the row the cursor is in is taller than the window's height,
13715 it's not clear what to do, so do nothing. */
13716 window_height
= window_box_height (w
);
13717 if (row
->height
>= window_height
)
13719 if (!force_p
|| MINI_WINDOW_P (w
)
13720 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13727 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13728 non-zero means only WINDOW is redisplayed in redisplay_internal.
13729 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13730 in redisplay_window to bring a partially visible line into view in
13731 the case that only the cursor has moved.
13733 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13734 last screen line's vertical height extends past the end of the screen.
13738 1 if scrolling succeeded
13740 0 if scrolling didn't find point.
13742 -1 if new fonts have been loaded so that we must interrupt
13743 redisplay, adjust glyph matrices, and try again. */
13749 SCROLLING_NEED_LARGER_MATRICES
13752 /* If scroll-conservatively is more than this, never recenter.
13754 If you change this, don't forget to update the doc string of
13755 `scroll-conservatively' and the Emacs manual. */
13756 #define SCROLL_LIMIT 100
13759 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13760 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13761 int temp_scroll_step
, int last_line_misfit
)
13763 struct window
*w
= XWINDOW (window
);
13764 struct frame
*f
= XFRAME (w
->frame
);
13765 struct text_pos pos
, startp
;
13767 int this_scroll_margin
, scroll_max
, rc
, height
;
13768 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13769 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13770 Lisp_Object aggressive
;
13771 /* We will never try scrolling more than this number of lines. */
13772 int scroll_limit
= SCROLL_LIMIT
;
13775 debug_method_add (w
, "try_scrolling");
13778 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13780 /* Compute scroll margin height in pixels. We scroll when point is
13781 within this distance from the top or bottom of the window. */
13782 if (scroll_margin
> 0)
13783 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13784 * FRAME_LINE_HEIGHT (f
);
13786 this_scroll_margin
= 0;
13788 /* Force arg_scroll_conservatively to have a reasonable value, to
13789 avoid scrolling too far away with slow move_it_* functions. Note
13790 that the user can supply scroll-conservatively equal to
13791 `most-positive-fixnum', which can be larger than INT_MAX. */
13792 if (arg_scroll_conservatively
> scroll_limit
)
13794 arg_scroll_conservatively
= scroll_limit
+ 1;
13795 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13797 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13798 /* Compute how much we should try to scroll maximally to bring
13799 point into view. */
13800 scroll_max
= (max (scroll_step
,
13801 max (arg_scroll_conservatively
, temp_scroll_step
))
13802 * FRAME_LINE_HEIGHT (f
));
13803 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13804 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13805 /* We're trying to scroll because of aggressive scrolling but no
13806 scroll_step is set. Choose an arbitrary one. */
13807 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13813 /* Decide whether to scroll down. */
13814 if (PT
> CHARPOS (startp
))
13816 int scroll_margin_y
;
13818 /* Compute the pixel ypos of the scroll margin, then move it to
13819 either that ypos or PT, whichever comes first. */
13820 start_display (&it
, w
, startp
);
13821 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13822 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13823 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13824 (MOVE_TO_POS
| MOVE_TO_Y
));
13826 if (PT
> CHARPOS (it
.current
.pos
))
13828 int y0
= line_bottom_y (&it
);
13829 /* Compute how many pixels below window bottom to stop searching
13830 for PT. This avoids costly search for PT that is far away if
13831 the user limited scrolling by a small number of lines, but
13832 always finds PT if scroll_conservatively is set to a large
13833 number, such as most-positive-fixnum. */
13834 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13835 int y_to_move
= it
.last_visible_y
+ slack
;
13837 /* Compute the distance from the scroll margin to PT or to
13838 the scroll limit, whichever comes first. This should
13839 include the height of the cursor line, to make that line
13841 move_it_to (&it
, PT
, -1, y_to_move
,
13842 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13843 dy
= line_bottom_y (&it
) - y0
;
13845 if (dy
> scroll_max
)
13846 return SCROLLING_FAILED
;
13854 /* Point is in or below the bottom scroll margin, so move the
13855 window start down. If scrolling conservatively, move it just
13856 enough down to make point visible. If scroll_step is set,
13857 move it down by scroll_step. */
13858 if (arg_scroll_conservatively
)
13860 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13861 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13862 else if (scroll_step
|| temp_scroll_step
)
13863 amount_to_scroll
= scroll_max
;
13866 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13867 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13868 if (NUMBERP (aggressive
))
13870 double float_amount
= XFLOATINT (aggressive
) * height
;
13871 amount_to_scroll
= float_amount
;
13872 if (amount_to_scroll
== 0 && float_amount
> 0)
13873 amount_to_scroll
= 1;
13874 /* Don't let point enter the scroll margin near top of
13876 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13877 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13881 if (amount_to_scroll
<= 0)
13882 return SCROLLING_FAILED
;
13884 start_display (&it
, w
, startp
);
13885 if (arg_scroll_conservatively
<= scroll_limit
)
13886 move_it_vertically (&it
, amount_to_scroll
);
13889 /* Extra precision for users who set scroll-conservatively
13890 to a large number: make sure the amount we scroll
13891 the window start is never less than amount_to_scroll,
13892 which was computed as distance from window bottom to
13893 point. This matters when lines at window top and lines
13894 below window bottom have different height. */
13896 void *it1data
= NULL
;
13897 /* We use a temporary it1 because line_bottom_y can modify
13898 its argument, if it moves one line down; see there. */
13901 SAVE_IT (it1
, it
, it1data
);
13902 start_y
= line_bottom_y (&it1
);
13904 RESTORE_IT (&it
, &it
, it1data
);
13905 move_it_by_lines (&it
, 1);
13906 SAVE_IT (it1
, it
, it1data
);
13907 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13910 /* If STARTP is unchanged, move it down another screen line. */
13911 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13912 move_it_by_lines (&it
, 1);
13913 startp
= it
.current
.pos
;
13917 struct text_pos scroll_margin_pos
= startp
;
13919 /* See if point is inside the scroll margin at the top of the
13921 if (this_scroll_margin
)
13923 start_display (&it
, w
, startp
);
13924 move_it_vertically (&it
, this_scroll_margin
);
13925 scroll_margin_pos
= it
.current
.pos
;
13928 if (PT
< CHARPOS (scroll_margin_pos
))
13930 /* Point is in the scroll margin at the top of the window or
13931 above what is displayed in the window. */
13934 /* Compute the vertical distance from PT to the scroll
13935 margin position. Move as far as scroll_max allows, or
13936 one screenful, or 10 screen lines, whichever is largest.
13937 Give up if distance is greater than scroll_max. */
13938 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13939 start_display (&it
, w
, pos
);
13941 y_to_move
= max (it
.last_visible_y
,
13942 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13943 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13945 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13946 dy
= it
.current_y
- y0
;
13947 if (dy
> scroll_max
)
13948 return SCROLLING_FAILED
;
13950 /* Compute new window start. */
13951 start_display (&it
, w
, startp
);
13953 if (arg_scroll_conservatively
)
13954 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13955 max (scroll_step
, temp_scroll_step
));
13956 else if (scroll_step
|| temp_scroll_step
)
13957 amount_to_scroll
= scroll_max
;
13960 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13961 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13962 if (NUMBERP (aggressive
))
13964 double float_amount
= XFLOATINT (aggressive
) * height
;
13965 amount_to_scroll
= float_amount
;
13966 if (amount_to_scroll
== 0 && float_amount
> 0)
13967 amount_to_scroll
= 1;
13968 amount_to_scroll
-=
13969 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13970 /* Don't let point enter the scroll margin near
13971 bottom of the window. */
13972 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13973 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13977 if (amount_to_scroll
<= 0)
13978 return SCROLLING_FAILED
;
13980 move_it_vertically_backward (&it
, amount_to_scroll
);
13981 startp
= it
.current
.pos
;
13985 /* Run window scroll functions. */
13986 startp
= run_window_scroll_functions (window
, startp
);
13988 /* Display the window. Give up if new fonts are loaded, or if point
13990 if (!try_window (window
, startp
, 0))
13991 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13992 else if (w
->cursor
.vpos
< 0)
13994 clear_glyph_matrix (w
->desired_matrix
);
13995 rc
= SCROLLING_FAILED
;
13999 /* Maybe forget recorded base line for line number display. */
14000 if (!just_this_one_p
14001 || current_buffer
->clip_changed
14002 || BEG_UNCHANGED
< CHARPOS (startp
))
14003 w
->base_line_number
= Qnil
;
14005 /* If cursor ends up on a partially visible line,
14006 treat that as being off the bottom of the screen. */
14007 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14008 /* It's possible that the cursor is on the first line of the
14009 buffer, which is partially obscured due to a vscroll
14010 (Bug#7537). In that case, avoid looping forever . */
14011 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14013 clear_glyph_matrix (w
->desired_matrix
);
14014 ++extra_scroll_margin_lines
;
14017 rc
= SCROLLING_SUCCESS
;
14024 /* Compute a suitable window start for window W if display of W starts
14025 on a continuation line. Value is non-zero if a new window start
14028 The new window start will be computed, based on W's width, starting
14029 from the start of the continued line. It is the start of the
14030 screen line with the minimum distance from the old start W->start. */
14033 compute_window_start_on_continuation_line (struct window
*w
)
14035 struct text_pos pos
, start_pos
;
14036 int window_start_changed_p
= 0;
14038 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14040 /* If window start is on a continuation line... Window start may be
14041 < BEGV in case there's invisible text at the start of the
14042 buffer (M-x rmail, for example). */
14043 if (CHARPOS (start_pos
) > BEGV
14044 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14047 struct glyph_row
*row
;
14049 /* Handle the case that the window start is out of range. */
14050 if (CHARPOS (start_pos
) < BEGV
)
14051 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14052 else if (CHARPOS (start_pos
) > ZV
)
14053 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14055 /* Find the start of the continued line. This should be fast
14056 because scan_buffer is fast (newline cache). */
14057 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14058 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14059 row
, DEFAULT_FACE_ID
);
14060 reseat_at_previous_visible_line_start (&it
);
14062 /* If the line start is "too far" away from the window start,
14063 say it takes too much time to compute a new window start. */
14064 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14065 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14067 int min_distance
, distance
;
14069 /* Move forward by display lines to find the new window
14070 start. If window width was enlarged, the new start can
14071 be expected to be > the old start. If window width was
14072 decreased, the new window start will be < the old start.
14073 So, we're looking for the display line start with the
14074 minimum distance from the old window start. */
14075 pos
= it
.current
.pos
;
14076 min_distance
= INFINITY
;
14077 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14078 distance
< min_distance
)
14080 min_distance
= distance
;
14081 pos
= it
.current
.pos
;
14082 move_it_by_lines (&it
, 1);
14085 /* Set the window start there. */
14086 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14087 window_start_changed_p
= 1;
14091 return window_start_changed_p
;
14095 /* Try cursor movement in case text has not changed in window WINDOW,
14096 with window start STARTP. Value is
14098 CURSOR_MOVEMENT_SUCCESS if successful
14100 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14102 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14103 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14104 we want to scroll as if scroll-step were set to 1. See the code.
14106 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14107 which case we have to abort this redisplay, and adjust matrices
14112 CURSOR_MOVEMENT_SUCCESS
,
14113 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14114 CURSOR_MOVEMENT_MUST_SCROLL
,
14115 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14119 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14121 struct window
*w
= XWINDOW (window
);
14122 struct frame
*f
= XFRAME (w
->frame
);
14123 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14126 if (inhibit_try_cursor_movement
)
14130 /* Handle case where text has not changed, only point, and it has
14131 not moved off the frame. */
14132 if (/* Point may be in this window. */
14133 PT
>= CHARPOS (startp
)
14134 /* Selective display hasn't changed. */
14135 && !current_buffer
->clip_changed
14136 /* Function force-mode-line-update is used to force a thorough
14137 redisplay. It sets either windows_or_buffers_changed or
14138 update_mode_lines. So don't take a shortcut here for these
14140 && !update_mode_lines
14141 && !windows_or_buffers_changed
14142 && !cursor_type_changed
14143 /* Can't use this case if highlighting a region. When a
14144 region exists, cursor movement has to do more than just
14146 && !(!NILP (Vtransient_mark_mode
)
14147 && !NILP (BVAR (current_buffer
, mark_active
)))
14148 && NILP (w
->region_showing
)
14149 && NILP (Vshow_trailing_whitespace
)
14150 /* Right after splitting windows, last_point may be nil. */
14151 && INTEGERP (w
->last_point
)
14152 /* This code is not used for mini-buffer for the sake of the case
14153 of redisplaying to replace an echo area message; since in
14154 that case the mini-buffer contents per se are usually
14155 unchanged. This code is of no real use in the mini-buffer
14156 since the handling of this_line_start_pos, etc., in redisplay
14157 handles the same cases. */
14158 && !EQ (window
, minibuf_window
)
14159 /* When splitting windows or for new windows, it happens that
14160 redisplay is called with a nil window_end_vpos or one being
14161 larger than the window. This should really be fixed in
14162 window.c. I don't have this on my list, now, so we do
14163 approximately the same as the old redisplay code. --gerd. */
14164 && INTEGERP (w
->window_end_vpos
)
14165 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14166 && (FRAME_WINDOW_P (f
)
14167 || !overlay_arrow_in_current_buffer_p ()))
14169 int this_scroll_margin
, top_scroll_margin
;
14170 struct glyph_row
*row
= NULL
;
14173 debug_method_add (w
, "cursor movement");
14176 /* Scroll if point within this distance from the top or bottom
14177 of the window. This is a pixel value. */
14178 if (scroll_margin
> 0)
14180 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14181 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14184 this_scroll_margin
= 0;
14186 top_scroll_margin
= this_scroll_margin
;
14187 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14188 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14190 /* Start with the row the cursor was displayed during the last
14191 not paused redisplay. Give up if that row is not valid. */
14192 if (w
->last_cursor
.vpos
< 0
14193 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14194 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14197 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14198 if (row
->mode_line_p
)
14200 if (!row
->enabled_p
)
14201 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14204 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14206 int scroll_p
= 0, must_scroll
= 0;
14207 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14209 if (PT
> XFASTINT (w
->last_point
))
14211 /* Point has moved forward. */
14212 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14213 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14215 xassert (row
->enabled_p
);
14219 /* If the end position of a row equals the start
14220 position of the next row, and PT is at that position,
14221 we would rather display cursor in the next line. */
14222 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14223 && MATRIX_ROW_END_CHARPOS (row
) == PT
14224 && row
< w
->current_matrix
->rows
14225 + w
->current_matrix
->nrows
- 1
14226 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14227 && !cursor_row_p (row
))
14230 /* If within the scroll margin, scroll. Note that
14231 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14232 the next line would be drawn, and that
14233 this_scroll_margin can be zero. */
14234 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14235 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14236 /* Line is completely visible last line in window
14237 and PT is to be set in the next line. */
14238 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14239 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14240 && !row
->ends_at_zv_p
14241 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14244 else if (PT
< XFASTINT (w
->last_point
))
14246 /* Cursor has to be moved backward. Note that PT >=
14247 CHARPOS (startp) because of the outer if-statement. */
14248 while (!row
->mode_line_p
14249 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14250 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14251 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14252 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14253 row
> w
->current_matrix
->rows
14254 && (row
-1)->ends_in_newline_from_string_p
))))
14255 && (row
->y
> top_scroll_margin
14256 || CHARPOS (startp
) == BEGV
))
14258 xassert (row
->enabled_p
);
14262 /* Consider the following case: Window starts at BEGV,
14263 there is invisible, intangible text at BEGV, so that
14264 display starts at some point START > BEGV. It can
14265 happen that we are called with PT somewhere between
14266 BEGV and START. Try to handle that case. */
14267 if (row
< w
->current_matrix
->rows
14268 || row
->mode_line_p
)
14270 row
= w
->current_matrix
->rows
;
14271 if (row
->mode_line_p
)
14275 /* Due to newlines in overlay strings, we may have to
14276 skip forward over overlay strings. */
14277 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14278 && MATRIX_ROW_END_CHARPOS (row
) == PT
14279 && !cursor_row_p (row
))
14282 /* If within the scroll margin, scroll. */
14283 if (row
->y
< top_scroll_margin
14284 && CHARPOS (startp
) != BEGV
)
14289 /* Cursor did not move. So don't scroll even if cursor line
14290 is partially visible, as it was so before. */
14291 rc
= CURSOR_MOVEMENT_SUCCESS
;
14294 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14295 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14297 /* if PT is not in the glyph row, give up. */
14298 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14301 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14302 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14304 /* If rows are bidi-reordered and point moved, back up
14305 until we find a row that does not belong to a
14306 continuation line. This is because we must consider
14307 all rows of a continued line as candidates for the
14308 new cursor positioning, since row start and end
14309 positions change non-linearly with vertical position
14311 /* FIXME: Revisit this when glyph ``spilling'' in
14312 continuation lines' rows is implemented for
14313 bidi-reordered rows. */
14314 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14316 xassert (row
->enabled_p
);
14318 /* If we hit the beginning of the displayed portion
14319 without finding the first row of a continued
14321 if (row
<= w
->current_matrix
->rows
)
14323 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14331 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14332 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14333 && make_cursor_line_fully_visible_p
)
14335 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14336 && !row
->ends_at_zv_p
14337 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14338 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14339 else if (row
->height
> window_box_height (w
))
14341 /* If we end up in a partially visible line, let's
14342 make it fully visible, except when it's taller
14343 than the window, in which case we can't do much
14346 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14350 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14351 if (!cursor_row_fully_visible_p (w
, 0, 1))
14352 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14354 rc
= CURSOR_MOVEMENT_SUCCESS
;
14358 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14359 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14360 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14362 /* With bidi-reordered rows, there could be more than
14363 one candidate row whose start and end positions
14364 occlude point. We need to let set_cursor_from_row
14365 find the best candidate. */
14366 /* FIXME: Revisit this when glyph ``spilling'' in
14367 continuation lines' rows is implemented for
14368 bidi-reordered rows. */
14373 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14374 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14375 && cursor_row_p (row
))
14376 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14378 /* As soon as we've found the first suitable row
14379 whose ends_at_zv_p flag is set, we are done. */
14381 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14383 rc
= CURSOR_MOVEMENT_SUCCESS
;
14388 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14389 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14390 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14391 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14392 /* If we didn't find any candidate rows, or exited the
14393 loop before all the candidates were examined, signal
14394 to the caller that this method failed. */
14395 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14396 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14397 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14399 rc
= CURSOR_MOVEMENT_SUCCESS
;
14405 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14407 rc
= CURSOR_MOVEMENT_SUCCESS
;
14412 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14413 && MATRIX_ROW_START_CHARPOS (row
) == PT
14414 && cursor_row_p (row
));
14422 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14426 set_vertical_scroll_bar (struct window
*w
)
14428 EMACS_INT start
, end
, whole
;
14430 /* Calculate the start and end positions for the current window.
14431 At some point, it would be nice to choose between scrollbars
14432 which reflect the whole buffer size, with special markers
14433 indicating narrowing, and scrollbars which reflect only the
14436 Note that mini-buffers sometimes aren't displaying any text. */
14437 if (!MINI_WINDOW_P (w
)
14438 || (w
== XWINDOW (minibuf_window
)
14439 && NILP (echo_area_buffer
[0])))
14441 struct buffer
*buf
= XBUFFER (w
->buffer
);
14442 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14443 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14444 /* I don't think this is guaranteed to be right. For the
14445 moment, we'll pretend it is. */
14446 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14450 if (whole
< (end
- start
))
14451 whole
= end
- start
;
14454 start
= end
= whole
= 0;
14456 /* Indicate what this scroll bar ought to be displaying now. */
14457 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14458 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14459 (w
, end
- start
, whole
, start
);
14463 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14464 selected_window is redisplayed.
14466 We can return without actually redisplaying the window if
14467 fonts_changed_p is nonzero. In that case, redisplay_internal will
14471 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14473 struct window
*w
= XWINDOW (window
);
14474 struct frame
*f
= XFRAME (w
->frame
);
14475 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14476 struct buffer
*old
= current_buffer
;
14477 struct text_pos lpoint
, opoint
, startp
;
14478 int update_mode_line
;
14481 /* Record it now because it's overwritten. */
14482 int current_matrix_up_to_date_p
= 0;
14483 int used_current_matrix_p
= 0;
14484 /* This is less strict than current_matrix_up_to_date_p.
14485 It indictes that the buffer contents and narrowing are unchanged. */
14486 int buffer_unchanged_p
= 0;
14487 int temp_scroll_step
= 0;
14488 int count
= SPECPDL_INDEX ();
14490 int centering_position
= -1;
14491 int last_line_misfit
= 0;
14492 EMACS_INT beg_unchanged
, end_unchanged
;
14494 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14497 /* W must be a leaf window here. */
14498 xassert (!NILP (w
->buffer
));
14500 *w
->desired_matrix
->method
= 0;
14504 reconsider_clip_changes (w
, buffer
);
14506 /* Has the mode line to be updated? */
14507 update_mode_line
= (!NILP (w
->update_mode_line
)
14508 || update_mode_lines
14509 || buffer
->clip_changed
14510 || buffer
->prevent_redisplay_optimizations_p
);
14512 if (MINI_WINDOW_P (w
))
14514 if (w
== XWINDOW (echo_area_window
)
14515 && !NILP (echo_area_buffer
[0]))
14517 if (update_mode_line
)
14518 /* We may have to update a tty frame's menu bar or a
14519 tool-bar. Example `M-x C-h C-h C-g'. */
14520 goto finish_menu_bars
;
14522 /* We've already displayed the echo area glyphs in this window. */
14523 goto finish_scroll_bars
;
14525 else if ((w
!= XWINDOW (minibuf_window
)
14526 || minibuf_level
== 0)
14527 /* When buffer is nonempty, redisplay window normally. */
14528 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14529 /* Quail displays non-mini buffers in minibuffer window.
14530 In that case, redisplay the window normally. */
14531 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14533 /* W is a mini-buffer window, but it's not active, so clear
14535 int yb
= window_text_bottom_y (w
);
14536 struct glyph_row
*row
;
14539 for (y
= 0, row
= w
->desired_matrix
->rows
;
14541 y
+= row
->height
, ++row
)
14542 blank_row (w
, row
, y
);
14543 goto finish_scroll_bars
;
14546 clear_glyph_matrix (w
->desired_matrix
);
14549 /* Otherwise set up data on this window; select its buffer and point
14551 /* Really select the buffer, for the sake of buffer-local
14553 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14555 current_matrix_up_to_date_p
14556 = (!NILP (w
->window_end_valid
)
14557 && !current_buffer
->clip_changed
14558 && !current_buffer
->prevent_redisplay_optimizations_p
14559 && XFASTINT (w
->last_modified
) >= MODIFF
14560 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14562 /* Run the window-bottom-change-functions
14563 if it is possible that the text on the screen has changed
14564 (either due to modification of the text, or any other reason). */
14565 if (!current_matrix_up_to_date_p
14566 && !NILP (Vwindow_text_change_functions
))
14568 safe_run_hooks (Qwindow_text_change_functions
);
14572 beg_unchanged
= BEG_UNCHANGED
;
14573 end_unchanged
= END_UNCHANGED
;
14575 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14577 specbind (Qinhibit_point_motion_hooks
, Qt
);
14580 = (!NILP (w
->window_end_valid
)
14581 && !current_buffer
->clip_changed
14582 && XFASTINT (w
->last_modified
) >= MODIFF
14583 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14585 /* When windows_or_buffers_changed is non-zero, we can't rely on
14586 the window end being valid, so set it to nil there. */
14587 if (windows_or_buffers_changed
)
14589 /* If window starts on a continuation line, maybe adjust the
14590 window start in case the window's width changed. */
14591 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14592 compute_window_start_on_continuation_line (w
);
14594 w
->window_end_valid
= Qnil
;
14597 /* Some sanity checks. */
14598 CHECK_WINDOW_END (w
);
14599 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14601 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14604 /* If %c is in mode line, update it if needed. */
14605 if (!NILP (w
->column_number_displayed
)
14606 /* This alternative quickly identifies a common case
14607 where no change is needed. */
14608 && !(PT
== XFASTINT (w
->last_point
)
14609 && XFASTINT (w
->last_modified
) >= MODIFF
14610 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14611 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14612 update_mode_line
= 1;
14614 /* Count number of windows showing the selected buffer. An indirect
14615 buffer counts as its base buffer. */
14616 if (!just_this_one_p
)
14618 struct buffer
*current_base
, *window_base
;
14619 current_base
= current_buffer
;
14620 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14621 if (current_base
->base_buffer
)
14622 current_base
= current_base
->base_buffer
;
14623 if (window_base
->base_buffer
)
14624 window_base
= window_base
->base_buffer
;
14625 if (current_base
== window_base
)
14629 /* Point refers normally to the selected window. For any other
14630 window, set up appropriate value. */
14631 if (!EQ (window
, selected_window
))
14633 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14634 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14638 new_pt_byte
= BEGV_BYTE
;
14639 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14641 else if (new_pt
> (ZV
- 1))
14644 new_pt_byte
= ZV_BYTE
;
14645 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14648 /* We don't use SET_PT so that the point-motion hooks don't run. */
14649 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14652 /* If any of the character widths specified in the display table
14653 have changed, invalidate the width run cache. It's true that
14654 this may be a bit late to catch such changes, but the rest of
14655 redisplay goes (non-fatally) haywire when the display table is
14656 changed, so why should we worry about doing any better? */
14657 if (current_buffer
->width_run_cache
)
14659 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14661 if (! disptab_matches_widthtab (disptab
,
14662 XVECTOR (BVAR (current_buffer
, width_table
))))
14664 invalidate_region_cache (current_buffer
,
14665 current_buffer
->width_run_cache
,
14667 recompute_width_table (current_buffer
, disptab
);
14671 /* If window-start is screwed up, choose a new one. */
14672 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14675 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14677 /* If someone specified a new starting point but did not insist,
14678 check whether it can be used. */
14679 if (!NILP (w
->optional_new_start
)
14680 && CHARPOS (startp
) >= BEGV
14681 && CHARPOS (startp
) <= ZV
)
14683 w
->optional_new_start
= Qnil
;
14684 start_display (&it
, w
, startp
);
14685 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14686 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14687 if (IT_CHARPOS (it
) == PT
)
14688 w
->force_start
= Qt
;
14689 /* IT may overshoot PT if text at PT is invisible. */
14690 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14691 w
->force_start
= Qt
;
14696 /* Handle case where place to start displaying has been specified,
14697 unless the specified location is outside the accessible range. */
14698 if (!NILP (w
->force_start
)
14699 || w
->frozen_window_start_p
)
14701 /* We set this later on if we have to adjust point. */
14704 w
->force_start
= Qnil
;
14706 w
->window_end_valid
= Qnil
;
14708 /* Forget any recorded base line for line number display. */
14709 if (!buffer_unchanged_p
)
14710 w
->base_line_number
= Qnil
;
14712 /* Redisplay the mode line. Select the buffer properly for that.
14713 Also, run the hook window-scroll-functions
14714 because we have scrolled. */
14715 /* Note, we do this after clearing force_start because
14716 if there's an error, it is better to forget about force_start
14717 than to get into an infinite loop calling the hook functions
14718 and having them get more errors. */
14719 if (!update_mode_line
14720 || ! NILP (Vwindow_scroll_functions
))
14722 update_mode_line
= 1;
14723 w
->update_mode_line
= Qt
;
14724 startp
= run_window_scroll_functions (window
, startp
);
14727 w
->last_modified
= make_number (0);
14728 w
->last_overlay_modified
= make_number (0);
14729 if (CHARPOS (startp
) < BEGV
)
14730 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14731 else if (CHARPOS (startp
) > ZV
)
14732 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14734 /* Redisplay, then check if cursor has been set during the
14735 redisplay. Give up if new fonts were loaded. */
14736 /* We used to issue a CHECK_MARGINS argument to try_window here,
14737 but this causes scrolling to fail when point begins inside
14738 the scroll margin (bug#148) -- cyd */
14739 if (!try_window (window
, startp
, 0))
14741 w
->force_start
= Qt
;
14742 clear_glyph_matrix (w
->desired_matrix
);
14743 goto need_larger_matrices
;
14746 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14748 /* If point does not appear, try to move point so it does
14749 appear. The desired matrix has been built above, so we
14750 can use it here. */
14751 new_vpos
= window_box_height (w
) / 2;
14754 if (!cursor_row_fully_visible_p (w
, 0, 0))
14756 /* Point does appear, but on a line partly visible at end of window.
14757 Move it back to a fully-visible line. */
14758 new_vpos
= window_box_height (w
);
14761 /* If we need to move point for either of the above reasons,
14762 now actually do it. */
14765 struct glyph_row
*row
;
14767 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14768 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14771 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14772 MATRIX_ROW_START_BYTEPOS (row
));
14774 if (w
!= XWINDOW (selected_window
))
14775 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14776 else if (current_buffer
== old
)
14777 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14779 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14781 /* If we are highlighting the region, then we just changed
14782 the region, so redisplay to show it. */
14783 if (!NILP (Vtransient_mark_mode
)
14784 && !NILP (BVAR (current_buffer
, mark_active
)))
14786 clear_glyph_matrix (w
->desired_matrix
);
14787 if (!try_window (window
, startp
, 0))
14788 goto need_larger_matrices
;
14793 debug_method_add (w
, "forced window start");
14798 /* Handle case where text has not changed, only point, and it has
14799 not moved off the frame, and we are not retrying after hscroll.
14800 (current_matrix_up_to_date_p is nonzero when retrying.) */
14801 if (current_matrix_up_to_date_p
14802 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14803 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14807 case CURSOR_MOVEMENT_SUCCESS
:
14808 used_current_matrix_p
= 1;
14811 case CURSOR_MOVEMENT_MUST_SCROLL
:
14812 goto try_to_scroll
;
14818 /* If current starting point was originally the beginning of a line
14819 but no longer is, find a new starting point. */
14820 else if (!NILP (w
->start_at_line_beg
)
14821 && !(CHARPOS (startp
) <= BEGV
14822 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14825 debug_method_add (w
, "recenter 1");
14830 /* Try scrolling with try_window_id. Value is > 0 if update has
14831 been done, it is -1 if we know that the same window start will
14832 not work. It is 0 if unsuccessful for some other reason. */
14833 else if ((tem
= try_window_id (w
)) != 0)
14836 debug_method_add (w
, "try_window_id %d", tem
);
14839 if (fonts_changed_p
)
14840 goto need_larger_matrices
;
14844 /* Otherwise try_window_id has returned -1 which means that we
14845 don't want the alternative below this comment to execute. */
14847 else if (CHARPOS (startp
) >= BEGV
14848 && CHARPOS (startp
) <= ZV
14849 && PT
>= CHARPOS (startp
)
14850 && (CHARPOS (startp
) < ZV
14851 /* Avoid starting at end of buffer. */
14852 || CHARPOS (startp
) == BEGV
14853 || (XFASTINT (w
->last_modified
) >= MODIFF
14854 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14857 /* If first window line is a continuation line, and window start
14858 is inside the modified region, but the first change is before
14859 current window start, we must select a new window start.
14861 However, if this is the result of a down-mouse event (e.g. by
14862 extending the mouse-drag-overlay), we don't want to select a
14863 new window start, since that would change the position under
14864 the mouse, resulting in an unwanted mouse-movement rather
14865 than a simple mouse-click. */
14866 if (NILP (w
->start_at_line_beg
)
14867 && NILP (do_mouse_tracking
)
14868 && CHARPOS (startp
) > BEGV
14869 && CHARPOS (startp
) > BEG
+ beg_unchanged
14870 && CHARPOS (startp
) <= Z
- end_unchanged
14871 /* Even if w->start_at_line_beg is nil, a new window may
14872 start at a line_beg, since that's how set_buffer_window
14873 sets it. So, we need to check the return value of
14874 compute_window_start_on_continuation_line. (See also
14876 && XMARKER (w
->start
)->buffer
== current_buffer
14877 && compute_window_start_on_continuation_line (w
))
14879 w
->force_start
= Qt
;
14880 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14885 debug_method_add (w
, "same window start");
14888 /* Try to redisplay starting at same place as before.
14889 If point has not moved off frame, accept the results. */
14890 if (!current_matrix_up_to_date_p
14891 /* Don't use try_window_reusing_current_matrix in this case
14892 because a window scroll function can have changed the
14894 || !NILP (Vwindow_scroll_functions
)
14895 || MINI_WINDOW_P (w
)
14896 || !(used_current_matrix_p
14897 = try_window_reusing_current_matrix (w
)))
14899 IF_DEBUG (debug_method_add (w
, "1"));
14900 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14901 /* -1 means we need to scroll.
14902 0 means we need new matrices, but fonts_changed_p
14903 is set in that case, so we will detect it below. */
14904 goto try_to_scroll
;
14907 if (fonts_changed_p
)
14908 goto need_larger_matrices
;
14910 if (w
->cursor
.vpos
>= 0)
14912 if (!just_this_one_p
14913 || current_buffer
->clip_changed
14914 || BEG_UNCHANGED
< CHARPOS (startp
))
14915 /* Forget any recorded base line for line number display. */
14916 w
->base_line_number
= Qnil
;
14918 if (!cursor_row_fully_visible_p (w
, 1, 0))
14920 clear_glyph_matrix (w
->desired_matrix
);
14921 last_line_misfit
= 1;
14923 /* Drop through and scroll. */
14928 clear_glyph_matrix (w
->desired_matrix
);
14933 w
->last_modified
= make_number (0);
14934 w
->last_overlay_modified
= make_number (0);
14936 /* Redisplay the mode line. Select the buffer properly for that. */
14937 if (!update_mode_line
)
14939 update_mode_line
= 1;
14940 w
->update_mode_line
= Qt
;
14943 /* Try to scroll by specified few lines. */
14944 if ((scroll_conservatively
14945 || emacs_scroll_step
14946 || temp_scroll_step
14947 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14948 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14949 && CHARPOS (startp
) >= BEGV
14950 && CHARPOS (startp
) <= ZV
)
14952 /* The function returns -1 if new fonts were loaded, 1 if
14953 successful, 0 if not successful. */
14954 int ss
= try_scrolling (window
, just_this_one_p
,
14955 scroll_conservatively
,
14957 temp_scroll_step
, last_line_misfit
);
14960 case SCROLLING_SUCCESS
:
14963 case SCROLLING_NEED_LARGER_MATRICES
:
14964 goto need_larger_matrices
;
14966 case SCROLLING_FAILED
:
14974 /* Finally, just choose a place to start which positions point
14975 according to user preferences. */
14980 debug_method_add (w
, "recenter");
14983 /* w->vscroll = 0; */
14985 /* Forget any previously recorded base line for line number display. */
14986 if (!buffer_unchanged_p
)
14987 w
->base_line_number
= Qnil
;
14989 /* Determine the window start relative to point. */
14990 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14991 it
.current_y
= it
.last_visible_y
;
14992 if (centering_position
< 0)
14996 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14998 EMACS_INT margin_pos
= CHARPOS (startp
);
15000 Lisp_Object aggressive
;
15002 /* If there is a scroll margin at the top of the window, find
15003 its character position. */
15005 /* Cannot call start_display if startp is not in the
15006 accessible region of the buffer. This can happen when we
15007 have just switched to a different buffer and/or changed
15008 its restriction. In that case, startp is initialized to
15009 the character position 1 (BEG) because we did not yet
15010 have chance to display the buffer even once. */
15011 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15014 void *it1data
= NULL
;
15016 SAVE_IT (it1
, it
, it1data
);
15017 start_display (&it1
, w
, startp
);
15018 move_it_vertically (&it1
, margin
);
15019 margin_pos
= IT_CHARPOS (it1
);
15020 RESTORE_IT (&it
, &it
, it1data
);
15022 scrolling_up
= PT
> margin_pos
;
15025 ? BVAR (current_buffer
, scroll_up_aggressively
)
15026 : BVAR (current_buffer
, scroll_down_aggressively
);
15028 if (!MINI_WINDOW_P (w
)
15029 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15033 /* Setting scroll-conservatively overrides
15034 scroll-*-aggressively. */
15035 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15037 double float_amount
= XFLOATINT (aggressive
);
15039 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15040 if (pt_offset
== 0 && float_amount
> 0)
15045 /* Compute how much to move the window start backward from
15046 point so that point will be displayed where the user
15050 centering_position
= it
.last_visible_y
;
15052 centering_position
-= pt_offset
;
15053 centering_position
-=
15054 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15055 /* Don't let point enter the scroll margin near top of
15057 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15058 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15061 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15064 /* Set the window start half the height of the window backward
15066 centering_position
= window_box_height (w
) / 2;
15068 move_it_vertically_backward (&it
, centering_position
);
15070 xassert (IT_CHARPOS (it
) >= BEGV
);
15072 /* The function move_it_vertically_backward may move over more
15073 than the specified y-distance. If it->w is small, e.g. a
15074 mini-buffer window, we may end up in front of the window's
15075 display area. Start displaying at the start of the line
15076 containing PT in this case. */
15077 if (it
.current_y
<= 0)
15079 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15080 move_it_vertically_backward (&it
, 0);
15084 it
.current_x
= it
.hpos
= 0;
15086 /* Set the window start position here explicitly, to avoid an
15087 infinite loop in case the functions in window-scroll-functions
15089 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15091 /* Run scroll hooks. */
15092 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15094 /* Redisplay the window. */
15095 if (!current_matrix_up_to_date_p
15096 || windows_or_buffers_changed
15097 || cursor_type_changed
15098 /* Don't use try_window_reusing_current_matrix in this case
15099 because it can have changed the buffer. */
15100 || !NILP (Vwindow_scroll_functions
)
15101 || !just_this_one_p
15102 || MINI_WINDOW_P (w
)
15103 || !(used_current_matrix_p
15104 = try_window_reusing_current_matrix (w
)))
15105 try_window (window
, startp
, 0);
15107 /* If new fonts have been loaded (due to fontsets), give up. We
15108 have to start a new redisplay since we need to re-adjust glyph
15110 if (fonts_changed_p
)
15111 goto need_larger_matrices
;
15113 /* If cursor did not appear assume that the middle of the window is
15114 in the first line of the window. Do it again with the next line.
15115 (Imagine a window of height 100, displaying two lines of height
15116 60. Moving back 50 from it->last_visible_y will end in the first
15118 if (w
->cursor
.vpos
< 0)
15120 if (!NILP (w
->window_end_valid
)
15121 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15123 clear_glyph_matrix (w
->desired_matrix
);
15124 move_it_by_lines (&it
, 1);
15125 try_window (window
, it
.current
.pos
, 0);
15127 else if (PT
< IT_CHARPOS (it
))
15129 clear_glyph_matrix (w
->desired_matrix
);
15130 move_it_by_lines (&it
, -1);
15131 try_window (window
, it
.current
.pos
, 0);
15135 /* Not much we can do about it. */
15139 /* Consider the following case: Window starts at BEGV, there is
15140 invisible, intangible text at BEGV, so that display starts at
15141 some point START > BEGV. It can happen that we are called with
15142 PT somewhere between BEGV and START. Try to handle that case. */
15143 if (w
->cursor
.vpos
< 0)
15145 struct glyph_row
*row
= w
->current_matrix
->rows
;
15146 if (row
->mode_line_p
)
15148 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15151 if (!cursor_row_fully_visible_p (w
, 0, 0))
15153 /* If vscroll is enabled, disable it and try again. */
15157 clear_glyph_matrix (w
->desired_matrix
);
15161 /* If centering point failed to make the whole line visible,
15162 put point at the top instead. That has to make the whole line
15163 visible, if it can be done. */
15164 if (centering_position
== 0)
15167 clear_glyph_matrix (w
->desired_matrix
);
15168 centering_position
= 0;
15174 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15175 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15176 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15179 /* Display the mode line, if we must. */
15180 if ((update_mode_line
15181 /* If window not full width, must redo its mode line
15182 if (a) the window to its side is being redone and
15183 (b) we do a frame-based redisplay. This is a consequence
15184 of how inverted lines are drawn in frame-based redisplay. */
15185 || (!just_this_one_p
15186 && !FRAME_WINDOW_P (f
)
15187 && !WINDOW_FULL_WIDTH_P (w
))
15188 /* Line number to display. */
15189 || INTEGERP (w
->base_line_pos
)
15190 /* Column number is displayed and different from the one displayed. */
15191 || (!NILP (w
->column_number_displayed
)
15192 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15193 /* This means that the window has a mode line. */
15194 && (WINDOW_WANTS_MODELINE_P (w
)
15195 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15197 display_mode_lines (w
);
15199 /* If mode line height has changed, arrange for a thorough
15200 immediate redisplay using the correct mode line height. */
15201 if (WINDOW_WANTS_MODELINE_P (w
)
15202 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15204 fonts_changed_p
= 1;
15205 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15206 = DESIRED_MODE_LINE_HEIGHT (w
);
15209 /* If header line height has changed, arrange for a thorough
15210 immediate redisplay using the correct header line height. */
15211 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15212 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15214 fonts_changed_p
= 1;
15215 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15216 = DESIRED_HEADER_LINE_HEIGHT (w
);
15219 if (fonts_changed_p
)
15220 goto need_larger_matrices
;
15223 if (!line_number_displayed
15224 && !BUFFERP (w
->base_line_pos
))
15226 w
->base_line_pos
= Qnil
;
15227 w
->base_line_number
= Qnil
;
15232 /* When we reach a frame's selected window, redo the frame's menu bar. */
15233 if (update_mode_line
15234 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15236 int redisplay_menu_p
= 0;
15238 if (FRAME_WINDOW_P (f
))
15240 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15241 || defined (HAVE_NS) || defined (USE_GTK)
15242 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15244 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15248 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15250 if (redisplay_menu_p
)
15251 display_menu_bar (w
);
15253 #ifdef HAVE_WINDOW_SYSTEM
15254 if (FRAME_WINDOW_P (f
))
15256 #if defined (USE_GTK) || defined (HAVE_NS)
15257 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15258 redisplay_tool_bar (f
);
15260 if (WINDOWP (f
->tool_bar_window
)
15261 && (FRAME_TOOL_BAR_LINES (f
) > 0
15262 || !NILP (Vauto_resize_tool_bars
))
15263 && redisplay_tool_bar (f
))
15264 ignore_mouse_drag_p
= 1;
15270 #ifdef HAVE_WINDOW_SYSTEM
15271 if (FRAME_WINDOW_P (f
)
15272 && update_window_fringes (w
, (just_this_one_p
15273 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15274 || w
->pseudo_window_p
)))
15278 if (draw_window_fringes (w
, 1))
15279 x_draw_vertical_border (w
);
15283 #endif /* HAVE_WINDOW_SYSTEM */
15285 /* We go to this label, with fonts_changed_p nonzero,
15286 if it is necessary to try again using larger glyph matrices.
15287 We have to redeem the scroll bar even in this case,
15288 because the loop in redisplay_internal expects that. */
15289 need_larger_matrices
:
15291 finish_scroll_bars
:
15293 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15295 /* Set the thumb's position and size. */
15296 set_vertical_scroll_bar (w
);
15298 /* Note that we actually used the scroll bar attached to this
15299 window, so it shouldn't be deleted at the end of redisplay. */
15300 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15301 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15304 /* Restore current_buffer and value of point in it. The window
15305 update may have changed the buffer, so first make sure `opoint'
15306 is still valid (Bug#6177). */
15307 if (CHARPOS (opoint
) < BEGV
)
15308 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15309 else if (CHARPOS (opoint
) > ZV
)
15310 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15312 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15314 set_buffer_internal_1 (old
);
15315 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15316 shorter. This can be caused by log truncation in *Messages*. */
15317 if (CHARPOS (lpoint
) <= ZV
)
15318 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15320 unbind_to (count
, Qnil
);
15324 /* Build the complete desired matrix of WINDOW with a window start
15325 buffer position POS.
15327 Value is 1 if successful. It is zero if fonts were loaded during
15328 redisplay which makes re-adjusting glyph matrices necessary, and -1
15329 if point would appear in the scroll margins.
15330 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15331 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15335 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15337 struct window
*w
= XWINDOW (window
);
15339 struct glyph_row
*last_text_row
= NULL
;
15340 struct frame
*f
= XFRAME (w
->frame
);
15342 /* Make POS the new window start. */
15343 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15345 /* Mark cursor position as unknown. No overlay arrow seen. */
15346 w
->cursor
.vpos
= -1;
15347 overlay_arrow_seen
= 0;
15349 /* Initialize iterator and info to start at POS. */
15350 start_display (&it
, w
, pos
);
15352 /* Display all lines of W. */
15353 while (it
.current_y
< it
.last_visible_y
)
15355 if (display_line (&it
))
15356 last_text_row
= it
.glyph_row
- 1;
15357 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15361 /* Don't let the cursor end in the scroll margins. */
15362 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15363 && !MINI_WINDOW_P (w
))
15365 int this_scroll_margin
;
15367 if (scroll_margin
> 0)
15369 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15370 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15373 this_scroll_margin
= 0;
15375 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15376 && w
->cursor
.y
< this_scroll_margin
15377 && CHARPOS (pos
) > BEGV
15378 && IT_CHARPOS (it
) < ZV
)
15379 /* rms: considering make_cursor_line_fully_visible_p here
15380 seems to give wrong results. We don't want to recenter
15381 when the last line is partly visible, we want to allow
15382 that case to be handled in the usual way. */
15383 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15385 w
->cursor
.vpos
= -1;
15386 clear_glyph_matrix (w
->desired_matrix
);
15391 /* If bottom moved off end of frame, change mode line percentage. */
15392 if (XFASTINT (w
->window_end_pos
) <= 0
15393 && Z
!= IT_CHARPOS (it
))
15394 w
->update_mode_line
= Qt
;
15396 /* Set window_end_pos to the offset of the last character displayed
15397 on the window from the end of current_buffer. Set
15398 window_end_vpos to its row number. */
15401 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15402 w
->window_end_bytepos
15403 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15405 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15407 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15408 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15409 ->displays_text_p
);
15413 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15414 w
->window_end_pos
= make_number (Z
- ZV
);
15415 w
->window_end_vpos
= make_number (0);
15418 /* But that is not valid info until redisplay finishes. */
15419 w
->window_end_valid
= Qnil
;
15425 /************************************************************************
15426 Window redisplay reusing current matrix when buffer has not changed
15427 ************************************************************************/
15429 /* Try redisplay of window W showing an unchanged buffer with a
15430 different window start than the last time it was displayed by
15431 reusing its current matrix. Value is non-zero if successful.
15432 W->start is the new window start. */
15435 try_window_reusing_current_matrix (struct window
*w
)
15437 struct frame
*f
= XFRAME (w
->frame
);
15438 struct glyph_row
*bottom_row
;
15441 struct text_pos start
, new_start
;
15442 int nrows_scrolled
, i
;
15443 struct glyph_row
*last_text_row
;
15444 struct glyph_row
*last_reused_text_row
;
15445 struct glyph_row
*start_row
;
15446 int start_vpos
, min_y
, max_y
;
15449 if (inhibit_try_window_reusing
)
15453 if (/* This function doesn't handle terminal frames. */
15454 !FRAME_WINDOW_P (f
)
15455 /* Don't try to reuse the display if windows have been split
15457 || windows_or_buffers_changed
15458 || cursor_type_changed
)
15461 /* Can't do this if region may have changed. */
15462 if ((!NILP (Vtransient_mark_mode
)
15463 && !NILP (BVAR (current_buffer
, mark_active
)))
15464 || !NILP (w
->region_showing
)
15465 || !NILP (Vshow_trailing_whitespace
))
15468 /* If top-line visibility has changed, give up. */
15469 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15470 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15473 /* Give up if old or new display is scrolled vertically. We could
15474 make this function handle this, but right now it doesn't. */
15475 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15476 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15479 /* The variable new_start now holds the new window start. The old
15480 start `start' can be determined from the current matrix. */
15481 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15482 start
= start_row
->minpos
;
15483 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15485 /* Clear the desired matrix for the display below. */
15486 clear_glyph_matrix (w
->desired_matrix
);
15488 if (CHARPOS (new_start
) <= CHARPOS (start
))
15490 /* Don't use this method if the display starts with an ellipsis
15491 displayed for invisible text. It's not easy to handle that case
15492 below, and it's certainly not worth the effort since this is
15493 not a frequent case. */
15494 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15497 IF_DEBUG (debug_method_add (w
, "twu1"));
15499 /* Display up to a row that can be reused. The variable
15500 last_text_row is set to the last row displayed that displays
15501 text. Note that it.vpos == 0 if or if not there is a
15502 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15503 start_display (&it
, w
, new_start
);
15504 w
->cursor
.vpos
= -1;
15505 last_text_row
= last_reused_text_row
= NULL
;
15507 while (it
.current_y
< it
.last_visible_y
15508 && !fonts_changed_p
)
15510 /* If we have reached into the characters in the START row,
15511 that means the line boundaries have changed. So we
15512 can't start copying with the row START. Maybe it will
15513 work to start copying with the following row. */
15514 while (IT_CHARPOS (it
) > CHARPOS (start
))
15516 /* Advance to the next row as the "start". */
15518 start
= start_row
->minpos
;
15519 /* If there are no more rows to try, or just one, give up. */
15520 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15521 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15522 || CHARPOS (start
) == ZV
)
15524 clear_glyph_matrix (w
->desired_matrix
);
15528 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15530 /* If we have reached alignment,
15531 we can copy the rest of the rows. */
15532 if (IT_CHARPOS (it
) == CHARPOS (start
))
15535 if (display_line (&it
))
15536 last_text_row
= it
.glyph_row
- 1;
15539 /* A value of current_y < last_visible_y means that we stopped
15540 at the previous window start, which in turn means that we
15541 have at least one reusable row. */
15542 if (it
.current_y
< it
.last_visible_y
)
15544 struct glyph_row
*row
;
15546 /* IT.vpos always starts from 0; it counts text lines. */
15547 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15549 /* Find PT if not already found in the lines displayed. */
15550 if (w
->cursor
.vpos
< 0)
15552 int dy
= it
.current_y
- start_row
->y
;
15554 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15555 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15557 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15558 dy
, nrows_scrolled
);
15561 clear_glyph_matrix (w
->desired_matrix
);
15566 /* Scroll the display. Do it before the current matrix is
15567 changed. The problem here is that update has not yet
15568 run, i.e. part of the current matrix is not up to date.
15569 scroll_run_hook will clear the cursor, and use the
15570 current matrix to get the height of the row the cursor is
15572 run
.current_y
= start_row
->y
;
15573 run
.desired_y
= it
.current_y
;
15574 run
.height
= it
.last_visible_y
- it
.current_y
;
15576 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15579 FRAME_RIF (f
)->update_window_begin_hook (w
);
15580 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15581 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15582 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15586 /* Shift current matrix down by nrows_scrolled lines. */
15587 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15588 rotate_matrix (w
->current_matrix
,
15590 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15593 /* Disable lines that must be updated. */
15594 for (i
= 0; i
< nrows_scrolled
; ++i
)
15595 (start_row
+ i
)->enabled_p
= 0;
15597 /* Re-compute Y positions. */
15598 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15599 max_y
= it
.last_visible_y
;
15600 for (row
= start_row
+ nrows_scrolled
;
15604 row
->y
= it
.current_y
;
15605 row
->visible_height
= row
->height
;
15607 if (row
->y
< min_y
)
15608 row
->visible_height
-= min_y
- row
->y
;
15609 if (row
->y
+ row
->height
> max_y
)
15610 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15611 if (row
->fringe_bitmap_periodic_p
)
15612 row
->redraw_fringe_bitmaps_p
= 1;
15614 it
.current_y
+= row
->height
;
15616 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15617 last_reused_text_row
= row
;
15618 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15622 /* Disable lines in the current matrix which are now
15623 below the window. */
15624 for (++row
; row
< bottom_row
; ++row
)
15625 row
->enabled_p
= row
->mode_line_p
= 0;
15628 /* Update window_end_pos etc.; last_reused_text_row is the last
15629 reused row from the current matrix containing text, if any.
15630 The value of last_text_row is the last displayed line
15631 containing text. */
15632 if (last_reused_text_row
)
15634 w
->window_end_bytepos
15635 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15637 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15639 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15640 w
->current_matrix
));
15642 else if (last_text_row
)
15644 w
->window_end_bytepos
15645 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15647 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15649 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15653 /* This window must be completely empty. */
15654 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15655 w
->window_end_pos
= make_number (Z
- ZV
);
15656 w
->window_end_vpos
= make_number (0);
15658 w
->window_end_valid
= Qnil
;
15660 /* Update hint: don't try scrolling again in update_window. */
15661 w
->desired_matrix
->no_scrolling_p
= 1;
15664 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15668 else if (CHARPOS (new_start
) > CHARPOS (start
))
15670 struct glyph_row
*pt_row
, *row
;
15671 struct glyph_row
*first_reusable_row
;
15672 struct glyph_row
*first_row_to_display
;
15674 int yb
= window_text_bottom_y (w
);
15676 /* Find the row starting at new_start, if there is one. Don't
15677 reuse a partially visible line at the end. */
15678 first_reusable_row
= start_row
;
15679 while (first_reusable_row
->enabled_p
15680 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15681 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15682 < CHARPOS (new_start
)))
15683 ++first_reusable_row
;
15685 /* Give up if there is no row to reuse. */
15686 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15687 || !first_reusable_row
->enabled_p
15688 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15689 != CHARPOS (new_start
)))
15692 /* We can reuse fully visible rows beginning with
15693 first_reusable_row to the end of the window. Set
15694 first_row_to_display to the first row that cannot be reused.
15695 Set pt_row to the row containing point, if there is any. */
15697 for (first_row_to_display
= first_reusable_row
;
15698 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15699 ++first_row_to_display
)
15701 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15702 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15703 pt_row
= first_row_to_display
;
15706 /* Start displaying at the start of first_row_to_display. */
15707 xassert (first_row_to_display
->y
< yb
);
15708 init_to_row_start (&it
, w
, first_row_to_display
);
15710 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15712 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15714 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15715 + WINDOW_HEADER_LINE_HEIGHT (w
));
15717 /* Display lines beginning with first_row_to_display in the
15718 desired matrix. Set last_text_row to the last row displayed
15719 that displays text. */
15720 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15721 if (pt_row
== NULL
)
15722 w
->cursor
.vpos
= -1;
15723 last_text_row
= NULL
;
15724 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15725 if (display_line (&it
))
15726 last_text_row
= it
.glyph_row
- 1;
15728 /* If point is in a reused row, adjust y and vpos of the cursor
15732 w
->cursor
.vpos
-= nrows_scrolled
;
15733 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15736 /* Give up if point isn't in a row displayed or reused. (This
15737 also handles the case where w->cursor.vpos < nrows_scrolled
15738 after the calls to display_line, which can happen with scroll
15739 margins. See bug#1295.) */
15740 if (w
->cursor
.vpos
< 0)
15742 clear_glyph_matrix (w
->desired_matrix
);
15746 /* Scroll the display. */
15747 run
.current_y
= first_reusable_row
->y
;
15748 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15749 run
.height
= it
.last_visible_y
- run
.current_y
;
15750 dy
= run
.current_y
- run
.desired_y
;
15755 FRAME_RIF (f
)->update_window_begin_hook (w
);
15756 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15757 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15758 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15762 /* Adjust Y positions of reused rows. */
15763 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15764 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15765 max_y
= it
.last_visible_y
;
15766 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15769 row
->visible_height
= row
->height
;
15770 if (row
->y
< min_y
)
15771 row
->visible_height
-= min_y
- row
->y
;
15772 if (row
->y
+ row
->height
> max_y
)
15773 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15774 if (row
->fringe_bitmap_periodic_p
)
15775 row
->redraw_fringe_bitmaps_p
= 1;
15778 /* Scroll the current matrix. */
15779 xassert (nrows_scrolled
> 0);
15780 rotate_matrix (w
->current_matrix
,
15782 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15785 /* Disable rows not reused. */
15786 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15787 row
->enabled_p
= 0;
15789 /* Point may have moved to a different line, so we cannot assume that
15790 the previous cursor position is valid; locate the correct row. */
15793 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15794 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15798 w
->cursor
.y
= row
->y
;
15800 if (row
< bottom_row
)
15802 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15803 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15805 /* Can't use this optimization with bidi-reordered glyph
15806 rows, unless cursor is already at point. */
15807 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15809 if (!(w
->cursor
.hpos
>= 0
15810 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15811 && BUFFERP (glyph
->object
)
15812 && glyph
->charpos
== PT
))
15817 && (!BUFFERP (glyph
->object
)
15818 || glyph
->charpos
< PT
);
15822 w
->cursor
.x
+= glyph
->pixel_width
;
15827 /* Adjust window end. A null value of last_text_row means that
15828 the window end is in reused rows which in turn means that
15829 only its vpos can have changed. */
15832 w
->window_end_bytepos
15833 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15835 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15837 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15842 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15845 w
->window_end_valid
= Qnil
;
15846 w
->desired_matrix
->no_scrolling_p
= 1;
15849 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15859 /************************************************************************
15860 Window redisplay reusing current matrix when buffer has changed
15861 ************************************************************************/
15863 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15864 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15865 EMACS_INT
*, EMACS_INT
*);
15866 static struct glyph_row
*
15867 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15868 struct glyph_row
*);
15871 /* Return the last row in MATRIX displaying text. If row START is
15872 non-null, start searching with that row. IT gives the dimensions
15873 of the display. Value is null if matrix is empty; otherwise it is
15874 a pointer to the row found. */
15876 static struct glyph_row
*
15877 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15878 struct glyph_row
*start
)
15880 struct glyph_row
*row
, *row_found
;
15882 /* Set row_found to the last row in IT->w's current matrix
15883 displaying text. The loop looks funny but think of partially
15886 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15887 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15889 xassert (row
->enabled_p
);
15891 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15900 /* Return the last row in the current matrix of W that is not affected
15901 by changes at the start of current_buffer that occurred since W's
15902 current matrix was built. Value is null if no such row exists.
15904 BEG_UNCHANGED us the number of characters unchanged at the start of
15905 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15906 first changed character in current_buffer. Characters at positions <
15907 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15908 when the current matrix was built. */
15910 static struct glyph_row
*
15911 find_last_unchanged_at_beg_row (struct window
*w
)
15913 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15914 struct glyph_row
*row
;
15915 struct glyph_row
*row_found
= NULL
;
15916 int yb
= window_text_bottom_y (w
);
15918 /* Find the last row displaying unchanged text. */
15919 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15920 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15921 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15924 if (/* If row ends before first_changed_pos, it is unchanged,
15925 except in some case. */
15926 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15927 /* When row ends in ZV and we write at ZV it is not
15929 && !row
->ends_at_zv_p
15930 /* When first_changed_pos is the end of a continued line,
15931 row is not unchanged because it may be no longer
15933 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15934 && (row
->continued_p
15935 || row
->exact_window_width_line_p
)))
15938 /* Stop if last visible row. */
15939 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15947 /* Find the first glyph row in the current matrix of W that is not
15948 affected by changes at the end of current_buffer since the
15949 time W's current matrix was built.
15951 Return in *DELTA the number of chars by which buffer positions in
15952 unchanged text at the end of current_buffer must be adjusted.
15954 Return in *DELTA_BYTES the corresponding number of bytes.
15956 Value is null if no such row exists, i.e. all rows are affected by
15959 static struct glyph_row
*
15960 find_first_unchanged_at_end_row (struct window
*w
,
15961 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15963 struct glyph_row
*row
;
15964 struct glyph_row
*row_found
= NULL
;
15966 *delta
= *delta_bytes
= 0;
15968 /* Display must not have been paused, otherwise the current matrix
15969 is not up to date. */
15970 eassert (!NILP (w
->window_end_valid
));
15972 /* A value of window_end_pos >= END_UNCHANGED means that the window
15973 end is in the range of changed text. If so, there is no
15974 unchanged row at the end of W's current matrix. */
15975 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15978 /* Set row to the last row in W's current matrix displaying text. */
15979 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15981 /* If matrix is entirely empty, no unchanged row exists. */
15982 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15984 /* The value of row is the last glyph row in the matrix having a
15985 meaningful buffer position in it. The end position of row
15986 corresponds to window_end_pos. This allows us to translate
15987 buffer positions in the current matrix to current buffer
15988 positions for characters not in changed text. */
15990 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15991 EMACS_INT Z_BYTE_old
=
15992 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15993 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15994 struct glyph_row
*first_text_row
15995 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15997 *delta
= Z
- Z_old
;
15998 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16000 /* Set last_unchanged_pos to the buffer position of the last
16001 character in the buffer that has not been changed. Z is the
16002 index + 1 of the last character in current_buffer, i.e. by
16003 subtracting END_UNCHANGED we get the index of the last
16004 unchanged character, and we have to add BEG to get its buffer
16006 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16007 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16009 /* Search backward from ROW for a row displaying a line that
16010 starts at a minimum position >= last_unchanged_pos_old. */
16011 for (; row
> first_text_row
; --row
)
16013 /* This used to abort, but it can happen.
16014 It is ok to just stop the search instead here. KFS. */
16015 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16018 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16023 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16029 /* Make sure that glyph rows in the current matrix of window W
16030 reference the same glyph memory as corresponding rows in the
16031 frame's frame matrix. This function is called after scrolling W's
16032 current matrix on a terminal frame in try_window_id and
16033 try_window_reusing_current_matrix. */
16036 sync_frame_with_window_matrix_rows (struct window
*w
)
16038 struct frame
*f
= XFRAME (w
->frame
);
16039 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16041 /* Preconditions: W must be a leaf window and full-width. Its frame
16042 must have a frame matrix. */
16043 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16044 xassert (WINDOW_FULL_WIDTH_P (w
));
16045 xassert (!FRAME_WINDOW_P (f
));
16047 /* If W is a full-width window, glyph pointers in W's current matrix
16048 have, by definition, to be the same as glyph pointers in the
16049 corresponding frame matrix. Note that frame matrices have no
16050 marginal areas (see build_frame_matrix). */
16051 window_row
= w
->current_matrix
->rows
;
16052 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16053 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16054 while (window_row
< window_row_end
)
16056 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16057 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16059 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16060 frame_row
->glyphs
[TEXT_AREA
] = start
;
16061 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16062 frame_row
->glyphs
[LAST_AREA
] = end
;
16064 /* Disable frame rows whose corresponding window rows have
16065 been disabled in try_window_id. */
16066 if (!window_row
->enabled_p
)
16067 frame_row
->enabled_p
= 0;
16069 ++window_row
, ++frame_row
;
16074 /* Find the glyph row in window W containing CHARPOS. Consider all
16075 rows between START and END (not inclusive). END null means search
16076 all rows to the end of the display area of W. Value is the row
16077 containing CHARPOS or null. */
16080 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16081 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16083 struct glyph_row
*row
= start
;
16084 struct glyph_row
*best_row
= NULL
;
16085 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16088 /* If we happen to start on a header-line, skip that. */
16089 if (row
->mode_line_p
)
16092 if ((end
&& row
>= end
) || !row
->enabled_p
)
16095 last_y
= window_text_bottom_y (w
) - dy
;
16099 /* Give up if we have gone too far. */
16100 if (end
&& row
>= end
)
16102 /* This formerly returned if they were equal.
16103 I think that both quantities are of a "last plus one" type;
16104 if so, when they are equal, the row is within the screen. -- rms. */
16105 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16108 /* If it is in this row, return this row. */
16109 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16110 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16111 /* The end position of a row equals the start
16112 position of the next row. If CHARPOS is there, we
16113 would rather display it in the next line, except
16114 when this line ends in ZV. */
16115 && !row
->ends_at_zv_p
16116 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16117 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16121 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16122 || (!best_row
&& !row
->continued_p
))
16124 /* In bidi-reordered rows, there could be several rows
16125 occluding point, all of them belonging to the same
16126 continued line. We need to find the row which fits
16127 CHARPOS the best. */
16128 for (g
= row
->glyphs
[TEXT_AREA
];
16129 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16132 if (!STRINGP (g
->object
))
16134 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16136 mindif
= eabs (g
->charpos
- charpos
);
16138 /* Exact match always wins. */
16145 else if (best_row
&& !row
->continued_p
)
16152 /* Try to redisplay window W by reusing its existing display. W's
16153 current matrix must be up to date when this function is called,
16154 i.e. window_end_valid must not be nil.
16158 1 if display has been updated
16159 0 if otherwise unsuccessful
16160 -1 if redisplay with same window start is known not to succeed
16162 The following steps are performed:
16164 1. Find the last row in the current matrix of W that is not
16165 affected by changes at the start of current_buffer. If no such row
16168 2. Find the first row in W's current matrix that is not affected by
16169 changes at the end of current_buffer. Maybe there is no such row.
16171 3. Display lines beginning with the row + 1 found in step 1 to the
16172 row found in step 2 or, if step 2 didn't find a row, to the end of
16175 4. If cursor is not known to appear on the window, give up.
16177 5. If display stopped at the row found in step 2, scroll the
16178 display and current matrix as needed.
16180 6. Maybe display some lines at the end of W, if we must. This can
16181 happen under various circumstances, like a partially visible line
16182 becoming fully visible, or because newly displayed lines are displayed
16183 in smaller font sizes.
16185 7. Update W's window end information. */
16188 try_window_id (struct window
*w
)
16190 struct frame
*f
= XFRAME (w
->frame
);
16191 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16192 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16193 struct glyph_row
*last_unchanged_at_beg_row
;
16194 struct glyph_row
*first_unchanged_at_end_row
;
16195 struct glyph_row
*row
;
16196 struct glyph_row
*bottom_row
;
16199 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16201 struct text_pos start_pos
;
16203 int first_unchanged_at_end_vpos
= 0;
16204 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16205 struct text_pos start
;
16206 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16209 if (inhibit_try_window_id
)
16213 /* This is handy for debugging. */
16215 #define GIVE_UP(X) \
16217 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16221 #define GIVE_UP(X) return 0
16224 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16226 /* Don't use this for mini-windows because these can show
16227 messages and mini-buffers, and we don't handle that here. */
16228 if (MINI_WINDOW_P (w
))
16231 /* This flag is used to prevent redisplay optimizations. */
16232 if (windows_or_buffers_changed
|| cursor_type_changed
)
16235 /* Verify that narrowing has not changed.
16236 Also verify that we were not told to prevent redisplay optimizations.
16237 It would be nice to further
16238 reduce the number of cases where this prevents try_window_id. */
16239 if (current_buffer
->clip_changed
16240 || current_buffer
->prevent_redisplay_optimizations_p
)
16243 /* Window must either use window-based redisplay or be full width. */
16244 if (!FRAME_WINDOW_P (f
)
16245 && (!FRAME_LINE_INS_DEL_OK (f
)
16246 || !WINDOW_FULL_WIDTH_P (w
)))
16249 /* Give up if point is known NOT to appear in W. */
16250 if (PT
< CHARPOS (start
))
16253 /* Another way to prevent redisplay optimizations. */
16254 if (XFASTINT (w
->last_modified
) == 0)
16257 /* Verify that window is not hscrolled. */
16258 if (XFASTINT (w
->hscroll
) != 0)
16261 /* Verify that display wasn't paused. */
16262 if (NILP (w
->window_end_valid
))
16265 /* Can't use this if highlighting a region because a cursor movement
16266 will do more than just set the cursor. */
16267 if (!NILP (Vtransient_mark_mode
)
16268 && !NILP (BVAR (current_buffer
, mark_active
)))
16271 /* Likewise if highlighting trailing whitespace. */
16272 if (!NILP (Vshow_trailing_whitespace
))
16275 /* Likewise if showing a region. */
16276 if (!NILP (w
->region_showing
))
16279 /* Can't use this if overlay arrow position and/or string have
16281 if (overlay_arrows_changed_p ())
16284 /* When word-wrap is on, adding a space to the first word of a
16285 wrapped line can change the wrap position, altering the line
16286 above it. It might be worthwhile to handle this more
16287 intelligently, but for now just redisplay from scratch. */
16288 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16291 /* Under bidi reordering, adding or deleting a character in the
16292 beginning of a paragraph, before the first strong directional
16293 character, can change the base direction of the paragraph (unless
16294 the buffer specifies a fixed paragraph direction), which will
16295 require to redisplay the whole paragraph. It might be worthwhile
16296 to find the paragraph limits and widen the range of redisplayed
16297 lines to that, but for now just give up this optimization and
16298 redisplay from scratch. */
16299 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16300 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16303 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16304 only if buffer has really changed. The reason is that the gap is
16305 initially at Z for freshly visited files. The code below would
16306 set end_unchanged to 0 in that case. */
16307 if (MODIFF
> SAVE_MODIFF
16308 /* This seems to happen sometimes after saving a buffer. */
16309 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16311 if (GPT
- BEG
< BEG_UNCHANGED
)
16312 BEG_UNCHANGED
= GPT
- BEG
;
16313 if (Z
- GPT
< END_UNCHANGED
)
16314 END_UNCHANGED
= Z
- GPT
;
16317 /* The position of the first and last character that has been changed. */
16318 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16319 last_changed_charpos
= Z
- END_UNCHANGED
;
16321 /* If window starts after a line end, and the last change is in
16322 front of that newline, then changes don't affect the display.
16323 This case happens with stealth-fontification. Note that although
16324 the display is unchanged, glyph positions in the matrix have to
16325 be adjusted, of course. */
16326 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16327 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16328 && ((last_changed_charpos
< CHARPOS (start
)
16329 && CHARPOS (start
) == BEGV
)
16330 || (last_changed_charpos
< CHARPOS (start
) - 1
16331 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16333 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16334 struct glyph_row
*r0
;
16336 /* Compute how many chars/bytes have been added to or removed
16337 from the buffer. */
16338 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16339 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16340 Z_delta
= Z
- Z_old
;
16341 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16343 /* Give up if PT is not in the window. Note that it already has
16344 been checked at the start of try_window_id that PT is not in
16345 front of the window start. */
16346 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16349 /* If window start is unchanged, we can reuse the whole matrix
16350 as is, after adjusting glyph positions. No need to compute
16351 the window end again, since its offset from Z hasn't changed. */
16352 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16353 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16354 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16355 /* PT must not be in a partially visible line. */
16356 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16357 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16359 /* Adjust positions in the glyph matrix. */
16360 if (Z_delta
|| Z_delta_bytes
)
16362 struct glyph_row
*r1
16363 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16364 increment_matrix_positions (w
->current_matrix
,
16365 MATRIX_ROW_VPOS (r0
, current_matrix
),
16366 MATRIX_ROW_VPOS (r1
, current_matrix
),
16367 Z_delta
, Z_delta_bytes
);
16370 /* Set the cursor. */
16371 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16373 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16380 /* Handle the case that changes are all below what is displayed in
16381 the window, and that PT is in the window. This shortcut cannot
16382 be taken if ZV is visible in the window, and text has been added
16383 there that is visible in the window. */
16384 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16385 /* ZV is not visible in the window, or there are no
16386 changes at ZV, actually. */
16387 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16388 || first_changed_charpos
== last_changed_charpos
))
16390 struct glyph_row
*r0
;
16392 /* Give up if PT is not in the window. Note that it already has
16393 been checked at the start of try_window_id that PT is not in
16394 front of the window start. */
16395 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16398 /* If window start is unchanged, we can reuse the whole matrix
16399 as is, without changing glyph positions since no text has
16400 been added/removed in front of the window end. */
16401 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16402 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16403 /* PT must not be in a partially visible line. */
16404 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16405 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16407 /* We have to compute the window end anew since text
16408 could have been added/removed after it. */
16410 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16411 w
->window_end_bytepos
16412 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16414 /* Set the cursor. */
16415 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16417 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16424 /* Give up if window start is in the changed area.
16426 The condition used to read
16428 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16430 but why that was tested escapes me at the moment. */
16431 if (CHARPOS (start
) >= first_changed_charpos
16432 && CHARPOS (start
) <= last_changed_charpos
)
16435 /* Check that window start agrees with the start of the first glyph
16436 row in its current matrix. Check this after we know the window
16437 start is not in changed text, otherwise positions would not be
16439 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16440 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16443 /* Give up if the window ends in strings. Overlay strings
16444 at the end are difficult to handle, so don't try. */
16445 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16446 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16449 /* Compute the position at which we have to start displaying new
16450 lines. Some of the lines at the top of the window might be
16451 reusable because they are not displaying changed text. Find the
16452 last row in W's current matrix not affected by changes at the
16453 start of current_buffer. Value is null if changes start in the
16454 first line of window. */
16455 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16456 if (last_unchanged_at_beg_row
)
16458 /* Avoid starting to display in the moddle of a character, a TAB
16459 for instance. This is easier than to set up the iterator
16460 exactly, and it's not a frequent case, so the additional
16461 effort wouldn't really pay off. */
16462 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16463 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16464 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16465 --last_unchanged_at_beg_row
;
16467 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16470 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16472 start_pos
= it
.current
.pos
;
16474 /* Start displaying new lines in the desired matrix at the same
16475 vpos we would use in the current matrix, i.e. below
16476 last_unchanged_at_beg_row. */
16477 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16479 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16480 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16482 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16486 /* There are no reusable lines at the start of the window.
16487 Start displaying in the first text line. */
16488 start_display (&it
, w
, start
);
16489 it
.vpos
= it
.first_vpos
;
16490 start_pos
= it
.current
.pos
;
16493 /* Find the first row that is not affected by changes at the end of
16494 the buffer. Value will be null if there is no unchanged row, in
16495 which case we must redisplay to the end of the window. delta
16496 will be set to the value by which buffer positions beginning with
16497 first_unchanged_at_end_row have to be adjusted due to text
16499 first_unchanged_at_end_row
16500 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16501 IF_DEBUG (debug_delta
= delta
);
16502 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16504 /* Set stop_pos to the buffer position up to which we will have to
16505 display new lines. If first_unchanged_at_end_row != NULL, this
16506 is the buffer position of the start of the line displayed in that
16507 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16508 that we don't stop at a buffer position. */
16510 if (first_unchanged_at_end_row
)
16512 xassert (last_unchanged_at_beg_row
== NULL
16513 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16515 /* If this is a continuation line, move forward to the next one
16516 that isn't. Changes in lines above affect this line.
16517 Caution: this may move first_unchanged_at_end_row to a row
16518 not displaying text. */
16519 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16520 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16521 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16522 < it
.last_visible_y
))
16523 ++first_unchanged_at_end_row
;
16525 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16526 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16527 >= it
.last_visible_y
))
16528 first_unchanged_at_end_row
= NULL
;
16531 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16533 first_unchanged_at_end_vpos
16534 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16535 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16538 else if (last_unchanged_at_beg_row
== NULL
)
16544 /* Either there is no unchanged row at the end, or the one we have
16545 now displays text. This is a necessary condition for the window
16546 end pos calculation at the end of this function. */
16547 xassert (first_unchanged_at_end_row
== NULL
16548 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16550 debug_last_unchanged_at_beg_vpos
16551 = (last_unchanged_at_beg_row
16552 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16554 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16556 #endif /* GLYPH_DEBUG != 0 */
16559 /* Display new lines. Set last_text_row to the last new line
16560 displayed which has text on it, i.e. might end up as being the
16561 line where the window_end_vpos is. */
16562 w
->cursor
.vpos
= -1;
16563 last_text_row
= NULL
;
16564 overlay_arrow_seen
= 0;
16565 while (it
.current_y
< it
.last_visible_y
16566 && !fonts_changed_p
16567 && (first_unchanged_at_end_row
== NULL
16568 || IT_CHARPOS (it
) < stop_pos
))
16570 if (display_line (&it
))
16571 last_text_row
= it
.glyph_row
- 1;
16574 if (fonts_changed_p
)
16578 /* Compute differences in buffer positions, y-positions etc. for
16579 lines reused at the bottom of the window. Compute what we can
16581 if (first_unchanged_at_end_row
16582 /* No lines reused because we displayed everything up to the
16583 bottom of the window. */
16584 && it
.current_y
< it
.last_visible_y
)
16587 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16589 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16590 run
.current_y
= first_unchanged_at_end_row
->y
;
16591 run
.desired_y
= run
.current_y
+ dy
;
16592 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16596 delta
= delta_bytes
= dvpos
= dy
16597 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16598 first_unchanged_at_end_row
= NULL
;
16600 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16603 /* Find the cursor if not already found. We have to decide whether
16604 PT will appear on this window (it sometimes doesn't, but this is
16605 not a very frequent case.) This decision has to be made before
16606 the current matrix is altered. A value of cursor.vpos < 0 means
16607 that PT is either in one of the lines beginning at
16608 first_unchanged_at_end_row or below the window. Don't care for
16609 lines that might be displayed later at the window end; as
16610 mentioned, this is not a frequent case. */
16611 if (w
->cursor
.vpos
< 0)
16613 /* Cursor in unchanged rows at the top? */
16614 if (PT
< CHARPOS (start_pos
)
16615 && last_unchanged_at_beg_row
)
16617 row
= row_containing_pos (w
, PT
,
16618 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16619 last_unchanged_at_beg_row
+ 1, 0);
16621 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16624 /* Start from first_unchanged_at_end_row looking for PT. */
16625 else if (first_unchanged_at_end_row
)
16627 row
= row_containing_pos (w
, PT
- delta
,
16628 first_unchanged_at_end_row
, NULL
, 0);
16630 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16631 delta_bytes
, dy
, dvpos
);
16634 /* Give up if cursor was not found. */
16635 if (w
->cursor
.vpos
< 0)
16637 clear_glyph_matrix (w
->desired_matrix
);
16642 /* Don't let the cursor end in the scroll margins. */
16644 int this_scroll_margin
, cursor_height
;
16646 this_scroll_margin
= max (0, scroll_margin
);
16647 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16648 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16649 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16651 if ((w
->cursor
.y
< this_scroll_margin
16652 && CHARPOS (start
) > BEGV
)
16653 /* Old redisplay didn't take scroll margin into account at the bottom,
16654 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16655 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16656 ? cursor_height
+ this_scroll_margin
16657 : 1)) > it
.last_visible_y
)
16659 w
->cursor
.vpos
= -1;
16660 clear_glyph_matrix (w
->desired_matrix
);
16665 /* Scroll the display. Do it before changing the current matrix so
16666 that xterm.c doesn't get confused about where the cursor glyph is
16668 if (dy
&& run
.height
)
16672 if (FRAME_WINDOW_P (f
))
16674 FRAME_RIF (f
)->update_window_begin_hook (w
);
16675 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16676 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16677 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16681 /* Terminal frame. In this case, dvpos gives the number of
16682 lines to scroll by; dvpos < 0 means scroll up. */
16684 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16685 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16686 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16687 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16688 + window_internal_height (w
));
16690 #if defined (HAVE_GPM) || defined (MSDOS)
16691 x_clear_window_mouse_face (w
);
16693 /* Perform the operation on the screen. */
16696 /* Scroll last_unchanged_at_beg_row to the end of the
16697 window down dvpos lines. */
16698 set_terminal_window (f
, end
);
16700 /* On dumb terminals delete dvpos lines at the end
16701 before inserting dvpos empty lines. */
16702 if (!FRAME_SCROLL_REGION_OK (f
))
16703 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16705 /* Insert dvpos empty lines in front of
16706 last_unchanged_at_beg_row. */
16707 ins_del_lines (f
, from
, dvpos
);
16709 else if (dvpos
< 0)
16711 /* Scroll up last_unchanged_at_beg_vpos to the end of
16712 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16713 set_terminal_window (f
, end
);
16715 /* Delete dvpos lines in front of
16716 last_unchanged_at_beg_vpos. ins_del_lines will set
16717 the cursor to the given vpos and emit |dvpos| delete
16719 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16721 /* On a dumb terminal insert dvpos empty lines at the
16723 if (!FRAME_SCROLL_REGION_OK (f
))
16724 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16727 set_terminal_window (f
, 0);
16733 /* Shift reused rows of the current matrix to the right position.
16734 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16736 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16737 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16740 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16741 bottom_vpos
, dvpos
);
16742 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16745 else if (dvpos
> 0)
16747 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16748 bottom_vpos
, dvpos
);
16749 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16750 first_unchanged_at_end_vpos
+ dvpos
, 0);
16753 /* For frame-based redisplay, make sure that current frame and window
16754 matrix are in sync with respect to glyph memory. */
16755 if (!FRAME_WINDOW_P (f
))
16756 sync_frame_with_window_matrix_rows (w
);
16758 /* Adjust buffer positions in reused rows. */
16759 if (delta
|| delta_bytes
)
16760 increment_matrix_positions (current_matrix
,
16761 first_unchanged_at_end_vpos
+ dvpos
,
16762 bottom_vpos
, delta
, delta_bytes
);
16764 /* Adjust Y positions. */
16766 shift_glyph_matrix (w
, current_matrix
,
16767 first_unchanged_at_end_vpos
+ dvpos
,
16770 if (first_unchanged_at_end_row
)
16772 first_unchanged_at_end_row
+= dvpos
;
16773 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16774 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16775 first_unchanged_at_end_row
= NULL
;
16778 /* If scrolling up, there may be some lines to display at the end of
16780 last_text_row_at_end
= NULL
;
16783 /* Scrolling up can leave for example a partially visible line
16784 at the end of the window to be redisplayed. */
16785 /* Set last_row to the glyph row in the current matrix where the
16786 window end line is found. It has been moved up or down in
16787 the matrix by dvpos. */
16788 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16789 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16791 /* If last_row is the window end line, it should display text. */
16792 xassert (last_row
->displays_text_p
);
16794 /* If window end line was partially visible before, begin
16795 displaying at that line. Otherwise begin displaying with the
16796 line following it. */
16797 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16799 init_to_row_start (&it
, w
, last_row
);
16800 it
.vpos
= last_vpos
;
16801 it
.current_y
= last_row
->y
;
16805 init_to_row_end (&it
, w
, last_row
);
16806 it
.vpos
= 1 + last_vpos
;
16807 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16811 /* We may start in a continuation line. If so, we have to
16812 get the right continuation_lines_width and current_x. */
16813 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16814 it
.hpos
= it
.current_x
= 0;
16816 /* Display the rest of the lines at the window end. */
16817 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16818 while (it
.current_y
< it
.last_visible_y
16819 && !fonts_changed_p
)
16821 /* Is it always sure that the display agrees with lines in
16822 the current matrix? I don't think so, so we mark rows
16823 displayed invalid in the current matrix by setting their
16824 enabled_p flag to zero. */
16825 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16826 if (display_line (&it
))
16827 last_text_row_at_end
= it
.glyph_row
- 1;
16831 /* Update window_end_pos and window_end_vpos. */
16832 if (first_unchanged_at_end_row
16833 && !last_text_row_at_end
)
16835 /* Window end line if one of the preserved rows from the current
16836 matrix. Set row to the last row displaying text in current
16837 matrix starting at first_unchanged_at_end_row, after
16839 xassert (first_unchanged_at_end_row
->displays_text_p
);
16840 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16841 first_unchanged_at_end_row
);
16842 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16844 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16845 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16847 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16848 xassert (w
->window_end_bytepos
>= 0);
16849 IF_DEBUG (debug_method_add (w
, "A"));
16851 else if (last_text_row_at_end
)
16854 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16855 w
->window_end_bytepos
16856 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16858 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16859 xassert (w
->window_end_bytepos
>= 0);
16860 IF_DEBUG (debug_method_add (w
, "B"));
16862 else if (last_text_row
)
16864 /* We have displayed either to the end of the window or at the
16865 end of the window, i.e. the last row with text is to be found
16866 in the desired matrix. */
16868 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16869 w
->window_end_bytepos
16870 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16872 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16873 xassert (w
->window_end_bytepos
>= 0);
16875 else if (first_unchanged_at_end_row
== NULL
16876 && last_text_row
== NULL
16877 && last_text_row_at_end
== NULL
)
16879 /* Displayed to end of window, but no line containing text was
16880 displayed. Lines were deleted at the end of the window. */
16881 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16882 int vpos
= XFASTINT (w
->window_end_vpos
);
16883 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16884 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16887 row
== NULL
&& vpos
>= first_vpos
;
16888 --vpos
, --current_row
, --desired_row
)
16890 if (desired_row
->enabled_p
)
16892 if (desired_row
->displays_text_p
)
16895 else if (current_row
->displays_text_p
)
16899 xassert (row
!= NULL
);
16900 w
->window_end_vpos
= make_number (vpos
+ 1);
16901 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16902 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16903 xassert (w
->window_end_bytepos
>= 0);
16904 IF_DEBUG (debug_method_add (w
, "C"));
16909 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16910 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16912 /* Record that display has not been completed. */
16913 w
->window_end_valid
= Qnil
;
16914 w
->desired_matrix
->no_scrolling_p
= 1;
16922 /***********************************************************************
16923 More debugging support
16924 ***********************************************************************/
16928 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
16929 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
16930 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
16933 /* Dump the contents of glyph matrix MATRIX on stderr.
16935 GLYPHS 0 means don't show glyph contents.
16936 GLYPHS 1 means show glyphs in short form
16937 GLYPHS > 1 means show glyphs in long form. */
16940 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
16943 for (i
= 0; i
< matrix
->nrows
; ++i
)
16944 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16948 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16949 the glyph row and area where the glyph comes from. */
16952 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
16954 if (glyph
->type
== CHAR_GLYPH
)
16957 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16958 glyph
- row
->glyphs
[TEXT_AREA
],
16961 (BUFFERP (glyph
->object
)
16963 : (STRINGP (glyph
->object
)
16966 glyph
->pixel_width
,
16968 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16972 glyph
->left_box_line_p
,
16973 glyph
->right_box_line_p
);
16975 else if (glyph
->type
== STRETCH_GLYPH
)
16978 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16979 glyph
- row
->glyphs
[TEXT_AREA
],
16982 (BUFFERP (glyph
->object
)
16984 : (STRINGP (glyph
->object
)
16987 glyph
->pixel_width
,
16991 glyph
->left_box_line_p
,
16992 glyph
->right_box_line_p
);
16994 else if (glyph
->type
== IMAGE_GLYPH
)
16997 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16998 glyph
- row
->glyphs
[TEXT_AREA
],
17001 (BUFFERP (glyph
->object
)
17003 : (STRINGP (glyph
->object
)
17006 glyph
->pixel_width
,
17010 glyph
->left_box_line_p
,
17011 glyph
->right_box_line_p
);
17013 else if (glyph
->type
== COMPOSITE_GLYPH
)
17016 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17017 glyph
- row
->glyphs
[TEXT_AREA
],
17020 (BUFFERP (glyph
->object
)
17022 : (STRINGP (glyph
->object
)
17025 glyph
->pixel_width
,
17027 if (glyph
->u
.cmp
.automatic
)
17030 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17031 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17033 glyph
->left_box_line_p
,
17034 glyph
->right_box_line_p
);
17039 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17040 GLYPHS 0 means don't show glyph contents.
17041 GLYPHS 1 means show glyphs in short form
17042 GLYPHS > 1 means show glyphs in long form. */
17045 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17049 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17050 fprintf (stderr
, "======================================================================\n");
17052 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17053 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17055 MATRIX_ROW_START_CHARPOS (row
),
17056 MATRIX_ROW_END_CHARPOS (row
),
17057 row
->used
[TEXT_AREA
],
17058 row
->contains_overlapping_glyphs_p
,
17060 row
->truncated_on_left_p
,
17061 row
->truncated_on_right_p
,
17063 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17064 row
->displays_text_p
,
17067 row
->ends_in_middle_of_char_p
,
17068 row
->starts_in_middle_of_char_p
,
17074 row
->visible_height
,
17077 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17078 row
->end
.overlay_string_index
,
17079 row
->continuation_lines_width
);
17080 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17081 CHARPOS (row
->start
.string_pos
),
17082 CHARPOS (row
->end
.string_pos
));
17083 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17084 row
->end
.dpvec_index
);
17091 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17093 struct glyph
*glyph
= row
->glyphs
[area
];
17094 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17096 /* Glyph for a line end in text. */
17097 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17100 if (glyph
< glyph_end
)
17101 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17103 for (; glyph
< glyph_end
; ++glyph
)
17104 dump_glyph (row
, glyph
, area
);
17107 else if (glyphs
== 1)
17111 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17113 char *s
= (char *) alloca (row
->used
[area
] + 1);
17116 for (i
= 0; i
< row
->used
[area
]; ++i
)
17118 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17119 if (glyph
->type
== CHAR_GLYPH
17120 && glyph
->u
.ch
< 0x80
17121 && glyph
->u
.ch
>= ' ')
17122 s
[i
] = glyph
->u
.ch
;
17128 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17134 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17135 Sdump_glyph_matrix
, 0, 1, "p",
17136 doc
: /* Dump the current matrix of the selected window to stderr.
17137 Shows contents of glyph row structures. With non-nil
17138 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17139 glyphs in short form, otherwise show glyphs in long form. */)
17140 (Lisp_Object glyphs
)
17142 struct window
*w
= XWINDOW (selected_window
);
17143 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17145 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17146 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17147 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17148 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17149 fprintf (stderr
, "=============================================\n");
17150 dump_glyph_matrix (w
->current_matrix
,
17151 NILP (glyphs
) ? 0 : XINT (glyphs
));
17156 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17157 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17160 struct frame
*f
= XFRAME (selected_frame
);
17161 dump_glyph_matrix (f
->current_matrix
, 1);
17166 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17167 doc
: /* Dump glyph row ROW to stderr.
17168 GLYPH 0 means don't dump glyphs.
17169 GLYPH 1 means dump glyphs in short form.
17170 GLYPH > 1 or omitted means dump glyphs in long form. */)
17171 (Lisp_Object row
, Lisp_Object glyphs
)
17173 struct glyph_matrix
*matrix
;
17176 CHECK_NUMBER (row
);
17177 matrix
= XWINDOW (selected_window
)->current_matrix
;
17179 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17180 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17182 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17187 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17188 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17189 GLYPH 0 means don't dump glyphs.
17190 GLYPH 1 means dump glyphs in short form.
17191 GLYPH > 1 or omitted means dump glyphs in long form. */)
17192 (Lisp_Object row
, Lisp_Object glyphs
)
17194 struct frame
*sf
= SELECTED_FRAME ();
17195 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17198 CHECK_NUMBER (row
);
17200 if (vpos
>= 0 && vpos
< m
->nrows
)
17201 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17202 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17207 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17208 doc
: /* Toggle tracing of redisplay.
17209 With ARG, turn tracing on if and only if ARG is positive. */)
17213 trace_redisplay_p
= !trace_redisplay_p
;
17216 arg
= Fprefix_numeric_value (arg
);
17217 trace_redisplay_p
= XINT (arg
) > 0;
17224 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17225 doc
: /* Like `format', but print result to stderr.
17226 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17227 (ptrdiff_t nargs
, Lisp_Object
*args
)
17229 Lisp_Object s
= Fformat (nargs
, args
);
17230 fprintf (stderr
, "%s", SDATA (s
));
17234 #endif /* GLYPH_DEBUG */
17238 /***********************************************************************
17239 Building Desired Matrix Rows
17240 ***********************************************************************/
17242 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17243 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17245 static struct glyph_row
*
17246 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17248 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17249 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17250 struct buffer
*old
= current_buffer
;
17251 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17252 int arrow_len
= SCHARS (overlay_arrow_string
);
17253 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17254 const unsigned char *p
;
17257 int n_glyphs_before
;
17259 set_buffer_temp (buffer
);
17260 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17261 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17262 SET_TEXT_POS (it
.position
, 0, 0);
17264 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17266 while (p
< arrow_end
)
17268 Lisp_Object face
, ilisp
;
17270 /* Get the next character. */
17272 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17275 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17276 if (! ASCII_CHAR_P (it
.c
))
17277 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17281 /* Get its face. */
17282 ilisp
= make_number (p
- arrow_string
);
17283 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17284 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17286 /* Compute its width, get its glyphs. */
17287 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17288 SET_TEXT_POS (it
.position
, -1, -1);
17289 PRODUCE_GLYPHS (&it
);
17291 /* If this character doesn't fit any more in the line, we have
17292 to remove some glyphs. */
17293 if (it
.current_x
> it
.last_visible_x
)
17295 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17300 set_buffer_temp (old
);
17301 return it
.glyph_row
;
17305 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17306 glyphs are only inserted for terminal frames since we can't really
17307 win with truncation glyphs when partially visible glyphs are
17308 involved. Which glyphs to insert is determined by
17309 produce_special_glyphs. */
17312 insert_left_trunc_glyphs (struct it
*it
)
17314 struct it truncate_it
;
17315 struct glyph
*from
, *end
, *to
, *toend
;
17317 xassert (!FRAME_WINDOW_P (it
->f
));
17319 /* Get the truncation glyphs. */
17321 truncate_it
.current_x
= 0;
17322 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17323 truncate_it
.glyph_row
= &scratch_glyph_row
;
17324 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17325 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17326 truncate_it
.object
= make_number (0);
17327 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17329 /* Overwrite glyphs from IT with truncation glyphs. */
17330 if (!it
->glyph_row
->reversed_p
)
17332 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17333 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17334 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17335 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17340 /* There may be padding glyphs left over. Overwrite them too. */
17341 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17343 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17349 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17353 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17354 that back to front. */
17355 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17356 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17357 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17358 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17360 while (from
>= end
&& to
>= toend
)
17362 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17365 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17366 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17367 while (from
>= end
&& to
>= toend
)
17372 /* Need to free some room before prepending additional
17374 int move_by
= from
- end
+ 1;
17375 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17376 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17378 for ( ; g
>= g0
; g
--)
17380 while (from
>= end
)
17382 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17388 /* Compute the pixel height and width of IT->glyph_row.
17390 Most of the time, ascent and height of a display line will be equal
17391 to the max_ascent and max_height values of the display iterator
17392 structure. This is not the case if
17394 1. We hit ZV without displaying anything. In this case, max_ascent
17395 and max_height will be zero.
17397 2. We have some glyphs that don't contribute to the line height.
17398 (The glyph row flag contributes_to_line_height_p is for future
17399 pixmap extensions).
17401 The first case is easily covered by using default values because in
17402 these cases, the line height does not really matter, except that it
17403 must not be zero. */
17406 compute_line_metrics (struct it
*it
)
17408 struct glyph_row
*row
= it
->glyph_row
;
17410 if (FRAME_WINDOW_P (it
->f
))
17412 int i
, min_y
, max_y
;
17414 /* The line may consist of one space only, that was added to
17415 place the cursor on it. If so, the row's height hasn't been
17417 if (row
->height
== 0)
17419 if (it
->max_ascent
+ it
->max_descent
== 0)
17420 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17421 row
->ascent
= it
->max_ascent
;
17422 row
->height
= it
->max_ascent
+ it
->max_descent
;
17423 row
->phys_ascent
= it
->max_phys_ascent
;
17424 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17425 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17428 /* Compute the width of this line. */
17429 row
->pixel_width
= row
->x
;
17430 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17431 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17433 xassert (row
->pixel_width
>= 0);
17434 xassert (row
->ascent
>= 0 && row
->height
> 0);
17436 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17437 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17439 /* If first line's physical ascent is larger than its logical
17440 ascent, use the physical ascent, and make the row taller.
17441 This makes accented characters fully visible. */
17442 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17443 && row
->phys_ascent
> row
->ascent
)
17445 row
->height
+= row
->phys_ascent
- row
->ascent
;
17446 row
->ascent
= row
->phys_ascent
;
17449 /* Compute how much of the line is visible. */
17450 row
->visible_height
= row
->height
;
17452 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17453 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17455 if (row
->y
< min_y
)
17456 row
->visible_height
-= min_y
- row
->y
;
17457 if (row
->y
+ row
->height
> max_y
)
17458 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17462 row
->pixel_width
= row
->used
[TEXT_AREA
];
17463 if (row
->continued_p
)
17464 row
->pixel_width
-= it
->continuation_pixel_width
;
17465 else if (row
->truncated_on_right_p
)
17466 row
->pixel_width
-= it
->truncation_pixel_width
;
17467 row
->ascent
= row
->phys_ascent
= 0;
17468 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17469 row
->extra_line_spacing
= 0;
17472 /* Compute a hash code for this row. */
17476 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17477 for (i
= 0; i
< row
->used
[area
]; ++i
)
17478 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17479 + row
->glyphs
[area
][i
].u
.val
17480 + row
->glyphs
[area
][i
].face_id
17481 + row
->glyphs
[area
][i
].padding_p
17482 + (row
->glyphs
[area
][i
].type
<< 2));
17485 it
->max_ascent
= it
->max_descent
= 0;
17486 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17490 /* Append one space to the glyph row of iterator IT if doing a
17491 window-based redisplay. The space has the same face as
17492 IT->face_id. Value is non-zero if a space was added.
17494 This function is called to make sure that there is always one glyph
17495 at the end of a glyph row that the cursor can be set on under
17496 window-systems. (If there weren't such a glyph we would not know
17497 how wide and tall a box cursor should be displayed).
17499 At the same time this space let's a nicely handle clearing to the
17500 end of the line if the row ends in italic text. */
17503 append_space_for_newline (struct it
*it
, int default_face_p
)
17505 if (FRAME_WINDOW_P (it
->f
))
17507 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17509 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17510 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17512 /* Save some values that must not be changed.
17513 Must save IT->c and IT->len because otherwise
17514 ITERATOR_AT_END_P wouldn't work anymore after
17515 append_space_for_newline has been called. */
17516 enum display_element_type saved_what
= it
->what
;
17517 int saved_c
= it
->c
, saved_len
= it
->len
;
17518 int saved_char_to_display
= it
->char_to_display
;
17519 int saved_x
= it
->current_x
;
17520 int saved_face_id
= it
->face_id
;
17521 struct text_pos saved_pos
;
17522 Lisp_Object saved_object
;
17525 saved_object
= it
->object
;
17526 saved_pos
= it
->position
;
17528 it
->what
= IT_CHARACTER
;
17529 memset (&it
->position
, 0, sizeof it
->position
);
17530 it
->object
= make_number (0);
17531 it
->c
= it
->char_to_display
= ' ';
17534 if (default_face_p
)
17535 it
->face_id
= DEFAULT_FACE_ID
;
17536 else if (it
->face_before_selective_p
)
17537 it
->face_id
= it
->saved_face_id
;
17538 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17539 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17541 PRODUCE_GLYPHS (it
);
17543 it
->override_ascent
= -1;
17544 it
->constrain_row_ascent_descent_p
= 0;
17545 it
->current_x
= saved_x
;
17546 it
->object
= saved_object
;
17547 it
->position
= saved_pos
;
17548 it
->what
= saved_what
;
17549 it
->face_id
= saved_face_id
;
17550 it
->len
= saved_len
;
17552 it
->char_to_display
= saved_char_to_display
;
17561 /* Extend the face of the last glyph in the text area of IT->glyph_row
17562 to the end of the display line. Called from display_line. If the
17563 glyph row is empty, add a space glyph to it so that we know the
17564 face to draw. Set the glyph row flag fill_line_p. If the glyph
17565 row is R2L, prepend a stretch glyph to cover the empty space to the
17566 left of the leftmost glyph. */
17569 extend_face_to_end_of_line (struct it
*it
)
17572 struct frame
*f
= it
->f
;
17574 /* If line is already filled, do nothing. Non window-system frames
17575 get a grace of one more ``pixel'' because their characters are
17576 1-``pixel'' wide, so they hit the equality too early. This grace
17577 is needed only for R2L rows that are not continued, to produce
17578 one extra blank where we could display the cursor. */
17579 if (it
->current_x
>= it
->last_visible_x
17580 + (!FRAME_WINDOW_P (f
)
17581 && it
->glyph_row
->reversed_p
17582 && !it
->glyph_row
->continued_p
))
17585 /* Face extension extends the background and box of IT->face_id
17586 to the end of the line. If the background equals the background
17587 of the frame, we don't have to do anything. */
17588 if (it
->face_before_selective_p
)
17589 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17591 face
= FACE_FROM_ID (f
, it
->face_id
);
17593 if (FRAME_WINDOW_P (f
)
17594 && it
->glyph_row
->displays_text_p
17595 && face
->box
== FACE_NO_BOX
17596 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17598 && !it
->glyph_row
->reversed_p
)
17601 /* Set the glyph row flag indicating that the face of the last glyph
17602 in the text area has to be drawn to the end of the text area. */
17603 it
->glyph_row
->fill_line_p
= 1;
17605 /* If current character of IT is not ASCII, make sure we have the
17606 ASCII face. This will be automatically undone the next time
17607 get_next_display_element returns a multibyte character. Note
17608 that the character will always be single byte in unibyte
17610 if (!ASCII_CHAR_P (it
->c
))
17612 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17615 if (FRAME_WINDOW_P (f
))
17617 /* If the row is empty, add a space with the current face of IT,
17618 so that we know which face to draw. */
17619 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17621 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17622 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17623 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17625 #ifdef HAVE_WINDOW_SYSTEM
17626 if (it
->glyph_row
->reversed_p
)
17628 /* Prepend a stretch glyph to the row, such that the
17629 rightmost glyph will be drawn flushed all the way to the
17630 right margin of the window. The stretch glyph that will
17631 occupy the empty space, if any, to the left of the
17633 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17634 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17635 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17637 int row_width
, stretch_ascent
, stretch_width
;
17638 struct text_pos saved_pos
;
17639 int saved_face_id
, saved_avoid_cursor
;
17641 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17642 row_width
+= g
->pixel_width
;
17643 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17644 if (stretch_width
> 0)
17647 (((it
->ascent
+ it
->descent
)
17648 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17649 saved_pos
= it
->position
;
17650 memset (&it
->position
, 0, sizeof it
->position
);
17651 saved_avoid_cursor
= it
->avoid_cursor_p
;
17652 it
->avoid_cursor_p
= 1;
17653 saved_face_id
= it
->face_id
;
17654 /* The last row's stretch glyph should get the default
17655 face, to avoid painting the rest of the window with
17656 the region face, if the region ends at ZV. */
17657 if (it
->glyph_row
->ends_at_zv_p
)
17658 it
->face_id
= DEFAULT_FACE_ID
;
17660 it
->face_id
= face
->id
;
17661 append_stretch_glyph (it
, make_number (0), stretch_width
,
17662 it
->ascent
+ it
->descent
, stretch_ascent
);
17663 it
->position
= saved_pos
;
17664 it
->avoid_cursor_p
= saved_avoid_cursor
;
17665 it
->face_id
= saved_face_id
;
17668 #endif /* HAVE_WINDOW_SYSTEM */
17672 /* Save some values that must not be changed. */
17673 int saved_x
= it
->current_x
;
17674 struct text_pos saved_pos
;
17675 Lisp_Object saved_object
;
17676 enum display_element_type saved_what
= it
->what
;
17677 int saved_face_id
= it
->face_id
;
17679 saved_object
= it
->object
;
17680 saved_pos
= it
->position
;
17682 it
->what
= IT_CHARACTER
;
17683 memset (&it
->position
, 0, sizeof it
->position
);
17684 it
->object
= make_number (0);
17685 it
->c
= it
->char_to_display
= ' ';
17687 /* The last row's blank glyphs should get the default face, to
17688 avoid painting the rest of the window with the region face,
17689 if the region ends at ZV. */
17690 if (it
->glyph_row
->ends_at_zv_p
)
17691 it
->face_id
= DEFAULT_FACE_ID
;
17693 it
->face_id
= face
->id
;
17695 PRODUCE_GLYPHS (it
);
17697 while (it
->current_x
<= it
->last_visible_x
)
17698 PRODUCE_GLYPHS (it
);
17700 /* Don't count these blanks really. It would let us insert a left
17701 truncation glyph below and make us set the cursor on them, maybe. */
17702 it
->current_x
= saved_x
;
17703 it
->object
= saved_object
;
17704 it
->position
= saved_pos
;
17705 it
->what
= saved_what
;
17706 it
->face_id
= saved_face_id
;
17711 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17712 trailing whitespace. */
17715 trailing_whitespace_p (EMACS_INT charpos
)
17717 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17720 while (bytepos
< ZV_BYTE
17721 && (c
= FETCH_CHAR (bytepos
),
17722 c
== ' ' || c
== '\t'))
17725 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17727 if (bytepos
!= PT_BYTE
)
17734 /* Highlight trailing whitespace, if any, in ROW. */
17737 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17739 int used
= row
->used
[TEXT_AREA
];
17743 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17744 struct glyph
*glyph
= start
+ used
- 1;
17746 if (row
->reversed_p
)
17748 /* Right-to-left rows need to be processed in the opposite
17749 direction, so swap the edge pointers. */
17751 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17754 /* Skip over glyphs inserted to display the cursor at the
17755 end of a line, for extending the face of the last glyph
17756 to the end of the line on terminals, and for truncation
17757 and continuation glyphs. */
17758 if (!row
->reversed_p
)
17760 while (glyph
>= start
17761 && glyph
->type
== CHAR_GLYPH
17762 && INTEGERP (glyph
->object
))
17767 while (glyph
<= start
17768 && glyph
->type
== CHAR_GLYPH
17769 && INTEGERP (glyph
->object
))
17773 /* If last glyph is a space or stretch, and it's trailing
17774 whitespace, set the face of all trailing whitespace glyphs in
17775 IT->glyph_row to `trailing-whitespace'. */
17776 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17777 && BUFFERP (glyph
->object
)
17778 && (glyph
->type
== STRETCH_GLYPH
17779 || (glyph
->type
== CHAR_GLYPH
17780 && glyph
->u
.ch
== ' '))
17781 && trailing_whitespace_p (glyph
->charpos
))
17783 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17787 if (!row
->reversed_p
)
17789 while (glyph
>= start
17790 && BUFFERP (glyph
->object
)
17791 && (glyph
->type
== STRETCH_GLYPH
17792 || (glyph
->type
== CHAR_GLYPH
17793 && glyph
->u
.ch
== ' ')))
17794 (glyph
--)->face_id
= face_id
;
17798 while (glyph
<= start
17799 && BUFFERP (glyph
->object
)
17800 && (glyph
->type
== STRETCH_GLYPH
17801 || (glyph
->type
== CHAR_GLYPH
17802 && glyph
->u
.ch
== ' ')))
17803 (glyph
++)->face_id
= face_id
;
17810 /* Value is non-zero if glyph row ROW should be
17811 used to hold the cursor. */
17814 cursor_row_p (struct glyph_row
*row
)
17818 if (PT
== CHARPOS (row
->end
.pos
))
17820 /* Suppose the row ends on a string.
17821 Unless the row is continued, that means it ends on a newline
17822 in the string. If it's anything other than a display string
17823 (e.g. a before-string from an overlay), we don't want the
17824 cursor there. (This heuristic seems to give the optimal
17825 behavior for the various types of multi-line strings.) */
17826 if (CHARPOS (row
->end
.string_pos
) >= 0)
17828 if (row
->continued_p
)
17832 /* Check for `display' property. */
17833 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17834 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17835 struct glyph
*glyph
;
17838 for (glyph
= end
; glyph
>= beg
; --glyph
)
17839 if (STRINGP (glyph
->object
))
17842 = Fget_char_property (make_number (PT
),
17846 && display_prop_string_p (prop
, glyph
->object
));
17851 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17853 /* If the row ends in middle of a real character,
17854 and the line is continued, we want the cursor here.
17855 That's because CHARPOS (ROW->end.pos) would equal
17856 PT if PT is before the character. */
17857 if (!row
->ends_in_ellipsis_p
)
17858 result
= row
->continued_p
;
17860 /* If the row ends in an ellipsis, then
17861 CHARPOS (ROW->end.pos) will equal point after the
17862 invisible text. We want that position to be displayed
17863 after the ellipsis. */
17866 /* If the row ends at ZV, display the cursor at the end of that
17867 row instead of at the start of the row below. */
17868 else if (row
->ends_at_zv_p
)
17879 /* Push the display property PROP so that it will be rendered at the
17880 current position in IT. Return 1 if PROP was successfully pushed,
17884 push_display_prop (struct it
*it
, Lisp_Object prop
)
17886 xassert (it
->method
== GET_FROM_BUFFER
);
17888 push_it (it
, NULL
);
17890 if (STRINGP (prop
))
17892 if (SCHARS (prop
) == 0)
17899 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17900 it
->current
.overlay_string_index
= -1;
17901 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17902 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17903 it
->method
= GET_FROM_STRING
;
17904 it
->stop_charpos
= 0;
17906 it
->base_level_stop
= 0;
17907 it
->string_from_display_prop_p
= 1;
17908 it
->from_disp_prop_p
= 1;
17910 /* Force paragraph direction to be that of the parent
17912 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
17913 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
17915 it
->paragraph_embedding
= L2R
;
17917 /* Set up the bidi iterator for this display string. */
17920 it
->bidi_it
.string
.lstring
= it
->string
;
17921 it
->bidi_it
.string
.s
= NULL
;
17922 it
->bidi_it
.string
.schars
= it
->end_charpos
;
17923 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
17924 it
->bidi_it
.string
.from_disp_str
= 1;
17925 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
17926 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
17929 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17931 it
->method
= GET_FROM_STRETCH
;
17934 #ifdef HAVE_WINDOW_SYSTEM
17935 else if (IMAGEP (prop
))
17937 it
->what
= IT_IMAGE
;
17938 it
->image_id
= lookup_image (it
->f
, prop
);
17939 it
->method
= GET_FROM_IMAGE
;
17941 #endif /* HAVE_WINDOW_SYSTEM */
17944 pop_it (it
); /* bogus display property, give up */
17951 /* Return the character-property PROP at the current position in IT. */
17954 get_it_property (struct it
*it
, Lisp_Object prop
)
17956 Lisp_Object position
;
17958 if (STRINGP (it
->object
))
17959 position
= make_number (IT_STRING_CHARPOS (*it
));
17960 else if (BUFFERP (it
->object
))
17961 position
= make_number (IT_CHARPOS (*it
));
17965 return Fget_char_property (position
, prop
, it
->object
);
17968 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17971 handle_line_prefix (struct it
*it
)
17973 Lisp_Object prefix
;
17975 if (it
->continuation_lines_width
> 0)
17977 prefix
= get_it_property (it
, Qwrap_prefix
);
17979 prefix
= Vwrap_prefix
;
17983 prefix
= get_it_property (it
, Qline_prefix
);
17985 prefix
= Vline_prefix
;
17987 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17989 /* If the prefix is wider than the window, and we try to wrap
17990 it, it would acquire its own wrap prefix, and so on till the
17991 iterator stack overflows. So, don't wrap the prefix. */
17992 it
->line_wrap
= TRUNCATE
;
17993 it
->avoid_cursor_p
= 1;
17999 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18000 only for R2L lines from display_line and display_string, when they
18001 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18002 the line/string needs to be continued on the next glyph row. */
18004 unproduce_glyphs (struct it
*it
, int n
)
18006 struct glyph
*glyph
, *end
;
18008 xassert (it
->glyph_row
);
18009 xassert (it
->glyph_row
->reversed_p
);
18010 xassert (it
->area
== TEXT_AREA
);
18011 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18013 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18014 n
= it
->glyph_row
->used
[TEXT_AREA
];
18015 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18016 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18017 for ( ; glyph
< end
; glyph
++)
18018 glyph
[-n
] = *glyph
;
18021 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18022 and ROW->maxpos. */
18024 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18025 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18026 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18028 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18029 lines' rows is implemented for bidi-reordered rows. */
18031 /* ROW->minpos is the value of min_pos, the minimal buffer position
18032 we have in ROW, or ROW->start.pos if that is smaller. */
18033 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18034 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18036 /* We didn't find buffer positions smaller than ROW->start, or
18037 didn't find _any_ valid buffer positions in any of the glyphs,
18038 so we must trust the iterator's computed positions. */
18039 row
->minpos
= row
->start
.pos
;
18042 max_pos
= CHARPOS (it
->current
.pos
);
18043 max_bpos
= BYTEPOS (it
->current
.pos
);
18046 /* Here are the various use-cases for ending the row, and the
18047 corresponding values for ROW->maxpos:
18049 Line ends in a newline from buffer eol_pos + 1
18050 Line is continued from buffer max_pos + 1
18051 Line is truncated on right it->current.pos
18052 Line ends in a newline from string max_pos
18053 Line is continued from string max_pos
18054 Line is continued from display vector max_pos
18055 Line is entirely from a string min_pos == max_pos
18056 Line is entirely from a display vector min_pos == max_pos
18057 Line that ends at ZV ZV
18059 If you discover other use-cases, please add them here as
18061 if (row
->ends_at_zv_p
)
18062 row
->maxpos
= it
->current
.pos
;
18063 else if (row
->used
[TEXT_AREA
])
18065 if (row
->ends_in_newline_from_string_p
)
18066 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18067 else if (CHARPOS (it
->eol_pos
) > 0)
18068 SET_TEXT_POS (row
->maxpos
,
18069 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18070 else if (row
->continued_p
)
18072 /* If max_pos is different from IT's current position, it
18073 means IT->method does not belong to the display element
18074 at max_pos. However, it also means that the display
18075 element at max_pos was displayed in its entirety on this
18076 line, which is equivalent to saying that the next line
18077 starts at the next buffer position. */
18078 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18079 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18082 INC_BOTH (max_pos
, max_bpos
);
18083 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18086 else if (row
->truncated_on_right_p
)
18087 /* display_line already called reseat_at_next_visible_line_start,
18088 which puts the iterator at the beginning of the next line, in
18089 the logical order. */
18090 row
->maxpos
= it
->current
.pos
;
18091 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18092 /* A line that is entirely from a string/image/stretch... */
18093 row
->maxpos
= row
->minpos
;
18098 row
->maxpos
= it
->current
.pos
;
18101 /* Construct the glyph row IT->glyph_row in the desired matrix of
18102 IT->w from text at the current position of IT. See dispextern.h
18103 for an overview of struct it. Value is non-zero if
18104 IT->glyph_row displays text, as opposed to a line displaying ZV
18108 display_line (struct it
*it
)
18110 struct glyph_row
*row
= it
->glyph_row
;
18111 Lisp_Object overlay_arrow_string
;
18113 void *wrap_data
= NULL
;
18114 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18115 int wrap_row_used
= -1;
18116 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18117 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18118 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18119 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18120 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18122 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18123 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18125 /* We always start displaying at hpos zero even if hscrolled. */
18126 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18128 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18129 >= it
->w
->desired_matrix
->nrows
)
18131 it
->w
->nrows_scale_factor
++;
18132 fonts_changed_p
= 1;
18136 /* Is IT->w showing the region? */
18137 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18139 /* Clear the result glyph row and enable it. */
18140 prepare_desired_row (row
);
18142 row
->y
= it
->current_y
;
18143 row
->start
= it
->start
;
18144 row
->continuation_lines_width
= it
->continuation_lines_width
;
18145 row
->displays_text_p
= 1;
18146 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18147 it
->starts_in_middle_of_char_p
= 0;
18149 /* Arrange the overlays nicely for our purposes. Usually, we call
18150 display_line on only one line at a time, in which case this
18151 can't really hurt too much, or we call it on lines which appear
18152 one after another in the buffer, in which case all calls to
18153 recenter_overlay_lists but the first will be pretty cheap. */
18154 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18156 /* Move over display elements that are not visible because we are
18157 hscrolled. This may stop at an x-position < IT->first_visible_x
18158 if the first glyph is partially visible or if we hit a line end. */
18159 if (it
->current_x
< it
->first_visible_x
)
18161 this_line_min_pos
= row
->start
.pos
;
18162 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18163 MOVE_TO_POS
| MOVE_TO_X
);
18164 /* Record the smallest positions seen while we moved over
18165 display elements that are not visible. This is needed by
18166 redisplay_internal for optimizing the case where the cursor
18167 stays inside the same line. The rest of this function only
18168 considers positions that are actually displayed, so
18169 RECORD_MAX_MIN_POS will not otherwise record positions that
18170 are hscrolled to the left of the left edge of the window. */
18171 min_pos
= CHARPOS (this_line_min_pos
);
18172 min_bpos
= BYTEPOS (this_line_min_pos
);
18176 /* We only do this when not calling `move_it_in_display_line_to'
18177 above, because move_it_in_display_line_to calls
18178 handle_line_prefix itself. */
18179 handle_line_prefix (it
);
18182 /* Get the initial row height. This is either the height of the
18183 text hscrolled, if there is any, or zero. */
18184 row
->ascent
= it
->max_ascent
;
18185 row
->height
= it
->max_ascent
+ it
->max_descent
;
18186 row
->phys_ascent
= it
->max_phys_ascent
;
18187 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18188 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18190 /* Utility macro to record max and min buffer positions seen until now. */
18191 #define RECORD_MAX_MIN_POS(IT) \
18194 if (IT_CHARPOS (*(IT)) < min_pos) \
18196 min_pos = IT_CHARPOS (*(IT)); \
18197 min_bpos = IT_BYTEPOS (*(IT)); \
18199 if (IT_CHARPOS (*(IT)) > max_pos) \
18201 max_pos = IT_CHARPOS (*(IT)); \
18202 max_bpos = IT_BYTEPOS (*(IT)); \
18207 /* Loop generating characters. The loop is left with IT on the next
18208 character to display. */
18211 int n_glyphs_before
, hpos_before
, x_before
;
18213 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18215 /* Retrieve the next thing to display. Value is zero if end of
18217 if (!get_next_display_element (it
))
18219 /* Maybe add a space at the end of this line that is used to
18220 display the cursor there under X. Set the charpos of the
18221 first glyph of blank lines not corresponding to any text
18223 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18224 row
->exact_window_width_line_p
= 1;
18225 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18226 || row
->used
[TEXT_AREA
] == 0)
18228 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18229 row
->displays_text_p
= 0;
18231 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18232 && (!MINI_WINDOW_P (it
->w
)
18233 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18234 row
->indicate_empty_line_p
= 1;
18237 it
->continuation_lines_width
= 0;
18238 row
->ends_at_zv_p
= 1;
18239 /* A row that displays right-to-left text must always have
18240 its last face extended all the way to the end of line,
18241 even if this row ends in ZV, because we still write to
18242 the screen left to right. */
18243 if (row
->reversed_p
)
18244 extend_face_to_end_of_line (it
);
18248 /* Now, get the metrics of what we want to display. This also
18249 generates glyphs in `row' (which is IT->glyph_row). */
18250 n_glyphs_before
= row
->used
[TEXT_AREA
];
18253 /* Remember the line height so far in case the next element doesn't
18254 fit on the line. */
18255 if (it
->line_wrap
!= TRUNCATE
)
18257 ascent
= it
->max_ascent
;
18258 descent
= it
->max_descent
;
18259 phys_ascent
= it
->max_phys_ascent
;
18260 phys_descent
= it
->max_phys_descent
;
18262 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18264 if (IT_DISPLAYING_WHITESPACE (it
))
18268 SAVE_IT (wrap_it
, *it
, wrap_data
);
18270 wrap_row_used
= row
->used
[TEXT_AREA
];
18271 wrap_row_ascent
= row
->ascent
;
18272 wrap_row_height
= row
->height
;
18273 wrap_row_phys_ascent
= row
->phys_ascent
;
18274 wrap_row_phys_height
= row
->phys_height
;
18275 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18276 wrap_row_min_pos
= min_pos
;
18277 wrap_row_min_bpos
= min_bpos
;
18278 wrap_row_max_pos
= max_pos
;
18279 wrap_row_max_bpos
= max_bpos
;
18285 PRODUCE_GLYPHS (it
);
18287 /* If this display element was in marginal areas, continue with
18289 if (it
->area
!= TEXT_AREA
)
18291 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18292 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18293 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18294 row
->phys_height
= max (row
->phys_height
,
18295 it
->max_phys_ascent
+ it
->max_phys_descent
);
18296 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18297 it
->max_extra_line_spacing
);
18298 set_iterator_to_next (it
, 1);
18302 /* Does the display element fit on the line? If we truncate
18303 lines, we should draw past the right edge of the window. If
18304 we don't truncate, we want to stop so that we can display the
18305 continuation glyph before the right margin. If lines are
18306 continued, there are two possible strategies for characters
18307 resulting in more than 1 glyph (e.g. tabs): Display as many
18308 glyphs as possible in this line and leave the rest for the
18309 continuation line, or display the whole element in the next
18310 line. Original redisplay did the former, so we do it also. */
18311 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18312 hpos_before
= it
->hpos
;
18315 if (/* Not a newline. */
18317 /* Glyphs produced fit entirely in the line. */
18318 && it
->current_x
< it
->last_visible_x
)
18320 it
->hpos
+= nglyphs
;
18321 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18322 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18323 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18324 row
->phys_height
= max (row
->phys_height
,
18325 it
->max_phys_ascent
+ it
->max_phys_descent
);
18326 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18327 it
->max_extra_line_spacing
);
18328 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18329 row
->x
= x
- it
->first_visible_x
;
18330 /* Record the maximum and minimum buffer positions seen so
18331 far in glyphs that will be displayed by this row. */
18333 RECORD_MAX_MIN_POS (it
);
18338 struct glyph
*glyph
;
18340 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18342 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18343 new_x
= x
+ glyph
->pixel_width
;
18345 if (/* Lines are continued. */
18346 it
->line_wrap
!= TRUNCATE
18347 && (/* Glyph doesn't fit on the line. */
18348 new_x
> it
->last_visible_x
18349 /* Or it fits exactly on a window system frame. */
18350 || (new_x
== it
->last_visible_x
18351 && FRAME_WINDOW_P (it
->f
))))
18353 /* End of a continued line. */
18356 || (new_x
== it
->last_visible_x
18357 && FRAME_WINDOW_P (it
->f
)))
18359 /* Current glyph is the only one on the line or
18360 fits exactly on the line. We must continue
18361 the line because we can't draw the cursor
18362 after the glyph. */
18363 row
->continued_p
= 1;
18364 it
->current_x
= new_x
;
18365 it
->continuation_lines_width
+= new_x
;
18367 /* Record the maximum and minimum buffer
18368 positions seen so far in glyphs that will be
18369 displayed by this row. */
18371 RECORD_MAX_MIN_POS (it
);
18372 if (i
== nglyphs
- 1)
18374 /* If line-wrap is on, check if a previous
18375 wrap point was found. */
18376 if (wrap_row_used
> 0
18377 /* Even if there is a previous wrap
18378 point, continue the line here as
18379 usual, if (i) the previous character
18380 was a space or tab AND (ii) the
18381 current character is not. */
18383 || IT_DISPLAYING_WHITESPACE (it
)))
18386 set_iterator_to_next (it
, 1);
18387 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18389 if (!get_next_display_element (it
))
18391 row
->exact_window_width_line_p
= 1;
18392 it
->continuation_lines_width
= 0;
18393 row
->continued_p
= 0;
18394 row
->ends_at_zv_p
= 1;
18396 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18398 row
->continued_p
= 0;
18399 row
->exact_window_width_line_p
= 1;
18404 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18405 && !FRAME_WINDOW_P (it
->f
))
18407 /* A padding glyph that doesn't fit on this line.
18408 This means the whole character doesn't fit
18410 if (row
->reversed_p
)
18411 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18412 - n_glyphs_before
);
18413 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18415 /* Fill the rest of the row with continuation
18416 glyphs like in 20.x. */
18417 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18418 < row
->glyphs
[1 + TEXT_AREA
])
18419 produce_special_glyphs (it
, IT_CONTINUATION
);
18421 row
->continued_p
= 1;
18422 it
->current_x
= x_before
;
18423 it
->continuation_lines_width
+= x_before
;
18425 /* Restore the height to what it was before the
18426 element not fitting on the line. */
18427 it
->max_ascent
= ascent
;
18428 it
->max_descent
= descent
;
18429 it
->max_phys_ascent
= phys_ascent
;
18430 it
->max_phys_descent
= phys_descent
;
18432 else if (wrap_row_used
> 0)
18435 if (row
->reversed_p
)
18436 unproduce_glyphs (it
,
18437 row
->used
[TEXT_AREA
] - wrap_row_used
);
18438 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18439 it
->continuation_lines_width
+= wrap_x
;
18440 row
->used
[TEXT_AREA
] = wrap_row_used
;
18441 row
->ascent
= wrap_row_ascent
;
18442 row
->height
= wrap_row_height
;
18443 row
->phys_ascent
= wrap_row_phys_ascent
;
18444 row
->phys_height
= wrap_row_phys_height
;
18445 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18446 min_pos
= wrap_row_min_pos
;
18447 min_bpos
= wrap_row_min_bpos
;
18448 max_pos
= wrap_row_max_pos
;
18449 max_bpos
= wrap_row_max_bpos
;
18450 row
->continued_p
= 1;
18451 row
->ends_at_zv_p
= 0;
18452 row
->exact_window_width_line_p
= 0;
18453 it
->continuation_lines_width
+= x
;
18455 /* Make sure that a non-default face is extended
18456 up to the right margin of the window. */
18457 extend_face_to_end_of_line (it
);
18459 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18461 /* A TAB that extends past the right edge of the
18462 window. This produces a single glyph on
18463 window system frames. We leave the glyph in
18464 this row and let it fill the row, but don't
18465 consume the TAB. */
18466 it
->continuation_lines_width
+= it
->last_visible_x
;
18467 row
->ends_in_middle_of_char_p
= 1;
18468 row
->continued_p
= 1;
18469 glyph
->pixel_width
= it
->last_visible_x
- x
;
18470 it
->starts_in_middle_of_char_p
= 1;
18474 /* Something other than a TAB that draws past
18475 the right edge of the window. Restore
18476 positions to values before the element. */
18477 if (row
->reversed_p
)
18478 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18479 - (n_glyphs_before
+ i
));
18480 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18482 /* Display continuation glyphs. */
18483 if (!FRAME_WINDOW_P (it
->f
))
18484 produce_special_glyphs (it
, IT_CONTINUATION
);
18485 row
->continued_p
= 1;
18487 it
->current_x
= x_before
;
18488 it
->continuation_lines_width
+= x
;
18489 extend_face_to_end_of_line (it
);
18491 if (nglyphs
> 1 && i
> 0)
18493 row
->ends_in_middle_of_char_p
= 1;
18494 it
->starts_in_middle_of_char_p
= 1;
18497 /* Restore the height to what it was before the
18498 element not fitting on the line. */
18499 it
->max_ascent
= ascent
;
18500 it
->max_descent
= descent
;
18501 it
->max_phys_ascent
= phys_ascent
;
18502 it
->max_phys_descent
= phys_descent
;
18507 else if (new_x
> it
->first_visible_x
)
18509 /* Increment number of glyphs actually displayed. */
18512 /* Record the maximum and minimum buffer positions
18513 seen so far in glyphs that will be displayed by
18516 RECORD_MAX_MIN_POS (it
);
18518 if (x
< it
->first_visible_x
)
18519 /* Glyph is partially visible, i.e. row starts at
18520 negative X position. */
18521 row
->x
= x
- it
->first_visible_x
;
18525 /* Glyph is completely off the left margin of the
18526 window. This should not happen because of the
18527 move_it_in_display_line at the start of this
18528 function, unless the text display area of the
18529 window is empty. */
18530 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18534 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18535 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18536 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18537 row
->phys_height
= max (row
->phys_height
,
18538 it
->max_phys_ascent
+ it
->max_phys_descent
);
18539 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18540 it
->max_extra_line_spacing
);
18542 /* End of this display line if row is continued. */
18543 if (row
->continued_p
|| row
->ends_at_zv_p
)
18548 /* Is this a line end? If yes, we're also done, after making
18549 sure that a non-default face is extended up to the right
18550 margin of the window. */
18551 if (ITERATOR_AT_END_OF_LINE_P (it
))
18553 int used_before
= row
->used
[TEXT_AREA
];
18555 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18557 /* Add a space at the end of the line that is used to
18558 display the cursor there. */
18559 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18560 append_space_for_newline (it
, 0);
18562 /* Extend the face to the end of the line. */
18563 extend_face_to_end_of_line (it
);
18565 /* Make sure we have the position. */
18566 if (used_before
== 0)
18567 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18569 /* Record the position of the newline, for use in
18571 it
->eol_pos
= it
->current
.pos
;
18573 /* Consume the line end. This skips over invisible lines. */
18574 set_iterator_to_next (it
, 1);
18575 it
->continuation_lines_width
= 0;
18579 /* Proceed with next display element. Note that this skips
18580 over lines invisible because of selective display. */
18581 set_iterator_to_next (it
, 1);
18583 /* If we truncate lines, we are done when the last displayed
18584 glyphs reach past the right margin of the window. */
18585 if (it
->line_wrap
== TRUNCATE
18586 && (FRAME_WINDOW_P (it
->f
)
18587 ? (it
->current_x
>= it
->last_visible_x
)
18588 : (it
->current_x
> it
->last_visible_x
)))
18590 /* Maybe add truncation glyphs. */
18591 if (!FRAME_WINDOW_P (it
->f
))
18595 if (!row
->reversed_p
)
18597 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18598 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18603 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18604 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18606 /* Remove any padding glyphs at the front of ROW, to
18607 make room for the truncation glyphs we will be
18608 adding below. The loop below always inserts at
18609 least one truncation glyph, so also remove the
18610 last glyph added to ROW. */
18611 unproduce_glyphs (it
, i
+ 1);
18612 /* Adjust i for the loop below. */
18613 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18616 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18618 row
->used
[TEXT_AREA
] = i
;
18619 produce_special_glyphs (it
, IT_TRUNCATION
);
18622 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18624 /* Don't truncate if we can overflow newline into fringe. */
18625 if (!get_next_display_element (it
))
18627 it
->continuation_lines_width
= 0;
18628 row
->ends_at_zv_p
= 1;
18629 row
->exact_window_width_line_p
= 1;
18632 if (ITERATOR_AT_END_OF_LINE_P (it
))
18634 row
->exact_window_width_line_p
= 1;
18635 goto at_end_of_line
;
18639 row
->truncated_on_right_p
= 1;
18640 it
->continuation_lines_width
= 0;
18641 reseat_at_next_visible_line_start (it
, 0);
18642 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18643 it
->hpos
= hpos_before
;
18644 it
->current_x
= x_before
;
18649 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18650 at the left window margin. */
18651 if (it
->first_visible_x
18652 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18654 if (!FRAME_WINDOW_P (it
->f
))
18655 insert_left_trunc_glyphs (it
);
18656 row
->truncated_on_left_p
= 1;
18659 /* Remember the position at which this line ends.
18661 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18662 cannot be before the call to find_row_edges below, since that is
18663 where these positions are determined. */
18664 row
->end
= it
->current
;
18667 row
->minpos
= row
->start
.pos
;
18668 row
->maxpos
= row
->end
.pos
;
18672 /* ROW->minpos and ROW->maxpos must be the smallest and
18673 `1 + the largest' buffer positions in ROW. But if ROW was
18674 bidi-reordered, these two positions can be anywhere in the
18675 row, so we must determine them now. */
18676 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18679 /* If the start of this line is the overlay arrow-position, then
18680 mark this glyph row as the one containing the overlay arrow.
18681 This is clearly a mess with variable size fonts. It would be
18682 better to let it be displayed like cursors under X. */
18683 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18684 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18685 !NILP (overlay_arrow_string
)))
18687 /* Overlay arrow in window redisplay is a fringe bitmap. */
18688 if (STRINGP (overlay_arrow_string
))
18690 struct glyph_row
*arrow_row
18691 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18692 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18693 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18694 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18695 struct glyph
*p2
, *end
;
18697 /* Copy the arrow glyphs. */
18698 while (glyph
< arrow_end
)
18701 /* Throw away padding glyphs. */
18703 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18704 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18710 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18715 xassert (INTEGERP (overlay_arrow_string
));
18716 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18718 overlay_arrow_seen
= 1;
18721 /* Compute pixel dimensions of this line. */
18722 compute_line_metrics (it
);
18724 /* Record whether this row ends inside an ellipsis. */
18725 row
->ends_in_ellipsis_p
18726 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18727 && it
->ellipsis_p
);
18729 /* Save fringe bitmaps in this row. */
18730 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18731 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18732 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18733 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18735 it
->left_user_fringe_bitmap
= 0;
18736 it
->left_user_fringe_face_id
= 0;
18737 it
->right_user_fringe_bitmap
= 0;
18738 it
->right_user_fringe_face_id
= 0;
18740 /* Maybe set the cursor. */
18741 cvpos
= it
->w
->cursor
.vpos
;
18743 /* In bidi-reordered rows, keep checking for proper cursor
18744 position even if one has been found already, because buffer
18745 positions in such rows change non-linearly with ROW->VPOS,
18746 when a line is continued. One exception: when we are at ZV,
18747 display cursor on the first suitable glyph row, since all
18748 the empty rows after that also have their position set to ZV. */
18749 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18750 lines' rows is implemented for bidi-reordered rows. */
18752 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18753 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18754 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18755 && cursor_row_p (row
))
18756 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18758 /* Highlight trailing whitespace. */
18759 if (!NILP (Vshow_trailing_whitespace
))
18760 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18762 /* Prepare for the next line. This line starts horizontally at (X
18763 HPOS) = (0 0). Vertical positions are incremented. As a
18764 convenience for the caller, IT->glyph_row is set to the next
18766 it
->current_x
= it
->hpos
= 0;
18767 it
->current_y
+= row
->height
;
18768 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18771 /* The next row should by default use the same value of the
18772 reversed_p flag as this one. set_iterator_to_next decides when
18773 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18774 the flag accordingly. */
18775 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18776 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18777 it
->start
= row
->end
;
18778 return row
->displays_text_p
;
18780 #undef RECORD_MAX_MIN_POS
18783 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18784 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18785 doc
: /* Return paragraph direction at point in BUFFER.
18786 Value is either `left-to-right' or `right-to-left'.
18787 If BUFFER is omitted or nil, it defaults to the current buffer.
18789 Paragraph direction determines how the text in the paragraph is displayed.
18790 In left-to-right paragraphs, text begins at the left margin of the window
18791 and the reading direction is generally left to right. In right-to-left
18792 paragraphs, text begins at the right margin and is read from right to left.
18794 See also `bidi-paragraph-direction'. */)
18795 (Lisp_Object buffer
)
18797 struct buffer
*buf
= current_buffer
;
18798 struct buffer
*old
= buf
;
18800 if (! NILP (buffer
))
18802 CHECK_BUFFER (buffer
);
18803 buf
= XBUFFER (buffer
);
18806 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18807 return Qleft_to_right
;
18808 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18809 return BVAR (buf
, bidi_paragraph_direction
);
18812 /* Determine the direction from buffer text. We could try to
18813 use current_matrix if it is up to date, but this seems fast
18814 enough as it is. */
18815 struct bidi_it itb
;
18816 EMACS_INT pos
= BUF_PT (buf
);
18817 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18820 set_buffer_temp (buf
);
18821 /* bidi_paragraph_init finds the base direction of the paragraph
18822 by searching forward from paragraph start. We need the base
18823 direction of the current or _previous_ paragraph, so we need
18824 to make sure we are within that paragraph. To that end, find
18825 the previous non-empty line. */
18826 if (pos
>= ZV
&& pos
> BEGV
)
18829 bytepos
= CHAR_TO_BYTE (pos
);
18831 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18832 || c
== ' ' || c
== '\t' || c
== '\f')
18834 if (bytepos
<= BEGV_BYTE
)
18839 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18842 itb
.bytepos
= bytepos
;
18844 itb
.string
.s
= NULL
;
18845 itb
.string
.lstring
= Qnil
;
18846 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18848 itb
.separator_limit
= -1;
18849 itb
.paragraph_dir
= NEUTRAL_DIR
;
18851 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18852 set_buffer_temp (old
);
18853 switch (itb
.paragraph_dir
)
18856 return Qleft_to_right
;
18859 return Qright_to_left
;
18869 /***********************************************************************
18871 ***********************************************************************/
18873 /* Redisplay the menu bar in the frame for window W.
18875 The menu bar of X frames that don't have X toolkit support is
18876 displayed in a special window W->frame->menu_bar_window.
18878 The menu bar of terminal frames is treated specially as far as
18879 glyph matrices are concerned. Menu bar lines are not part of
18880 windows, so the update is done directly on the frame matrix rows
18881 for the menu bar. */
18884 display_menu_bar (struct window
*w
)
18886 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18891 /* Don't do all this for graphical frames. */
18893 if (FRAME_W32_P (f
))
18896 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18902 if (FRAME_NS_P (f
))
18904 #endif /* HAVE_NS */
18906 #ifdef USE_X_TOOLKIT
18907 xassert (!FRAME_WINDOW_P (f
));
18908 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18909 it
.first_visible_x
= 0;
18910 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18911 #else /* not USE_X_TOOLKIT */
18912 if (FRAME_WINDOW_P (f
))
18914 /* Menu bar lines are displayed in the desired matrix of the
18915 dummy window menu_bar_window. */
18916 struct window
*menu_w
;
18917 xassert (WINDOWP (f
->menu_bar_window
));
18918 menu_w
= XWINDOW (f
->menu_bar_window
);
18919 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18921 it
.first_visible_x
= 0;
18922 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18926 /* This is a TTY frame, i.e. character hpos/vpos are used as
18928 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18930 it
.first_visible_x
= 0;
18931 it
.last_visible_x
= FRAME_COLS (f
);
18933 #endif /* not USE_X_TOOLKIT */
18935 /* FIXME: This should be controlled by a user option. See the
18936 comments in redisplay_tool_bar and display_mode_line about
18938 it
.paragraph_embedding
= L2R
;
18940 if (! mode_line_inverse_video
)
18941 /* Force the menu-bar to be displayed in the default face. */
18942 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18944 /* Clear all rows of the menu bar. */
18945 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18947 struct glyph_row
*row
= it
.glyph_row
+ i
;
18948 clear_glyph_row (row
);
18949 row
->enabled_p
= 1;
18950 row
->full_width_p
= 1;
18953 /* Display all items of the menu bar. */
18954 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18955 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18957 Lisp_Object string
;
18959 /* Stop at nil string. */
18960 string
= AREF (items
, i
+ 1);
18964 /* Remember where item was displayed. */
18965 ASET (items
, i
+ 3, make_number (it
.hpos
));
18967 /* Display the item, pad with one space. */
18968 if (it
.current_x
< it
.last_visible_x
)
18969 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18970 SCHARS (string
) + 1, 0, 0, -1);
18973 /* Fill out the line with spaces. */
18974 if (it
.current_x
< it
.last_visible_x
)
18975 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18977 /* Compute the total height of the lines. */
18978 compute_line_metrics (&it
);
18983 /***********************************************************************
18985 ***********************************************************************/
18987 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18988 FORCE is non-zero, redisplay mode lines unconditionally.
18989 Otherwise, redisplay only mode lines that are garbaged. Value is
18990 the number of windows whose mode lines were redisplayed. */
18993 redisplay_mode_lines (Lisp_Object window
, int force
)
18997 while (!NILP (window
))
18999 struct window
*w
= XWINDOW (window
);
19001 if (WINDOWP (w
->hchild
))
19002 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19003 else if (WINDOWP (w
->vchild
))
19004 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19006 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19007 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19009 struct text_pos lpoint
;
19010 struct buffer
*old
= current_buffer
;
19012 /* Set the window's buffer for the mode line display. */
19013 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19014 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19016 /* Point refers normally to the selected window. For any
19017 other window, set up appropriate value. */
19018 if (!EQ (window
, selected_window
))
19020 struct text_pos pt
;
19022 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19023 if (CHARPOS (pt
) < BEGV
)
19024 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19025 else if (CHARPOS (pt
) > (ZV
- 1))
19026 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19028 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19031 /* Display mode lines. */
19032 clear_glyph_matrix (w
->desired_matrix
);
19033 if (display_mode_lines (w
))
19036 w
->must_be_updated_p
= 1;
19039 /* Restore old settings. */
19040 set_buffer_internal_1 (old
);
19041 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19051 /* Display the mode and/or header line of window W. Value is the
19052 sum number of mode lines and header lines displayed. */
19055 display_mode_lines (struct window
*w
)
19057 Lisp_Object old_selected_window
, old_selected_frame
;
19060 old_selected_frame
= selected_frame
;
19061 selected_frame
= w
->frame
;
19062 old_selected_window
= selected_window
;
19063 XSETWINDOW (selected_window
, w
);
19065 /* These will be set while the mode line specs are processed. */
19066 line_number_displayed
= 0;
19067 w
->column_number_displayed
= Qnil
;
19069 if (WINDOW_WANTS_MODELINE_P (w
))
19071 struct window
*sel_w
= XWINDOW (old_selected_window
);
19073 /* Select mode line face based on the real selected window. */
19074 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19075 BVAR (current_buffer
, mode_line_format
));
19079 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19081 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19082 BVAR (current_buffer
, header_line_format
));
19086 selected_frame
= old_selected_frame
;
19087 selected_window
= old_selected_window
;
19092 /* Display mode or header line of window W. FACE_ID specifies which
19093 line to display; it is either MODE_LINE_FACE_ID or
19094 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19095 display. Value is the pixel height of the mode/header line
19099 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19103 int count
= SPECPDL_INDEX ();
19105 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19106 /* Don't extend on a previously drawn mode-line.
19107 This may happen if called from pos_visible_p. */
19108 it
.glyph_row
->enabled_p
= 0;
19109 prepare_desired_row (it
.glyph_row
);
19111 it
.glyph_row
->mode_line_p
= 1;
19113 if (! mode_line_inverse_video
)
19114 /* Force the mode-line to be displayed in the default face. */
19115 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19117 /* FIXME: This should be controlled by a user option. But
19118 supporting such an option is not trivial, since the mode line is
19119 made up of many separate strings. */
19120 it
.paragraph_embedding
= L2R
;
19122 record_unwind_protect (unwind_format_mode_line
,
19123 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19125 mode_line_target
= MODE_LINE_DISPLAY
;
19127 /* Temporarily make frame's keyboard the current kboard so that
19128 kboard-local variables in the mode_line_format will get the right
19130 push_kboard (FRAME_KBOARD (it
.f
));
19131 record_unwind_save_match_data ();
19132 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19135 unbind_to (count
, Qnil
);
19137 /* Fill up with spaces. */
19138 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19140 compute_line_metrics (&it
);
19141 it
.glyph_row
->full_width_p
= 1;
19142 it
.glyph_row
->continued_p
= 0;
19143 it
.glyph_row
->truncated_on_left_p
= 0;
19144 it
.glyph_row
->truncated_on_right_p
= 0;
19146 /* Make a 3D mode-line have a shadow at its right end. */
19147 face
= FACE_FROM_ID (it
.f
, face_id
);
19148 extend_face_to_end_of_line (&it
);
19149 if (face
->box
!= FACE_NO_BOX
)
19151 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19152 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19153 last
->right_box_line_p
= 1;
19156 return it
.glyph_row
->height
;
19159 /* Move element ELT in LIST to the front of LIST.
19160 Return the updated list. */
19163 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19165 register Lisp_Object tail
, prev
;
19166 register Lisp_Object tem
;
19170 while (CONSP (tail
))
19176 /* Splice out the link TAIL. */
19178 list
= XCDR (tail
);
19180 Fsetcdr (prev
, XCDR (tail
));
19182 /* Now make it the first. */
19183 Fsetcdr (tail
, list
);
19188 tail
= XCDR (tail
);
19192 /* Not found--return unchanged LIST. */
19196 /* Contribute ELT to the mode line for window IT->w. How it
19197 translates into text depends on its data type.
19199 IT describes the display environment in which we display, as usual.
19201 DEPTH is the depth in recursion. It is used to prevent
19202 infinite recursion here.
19204 FIELD_WIDTH is the number of characters the display of ELT should
19205 occupy in the mode line, and PRECISION is the maximum number of
19206 characters to display from ELT's representation. See
19207 display_string for details.
19209 Returns the hpos of the end of the text generated by ELT.
19211 PROPS is a property list to add to any string we encounter.
19213 If RISKY is nonzero, remove (disregard) any properties in any string
19214 we encounter, and ignore :eval and :propertize.
19216 The global variable `mode_line_target' determines whether the
19217 output is passed to `store_mode_line_noprop',
19218 `store_mode_line_string', or `display_string'. */
19221 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19222 Lisp_Object elt
, Lisp_Object props
, int risky
)
19224 int n
= 0, field
, prec
;
19229 elt
= build_string ("*too-deep*");
19233 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19237 /* A string: output it and check for %-constructs within it. */
19239 EMACS_INT offset
= 0;
19241 if (SCHARS (elt
) > 0
19242 && (!NILP (props
) || risky
))
19244 Lisp_Object oprops
, aelt
;
19245 oprops
= Ftext_properties_at (make_number (0), elt
);
19247 /* If the starting string's properties are not what
19248 we want, translate the string. Also, if the string
19249 is risky, do that anyway. */
19251 if (NILP (Fequal (props
, oprops
)) || risky
)
19253 /* If the starting string has properties,
19254 merge the specified ones onto the existing ones. */
19255 if (! NILP (oprops
) && !risky
)
19259 oprops
= Fcopy_sequence (oprops
);
19261 while (CONSP (tem
))
19263 oprops
= Fplist_put (oprops
, XCAR (tem
),
19264 XCAR (XCDR (tem
)));
19265 tem
= XCDR (XCDR (tem
));
19270 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19271 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19273 /* AELT is what we want. Move it to the front
19274 without consing. */
19276 mode_line_proptrans_alist
19277 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19283 /* If AELT has the wrong props, it is useless.
19284 so get rid of it. */
19286 mode_line_proptrans_alist
19287 = Fdelq (aelt
, mode_line_proptrans_alist
);
19289 elt
= Fcopy_sequence (elt
);
19290 Fset_text_properties (make_number (0), Flength (elt
),
19292 /* Add this item to mode_line_proptrans_alist. */
19293 mode_line_proptrans_alist
19294 = Fcons (Fcons (elt
, props
),
19295 mode_line_proptrans_alist
);
19296 /* Truncate mode_line_proptrans_alist
19297 to at most 50 elements. */
19298 tem
= Fnthcdr (make_number (50),
19299 mode_line_proptrans_alist
);
19301 XSETCDR (tem
, Qnil
);
19310 prec
= precision
- n
;
19311 switch (mode_line_target
)
19313 case MODE_LINE_NOPROP
:
19314 case MODE_LINE_TITLE
:
19315 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19317 case MODE_LINE_STRING
:
19318 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19320 case MODE_LINE_DISPLAY
:
19321 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19322 0, prec
, 0, STRING_MULTIBYTE (elt
));
19329 /* Handle the non-literal case. */
19331 while ((precision
<= 0 || n
< precision
)
19332 && SREF (elt
, offset
) != 0
19333 && (mode_line_target
!= MODE_LINE_DISPLAY
19334 || it
->current_x
< it
->last_visible_x
))
19336 EMACS_INT last_offset
= offset
;
19338 /* Advance to end of string or next format specifier. */
19339 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19342 if (offset
- 1 != last_offset
)
19344 EMACS_INT nchars
, nbytes
;
19346 /* Output to end of string or up to '%'. Field width
19347 is length of string. Don't output more than
19348 PRECISION allows us. */
19351 prec
= c_string_width (SDATA (elt
) + last_offset
,
19352 offset
- last_offset
, precision
- n
,
19355 switch (mode_line_target
)
19357 case MODE_LINE_NOPROP
:
19358 case MODE_LINE_TITLE
:
19359 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19361 case MODE_LINE_STRING
:
19363 EMACS_INT bytepos
= last_offset
;
19364 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19365 EMACS_INT endpos
= (precision
<= 0
19366 ? string_byte_to_char (elt
, offset
)
19367 : charpos
+ nchars
);
19369 n
+= store_mode_line_string (NULL
,
19370 Fsubstring (elt
, make_number (charpos
),
19371 make_number (endpos
)),
19375 case MODE_LINE_DISPLAY
:
19377 EMACS_INT bytepos
= last_offset
;
19378 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19380 if (precision
<= 0)
19381 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19382 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19384 STRING_MULTIBYTE (elt
));
19389 else /* c == '%' */
19391 EMACS_INT percent_position
= offset
;
19393 /* Get the specified minimum width. Zero means
19396 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19397 field
= field
* 10 + c
- '0';
19399 /* Don't pad beyond the total padding allowed. */
19400 if (field_width
- n
> 0 && field
> field_width
- n
)
19401 field
= field_width
- n
;
19403 /* Note that either PRECISION <= 0 or N < PRECISION. */
19404 prec
= precision
- n
;
19407 n
+= display_mode_element (it
, depth
, field
, prec
,
19408 Vglobal_mode_string
, props
,
19413 EMACS_INT bytepos
, charpos
;
19415 Lisp_Object string
;
19417 bytepos
= percent_position
;
19418 charpos
= (STRING_MULTIBYTE (elt
)
19419 ? string_byte_to_char (elt
, bytepos
)
19421 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19422 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19424 switch (mode_line_target
)
19426 case MODE_LINE_NOPROP
:
19427 case MODE_LINE_TITLE
:
19428 n
+= store_mode_line_noprop (spec
, field
, prec
);
19430 case MODE_LINE_STRING
:
19432 Lisp_Object tem
= build_string (spec
);
19433 props
= Ftext_properties_at (make_number (charpos
), elt
);
19434 /* Should only keep face property in props */
19435 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19438 case MODE_LINE_DISPLAY
:
19440 int nglyphs_before
, nwritten
;
19442 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19443 nwritten
= display_string (spec
, string
, elt
,
19448 /* Assign to the glyphs written above the
19449 string where the `%x' came from, position
19453 struct glyph
*glyph
19454 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19458 for (i
= 0; i
< nwritten
; ++i
)
19460 glyph
[i
].object
= elt
;
19461 glyph
[i
].charpos
= charpos
;
19478 /* A symbol: process the value of the symbol recursively
19479 as if it appeared here directly. Avoid error if symbol void.
19480 Special case: if value of symbol is a string, output the string
19483 register Lisp_Object tem
;
19485 /* If the variable is not marked as risky to set
19486 then its contents are risky to use. */
19487 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19490 tem
= Fboundp (elt
);
19493 tem
= Fsymbol_value (elt
);
19494 /* If value is a string, output that string literally:
19495 don't check for % within it. */
19499 if (!EQ (tem
, elt
))
19501 /* Give up right away for nil or t. */
19511 register Lisp_Object car
, tem
;
19513 /* A cons cell: five distinct cases.
19514 If first element is :eval or :propertize, do something special.
19515 If first element is a string or a cons, process all the elements
19516 and effectively concatenate them.
19517 If first element is a negative number, truncate displaying cdr to
19518 at most that many characters. If positive, pad (with spaces)
19519 to at least that many characters.
19520 If first element is a symbol, process the cadr or caddr recursively
19521 according to whether the symbol's value is non-nil or nil. */
19523 if (EQ (car
, QCeval
))
19525 /* An element of the form (:eval FORM) means evaluate FORM
19526 and use the result as mode line elements. */
19531 if (CONSP (XCDR (elt
)))
19534 spec
= safe_eval (XCAR (XCDR (elt
)));
19535 n
+= display_mode_element (it
, depth
, field_width
- n
,
19536 precision
- n
, spec
, props
,
19540 else if (EQ (car
, QCpropertize
))
19542 /* An element of the form (:propertize ELT PROPS...)
19543 means display ELT but applying properties PROPS. */
19548 if (CONSP (XCDR (elt
)))
19549 n
+= display_mode_element (it
, depth
, field_width
- n
,
19550 precision
- n
, XCAR (XCDR (elt
)),
19551 XCDR (XCDR (elt
)), risky
);
19553 else if (SYMBOLP (car
))
19555 tem
= Fboundp (car
);
19559 /* elt is now the cdr, and we know it is a cons cell.
19560 Use its car if CAR has a non-nil value. */
19563 tem
= Fsymbol_value (car
);
19570 /* Symbol's value is nil (or symbol is unbound)
19571 Get the cddr of the original list
19572 and if possible find the caddr and use that. */
19576 else if (!CONSP (elt
))
19581 else if (INTEGERP (car
))
19583 register int lim
= XINT (car
);
19587 /* Negative int means reduce maximum width. */
19588 if (precision
<= 0)
19591 precision
= min (precision
, -lim
);
19595 /* Padding specified. Don't let it be more than
19596 current maximum. */
19598 lim
= min (precision
, lim
);
19600 /* If that's more padding than already wanted, queue it.
19601 But don't reduce padding already specified even if
19602 that is beyond the current truncation point. */
19603 field_width
= max (lim
, field_width
);
19607 else if (STRINGP (car
) || CONSP (car
))
19609 Lisp_Object halftail
= elt
;
19613 && (precision
<= 0 || n
< precision
))
19615 n
+= display_mode_element (it
, depth
,
19616 /* Do padding only after the last
19617 element in the list. */
19618 (! CONSP (XCDR (elt
))
19621 precision
- n
, XCAR (elt
),
19625 if ((len
& 1) == 0)
19626 halftail
= XCDR (halftail
);
19627 /* Check for cycle. */
19628 if (EQ (halftail
, elt
))
19637 elt
= build_string ("*invalid*");
19641 /* Pad to FIELD_WIDTH. */
19642 if (field_width
> 0 && n
< field_width
)
19644 switch (mode_line_target
)
19646 case MODE_LINE_NOPROP
:
19647 case MODE_LINE_TITLE
:
19648 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19650 case MODE_LINE_STRING
:
19651 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19653 case MODE_LINE_DISPLAY
:
19654 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19663 /* Store a mode-line string element in mode_line_string_list.
19665 If STRING is non-null, display that C string. Otherwise, the Lisp
19666 string LISP_STRING is displayed.
19668 FIELD_WIDTH is the minimum number of output glyphs to produce.
19669 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19670 with spaces. FIELD_WIDTH <= 0 means don't pad.
19672 PRECISION is the maximum number of characters to output from
19673 STRING. PRECISION <= 0 means don't truncate the string.
19675 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19676 properties to the string.
19678 PROPS are the properties to add to the string.
19679 The mode_line_string_face face property is always added to the string.
19683 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19684 int field_width
, int precision
, Lisp_Object props
)
19689 if (string
!= NULL
)
19691 len
= strlen (string
);
19692 if (precision
> 0 && len
> precision
)
19694 lisp_string
= make_string (string
, len
);
19696 props
= mode_line_string_face_prop
;
19697 else if (!NILP (mode_line_string_face
))
19699 Lisp_Object face
= Fplist_get (props
, Qface
);
19700 props
= Fcopy_sequence (props
);
19702 face
= mode_line_string_face
;
19704 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19705 props
= Fplist_put (props
, Qface
, face
);
19707 Fadd_text_properties (make_number (0), make_number (len
),
19708 props
, lisp_string
);
19712 len
= XFASTINT (Flength (lisp_string
));
19713 if (precision
> 0 && len
> precision
)
19716 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19719 if (!NILP (mode_line_string_face
))
19723 props
= Ftext_properties_at (make_number (0), lisp_string
);
19724 face
= Fplist_get (props
, Qface
);
19726 face
= mode_line_string_face
;
19728 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19729 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19731 lisp_string
= Fcopy_sequence (lisp_string
);
19734 Fadd_text_properties (make_number (0), make_number (len
),
19735 props
, lisp_string
);
19740 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19744 if (field_width
> len
)
19746 field_width
-= len
;
19747 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19749 Fadd_text_properties (make_number (0), make_number (field_width
),
19750 props
, lisp_string
);
19751 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19759 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19761 doc
: /* Format a string out of a mode line format specification.
19762 First arg FORMAT specifies the mode line format (see `mode-line-format'
19763 for details) to use.
19765 By default, the format is evaluated for the currently selected window.
19767 Optional second arg FACE specifies the face property to put on all
19768 characters for which no face is specified. The value nil means the
19769 default face. The value t means whatever face the window's mode line
19770 currently uses (either `mode-line' or `mode-line-inactive',
19771 depending on whether the window is the selected window or not).
19772 An integer value means the value string has no text
19775 Optional third and fourth args WINDOW and BUFFER specify the window
19776 and buffer to use as the context for the formatting (defaults
19777 are the selected window and the WINDOW's buffer). */)
19778 (Lisp_Object format
, Lisp_Object face
,
19779 Lisp_Object window
, Lisp_Object buffer
)
19784 struct buffer
*old_buffer
= NULL
;
19786 int no_props
= INTEGERP (face
);
19787 int count
= SPECPDL_INDEX ();
19789 int string_start
= 0;
19792 window
= selected_window
;
19793 CHECK_WINDOW (window
);
19794 w
= XWINDOW (window
);
19797 buffer
= w
->buffer
;
19798 CHECK_BUFFER (buffer
);
19800 /* Make formatting the modeline a non-op when noninteractive, otherwise
19801 there will be problems later caused by a partially initialized frame. */
19802 if (NILP (format
) || noninteractive
)
19803 return empty_unibyte_string
;
19808 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19809 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19810 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19811 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19812 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19813 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19814 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19817 if (XBUFFER (buffer
) != current_buffer
)
19818 old_buffer
= current_buffer
;
19820 /* Save things including mode_line_proptrans_alist,
19821 and set that to nil so that we don't alter the outer value. */
19822 record_unwind_protect (unwind_format_mode_line
,
19823 format_mode_line_unwind_data
19824 (old_buffer
, selected_window
, 1));
19825 mode_line_proptrans_alist
= Qnil
;
19827 Fselect_window (window
, Qt
);
19829 set_buffer_internal_1 (XBUFFER (buffer
));
19831 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19835 mode_line_target
= MODE_LINE_NOPROP
;
19836 mode_line_string_face_prop
= Qnil
;
19837 mode_line_string_list
= Qnil
;
19838 string_start
= MODE_LINE_NOPROP_LEN (0);
19842 mode_line_target
= MODE_LINE_STRING
;
19843 mode_line_string_list
= Qnil
;
19844 mode_line_string_face
= face
;
19845 mode_line_string_face_prop
19846 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19849 push_kboard (FRAME_KBOARD (it
.f
));
19850 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19855 len
= MODE_LINE_NOPROP_LEN (string_start
);
19856 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19860 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19861 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19862 empty_unibyte_string
);
19865 unbind_to (count
, Qnil
);
19869 /* Write a null-terminated, right justified decimal representation of
19870 the positive integer D to BUF using a minimal field width WIDTH. */
19873 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19875 register char *p
= buf
;
19883 *p
++ = d
% 10 + '0';
19888 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19899 /* Write a null-terminated, right justified decimal and "human
19900 readable" representation of the nonnegative integer D to BUF using
19901 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19903 static const char power_letter
[] =
19917 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19919 /* We aim to represent the nonnegative integer D as
19920 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19921 EMACS_INT quotient
= d
;
19923 /* -1 means: do not use TENTHS. */
19927 /* Length of QUOTIENT.TENTHS as a string. */
19933 if (1000 <= quotient
)
19935 /* Scale to the appropriate EXPONENT. */
19938 remainder
= quotient
% 1000;
19942 while (1000 <= quotient
);
19944 /* Round to nearest and decide whether to use TENTHS or not. */
19947 tenths
= remainder
/ 100;
19948 if (50 <= remainder
% 100)
19955 if (quotient
== 10)
19963 if (500 <= remainder
)
19965 if (quotient
< 999)
19976 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19977 if (tenths
== -1 && quotient
<= 99)
19984 p
= psuffix
= buf
+ max (width
, length
);
19986 /* Print EXPONENT. */
19987 *psuffix
++ = power_letter
[exponent
];
19990 /* Print TENTHS. */
19993 *--p
= '0' + tenths
;
19997 /* Print QUOTIENT. */
20000 int digit
= quotient
% 10;
20001 *--p
= '0' + digit
;
20003 while ((quotient
/= 10) != 0);
20005 /* Print leading spaces. */
20010 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20011 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20012 type of CODING_SYSTEM. Return updated pointer into BUF. */
20014 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20017 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20020 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20021 const unsigned char *eol_str
;
20023 /* The EOL conversion we are using. */
20024 Lisp_Object eoltype
;
20026 val
= CODING_SYSTEM_SPEC (coding_system
);
20029 if (!VECTORP (val
)) /* Not yet decided. */
20034 eoltype
= eol_mnemonic_undecided
;
20035 /* Don't mention EOL conversion if it isn't decided. */
20040 Lisp_Object eolvalue
;
20042 attrs
= AREF (val
, 0);
20043 eolvalue
= AREF (val
, 2);
20046 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20050 /* The EOL conversion that is normal on this system. */
20052 if (NILP (eolvalue
)) /* Not yet decided. */
20053 eoltype
= eol_mnemonic_undecided
;
20054 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20055 eoltype
= eol_mnemonic_undecided
;
20056 else /* eolvalue is Qunix, Qdos, or Qmac. */
20057 eoltype
= (EQ (eolvalue
, Qunix
)
20058 ? eol_mnemonic_unix
20059 : (EQ (eolvalue
, Qdos
) == 1
20060 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20066 /* Mention the EOL conversion if it is not the usual one. */
20067 if (STRINGP (eoltype
))
20069 eol_str
= SDATA (eoltype
);
20070 eol_str_len
= SBYTES (eoltype
);
20072 else if (CHARACTERP (eoltype
))
20074 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20075 int c
= XFASTINT (eoltype
);
20076 eol_str_len
= CHAR_STRING (c
, tmp
);
20081 eol_str
= invalid_eol_type
;
20082 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20084 memcpy (buf
, eol_str
, eol_str_len
);
20085 buf
+= eol_str_len
;
20091 /* Return a string for the output of a mode line %-spec for window W,
20092 generated by character C. FIELD_WIDTH > 0 means pad the string
20093 returned with spaces to that value. Return a Lisp string in
20094 *STRING if the resulting string is taken from that Lisp string.
20096 Note we operate on the current buffer for most purposes,
20097 the exception being w->base_line_pos. */
20099 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20101 static const char *
20102 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20103 Lisp_Object
*string
)
20106 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20107 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20108 struct buffer
*b
= current_buffer
;
20116 if (!NILP (BVAR (b
, read_only
)))
20118 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20123 /* This differs from %* only for a modified read-only buffer. */
20124 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20126 if (!NILP (BVAR (b
, read_only
)))
20131 /* This differs from %* in ignoring read-only-ness. */
20132 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20144 if (command_loop_level
> 5)
20146 p
= decode_mode_spec_buf
;
20147 for (i
= 0; i
< command_loop_level
; i
++)
20150 return decode_mode_spec_buf
;
20158 if (command_loop_level
> 5)
20160 p
= decode_mode_spec_buf
;
20161 for (i
= 0; i
< command_loop_level
; i
++)
20164 return decode_mode_spec_buf
;
20171 /* Let lots_of_dashes be a string of infinite length. */
20172 if (mode_line_target
== MODE_LINE_NOPROP
||
20173 mode_line_target
== MODE_LINE_STRING
)
20175 if (field_width
<= 0
20176 || field_width
> sizeof (lots_of_dashes
))
20178 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20179 decode_mode_spec_buf
[i
] = '-';
20180 decode_mode_spec_buf
[i
] = '\0';
20181 return decode_mode_spec_buf
;
20184 return lots_of_dashes
;
20188 obj
= BVAR (b
, name
);
20192 /* %c and %l are ignored in `frame-title-format'.
20193 (In redisplay_internal, the frame title is drawn _before_ the
20194 windows are updated, so the stuff which depends on actual
20195 window contents (such as %l) may fail to render properly, or
20196 even crash emacs.) */
20197 if (mode_line_target
== MODE_LINE_TITLE
)
20201 EMACS_INT col
= current_column ();
20202 w
->column_number_displayed
= make_number (col
);
20203 pint2str (decode_mode_spec_buf
, field_width
, col
);
20204 return decode_mode_spec_buf
;
20208 #ifndef SYSTEM_MALLOC
20210 if (NILP (Vmemory_full
))
20213 return "!MEM FULL! ";
20220 /* %F displays the frame name. */
20221 if (!NILP (f
->title
))
20222 return SSDATA (f
->title
);
20223 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20224 return SSDATA (f
->name
);
20228 obj
= BVAR (b
, filename
);
20233 EMACS_INT size
= ZV
- BEGV
;
20234 pint2str (decode_mode_spec_buf
, field_width
, size
);
20235 return decode_mode_spec_buf
;
20240 EMACS_INT size
= ZV
- BEGV
;
20241 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20242 return decode_mode_spec_buf
;
20247 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20248 EMACS_INT topline
, nlines
, height
;
20251 /* %c and %l are ignored in `frame-title-format'. */
20252 if (mode_line_target
== MODE_LINE_TITLE
)
20255 startpos
= XMARKER (w
->start
)->charpos
;
20256 startpos_byte
= marker_byte_position (w
->start
);
20257 height
= WINDOW_TOTAL_LINES (w
);
20259 /* If we decided that this buffer isn't suitable for line numbers,
20260 don't forget that too fast. */
20261 if (EQ (w
->base_line_pos
, w
->buffer
))
20263 /* But do forget it, if the window shows a different buffer now. */
20264 else if (BUFFERP (w
->base_line_pos
))
20265 w
->base_line_pos
= Qnil
;
20267 /* If the buffer is very big, don't waste time. */
20268 if (INTEGERP (Vline_number_display_limit
)
20269 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20271 w
->base_line_pos
= Qnil
;
20272 w
->base_line_number
= Qnil
;
20276 if (INTEGERP (w
->base_line_number
)
20277 && INTEGERP (w
->base_line_pos
)
20278 && XFASTINT (w
->base_line_pos
) <= startpos
)
20280 line
= XFASTINT (w
->base_line_number
);
20281 linepos
= XFASTINT (w
->base_line_pos
);
20282 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20287 linepos
= BUF_BEGV (b
);
20288 linepos_byte
= BUF_BEGV_BYTE (b
);
20291 /* Count lines from base line to window start position. */
20292 nlines
= display_count_lines (linepos_byte
,
20296 topline
= nlines
+ line
;
20298 /* Determine a new base line, if the old one is too close
20299 or too far away, or if we did not have one.
20300 "Too close" means it's plausible a scroll-down would
20301 go back past it. */
20302 if (startpos
== BUF_BEGV (b
))
20304 w
->base_line_number
= make_number (topline
);
20305 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20307 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20308 || linepos
== BUF_BEGV (b
))
20310 EMACS_INT limit
= BUF_BEGV (b
);
20311 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20312 EMACS_INT position
;
20313 EMACS_INT distance
=
20314 (height
* 2 + 30) * line_number_display_limit_width
;
20316 if (startpos
- distance
> limit
)
20318 limit
= startpos
- distance
;
20319 limit_byte
= CHAR_TO_BYTE (limit
);
20322 nlines
= display_count_lines (startpos_byte
,
20324 - (height
* 2 + 30),
20326 /* If we couldn't find the lines we wanted within
20327 line_number_display_limit_width chars per line,
20328 give up on line numbers for this window. */
20329 if (position
== limit_byte
&& limit
== startpos
- distance
)
20331 w
->base_line_pos
= w
->buffer
;
20332 w
->base_line_number
= Qnil
;
20336 w
->base_line_number
= make_number (topline
- nlines
);
20337 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20340 /* Now count lines from the start pos to point. */
20341 nlines
= display_count_lines (startpos_byte
,
20342 PT_BYTE
, PT
, &junk
);
20344 /* Record that we did display the line number. */
20345 line_number_displayed
= 1;
20347 /* Make the string to show. */
20348 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20349 return decode_mode_spec_buf
;
20352 char* p
= decode_mode_spec_buf
;
20353 int pad
= field_width
- 2;
20359 return decode_mode_spec_buf
;
20365 obj
= BVAR (b
, mode_name
);
20369 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20375 EMACS_INT pos
= marker_position (w
->start
);
20376 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20378 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20380 if (pos
<= BUF_BEGV (b
))
20385 else if (pos
<= BUF_BEGV (b
))
20389 if (total
> 1000000)
20390 /* Do it differently for a large value, to avoid overflow. */
20391 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20393 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20394 /* We can't normally display a 3-digit number,
20395 so get us a 2-digit number that is close. */
20398 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20399 return decode_mode_spec_buf
;
20403 /* Display percentage of size above the bottom of the screen. */
20406 EMACS_INT toppos
= marker_position (w
->start
);
20407 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20408 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20410 if (botpos
>= BUF_ZV (b
))
20412 if (toppos
<= BUF_BEGV (b
))
20419 if (total
> 1000000)
20420 /* Do it differently for a large value, to avoid overflow. */
20421 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20423 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20424 /* We can't normally display a 3-digit number,
20425 so get us a 2-digit number that is close. */
20428 if (toppos
<= BUF_BEGV (b
))
20429 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20431 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20432 return decode_mode_spec_buf
;
20437 /* status of process */
20438 obj
= Fget_buffer_process (Fcurrent_buffer ());
20440 return "no process";
20442 obj
= Fsymbol_name (Fprocess_status (obj
));
20448 int count
= inhibit_garbage_collection ();
20449 Lisp_Object val
= call1 (intern ("file-remote-p"),
20450 BVAR (current_buffer
, directory
));
20451 unbind_to (count
, Qnil
);
20459 case 't': /* indicate TEXT or BINARY */
20463 /* coding-system (not including end-of-line format) */
20465 /* coding-system (including end-of-line type) */
20467 int eol_flag
= (c
== 'Z');
20468 char *p
= decode_mode_spec_buf
;
20470 if (! FRAME_WINDOW_P (f
))
20472 /* No need to mention EOL here--the terminal never needs
20473 to do EOL conversion. */
20474 p
= decode_mode_spec_coding (CODING_ID_NAME
20475 (FRAME_KEYBOARD_CODING (f
)->id
),
20477 p
= decode_mode_spec_coding (CODING_ID_NAME
20478 (FRAME_TERMINAL_CODING (f
)->id
),
20481 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20484 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20485 #ifdef subprocesses
20486 obj
= Fget_buffer_process (Fcurrent_buffer ());
20487 if (PROCESSP (obj
))
20489 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20491 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20494 #endif /* subprocesses */
20497 return decode_mode_spec_buf
;
20504 return SSDATA (obj
);
20511 /* Count up to COUNT lines starting from START_BYTE.
20512 But don't go beyond LIMIT_BYTE.
20513 Return the number of lines thus found (always nonnegative).
20515 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20518 display_count_lines (EMACS_INT start_byte
,
20519 EMACS_INT limit_byte
, EMACS_INT count
,
20520 EMACS_INT
*byte_pos_ptr
)
20522 register unsigned char *cursor
;
20523 unsigned char *base
;
20525 register EMACS_INT ceiling
;
20526 register unsigned char *ceiling_addr
;
20527 EMACS_INT orig_count
= count
;
20529 /* If we are not in selective display mode,
20530 check only for newlines. */
20531 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20532 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20536 while (start_byte
< limit_byte
)
20538 ceiling
= BUFFER_CEILING_OF (start_byte
);
20539 ceiling
= min (limit_byte
- 1, ceiling
);
20540 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20541 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20544 if (selective_display
)
20545 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20548 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20551 if (cursor
!= ceiling_addr
)
20555 start_byte
+= cursor
- base
+ 1;
20556 *byte_pos_ptr
= start_byte
;
20560 if (++cursor
== ceiling_addr
)
20566 start_byte
+= cursor
- base
;
20571 while (start_byte
> limit_byte
)
20573 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20574 ceiling
= max (limit_byte
, ceiling
);
20575 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20576 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20579 if (selective_display
)
20580 while (--cursor
!= ceiling_addr
20581 && *cursor
!= '\n' && *cursor
!= 015)
20584 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20587 if (cursor
!= ceiling_addr
)
20591 start_byte
+= cursor
- base
+ 1;
20592 *byte_pos_ptr
= start_byte
;
20593 /* When scanning backwards, we should
20594 not count the newline posterior to which we stop. */
20595 return - orig_count
- 1;
20601 /* Here we add 1 to compensate for the last decrement
20602 of CURSOR, which took it past the valid range. */
20603 start_byte
+= cursor
- base
+ 1;
20607 *byte_pos_ptr
= limit_byte
;
20610 return - orig_count
+ count
;
20611 return orig_count
- count
;
20617 /***********************************************************************
20619 ***********************************************************************/
20621 /* Display a NUL-terminated string, starting with index START.
20623 If STRING is non-null, display that C string. Otherwise, the Lisp
20624 string LISP_STRING is displayed. There's a case that STRING is
20625 non-null and LISP_STRING is not nil. It means STRING is a string
20626 data of LISP_STRING. In that case, we display LISP_STRING while
20627 ignoring its text properties.
20629 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20630 FACE_STRING. Display STRING or LISP_STRING with the face at
20631 FACE_STRING_POS in FACE_STRING:
20633 Display the string in the environment given by IT, but use the
20634 standard display table, temporarily.
20636 FIELD_WIDTH is the minimum number of output glyphs to produce.
20637 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20638 with spaces. If STRING has more characters, more than FIELD_WIDTH
20639 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20641 PRECISION is the maximum number of characters to output from
20642 STRING. PRECISION < 0 means don't truncate the string.
20644 This is roughly equivalent to printf format specifiers:
20646 FIELD_WIDTH PRECISION PRINTF
20647 ----------------------------------------
20653 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20654 display them, and < 0 means obey the current buffer's value of
20655 enable_multibyte_characters.
20657 Value is the number of columns displayed. */
20660 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20661 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20662 int field_width
, int precision
, int max_x
, int multibyte
)
20664 int hpos_at_start
= it
->hpos
;
20665 int saved_face_id
= it
->face_id
;
20666 struct glyph_row
*row
= it
->glyph_row
;
20667 EMACS_INT it_charpos
;
20669 /* Initialize the iterator IT for iteration over STRING beginning
20670 with index START. */
20671 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20672 precision
, field_width
, multibyte
);
20673 if (string
&& STRINGP (lisp_string
))
20674 /* LISP_STRING is the one returned by decode_mode_spec. We should
20675 ignore its text properties. */
20676 it
->stop_charpos
= it
->end_charpos
;
20678 /* If displaying STRING, set up the face of the iterator from
20679 FACE_STRING, if that's given. */
20680 if (STRINGP (face_string
))
20686 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20687 0, it
->region_beg_charpos
,
20688 it
->region_end_charpos
,
20689 &endptr
, it
->base_face_id
, 0);
20690 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20691 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20694 /* Set max_x to the maximum allowed X position. Don't let it go
20695 beyond the right edge of the window. */
20697 max_x
= it
->last_visible_x
;
20699 max_x
= min (max_x
, it
->last_visible_x
);
20701 /* Skip over display elements that are not visible. because IT->w is
20703 if (it
->current_x
< it
->first_visible_x
)
20704 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20705 MOVE_TO_POS
| MOVE_TO_X
);
20707 row
->ascent
= it
->max_ascent
;
20708 row
->height
= it
->max_ascent
+ it
->max_descent
;
20709 row
->phys_ascent
= it
->max_phys_ascent
;
20710 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20711 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20713 if (STRINGP (it
->string
))
20714 it_charpos
= IT_STRING_CHARPOS (*it
);
20716 it_charpos
= IT_CHARPOS (*it
);
20718 /* This condition is for the case that we are called with current_x
20719 past last_visible_x. */
20720 while (it
->current_x
< max_x
)
20722 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20724 /* Get the next display element. */
20725 if (!get_next_display_element (it
))
20728 /* Produce glyphs. */
20729 x_before
= it
->current_x
;
20730 n_glyphs_before
= row
->used
[TEXT_AREA
];
20731 PRODUCE_GLYPHS (it
);
20733 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20736 while (i
< nglyphs
)
20738 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20740 if (it
->line_wrap
!= TRUNCATE
20741 && x
+ glyph
->pixel_width
> max_x
)
20743 /* End of continued line or max_x reached. */
20744 if (CHAR_GLYPH_PADDING_P (*glyph
))
20746 /* A wide character is unbreakable. */
20747 if (row
->reversed_p
)
20748 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20749 - n_glyphs_before
);
20750 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20751 it
->current_x
= x_before
;
20755 if (row
->reversed_p
)
20756 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20757 - (n_glyphs_before
+ i
));
20758 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20763 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20765 /* Glyph is at least partially visible. */
20767 if (x
< it
->first_visible_x
)
20768 row
->x
= x
- it
->first_visible_x
;
20772 /* Glyph is off the left margin of the display area.
20773 Should not happen. */
20777 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20778 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20779 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20780 row
->phys_height
= max (row
->phys_height
,
20781 it
->max_phys_ascent
+ it
->max_phys_descent
);
20782 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20783 it
->max_extra_line_spacing
);
20784 x
+= glyph
->pixel_width
;
20788 /* Stop if max_x reached. */
20792 /* Stop at line ends. */
20793 if (ITERATOR_AT_END_OF_LINE_P (it
))
20795 it
->continuation_lines_width
= 0;
20799 set_iterator_to_next (it
, 1);
20800 if (STRINGP (it
->string
))
20801 it_charpos
= IT_STRING_CHARPOS (*it
);
20803 it_charpos
= IT_CHARPOS (*it
);
20805 /* Stop if truncating at the right edge. */
20806 if (it
->line_wrap
== TRUNCATE
20807 && it
->current_x
>= it
->last_visible_x
)
20809 /* Add truncation mark, but don't do it if the line is
20810 truncated at a padding space. */
20811 if (it_charpos
< it
->string_nchars
)
20813 if (!FRAME_WINDOW_P (it
->f
))
20817 if (it
->current_x
> it
->last_visible_x
)
20819 if (!row
->reversed_p
)
20821 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20822 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20827 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20828 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20830 unproduce_glyphs (it
, ii
+ 1);
20831 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20833 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20835 row
->used
[TEXT_AREA
] = ii
;
20836 produce_special_glyphs (it
, IT_TRUNCATION
);
20839 produce_special_glyphs (it
, IT_TRUNCATION
);
20841 row
->truncated_on_right_p
= 1;
20847 /* Maybe insert a truncation at the left. */
20848 if (it
->first_visible_x
20851 if (!FRAME_WINDOW_P (it
->f
))
20852 insert_left_trunc_glyphs (it
);
20853 row
->truncated_on_left_p
= 1;
20856 it
->face_id
= saved_face_id
;
20858 /* Value is number of columns displayed. */
20859 return it
->hpos
- hpos_at_start
;
20864 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20865 appears as an element of LIST or as the car of an element of LIST.
20866 If PROPVAL is a list, compare each element against LIST in that
20867 way, and return 1/2 if any element of PROPVAL is found in LIST.
20868 Otherwise return 0. This function cannot quit.
20869 The return value is 2 if the text is invisible but with an ellipsis
20870 and 1 if it's invisible and without an ellipsis. */
20873 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20875 register Lisp_Object tail
, proptail
;
20877 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20879 register Lisp_Object tem
;
20881 if (EQ (propval
, tem
))
20883 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20884 return NILP (XCDR (tem
)) ? 1 : 2;
20887 if (CONSP (propval
))
20889 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20891 Lisp_Object propelt
;
20892 propelt
= XCAR (proptail
);
20893 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20895 register Lisp_Object tem
;
20897 if (EQ (propelt
, tem
))
20899 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20900 return NILP (XCDR (tem
)) ? 1 : 2;
20908 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20909 doc
: /* Non-nil if the property makes the text invisible.
20910 POS-OR-PROP can be a marker or number, in which case it is taken to be
20911 a position in the current buffer and the value of the `invisible' property
20912 is checked; or it can be some other value, which is then presumed to be the
20913 value of the `invisible' property of the text of interest.
20914 The non-nil value returned can be t for truly invisible text or something
20915 else if the text is replaced by an ellipsis. */)
20916 (Lisp_Object pos_or_prop
)
20919 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20920 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20922 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20923 return (invis
== 0 ? Qnil
20925 : make_number (invis
));
20928 /* Calculate a width or height in pixels from a specification using
20929 the following elements:
20932 NUM - a (fractional) multiple of the default font width/height
20933 (NUM) - specifies exactly NUM pixels
20934 UNIT - a fixed number of pixels, see below.
20935 ELEMENT - size of a display element in pixels, see below.
20936 (NUM . SPEC) - equals NUM * SPEC
20937 (+ SPEC SPEC ...) - add pixel values
20938 (- SPEC SPEC ...) - subtract pixel values
20939 (- SPEC) - negate pixel value
20942 INT or FLOAT - a number constant
20943 SYMBOL - use symbol's (buffer local) variable binding.
20946 in - pixels per inch *)
20947 mm - pixels per 1/1000 meter *)
20948 cm - pixels per 1/100 meter *)
20949 width - width of current font in pixels.
20950 height - height of current font in pixels.
20952 *) using the ratio(s) defined in display-pixels-per-inch.
20956 left-fringe - left fringe width in pixels
20957 right-fringe - right fringe width in pixels
20959 left-margin - left margin width in pixels
20960 right-margin - right margin width in pixels
20962 scroll-bar - scroll-bar area width in pixels
20966 Pixels corresponding to 5 inches:
20969 Total width of non-text areas on left side of window (if scroll-bar is on left):
20970 '(space :width (+ left-fringe left-margin scroll-bar))
20972 Align to first text column (in header line):
20973 '(space :align-to 0)
20975 Align to middle of text area minus half the width of variable `my-image'
20976 containing a loaded image:
20977 '(space :align-to (0.5 . (- text my-image)))
20979 Width of left margin minus width of 1 character in the default font:
20980 '(space :width (- left-margin 1))
20982 Width of left margin minus width of 2 characters in the current font:
20983 '(space :width (- left-margin (2 . width)))
20985 Center 1 character over left-margin (in header line):
20986 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20988 Different ways to express width of left fringe plus left margin minus one pixel:
20989 '(space :width (- (+ left-fringe left-margin) (1)))
20990 '(space :width (+ left-fringe left-margin (- (1))))
20991 '(space :width (+ left-fringe left-margin (-1)))
20995 #define NUMVAL(X) \
20996 ((INTEGERP (X) || FLOATP (X)) \
21001 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21002 struct font
*font
, int width_p
, int *align_to
)
21006 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21007 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21010 return OK_PIXELS (0);
21012 xassert (FRAME_LIVE_P (it
->f
));
21014 if (SYMBOLP (prop
))
21016 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21018 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21020 if (unit
[0] == 'i' && unit
[1] == 'n')
21022 else if (unit
[0] == 'm' && unit
[1] == 'm')
21024 else if (unit
[0] == 'c' && unit
[1] == 'm')
21031 #ifdef HAVE_WINDOW_SYSTEM
21032 if (FRAME_WINDOW_P (it
->f
)
21034 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21035 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21037 return OK_PIXELS (ppi
/ pixels
);
21040 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21041 || (CONSP (Vdisplay_pixels_per_inch
)
21043 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21044 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21046 return OK_PIXELS (ppi
/ pixels
);
21052 #ifdef HAVE_WINDOW_SYSTEM
21053 if (EQ (prop
, Qheight
))
21054 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21055 if (EQ (prop
, Qwidth
))
21056 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21058 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21059 return OK_PIXELS (1);
21062 if (EQ (prop
, Qtext
))
21063 return OK_PIXELS (width_p
21064 ? window_box_width (it
->w
, TEXT_AREA
)
21065 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21067 if (align_to
&& *align_to
< 0)
21070 if (EQ (prop
, Qleft
))
21071 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21072 if (EQ (prop
, Qright
))
21073 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21074 if (EQ (prop
, Qcenter
))
21075 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21076 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21077 if (EQ (prop
, Qleft_fringe
))
21078 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21079 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21080 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21081 if (EQ (prop
, Qright_fringe
))
21082 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21083 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21084 : window_box_right_offset (it
->w
, TEXT_AREA
));
21085 if (EQ (prop
, Qleft_margin
))
21086 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21087 if (EQ (prop
, Qright_margin
))
21088 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21089 if (EQ (prop
, Qscroll_bar
))
21090 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21092 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21093 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21094 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21099 if (EQ (prop
, Qleft_fringe
))
21100 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21101 if (EQ (prop
, Qright_fringe
))
21102 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21103 if (EQ (prop
, Qleft_margin
))
21104 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21105 if (EQ (prop
, Qright_margin
))
21106 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21107 if (EQ (prop
, Qscroll_bar
))
21108 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21111 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21114 if (INTEGERP (prop
) || FLOATP (prop
))
21116 int base_unit
= (width_p
21117 ? FRAME_COLUMN_WIDTH (it
->f
)
21118 : FRAME_LINE_HEIGHT (it
->f
));
21119 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21124 Lisp_Object car
= XCAR (prop
);
21125 Lisp_Object cdr
= XCDR (prop
);
21129 #ifdef HAVE_WINDOW_SYSTEM
21130 if (FRAME_WINDOW_P (it
->f
)
21131 && valid_image_p (prop
))
21133 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21134 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21136 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21139 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21145 while (CONSP (cdr
))
21147 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21148 font
, width_p
, align_to
))
21151 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21156 if (EQ (car
, Qminus
))
21158 return OK_PIXELS (pixels
);
21161 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21164 if (INTEGERP (car
) || FLOATP (car
))
21167 pixels
= XFLOATINT (car
);
21169 return OK_PIXELS (pixels
);
21170 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21171 font
, width_p
, align_to
))
21172 return OK_PIXELS (pixels
* fact
);
21183 /***********************************************************************
21185 ***********************************************************************/
21187 #ifdef HAVE_WINDOW_SYSTEM
21192 dump_glyph_string (struct glyph_string
*s
)
21194 fprintf (stderr
, "glyph string\n");
21195 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21196 s
->x
, s
->y
, s
->width
, s
->height
);
21197 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21198 fprintf (stderr
, " hl = %d\n", s
->hl
);
21199 fprintf (stderr
, " left overhang = %d, right = %d\n",
21200 s
->left_overhang
, s
->right_overhang
);
21201 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21202 fprintf (stderr
, " extends to end of line = %d\n",
21203 s
->extends_to_end_of_line_p
);
21204 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21205 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21208 #endif /* GLYPH_DEBUG */
21210 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21211 of XChar2b structures for S; it can't be allocated in
21212 init_glyph_string because it must be allocated via `alloca'. W
21213 is the window on which S is drawn. ROW and AREA are the glyph row
21214 and area within the row from which S is constructed. START is the
21215 index of the first glyph structure covered by S. HL is a
21216 face-override for drawing S. */
21219 #define OPTIONAL_HDC(hdc) HDC hdc,
21220 #define DECLARE_HDC(hdc) HDC hdc;
21221 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21222 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21225 #ifndef OPTIONAL_HDC
21226 #define OPTIONAL_HDC(hdc)
21227 #define DECLARE_HDC(hdc)
21228 #define ALLOCATE_HDC(hdc, f)
21229 #define RELEASE_HDC(hdc, f)
21233 init_glyph_string (struct glyph_string
*s
,
21235 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21236 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21238 memset (s
, 0, sizeof *s
);
21240 s
->f
= XFRAME (w
->frame
);
21244 s
->display
= FRAME_X_DISPLAY (s
->f
);
21245 s
->window
= FRAME_X_WINDOW (s
->f
);
21246 s
->char2b
= char2b
;
21250 s
->first_glyph
= row
->glyphs
[area
] + start
;
21251 s
->height
= row
->height
;
21252 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21253 s
->ybase
= s
->y
+ row
->ascent
;
21257 /* Append the list of glyph strings with head H and tail T to the list
21258 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21261 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21262 struct glyph_string
*h
, struct glyph_string
*t
)
21276 /* Prepend the list of glyph strings with head H and tail T to the
21277 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21281 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21282 struct glyph_string
*h
, struct glyph_string
*t
)
21296 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21297 Set *HEAD and *TAIL to the resulting list. */
21300 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21301 struct glyph_string
*s
)
21303 s
->next
= s
->prev
= NULL
;
21304 append_glyph_string_lists (head
, tail
, s
, s
);
21308 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21309 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21310 make sure that X resources for the face returned are allocated.
21311 Value is a pointer to a realized face that is ready for display if
21312 DISPLAY_P is non-zero. */
21314 static inline struct face
*
21315 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21316 XChar2b
*char2b
, int display_p
)
21318 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21322 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21324 if (code
!= FONT_INVALID_CODE
)
21325 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21327 STORE_XCHAR2B (char2b
, 0, 0);
21330 /* Make sure X resources of the face are allocated. */
21331 #ifdef HAVE_X_WINDOWS
21335 xassert (face
!= NULL
);
21336 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21343 /* Get face and two-byte form of character glyph GLYPH on frame F.
21344 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21345 a pointer to a realized face that is ready for display. */
21347 static inline struct face
*
21348 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21349 XChar2b
*char2b
, int *two_byte_p
)
21353 xassert (glyph
->type
== CHAR_GLYPH
);
21354 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21363 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21364 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21366 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21368 if (code
!= FONT_INVALID_CODE
)
21369 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21371 STORE_XCHAR2B (char2b
, 0, 0);
21374 /* Make sure X resources of the face are allocated. */
21375 xassert (face
!= NULL
);
21376 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21381 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21382 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21385 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21389 if (CHAR_BYTE8_P (c
))
21390 code
= CHAR_TO_BYTE8 (c
);
21392 code
= font
->driver
->encode_char (font
, c
);
21394 if (code
== FONT_INVALID_CODE
)
21396 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21401 /* Fill glyph string S with composition components specified by S->cmp.
21403 BASE_FACE is the base face of the composition.
21404 S->cmp_from is the index of the first component for S.
21406 OVERLAPS non-zero means S should draw the foreground only, and use
21407 its physical height for clipping. See also draw_glyphs.
21409 Value is the index of a component not in S. */
21412 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21416 /* For all glyphs of this composition, starting at the offset
21417 S->cmp_from, until we reach the end of the definition or encounter a
21418 glyph that requires the different face, add it to S. */
21423 s
->for_overlaps
= overlaps
;
21426 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21428 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21432 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21435 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21442 s
->font
= s
->face
->font
;
21444 else if (s
->face
!= face
)
21452 /* All glyph strings for the same composition has the same width,
21453 i.e. the width set for the first component of the composition. */
21454 s
->width
= s
->first_glyph
->pixel_width
;
21456 /* If the specified font could not be loaded, use the frame's
21457 default font, but record the fact that we couldn't load it in
21458 the glyph string so that we can draw rectangles for the
21459 characters of the glyph string. */
21460 if (s
->font
== NULL
)
21462 s
->font_not_found_p
= 1;
21463 s
->font
= FRAME_FONT (s
->f
);
21466 /* Adjust base line for subscript/superscript text. */
21467 s
->ybase
+= s
->first_glyph
->voffset
;
21469 /* This glyph string must always be drawn with 16-bit functions. */
21476 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21477 int start
, int end
, int overlaps
)
21479 struct glyph
*glyph
, *last
;
21480 Lisp_Object lgstring
;
21483 s
->for_overlaps
= overlaps
;
21484 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21485 last
= s
->row
->glyphs
[s
->area
] + end
;
21486 s
->cmp_id
= glyph
->u
.cmp
.id
;
21487 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21488 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21489 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21490 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21491 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21493 while (glyph
< last
21494 && glyph
->u
.cmp
.automatic
21495 && glyph
->u
.cmp
.id
== s
->cmp_id
21496 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21497 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21499 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21501 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21502 unsigned code
= LGLYPH_CODE (lglyph
);
21504 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21506 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21507 return glyph
- s
->row
->glyphs
[s
->area
];
21511 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21512 See the comment of fill_glyph_string for arguments.
21513 Value is the index of the first glyph not in S. */
21517 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21518 int start
, int end
, int overlaps
)
21520 struct glyph
*glyph
, *last
;
21523 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21524 s
->for_overlaps
= overlaps
;
21525 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21526 last
= s
->row
->glyphs
[s
->area
] + end
;
21527 voffset
= glyph
->voffset
;
21528 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21529 s
->font
= s
->face
->font
;
21531 s
->width
= glyph
->pixel_width
;
21533 while (glyph
< last
21534 && glyph
->type
== GLYPHLESS_GLYPH
21535 && glyph
->voffset
== voffset
21536 && glyph
->face_id
== face_id
)
21539 s
->width
+= glyph
->pixel_width
;
21542 s
->ybase
+= voffset
;
21543 return glyph
- s
->row
->glyphs
[s
->area
];
21547 /* Fill glyph string S from a sequence of character glyphs.
21549 FACE_ID is the face id of the string. START is the index of the
21550 first glyph to consider, END is the index of the last + 1.
21551 OVERLAPS non-zero means S should draw the foreground only, and use
21552 its physical height for clipping. See also draw_glyphs.
21554 Value is the index of the first glyph not in S. */
21557 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21558 int start
, int end
, int overlaps
)
21560 struct glyph
*glyph
, *last
;
21562 int glyph_not_available_p
;
21564 xassert (s
->f
== XFRAME (s
->w
->frame
));
21565 xassert (s
->nchars
== 0);
21566 xassert (start
>= 0 && end
> start
);
21568 s
->for_overlaps
= overlaps
;
21569 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21570 last
= s
->row
->glyphs
[s
->area
] + end
;
21571 voffset
= glyph
->voffset
;
21572 s
->padding_p
= glyph
->padding_p
;
21573 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21575 while (glyph
< last
21576 && glyph
->type
== CHAR_GLYPH
21577 && glyph
->voffset
== voffset
21578 /* Same face id implies same font, nowadays. */
21579 && glyph
->face_id
== face_id
21580 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21584 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21585 s
->char2b
+ s
->nchars
,
21587 s
->two_byte_p
= two_byte_p
;
21589 xassert (s
->nchars
<= end
- start
);
21590 s
->width
+= glyph
->pixel_width
;
21591 if (glyph
++->padding_p
!= s
->padding_p
)
21595 s
->font
= s
->face
->font
;
21597 /* If the specified font could not be loaded, use the frame's font,
21598 but record the fact that we couldn't load it in
21599 S->font_not_found_p so that we can draw rectangles for the
21600 characters of the glyph string. */
21601 if (s
->font
== NULL
|| glyph_not_available_p
)
21603 s
->font_not_found_p
= 1;
21604 s
->font
= FRAME_FONT (s
->f
);
21607 /* Adjust base line for subscript/superscript text. */
21608 s
->ybase
+= voffset
;
21610 xassert (s
->face
&& s
->face
->gc
);
21611 return glyph
- s
->row
->glyphs
[s
->area
];
21615 /* Fill glyph string S from image glyph S->first_glyph. */
21618 fill_image_glyph_string (struct glyph_string
*s
)
21620 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21621 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21623 s
->slice
= s
->first_glyph
->slice
.img
;
21624 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21625 s
->font
= s
->face
->font
;
21626 s
->width
= s
->first_glyph
->pixel_width
;
21628 /* Adjust base line for subscript/superscript text. */
21629 s
->ybase
+= s
->first_glyph
->voffset
;
21633 /* Fill glyph string S from a sequence of stretch glyphs.
21635 START is the index of the first glyph to consider,
21636 END is the index of the last + 1.
21638 Value is the index of the first glyph not in S. */
21641 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21643 struct glyph
*glyph
, *last
;
21644 int voffset
, face_id
;
21646 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21648 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21649 last
= s
->row
->glyphs
[s
->area
] + end
;
21650 face_id
= glyph
->face_id
;
21651 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21652 s
->font
= s
->face
->font
;
21653 s
->width
= glyph
->pixel_width
;
21655 voffset
= glyph
->voffset
;
21659 && glyph
->type
== STRETCH_GLYPH
21660 && glyph
->voffset
== voffset
21661 && glyph
->face_id
== face_id
);
21663 s
->width
+= glyph
->pixel_width
;
21665 /* Adjust base line for subscript/superscript text. */
21666 s
->ybase
+= voffset
;
21668 /* The case that face->gc == 0 is handled when drawing the glyph
21669 string by calling PREPARE_FACE_FOR_DISPLAY. */
21671 return glyph
- s
->row
->glyphs
[s
->area
];
21674 static struct font_metrics
*
21675 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21677 static struct font_metrics metrics
;
21678 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21680 if (! font
|| code
== FONT_INVALID_CODE
)
21682 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21687 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21688 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21689 assumed to be zero. */
21692 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21694 *left
= *right
= 0;
21696 if (glyph
->type
== CHAR_GLYPH
)
21700 struct font_metrics
*pcm
;
21702 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21703 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21705 if (pcm
->rbearing
> pcm
->width
)
21706 *right
= pcm
->rbearing
- pcm
->width
;
21707 if (pcm
->lbearing
< 0)
21708 *left
= -pcm
->lbearing
;
21711 else if (glyph
->type
== COMPOSITE_GLYPH
)
21713 if (! glyph
->u
.cmp
.automatic
)
21715 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21717 if (cmp
->rbearing
> cmp
->pixel_width
)
21718 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21719 if (cmp
->lbearing
< 0)
21720 *left
= - cmp
->lbearing
;
21724 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21725 struct font_metrics metrics
;
21727 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21728 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21729 if (metrics
.rbearing
> metrics
.width
)
21730 *right
= metrics
.rbearing
- metrics
.width
;
21731 if (metrics
.lbearing
< 0)
21732 *left
= - metrics
.lbearing
;
21738 /* Return the index of the first glyph preceding glyph string S that
21739 is overwritten by S because of S's left overhang. Value is -1
21740 if no glyphs are overwritten. */
21743 left_overwritten (struct glyph_string
*s
)
21747 if (s
->left_overhang
)
21750 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21751 int first
= s
->first_glyph
- glyphs
;
21753 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21754 x
-= glyphs
[i
].pixel_width
;
21765 /* Return the index of the first glyph preceding glyph string S that
21766 is overwriting S because of its right overhang. Value is -1 if no
21767 glyph in front of S overwrites S. */
21770 left_overwriting (struct glyph_string
*s
)
21773 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21774 int first
= s
->first_glyph
- glyphs
;
21778 for (i
= first
- 1; i
>= 0; --i
)
21781 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21784 x
-= glyphs
[i
].pixel_width
;
21791 /* Return the index of the last glyph following glyph string S that is
21792 overwritten by S because of S's right overhang. Value is -1 if
21793 no such glyph is found. */
21796 right_overwritten (struct glyph_string
*s
)
21800 if (s
->right_overhang
)
21803 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21804 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21805 int end
= s
->row
->used
[s
->area
];
21807 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21808 x
+= glyphs
[i
].pixel_width
;
21817 /* Return the index of the last glyph following glyph string S that
21818 overwrites S because of its left overhang. Value is negative
21819 if no such glyph is found. */
21822 right_overwriting (struct glyph_string
*s
)
21825 int end
= s
->row
->used
[s
->area
];
21826 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21827 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21831 for (i
= first
; i
< end
; ++i
)
21834 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21837 x
+= glyphs
[i
].pixel_width
;
21844 /* Set background width of glyph string S. START is the index of the
21845 first glyph following S. LAST_X is the right-most x-position + 1
21846 in the drawing area. */
21849 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21851 /* If the face of this glyph string has to be drawn to the end of
21852 the drawing area, set S->extends_to_end_of_line_p. */
21854 if (start
== s
->row
->used
[s
->area
]
21855 && s
->area
== TEXT_AREA
21856 && ((s
->row
->fill_line_p
21857 && (s
->hl
== DRAW_NORMAL_TEXT
21858 || s
->hl
== DRAW_IMAGE_RAISED
21859 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21860 || s
->hl
== DRAW_MOUSE_FACE
))
21861 s
->extends_to_end_of_line_p
= 1;
21863 /* If S extends its face to the end of the line, set its
21864 background_width to the distance to the right edge of the drawing
21866 if (s
->extends_to_end_of_line_p
)
21867 s
->background_width
= last_x
- s
->x
+ 1;
21869 s
->background_width
= s
->width
;
21873 /* Compute overhangs and x-positions for glyph string S and its
21874 predecessors, or successors. X is the starting x-position for S.
21875 BACKWARD_P non-zero means process predecessors. */
21878 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21884 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21885 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21895 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21896 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21906 /* The following macros are only called from draw_glyphs below.
21907 They reference the following parameters of that function directly:
21908 `w', `row', `area', and `overlap_p'
21909 as well as the following local variables:
21910 `s', `f', and `hdc' (in W32) */
21913 /* On W32, silently add local `hdc' variable to argument list of
21914 init_glyph_string. */
21915 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21916 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21918 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21919 init_glyph_string (s, char2b, w, row, area, start, hl)
21922 /* Add a glyph string for a stretch glyph to the list of strings
21923 between HEAD and TAIL. START is the index of the stretch glyph in
21924 row area AREA of glyph row ROW. END is the index of the last glyph
21925 in that glyph row area. X is the current output position assigned
21926 to the new glyph string constructed. HL overrides that face of the
21927 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21928 is the right-most x-position of the drawing area. */
21930 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21931 and below -- keep them on one line. */
21932 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21935 s = (struct glyph_string *) alloca (sizeof *s); \
21936 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21937 START = fill_stretch_glyph_string (s, START, END); \
21938 append_glyph_string (&HEAD, &TAIL, s); \
21944 /* Add a glyph string for an image glyph to the list of strings
21945 between HEAD and TAIL. START is the index of the image glyph in
21946 row area AREA of glyph row ROW. END is the index of the last glyph
21947 in that glyph row area. X is the current output position assigned
21948 to the new glyph string constructed. HL overrides that face of the
21949 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21950 is the right-most x-position of the drawing area. */
21952 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21955 s = (struct glyph_string *) alloca (sizeof *s); \
21956 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21957 fill_image_glyph_string (s); \
21958 append_glyph_string (&HEAD, &TAIL, s); \
21965 /* Add a glyph string for a sequence of character glyphs to the list
21966 of strings between HEAD and TAIL. START is the index of the first
21967 glyph in row area AREA of glyph row ROW that is part of the new
21968 glyph string. END is the index of the last glyph in that glyph row
21969 area. X is the current output position assigned to the new glyph
21970 string constructed. HL overrides that face of the glyph; e.g. it
21971 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21972 right-most x-position of the drawing area. */
21974 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21980 face_id = (row)->glyphs[area][START].face_id; \
21982 s = (struct glyph_string *) alloca (sizeof *s); \
21983 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21984 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21985 append_glyph_string (&HEAD, &TAIL, s); \
21987 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21992 /* Add a glyph string for a composite sequence to the list of strings
21993 between HEAD and TAIL. START is the index of the first glyph in
21994 row area AREA of glyph row ROW that is part of the new glyph
21995 string. END is the index of the last glyph in that glyph row area.
21996 X is the current output position assigned to the new glyph string
21997 constructed. HL overrides that face of the glyph; e.g. it is
21998 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21999 x-position of the drawing area. */
22001 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22003 int face_id = (row)->glyphs[area][START].face_id; \
22004 struct face *base_face = FACE_FROM_ID (f, face_id); \
22005 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22006 struct composition *cmp = composition_table[cmp_id]; \
22008 struct glyph_string *first_s IF_LINT (= NULL); \
22011 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22013 /* Make glyph_strings for each glyph sequence that is drawable by \
22014 the same face, and append them to HEAD/TAIL. */ \
22015 for (n = 0; n < cmp->glyph_len;) \
22017 s = (struct glyph_string *) alloca (sizeof *s); \
22018 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22019 append_glyph_string (&(HEAD), &(TAIL), s); \
22025 n = fill_composite_glyph_string (s, base_face, overlaps); \
22033 /* Add a glyph string for a glyph-string sequence to the list of strings
22034 between HEAD and TAIL. */
22036 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22040 Lisp_Object gstring; \
22042 face_id = (row)->glyphs[area][START].face_id; \
22043 gstring = (composition_gstring_from_id \
22044 ((row)->glyphs[area][START].u.cmp.id)); \
22045 s = (struct glyph_string *) alloca (sizeof *s); \
22046 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22047 * LGSTRING_GLYPH_LEN (gstring)); \
22048 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22049 append_glyph_string (&(HEAD), &(TAIL), s); \
22051 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22055 /* Add a glyph string for a sequence of glyphless character's glyphs
22056 to the list of strings between HEAD and TAIL. The meanings of
22057 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22059 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22064 face_id = (row)->glyphs[area][START].face_id; \
22066 s = (struct glyph_string *) alloca (sizeof *s); \
22067 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22068 append_glyph_string (&HEAD, &TAIL, s); \
22070 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22076 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22077 of AREA of glyph row ROW on window W between indices START and END.
22078 HL overrides the face for drawing glyph strings, e.g. it is
22079 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22080 x-positions of the drawing area.
22082 This is an ugly monster macro construct because we must use alloca
22083 to allocate glyph strings (because draw_glyphs can be called
22084 asynchronously). */
22086 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22089 HEAD = TAIL = NULL; \
22090 while (START < END) \
22092 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22093 switch (first_glyph->type) \
22096 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22100 case COMPOSITE_GLYPH: \
22101 if (first_glyph->u.cmp.automatic) \
22102 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22105 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22109 case STRETCH_GLYPH: \
22110 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22114 case IMAGE_GLYPH: \
22115 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22119 case GLYPHLESS_GLYPH: \
22120 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22130 set_glyph_string_background_width (s, START, LAST_X); \
22137 /* Draw glyphs between START and END in AREA of ROW on window W,
22138 starting at x-position X. X is relative to AREA in W. HL is a
22139 face-override with the following meaning:
22141 DRAW_NORMAL_TEXT draw normally
22142 DRAW_CURSOR draw in cursor face
22143 DRAW_MOUSE_FACE draw in mouse face.
22144 DRAW_INVERSE_VIDEO draw in mode line face
22145 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22146 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22148 If OVERLAPS is non-zero, draw only the foreground of characters and
22149 clip to the physical height of ROW. Non-zero value also defines
22150 the overlapping part to be drawn:
22152 OVERLAPS_PRED overlap with preceding rows
22153 OVERLAPS_SUCC overlap with succeeding rows
22154 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22155 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22157 Value is the x-position reached, relative to AREA of W. */
22160 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22161 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22162 enum draw_glyphs_face hl
, int overlaps
)
22164 struct glyph_string
*head
, *tail
;
22165 struct glyph_string
*s
;
22166 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22167 int i
, j
, x_reached
, last_x
, area_left
= 0;
22168 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22171 ALLOCATE_HDC (hdc
, f
);
22173 /* Let's rather be paranoid than getting a SEGV. */
22174 end
= min (end
, row
->used
[area
]);
22175 start
= max (0, start
);
22176 start
= min (end
, start
);
22178 /* Translate X to frame coordinates. Set last_x to the right
22179 end of the drawing area. */
22180 if (row
->full_width_p
)
22182 /* X is relative to the left edge of W, without scroll bars
22184 area_left
= WINDOW_LEFT_EDGE_X (w
);
22185 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22189 area_left
= window_box_left (w
, area
);
22190 last_x
= area_left
+ window_box_width (w
, area
);
22194 /* Build a doubly-linked list of glyph_string structures between
22195 head and tail from what we have to draw. Note that the macro
22196 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22197 the reason we use a separate variable `i'. */
22199 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22201 x_reached
= tail
->x
+ tail
->background_width
;
22205 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22206 the row, redraw some glyphs in front or following the glyph
22207 strings built above. */
22208 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22210 struct glyph_string
*h
, *t
;
22211 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22212 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22213 int check_mouse_face
= 0;
22216 /* If mouse highlighting is on, we may need to draw adjacent
22217 glyphs using mouse-face highlighting. */
22218 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22220 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22222 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22223 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22225 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22227 check_mouse_face
= 1;
22228 mouse_beg_col
= (row
== mouse_beg_row
)
22229 ? hlinfo
->mouse_face_beg_col
: 0;
22230 mouse_end_col
= (row
== mouse_end_row
)
22231 ? hlinfo
->mouse_face_end_col
22232 : row
->used
[TEXT_AREA
];
22236 /* Compute overhangs for all glyph strings. */
22237 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22238 for (s
= head
; s
; s
= s
->next
)
22239 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22241 /* Prepend glyph strings for glyphs in front of the first glyph
22242 string that are overwritten because of the first glyph
22243 string's left overhang. The background of all strings
22244 prepended must be drawn because the first glyph string
22246 i
= left_overwritten (head
);
22249 enum draw_glyphs_face overlap_hl
;
22251 /* If this row contains mouse highlighting, attempt to draw
22252 the overlapped glyphs with the correct highlight. This
22253 code fails if the overlap encompasses more than one glyph
22254 and mouse-highlight spans only some of these glyphs.
22255 However, making it work perfectly involves a lot more
22256 code, and I don't know if the pathological case occurs in
22257 practice, so we'll stick to this for now. --- cyd */
22258 if (check_mouse_face
22259 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22260 overlap_hl
= DRAW_MOUSE_FACE
;
22262 overlap_hl
= DRAW_NORMAL_TEXT
;
22265 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22266 overlap_hl
, dummy_x
, last_x
);
22268 compute_overhangs_and_x (t
, head
->x
, 1);
22269 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22273 /* Prepend glyph strings for glyphs in front of the first glyph
22274 string that overwrite that glyph string because of their
22275 right overhang. For these strings, only the foreground must
22276 be drawn, because it draws over the glyph string at `head'.
22277 The background must not be drawn because this would overwrite
22278 right overhangs of preceding glyphs for which no glyph
22280 i
= left_overwriting (head
);
22283 enum draw_glyphs_face overlap_hl
;
22285 if (check_mouse_face
22286 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22287 overlap_hl
= DRAW_MOUSE_FACE
;
22289 overlap_hl
= DRAW_NORMAL_TEXT
;
22292 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22293 overlap_hl
, dummy_x
, last_x
);
22294 for (s
= h
; s
; s
= s
->next
)
22295 s
->background_filled_p
= 1;
22296 compute_overhangs_and_x (t
, head
->x
, 1);
22297 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22300 /* Append glyphs strings for glyphs following the last glyph
22301 string tail that are overwritten by tail. The background of
22302 these strings has to be drawn because tail's foreground draws
22304 i
= right_overwritten (tail
);
22307 enum draw_glyphs_face overlap_hl
;
22309 if (check_mouse_face
22310 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22311 overlap_hl
= DRAW_MOUSE_FACE
;
22313 overlap_hl
= DRAW_NORMAL_TEXT
;
22315 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22316 overlap_hl
, x
, last_x
);
22317 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22318 we don't have `end = i;' here. */
22319 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22320 append_glyph_string_lists (&head
, &tail
, h
, t
);
22324 /* Append glyph strings for glyphs following the last glyph
22325 string tail that overwrite tail. The foreground of such
22326 glyphs has to be drawn because it writes into the background
22327 of tail. The background must not be drawn because it could
22328 paint over the foreground of following glyphs. */
22329 i
= right_overwriting (tail
);
22332 enum draw_glyphs_face overlap_hl
;
22333 if (check_mouse_face
22334 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22335 overlap_hl
= DRAW_MOUSE_FACE
;
22337 overlap_hl
= DRAW_NORMAL_TEXT
;
22340 i
++; /* We must include the Ith glyph. */
22341 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22342 overlap_hl
, x
, last_x
);
22343 for (s
= h
; s
; s
= s
->next
)
22344 s
->background_filled_p
= 1;
22345 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22346 append_glyph_string_lists (&head
, &tail
, h
, t
);
22348 if (clip_head
|| clip_tail
)
22349 for (s
= head
; s
; s
= s
->next
)
22351 s
->clip_head
= clip_head
;
22352 s
->clip_tail
= clip_tail
;
22356 /* Draw all strings. */
22357 for (s
= head
; s
; s
= s
->next
)
22358 FRAME_RIF (f
)->draw_glyph_string (s
);
22361 /* When focus a sole frame and move horizontally, this sets on_p to 0
22362 causing a failure to erase prev cursor position. */
22363 if (area
== TEXT_AREA
22364 && !row
->full_width_p
22365 /* When drawing overlapping rows, only the glyph strings'
22366 foreground is drawn, which doesn't erase a cursor
22370 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22371 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22372 : (tail
? tail
->x
+ tail
->background_width
: x
));
22376 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22377 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22381 /* Value is the x-position up to which drawn, relative to AREA of W.
22382 This doesn't include parts drawn because of overhangs. */
22383 if (row
->full_width_p
)
22384 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22386 x_reached
-= area_left
;
22388 RELEASE_HDC (hdc
, f
);
22393 /* Expand row matrix if too narrow. Don't expand if area
22396 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22398 if (!fonts_changed_p \
22399 && (it->glyph_row->glyphs[area] \
22400 < it->glyph_row->glyphs[area + 1])) \
22402 it->w->ncols_scale_factor++; \
22403 fonts_changed_p = 1; \
22407 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22408 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22411 append_glyph (struct it
*it
)
22413 struct glyph
*glyph
;
22414 enum glyph_row_area area
= it
->area
;
22416 xassert (it
->glyph_row
);
22417 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22419 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22420 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22422 /* If the glyph row is reversed, we need to prepend the glyph
22423 rather than append it. */
22424 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22428 /* Make room for the additional glyph. */
22429 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22431 glyph
= it
->glyph_row
->glyphs
[area
];
22433 glyph
->charpos
= CHARPOS (it
->position
);
22434 glyph
->object
= it
->object
;
22435 if (it
->pixel_width
> 0)
22437 glyph
->pixel_width
= it
->pixel_width
;
22438 glyph
->padding_p
= 0;
22442 /* Assure at least 1-pixel width. Otherwise, cursor can't
22443 be displayed correctly. */
22444 glyph
->pixel_width
= 1;
22445 glyph
->padding_p
= 1;
22447 glyph
->ascent
= it
->ascent
;
22448 glyph
->descent
= it
->descent
;
22449 glyph
->voffset
= it
->voffset
;
22450 glyph
->type
= CHAR_GLYPH
;
22451 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22452 glyph
->multibyte_p
= it
->multibyte_p
;
22453 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22454 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22455 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22456 || it
->phys_descent
> it
->descent
);
22457 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22458 glyph
->face_id
= it
->face_id
;
22459 glyph
->u
.ch
= it
->char_to_display
;
22460 glyph
->slice
.img
= null_glyph_slice
;
22461 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22464 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22465 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22467 glyph
->bidi_type
= it
->bidi_it
.type
;
22471 glyph
->resolved_level
= 0;
22472 glyph
->bidi_type
= UNKNOWN_BT
;
22474 ++it
->glyph_row
->used
[area
];
22477 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22480 /* Store one glyph for the composition IT->cmp_it.id in
22481 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22485 append_composite_glyph (struct it
*it
)
22487 struct glyph
*glyph
;
22488 enum glyph_row_area area
= it
->area
;
22490 xassert (it
->glyph_row
);
22492 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22493 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22495 /* If the glyph row is reversed, we need to prepend the glyph
22496 rather than append it. */
22497 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22501 /* Make room for the new glyph. */
22502 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22504 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22506 glyph
->charpos
= it
->cmp_it
.charpos
;
22507 glyph
->object
= it
->object
;
22508 glyph
->pixel_width
= it
->pixel_width
;
22509 glyph
->ascent
= it
->ascent
;
22510 glyph
->descent
= it
->descent
;
22511 glyph
->voffset
= it
->voffset
;
22512 glyph
->type
= COMPOSITE_GLYPH
;
22513 if (it
->cmp_it
.ch
< 0)
22515 glyph
->u
.cmp
.automatic
= 0;
22516 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22517 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22521 glyph
->u
.cmp
.automatic
= 1;
22522 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22523 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22524 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22526 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22527 glyph
->multibyte_p
= it
->multibyte_p
;
22528 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22529 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22530 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22531 || it
->phys_descent
> it
->descent
);
22532 glyph
->padding_p
= 0;
22533 glyph
->glyph_not_available_p
= 0;
22534 glyph
->face_id
= it
->face_id
;
22535 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22538 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22539 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22541 glyph
->bidi_type
= it
->bidi_it
.type
;
22543 ++it
->glyph_row
->used
[area
];
22546 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22550 /* Change IT->ascent and IT->height according to the setting of
22554 take_vertical_position_into_account (struct it
*it
)
22558 if (it
->voffset
< 0)
22559 /* Increase the ascent so that we can display the text higher
22561 it
->ascent
-= it
->voffset
;
22563 /* Increase the descent so that we can display the text lower
22565 it
->descent
+= it
->voffset
;
22570 /* Produce glyphs/get display metrics for the image IT is loaded with.
22571 See the description of struct display_iterator in dispextern.h for
22572 an overview of struct display_iterator. */
22575 produce_image_glyph (struct it
*it
)
22579 int glyph_ascent
, crop
;
22580 struct glyph_slice slice
;
22582 xassert (it
->what
== IT_IMAGE
);
22584 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22586 /* Make sure X resources of the face is loaded. */
22587 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22589 if (it
->image_id
< 0)
22591 /* Fringe bitmap. */
22592 it
->ascent
= it
->phys_ascent
= 0;
22593 it
->descent
= it
->phys_descent
= 0;
22594 it
->pixel_width
= 0;
22599 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22601 /* Make sure X resources of the image is loaded. */
22602 prepare_image_for_display (it
->f
, img
);
22604 slice
.x
= slice
.y
= 0;
22605 slice
.width
= img
->width
;
22606 slice
.height
= img
->height
;
22608 if (INTEGERP (it
->slice
.x
))
22609 slice
.x
= XINT (it
->slice
.x
);
22610 else if (FLOATP (it
->slice
.x
))
22611 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22613 if (INTEGERP (it
->slice
.y
))
22614 slice
.y
= XINT (it
->slice
.y
);
22615 else if (FLOATP (it
->slice
.y
))
22616 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22618 if (INTEGERP (it
->slice
.width
))
22619 slice
.width
= XINT (it
->slice
.width
);
22620 else if (FLOATP (it
->slice
.width
))
22621 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22623 if (INTEGERP (it
->slice
.height
))
22624 slice
.height
= XINT (it
->slice
.height
);
22625 else if (FLOATP (it
->slice
.height
))
22626 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22628 if (slice
.x
>= img
->width
)
22629 slice
.x
= img
->width
;
22630 if (slice
.y
>= img
->height
)
22631 slice
.y
= img
->height
;
22632 if (slice
.x
+ slice
.width
>= img
->width
)
22633 slice
.width
= img
->width
- slice
.x
;
22634 if (slice
.y
+ slice
.height
> img
->height
)
22635 slice
.height
= img
->height
- slice
.y
;
22637 if (slice
.width
== 0 || slice
.height
== 0)
22640 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22642 it
->descent
= slice
.height
- glyph_ascent
;
22644 it
->descent
+= img
->vmargin
;
22645 if (slice
.y
+ slice
.height
== img
->height
)
22646 it
->descent
+= img
->vmargin
;
22647 it
->phys_descent
= it
->descent
;
22649 it
->pixel_width
= slice
.width
;
22651 it
->pixel_width
+= img
->hmargin
;
22652 if (slice
.x
+ slice
.width
== img
->width
)
22653 it
->pixel_width
+= img
->hmargin
;
22655 /* It's quite possible for images to have an ascent greater than
22656 their height, so don't get confused in that case. */
22657 if (it
->descent
< 0)
22662 if (face
->box
!= FACE_NO_BOX
)
22664 if (face
->box_line_width
> 0)
22667 it
->ascent
+= face
->box_line_width
;
22668 if (slice
.y
+ slice
.height
== img
->height
)
22669 it
->descent
+= face
->box_line_width
;
22672 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22673 it
->pixel_width
+= eabs (face
->box_line_width
);
22674 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22675 it
->pixel_width
+= eabs (face
->box_line_width
);
22678 take_vertical_position_into_account (it
);
22680 /* Automatically crop wide image glyphs at right edge so we can
22681 draw the cursor on same display row. */
22682 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22683 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22685 it
->pixel_width
-= crop
;
22686 slice
.width
-= crop
;
22691 struct glyph
*glyph
;
22692 enum glyph_row_area area
= it
->area
;
22694 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22695 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22697 glyph
->charpos
= CHARPOS (it
->position
);
22698 glyph
->object
= it
->object
;
22699 glyph
->pixel_width
= it
->pixel_width
;
22700 glyph
->ascent
= glyph_ascent
;
22701 glyph
->descent
= it
->descent
;
22702 glyph
->voffset
= it
->voffset
;
22703 glyph
->type
= IMAGE_GLYPH
;
22704 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22705 glyph
->multibyte_p
= it
->multibyte_p
;
22706 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22707 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22708 glyph
->overlaps_vertically_p
= 0;
22709 glyph
->padding_p
= 0;
22710 glyph
->glyph_not_available_p
= 0;
22711 glyph
->face_id
= it
->face_id
;
22712 glyph
->u
.img_id
= img
->id
;
22713 glyph
->slice
.img
= slice
;
22714 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22717 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22718 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22720 glyph
->bidi_type
= it
->bidi_it
.type
;
22722 ++it
->glyph_row
->used
[area
];
22725 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22730 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22731 of the glyph, WIDTH and HEIGHT are the width and height of the
22732 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22735 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22736 int width
, int height
, int ascent
)
22738 struct glyph
*glyph
;
22739 enum glyph_row_area area
= it
->area
;
22741 xassert (ascent
>= 0 && ascent
<= height
);
22743 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22744 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22746 /* If the glyph row is reversed, we need to prepend the glyph
22747 rather than append it. */
22748 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22752 /* Make room for the additional glyph. */
22753 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22755 glyph
= it
->glyph_row
->glyphs
[area
];
22757 glyph
->charpos
= CHARPOS (it
->position
);
22758 glyph
->object
= object
;
22759 glyph
->pixel_width
= width
;
22760 glyph
->ascent
= ascent
;
22761 glyph
->descent
= height
- ascent
;
22762 glyph
->voffset
= it
->voffset
;
22763 glyph
->type
= STRETCH_GLYPH
;
22764 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22765 glyph
->multibyte_p
= it
->multibyte_p
;
22766 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22767 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22768 glyph
->overlaps_vertically_p
= 0;
22769 glyph
->padding_p
= 0;
22770 glyph
->glyph_not_available_p
= 0;
22771 glyph
->face_id
= it
->face_id
;
22772 glyph
->u
.stretch
.ascent
= ascent
;
22773 glyph
->u
.stretch
.height
= height
;
22774 glyph
->slice
.img
= null_glyph_slice
;
22775 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22778 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22779 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22781 glyph
->bidi_type
= it
->bidi_it
.type
;
22785 glyph
->resolved_level
= 0;
22786 glyph
->bidi_type
= UNKNOWN_BT
;
22788 ++it
->glyph_row
->used
[area
];
22791 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22795 /* Produce a stretch glyph for iterator IT. IT->object is the value
22796 of the glyph property displayed. The value must be a list
22797 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22800 1. `:width WIDTH' specifies that the space should be WIDTH *
22801 canonical char width wide. WIDTH may be an integer or floating
22804 2. `:relative-width FACTOR' specifies that the width of the stretch
22805 should be computed from the width of the first character having the
22806 `glyph' property, and should be FACTOR times that width.
22808 3. `:align-to HPOS' specifies that the space should be wide enough
22809 to reach HPOS, a value in canonical character units.
22811 Exactly one of the above pairs must be present.
22813 4. `:height HEIGHT' specifies that the height of the stretch produced
22814 should be HEIGHT, measured in canonical character units.
22816 5. `:relative-height FACTOR' specifies that the height of the
22817 stretch should be FACTOR times the height of the characters having
22818 the glyph property.
22820 Either none or exactly one of 4 or 5 must be present.
22822 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22823 of the stretch should be used for the ascent of the stretch.
22824 ASCENT must be in the range 0 <= ASCENT <= 100. */
22827 produce_stretch_glyph (struct it
*it
)
22829 /* (space :width WIDTH :height HEIGHT ...) */
22830 Lisp_Object prop
, plist
;
22831 int width
= 0, height
= 0, align_to
= -1;
22832 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22835 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22836 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22838 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22840 /* List should start with `space'. */
22841 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22842 plist
= XCDR (it
->object
);
22844 /* Compute the width of the stretch. */
22845 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22846 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22848 /* Absolute width `:width WIDTH' specified and valid. */
22849 zero_width_ok_p
= 1;
22852 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22855 /* Relative width `:relative-width FACTOR' specified and valid.
22856 Compute the width of the characters having the `glyph'
22859 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22862 if (it
->multibyte_p
)
22863 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22866 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22867 if (! ASCII_CHAR_P (it2
.c
))
22868 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22871 it2
.glyph_row
= NULL
;
22872 it2
.what
= IT_CHARACTER
;
22873 x_produce_glyphs (&it2
);
22874 width
= NUMVAL (prop
) * it2
.pixel_width
;
22876 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22877 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22879 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22880 align_to
= (align_to
< 0
22882 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22883 else if (align_to
< 0)
22884 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22885 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22886 zero_width_ok_p
= 1;
22889 /* Nothing specified -> width defaults to canonical char width. */
22890 width
= FRAME_COLUMN_WIDTH (it
->f
);
22892 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22895 /* Compute height. */
22896 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22897 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22900 zero_height_ok_p
= 1;
22902 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22904 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22906 height
= FONT_HEIGHT (font
);
22908 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22911 /* Compute percentage of height used for ascent. If
22912 `:ascent ASCENT' is present and valid, use that. Otherwise,
22913 derive the ascent from the font in use. */
22914 if (prop
= Fplist_get (plist
, QCascent
),
22915 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22916 ascent
= height
* NUMVAL (prop
) / 100.0;
22917 else if (!NILP (prop
)
22918 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22919 ascent
= min (max (0, (int)tem
), height
);
22921 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22923 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22924 && it
->current_x
+ width
> it
->last_visible_x
)
22925 width
= it
->last_visible_x
- it
->current_x
- 1;
22927 if (width
> 0 && height
> 0 && it
->glyph_row
)
22929 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22930 if (!STRINGP (object
))
22931 object
= it
->w
->buffer
;
22932 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22935 it
->pixel_width
= width
;
22936 it
->ascent
= it
->phys_ascent
= ascent
;
22937 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22938 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22940 take_vertical_position_into_account (it
);
22943 /* Calculate line-height and line-spacing properties.
22944 An integer value specifies explicit pixel value.
22945 A float value specifies relative value to current face height.
22946 A cons (float . face-name) specifies relative value to
22947 height of specified face font.
22949 Returns height in pixels, or nil. */
22953 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22954 int boff
, int override
)
22956 Lisp_Object face_name
= Qnil
;
22957 int ascent
, descent
, height
;
22959 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22964 face_name
= XCAR (val
);
22966 if (!NUMBERP (val
))
22967 val
= make_number (1);
22968 if (NILP (face_name
))
22970 height
= it
->ascent
+ it
->descent
;
22975 if (NILP (face_name
))
22977 font
= FRAME_FONT (it
->f
);
22978 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22980 else if (EQ (face_name
, Qt
))
22989 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22991 return make_number (-1);
22993 face
= FACE_FROM_ID (it
->f
, face_id
);
22996 return make_number (-1);
22997 boff
= font
->baseline_offset
;
22998 if (font
->vertical_centering
)
22999 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23002 ascent
= FONT_BASE (font
) + boff
;
23003 descent
= FONT_DESCENT (font
) - boff
;
23007 it
->override_ascent
= ascent
;
23008 it
->override_descent
= descent
;
23009 it
->override_boff
= boff
;
23012 height
= ascent
+ descent
;
23016 height
= (int)(XFLOAT_DATA (val
) * height
);
23017 else if (INTEGERP (val
))
23018 height
*= XINT (val
);
23020 return make_number (height
);
23024 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23025 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23026 and only if this is for a character for which no font was found.
23028 If the display method (it->glyphless_method) is
23029 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23030 length of the acronym or the hexadecimal string, UPPER_XOFF and
23031 UPPER_YOFF are pixel offsets for the upper part of the string,
23032 LOWER_XOFF and LOWER_YOFF are for the lower part.
23034 For the other display methods, LEN through LOWER_YOFF are zero. */
23037 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23038 short upper_xoff
, short upper_yoff
,
23039 short lower_xoff
, short lower_yoff
)
23041 struct glyph
*glyph
;
23042 enum glyph_row_area area
= it
->area
;
23044 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23045 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23047 /* If the glyph row is reversed, we need to prepend the glyph
23048 rather than append it. */
23049 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23053 /* Make room for the additional glyph. */
23054 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23056 glyph
= it
->glyph_row
->glyphs
[area
];
23058 glyph
->charpos
= CHARPOS (it
->position
);
23059 glyph
->object
= it
->object
;
23060 glyph
->pixel_width
= it
->pixel_width
;
23061 glyph
->ascent
= it
->ascent
;
23062 glyph
->descent
= it
->descent
;
23063 glyph
->voffset
= it
->voffset
;
23064 glyph
->type
= GLYPHLESS_GLYPH
;
23065 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23066 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23067 glyph
->u
.glyphless
.len
= len
;
23068 glyph
->u
.glyphless
.ch
= it
->c
;
23069 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23070 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23071 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23072 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23073 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23074 glyph
->multibyte_p
= it
->multibyte_p
;
23075 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23076 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23077 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23078 || it
->phys_descent
> it
->descent
);
23079 glyph
->padding_p
= 0;
23080 glyph
->glyph_not_available_p
= 0;
23081 glyph
->face_id
= face_id
;
23082 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23085 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23086 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23088 glyph
->bidi_type
= it
->bidi_it
.type
;
23090 ++it
->glyph_row
->used
[area
];
23093 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23097 /* Produce a glyph for a glyphless character for iterator IT.
23098 IT->glyphless_method specifies which method to use for displaying
23099 the character. See the description of enum
23100 glyphless_display_method in dispextern.h for the detail.
23102 FOR_NO_FONT is nonzero if and only if this is for a character for
23103 which no font was found. ACRONYM, if non-nil, is an acronym string
23104 for the character. */
23107 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23112 int base_width
, base_height
, width
, height
;
23113 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23116 /* Get the metrics of the base font. We always refer to the current
23118 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23119 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23120 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23121 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23122 base_height
= it
->ascent
+ it
->descent
;
23123 base_width
= font
->average_width
;
23125 /* Get a face ID for the glyph by utilizing a cache (the same way as
23126 doen for `escape-glyph' in get_next_display_element). */
23127 if (it
->f
== last_glyphless_glyph_frame
23128 && it
->face_id
== last_glyphless_glyph_face_id
)
23130 face_id
= last_glyphless_glyph_merged_face_id
;
23134 /* Merge the `glyphless-char' face into the current face. */
23135 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23136 last_glyphless_glyph_frame
= it
->f
;
23137 last_glyphless_glyph_face_id
= it
->face_id
;
23138 last_glyphless_glyph_merged_face_id
= face_id
;
23141 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23143 it
->pixel_width
= THIN_SPACE_WIDTH
;
23145 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23147 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23149 width
= CHAR_WIDTH (it
->c
);
23152 else if (width
> 4)
23154 it
->pixel_width
= base_width
* width
;
23156 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23162 unsigned int code
[6];
23164 int ascent
, descent
;
23165 struct font_metrics metrics_upper
, metrics_lower
;
23167 face
= FACE_FROM_ID (it
->f
, face_id
);
23168 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23169 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23171 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23173 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23174 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23175 if (CONSP (acronym
))
23176 acronym
= XCAR (acronym
);
23177 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23181 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23182 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23185 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23186 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23187 upper_len
= (len
+ 1) / 2;
23188 font
->driver
->text_extents (font
, code
, upper_len
,
23190 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23195 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23196 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23197 upper_xoff
= upper_yoff
= 2; /* the typical case */
23198 if (base_width
>= width
)
23200 /* Align the upper to the left, the lower to the right. */
23201 it
->pixel_width
= base_width
;
23202 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23206 /* Center the shorter one. */
23207 it
->pixel_width
= width
;
23208 if (metrics_upper
.width
>= metrics_lower
.width
)
23209 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23212 /* FIXME: This code doesn't look right. It formerly was
23213 missing the "lower_xoff = 0;", which couldn't have
23214 been right since it left lower_xoff uninitialized. */
23216 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23220 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23221 top, bottom, and between upper and lower strings. */
23222 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23223 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23224 /* Center vertically.
23225 H:base_height, D:base_descent
23226 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23228 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23229 descent = D - H/2 + h/2;
23230 lower_yoff = descent - 2 - ld;
23231 upper_yoff = lower_yoff - la - 1 - ud; */
23232 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23233 descent
= it
->descent
- (base_height
- height
) / 2;
23234 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23235 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23236 - metrics_upper
.descent
);
23237 /* Don't make the height shorter than the base height. */
23238 if (height
> base_height
)
23240 it
->ascent
= ascent
;
23241 it
->descent
= descent
;
23245 it
->phys_ascent
= it
->ascent
;
23246 it
->phys_descent
= it
->descent
;
23248 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23249 upper_xoff
, upper_yoff
,
23250 lower_xoff
, lower_yoff
);
23252 take_vertical_position_into_account (it
);
23257 Produce glyphs/get display metrics for the display element IT is
23258 loaded with. See the description of struct it in dispextern.h
23259 for an overview of struct it. */
23262 x_produce_glyphs (struct it
*it
)
23264 int extra_line_spacing
= it
->extra_line_spacing
;
23266 it
->glyph_not_available_p
= 0;
23268 if (it
->what
== IT_CHARACTER
)
23271 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23272 struct font
*font
= face
->font
;
23273 struct font_metrics
*pcm
= NULL
;
23274 int boff
; /* baseline offset */
23278 /* When no suitable font is found, display this character by
23279 the method specified in the first extra slot of
23280 Vglyphless_char_display. */
23281 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23283 xassert (it
->what
== IT_GLYPHLESS
);
23284 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23288 boff
= font
->baseline_offset
;
23289 if (font
->vertical_centering
)
23290 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23292 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23298 if (it
->override_ascent
>= 0)
23300 it
->ascent
= it
->override_ascent
;
23301 it
->descent
= it
->override_descent
;
23302 boff
= it
->override_boff
;
23306 it
->ascent
= FONT_BASE (font
) + boff
;
23307 it
->descent
= FONT_DESCENT (font
) - boff
;
23310 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23312 pcm
= get_per_char_metric (font
, &char2b
);
23313 if (pcm
->width
== 0
23314 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23320 it
->phys_ascent
= pcm
->ascent
+ boff
;
23321 it
->phys_descent
= pcm
->descent
- boff
;
23322 it
->pixel_width
= pcm
->width
;
23326 it
->glyph_not_available_p
= 1;
23327 it
->phys_ascent
= it
->ascent
;
23328 it
->phys_descent
= it
->descent
;
23329 it
->pixel_width
= font
->space_width
;
23332 if (it
->constrain_row_ascent_descent_p
)
23334 if (it
->descent
> it
->max_descent
)
23336 it
->ascent
+= it
->descent
- it
->max_descent
;
23337 it
->descent
= it
->max_descent
;
23339 if (it
->ascent
> it
->max_ascent
)
23341 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23342 it
->ascent
= it
->max_ascent
;
23344 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23345 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23346 extra_line_spacing
= 0;
23349 /* If this is a space inside a region of text with
23350 `space-width' property, change its width. */
23351 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23353 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23355 /* If face has a box, add the box thickness to the character
23356 height. If character has a box line to the left and/or
23357 right, add the box line width to the character's width. */
23358 if (face
->box
!= FACE_NO_BOX
)
23360 int thick
= face
->box_line_width
;
23364 it
->ascent
+= thick
;
23365 it
->descent
+= thick
;
23370 if (it
->start_of_box_run_p
)
23371 it
->pixel_width
+= thick
;
23372 if (it
->end_of_box_run_p
)
23373 it
->pixel_width
+= thick
;
23376 /* If face has an overline, add the height of the overline
23377 (1 pixel) and a 1 pixel margin to the character height. */
23378 if (face
->overline_p
)
23379 it
->ascent
+= overline_margin
;
23381 if (it
->constrain_row_ascent_descent_p
)
23383 if (it
->ascent
> it
->max_ascent
)
23384 it
->ascent
= it
->max_ascent
;
23385 if (it
->descent
> it
->max_descent
)
23386 it
->descent
= it
->max_descent
;
23389 take_vertical_position_into_account (it
);
23391 /* If we have to actually produce glyphs, do it. */
23396 /* Translate a space with a `space-width' property
23397 into a stretch glyph. */
23398 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23399 / FONT_HEIGHT (font
));
23400 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23401 it
->ascent
+ it
->descent
, ascent
);
23406 /* If characters with lbearing or rbearing are displayed
23407 in this line, record that fact in a flag of the
23408 glyph row. This is used to optimize X output code. */
23409 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23410 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23412 if (! stretched_p
&& it
->pixel_width
== 0)
23413 /* We assure that all visible glyphs have at least 1-pixel
23415 it
->pixel_width
= 1;
23417 else if (it
->char_to_display
== '\n')
23419 /* A newline has no width, but we need the height of the
23420 line. But if previous part of the line sets a height,
23421 don't increase that height */
23423 Lisp_Object height
;
23424 Lisp_Object total_height
= Qnil
;
23426 it
->override_ascent
= -1;
23427 it
->pixel_width
= 0;
23430 height
= get_it_property (it
, Qline_height
);
23431 /* Split (line-height total-height) list */
23433 && CONSP (XCDR (height
))
23434 && NILP (XCDR (XCDR (height
))))
23436 total_height
= XCAR (XCDR (height
));
23437 height
= XCAR (height
);
23439 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23441 if (it
->override_ascent
>= 0)
23443 it
->ascent
= it
->override_ascent
;
23444 it
->descent
= it
->override_descent
;
23445 boff
= it
->override_boff
;
23449 it
->ascent
= FONT_BASE (font
) + boff
;
23450 it
->descent
= FONT_DESCENT (font
) - boff
;
23453 if (EQ (height
, Qt
))
23455 if (it
->descent
> it
->max_descent
)
23457 it
->ascent
+= it
->descent
- it
->max_descent
;
23458 it
->descent
= it
->max_descent
;
23460 if (it
->ascent
> it
->max_ascent
)
23462 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23463 it
->ascent
= it
->max_ascent
;
23465 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23466 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23467 it
->constrain_row_ascent_descent_p
= 1;
23468 extra_line_spacing
= 0;
23472 Lisp_Object spacing
;
23474 it
->phys_ascent
= it
->ascent
;
23475 it
->phys_descent
= it
->descent
;
23477 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23478 && face
->box
!= FACE_NO_BOX
23479 && face
->box_line_width
> 0)
23481 it
->ascent
+= face
->box_line_width
;
23482 it
->descent
+= face
->box_line_width
;
23485 && XINT (height
) > it
->ascent
+ it
->descent
)
23486 it
->ascent
= XINT (height
) - it
->descent
;
23488 if (!NILP (total_height
))
23489 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23492 spacing
= get_it_property (it
, Qline_spacing
);
23493 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23495 if (INTEGERP (spacing
))
23497 extra_line_spacing
= XINT (spacing
);
23498 if (!NILP (total_height
))
23499 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23503 else /* i.e. (it->char_to_display == '\t') */
23505 if (font
->space_width
> 0)
23507 int tab_width
= it
->tab_width
* font
->space_width
;
23508 int x
= it
->current_x
+ it
->continuation_lines_width
;
23509 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23511 /* If the distance from the current position to the next tab
23512 stop is less than a space character width, use the
23513 tab stop after that. */
23514 if (next_tab_x
- x
< font
->space_width
)
23515 next_tab_x
+= tab_width
;
23517 it
->pixel_width
= next_tab_x
- x
;
23519 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23520 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23524 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23525 it
->ascent
+ it
->descent
, it
->ascent
);
23530 it
->pixel_width
= 0;
23535 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23537 /* A static composition.
23539 Note: A composition is represented as one glyph in the
23540 glyph matrix. There are no padding glyphs.
23542 Important note: pixel_width, ascent, and descent are the
23543 values of what is drawn by draw_glyphs (i.e. the values of
23544 the overall glyphs composed). */
23545 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23546 int boff
; /* baseline offset */
23547 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23548 int glyph_len
= cmp
->glyph_len
;
23549 struct font
*font
= face
->font
;
23553 /* If we have not yet calculated pixel size data of glyphs of
23554 the composition for the current face font, calculate them
23555 now. Theoretically, we have to check all fonts for the
23556 glyphs, but that requires much time and memory space. So,
23557 here we check only the font of the first glyph. This may
23558 lead to incorrect display, but it's very rare, and C-l
23559 (recenter-top-bottom) can correct the display anyway. */
23560 if (! cmp
->font
|| cmp
->font
!= font
)
23562 /* Ascent and descent of the font of the first character
23563 of this composition (adjusted by baseline offset).
23564 Ascent and descent of overall glyphs should not be less
23565 than these, respectively. */
23566 int font_ascent
, font_descent
, font_height
;
23567 /* Bounding box of the overall glyphs. */
23568 int leftmost
, rightmost
, lowest
, highest
;
23569 int lbearing
, rbearing
;
23570 int i
, width
, ascent
, descent
;
23571 int left_padded
= 0, right_padded
= 0;
23572 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23574 struct font_metrics
*pcm
;
23575 int font_not_found_p
;
23578 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23579 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23581 if (glyph_len
< cmp
->glyph_len
)
23583 for (i
= 0; i
< glyph_len
; i
++)
23585 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23587 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23592 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23593 : IT_CHARPOS (*it
));
23594 /* If no suitable font is found, use the default font. */
23595 font_not_found_p
= font
== NULL
;
23596 if (font_not_found_p
)
23598 face
= face
->ascii_face
;
23601 boff
= font
->baseline_offset
;
23602 if (font
->vertical_centering
)
23603 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23604 font_ascent
= FONT_BASE (font
) + boff
;
23605 font_descent
= FONT_DESCENT (font
) - boff
;
23606 font_height
= FONT_HEIGHT (font
);
23608 cmp
->font
= (void *) font
;
23611 if (! font_not_found_p
)
23613 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23615 pcm
= get_per_char_metric (font
, &char2b
);
23618 /* Initialize the bounding box. */
23621 width
= pcm
->width
;
23622 ascent
= pcm
->ascent
;
23623 descent
= pcm
->descent
;
23624 lbearing
= pcm
->lbearing
;
23625 rbearing
= pcm
->rbearing
;
23629 width
= font
->space_width
;
23630 ascent
= FONT_BASE (font
);
23631 descent
= FONT_DESCENT (font
);
23638 lowest
= - descent
+ boff
;
23639 highest
= ascent
+ boff
;
23641 if (! font_not_found_p
23642 && font
->default_ascent
23643 && CHAR_TABLE_P (Vuse_default_ascent
)
23644 && !NILP (Faref (Vuse_default_ascent
,
23645 make_number (it
->char_to_display
))))
23646 highest
= font
->default_ascent
+ boff
;
23648 /* Draw the first glyph at the normal position. It may be
23649 shifted to right later if some other glyphs are drawn
23651 cmp
->offsets
[i
* 2] = 0;
23652 cmp
->offsets
[i
* 2 + 1] = boff
;
23653 cmp
->lbearing
= lbearing
;
23654 cmp
->rbearing
= rbearing
;
23656 /* Set cmp->offsets for the remaining glyphs. */
23657 for (i
++; i
< glyph_len
; i
++)
23659 int left
, right
, btm
, top
;
23660 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23662 struct face
*this_face
;
23666 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23667 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23668 font
= this_face
->font
;
23674 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23676 pcm
= get_per_char_metric (font
, &char2b
);
23679 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23682 width
= pcm
->width
;
23683 ascent
= pcm
->ascent
;
23684 descent
= pcm
->descent
;
23685 lbearing
= pcm
->lbearing
;
23686 rbearing
= pcm
->rbearing
;
23687 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23689 /* Relative composition with or without
23690 alternate chars. */
23691 left
= (leftmost
+ rightmost
- width
) / 2;
23692 btm
= - descent
+ boff
;
23693 if (font
->relative_compose
23694 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23695 || NILP (Faref (Vignore_relative_composition
,
23696 make_number (ch
)))))
23699 if (- descent
>= font
->relative_compose
)
23700 /* One extra pixel between two glyphs. */
23702 else if (ascent
<= 0)
23703 /* One extra pixel between two glyphs. */
23704 btm
= lowest
- 1 - ascent
- descent
;
23709 /* A composition rule is specified by an integer
23710 value that encodes global and new reference
23711 points (GREF and NREF). GREF and NREF are
23712 specified by numbers as below:
23714 0---1---2 -- ascent
23718 9--10--11 -- center
23720 ---3---4---5--- baseline
23722 6---7---8 -- descent
23724 int rule
= COMPOSITION_RULE (cmp
, i
);
23725 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23727 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23728 grefx
= gref
% 3, nrefx
= nref
% 3;
23729 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23731 xoff
= font_height
* (xoff
- 128) / 256;
23733 yoff
= font_height
* (yoff
- 128) / 256;
23736 + grefx
* (rightmost
- leftmost
) / 2
23737 - nrefx
* width
/ 2
23740 btm
= ((grefy
== 0 ? highest
23742 : grefy
== 2 ? lowest
23743 : (highest
+ lowest
) / 2)
23744 - (nrefy
== 0 ? ascent
+ descent
23745 : nrefy
== 1 ? descent
- boff
23747 : (ascent
+ descent
) / 2)
23751 cmp
->offsets
[i
* 2] = left
;
23752 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23754 /* Update the bounding box of the overall glyphs. */
23757 right
= left
+ width
;
23758 if (left
< leftmost
)
23760 if (right
> rightmost
)
23763 top
= btm
+ descent
+ ascent
;
23769 if (cmp
->lbearing
> left
+ lbearing
)
23770 cmp
->lbearing
= left
+ lbearing
;
23771 if (cmp
->rbearing
< left
+ rbearing
)
23772 cmp
->rbearing
= left
+ rbearing
;
23776 /* If there are glyphs whose x-offsets are negative,
23777 shift all glyphs to the right and make all x-offsets
23781 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23782 cmp
->offsets
[i
* 2] -= leftmost
;
23783 rightmost
-= leftmost
;
23784 cmp
->lbearing
-= leftmost
;
23785 cmp
->rbearing
-= leftmost
;
23788 if (left_padded
&& cmp
->lbearing
< 0)
23790 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23791 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23792 rightmost
-= cmp
->lbearing
;
23793 cmp
->rbearing
-= cmp
->lbearing
;
23796 if (right_padded
&& rightmost
< cmp
->rbearing
)
23798 rightmost
= cmp
->rbearing
;
23801 cmp
->pixel_width
= rightmost
;
23802 cmp
->ascent
= highest
;
23803 cmp
->descent
= - lowest
;
23804 if (cmp
->ascent
< font_ascent
)
23805 cmp
->ascent
= font_ascent
;
23806 if (cmp
->descent
< font_descent
)
23807 cmp
->descent
= font_descent
;
23811 && (cmp
->lbearing
< 0
23812 || cmp
->rbearing
> cmp
->pixel_width
))
23813 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23815 it
->pixel_width
= cmp
->pixel_width
;
23816 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23817 it
->descent
= it
->phys_descent
= cmp
->descent
;
23818 if (face
->box
!= FACE_NO_BOX
)
23820 int thick
= face
->box_line_width
;
23824 it
->ascent
+= thick
;
23825 it
->descent
+= thick
;
23830 if (it
->start_of_box_run_p
)
23831 it
->pixel_width
+= thick
;
23832 if (it
->end_of_box_run_p
)
23833 it
->pixel_width
+= thick
;
23836 /* If face has an overline, add the height of the overline
23837 (1 pixel) and a 1 pixel margin to the character height. */
23838 if (face
->overline_p
)
23839 it
->ascent
+= overline_margin
;
23841 take_vertical_position_into_account (it
);
23842 if (it
->ascent
< 0)
23844 if (it
->descent
< 0)
23848 append_composite_glyph (it
);
23850 else if (it
->what
== IT_COMPOSITION
)
23852 /* A dynamic (automatic) composition. */
23853 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23854 Lisp_Object gstring
;
23855 struct font_metrics metrics
;
23857 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23859 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23862 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23863 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23864 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23865 it
->descent
= it
->phys_descent
= metrics
.descent
;
23866 if (face
->box
!= FACE_NO_BOX
)
23868 int thick
= face
->box_line_width
;
23872 it
->ascent
+= thick
;
23873 it
->descent
+= thick
;
23878 if (it
->start_of_box_run_p
)
23879 it
->pixel_width
+= thick
;
23880 if (it
->end_of_box_run_p
)
23881 it
->pixel_width
+= thick
;
23883 /* If face has an overline, add the height of the overline
23884 (1 pixel) and a 1 pixel margin to the character height. */
23885 if (face
->overline_p
)
23886 it
->ascent
+= overline_margin
;
23887 take_vertical_position_into_account (it
);
23888 if (it
->ascent
< 0)
23890 if (it
->descent
< 0)
23894 append_composite_glyph (it
);
23896 else if (it
->what
== IT_GLYPHLESS
)
23897 produce_glyphless_glyph (it
, 0, Qnil
);
23898 else if (it
->what
== IT_IMAGE
)
23899 produce_image_glyph (it
);
23900 else if (it
->what
== IT_STRETCH
)
23901 produce_stretch_glyph (it
);
23904 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23905 because this isn't true for images with `:ascent 100'. */
23906 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23907 if (it
->area
== TEXT_AREA
)
23908 it
->current_x
+= it
->pixel_width
;
23910 if (extra_line_spacing
> 0)
23912 it
->descent
+= extra_line_spacing
;
23913 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23914 it
->max_extra_line_spacing
= extra_line_spacing
;
23917 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23918 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23919 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23920 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23924 Output LEN glyphs starting at START at the nominal cursor position.
23925 Advance the nominal cursor over the text. The global variable
23926 updated_window contains the window being updated, updated_row is
23927 the glyph row being updated, and updated_area is the area of that
23928 row being updated. */
23931 x_write_glyphs (struct glyph
*start
, int len
)
23935 xassert (updated_window
&& updated_row
);
23938 /* Write glyphs. */
23940 hpos
= start
- updated_row
->glyphs
[updated_area
];
23941 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23942 updated_row
, updated_area
,
23944 DRAW_NORMAL_TEXT
, 0);
23946 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23947 if (updated_area
== TEXT_AREA
23948 && updated_window
->phys_cursor_on_p
23949 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23950 && updated_window
->phys_cursor
.hpos
>= hpos
23951 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23952 updated_window
->phys_cursor_on_p
= 0;
23956 /* Advance the output cursor. */
23957 output_cursor
.hpos
+= len
;
23958 output_cursor
.x
= x
;
23963 Insert LEN glyphs from START at the nominal cursor position. */
23966 x_insert_glyphs (struct glyph
*start
, int len
)
23970 int line_height
, shift_by_width
, shifted_region_width
;
23971 struct glyph_row
*row
;
23972 struct glyph
*glyph
;
23973 int frame_x
, frame_y
;
23976 xassert (updated_window
&& updated_row
);
23978 w
= updated_window
;
23979 f
= XFRAME (WINDOW_FRAME (w
));
23981 /* Get the height of the line we are in. */
23983 line_height
= row
->height
;
23985 /* Get the width of the glyphs to insert. */
23986 shift_by_width
= 0;
23987 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23988 shift_by_width
+= glyph
->pixel_width
;
23990 /* Get the width of the region to shift right. */
23991 shifted_region_width
= (window_box_width (w
, updated_area
)
23996 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23997 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23999 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24000 line_height
, shift_by_width
);
24002 /* Write the glyphs. */
24003 hpos
= start
- row
->glyphs
[updated_area
];
24004 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24006 DRAW_NORMAL_TEXT
, 0);
24008 /* Advance the output cursor. */
24009 output_cursor
.hpos
+= len
;
24010 output_cursor
.x
+= shift_by_width
;
24016 Erase the current text line from the nominal cursor position
24017 (inclusive) to pixel column TO_X (exclusive). The idea is that
24018 everything from TO_X onward is already erased.
24020 TO_X is a pixel position relative to updated_area of
24021 updated_window. TO_X == -1 means clear to the end of this area. */
24024 x_clear_end_of_line (int to_x
)
24027 struct window
*w
= updated_window
;
24028 int max_x
, min_y
, max_y
;
24029 int from_x
, from_y
, to_y
;
24031 xassert (updated_window
&& updated_row
);
24032 f
= XFRAME (w
->frame
);
24034 if (updated_row
->full_width_p
)
24035 max_x
= WINDOW_TOTAL_WIDTH (w
);
24037 max_x
= window_box_width (w
, updated_area
);
24038 max_y
= window_text_bottom_y (w
);
24040 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24041 of window. For TO_X > 0, truncate to end of drawing area. */
24047 to_x
= min (to_x
, max_x
);
24049 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24051 /* Notice if the cursor will be cleared by this operation. */
24052 if (!updated_row
->full_width_p
)
24053 notice_overwritten_cursor (w
, updated_area
,
24054 output_cursor
.x
, -1,
24056 MATRIX_ROW_BOTTOM_Y (updated_row
));
24058 from_x
= output_cursor
.x
;
24060 /* Translate to frame coordinates. */
24061 if (updated_row
->full_width_p
)
24063 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24064 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24068 int area_left
= window_box_left (w
, updated_area
);
24069 from_x
+= area_left
;
24073 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24074 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24075 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24077 /* Prevent inadvertently clearing to end of the X window. */
24078 if (to_x
> from_x
&& to_y
> from_y
)
24081 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24082 to_x
- from_x
, to_y
- from_y
);
24087 #endif /* HAVE_WINDOW_SYSTEM */
24091 /***********************************************************************
24093 ***********************************************************************/
24095 /* Value is the internal representation of the specified cursor type
24096 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24097 of the bar cursor. */
24099 static enum text_cursor_kinds
24100 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24102 enum text_cursor_kinds type
;
24107 if (EQ (arg
, Qbox
))
24108 return FILLED_BOX_CURSOR
;
24110 if (EQ (arg
, Qhollow
))
24111 return HOLLOW_BOX_CURSOR
;
24113 if (EQ (arg
, Qbar
))
24120 && EQ (XCAR (arg
), Qbar
)
24121 && INTEGERP (XCDR (arg
))
24122 && XINT (XCDR (arg
)) >= 0)
24124 *width
= XINT (XCDR (arg
));
24128 if (EQ (arg
, Qhbar
))
24131 return HBAR_CURSOR
;
24135 && EQ (XCAR (arg
), Qhbar
)
24136 && INTEGERP (XCDR (arg
))
24137 && XINT (XCDR (arg
)) >= 0)
24139 *width
= XINT (XCDR (arg
));
24140 return HBAR_CURSOR
;
24143 /* Treat anything unknown as "hollow box cursor".
24144 It was bad to signal an error; people have trouble fixing
24145 .Xdefaults with Emacs, when it has something bad in it. */
24146 type
= HOLLOW_BOX_CURSOR
;
24151 /* Set the default cursor types for specified frame. */
24153 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24158 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24159 FRAME_CURSOR_WIDTH (f
) = width
;
24161 /* By default, set up the blink-off state depending on the on-state. */
24163 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24166 FRAME_BLINK_OFF_CURSOR (f
)
24167 = get_specified_cursor_type (XCDR (tem
), &width
);
24168 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24171 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24175 #ifdef HAVE_WINDOW_SYSTEM
24177 /* Return the cursor we want to be displayed in window W. Return
24178 width of bar/hbar cursor through WIDTH arg. Return with
24179 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24180 (i.e. if the `system caret' should track this cursor).
24182 In a mini-buffer window, we want the cursor only to appear if we
24183 are reading input from this window. For the selected window, we
24184 want the cursor type given by the frame parameter or buffer local
24185 setting of cursor-type. If explicitly marked off, draw no cursor.
24186 In all other cases, we want a hollow box cursor. */
24188 static enum text_cursor_kinds
24189 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24190 int *active_cursor
)
24192 struct frame
*f
= XFRAME (w
->frame
);
24193 struct buffer
*b
= XBUFFER (w
->buffer
);
24194 int cursor_type
= DEFAULT_CURSOR
;
24195 Lisp_Object alt_cursor
;
24196 int non_selected
= 0;
24198 *active_cursor
= 1;
24201 if (cursor_in_echo_area
24202 && FRAME_HAS_MINIBUF_P (f
)
24203 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24205 if (w
== XWINDOW (echo_area_window
))
24207 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24209 *width
= FRAME_CURSOR_WIDTH (f
);
24210 return FRAME_DESIRED_CURSOR (f
);
24213 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24216 *active_cursor
= 0;
24220 /* Detect a nonselected window or nonselected frame. */
24221 else if (w
!= XWINDOW (f
->selected_window
)
24222 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24224 *active_cursor
= 0;
24226 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24232 /* Never display a cursor in a window in which cursor-type is nil. */
24233 if (NILP (BVAR (b
, cursor_type
)))
24236 /* Get the normal cursor type for this window. */
24237 if (EQ (BVAR (b
, cursor_type
), Qt
))
24239 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24240 *width
= FRAME_CURSOR_WIDTH (f
);
24243 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24245 /* Use cursor-in-non-selected-windows instead
24246 for non-selected window or frame. */
24249 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24250 if (!EQ (Qt
, alt_cursor
))
24251 return get_specified_cursor_type (alt_cursor
, width
);
24252 /* t means modify the normal cursor type. */
24253 if (cursor_type
== FILLED_BOX_CURSOR
)
24254 cursor_type
= HOLLOW_BOX_CURSOR
;
24255 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24257 return cursor_type
;
24260 /* Use normal cursor if not blinked off. */
24261 if (!w
->cursor_off_p
)
24263 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24265 if (cursor_type
== FILLED_BOX_CURSOR
)
24267 /* Using a block cursor on large images can be very annoying.
24268 So use a hollow cursor for "large" images.
24269 If image is not transparent (no mask), also use hollow cursor. */
24270 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24271 if (img
!= NULL
&& IMAGEP (img
->spec
))
24273 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24274 where N = size of default frame font size.
24275 This should cover most of the "tiny" icons people may use. */
24277 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24278 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24279 cursor_type
= HOLLOW_BOX_CURSOR
;
24282 else if (cursor_type
!= NO_CURSOR
)
24284 /* Display current only supports BOX and HOLLOW cursors for images.
24285 So for now, unconditionally use a HOLLOW cursor when cursor is
24286 not a solid box cursor. */
24287 cursor_type
= HOLLOW_BOX_CURSOR
;
24290 return cursor_type
;
24293 /* Cursor is blinked off, so determine how to "toggle" it. */
24295 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24296 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24297 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24299 /* Then see if frame has specified a specific blink off cursor type. */
24300 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24302 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24303 return FRAME_BLINK_OFF_CURSOR (f
);
24307 /* Some people liked having a permanently visible blinking cursor,
24308 while others had very strong opinions against it. So it was
24309 decided to remove it. KFS 2003-09-03 */
24311 /* Finally perform built-in cursor blinking:
24312 filled box <-> hollow box
24313 wide [h]bar <-> narrow [h]bar
24314 narrow [h]bar <-> no cursor
24315 other type <-> no cursor */
24317 if (cursor_type
== FILLED_BOX_CURSOR
)
24318 return HOLLOW_BOX_CURSOR
;
24320 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24323 return cursor_type
;
24331 /* Notice when the text cursor of window W has been completely
24332 overwritten by a drawing operation that outputs glyphs in AREA
24333 starting at X0 and ending at X1 in the line starting at Y0 and
24334 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24335 the rest of the line after X0 has been written. Y coordinates
24336 are window-relative. */
24339 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24340 int x0
, int x1
, int y0
, int y1
)
24342 int cx0
, cx1
, cy0
, cy1
;
24343 struct glyph_row
*row
;
24345 if (!w
->phys_cursor_on_p
)
24347 if (area
!= TEXT_AREA
)
24350 if (w
->phys_cursor
.vpos
< 0
24351 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24352 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24353 !(row
->enabled_p
&& row
->displays_text_p
)))
24356 if (row
->cursor_in_fringe_p
)
24358 row
->cursor_in_fringe_p
= 0;
24359 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24360 w
->phys_cursor_on_p
= 0;
24364 cx0
= w
->phys_cursor
.x
;
24365 cx1
= cx0
+ w
->phys_cursor_width
;
24366 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24369 /* The cursor image will be completely removed from the
24370 screen if the output area intersects the cursor area in
24371 y-direction. When we draw in [y0 y1[, and some part of
24372 the cursor is at y < y0, that part must have been drawn
24373 before. When scrolling, the cursor is erased before
24374 actually scrolling, so we don't come here. When not
24375 scrolling, the rows above the old cursor row must have
24376 changed, and in this case these rows must have written
24377 over the cursor image.
24379 Likewise if part of the cursor is below y1, with the
24380 exception of the cursor being in the first blank row at
24381 the buffer and window end because update_text_area
24382 doesn't draw that row. (Except when it does, but
24383 that's handled in update_text_area.) */
24385 cy0
= w
->phys_cursor
.y
;
24386 cy1
= cy0
+ w
->phys_cursor_height
;
24387 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24390 w
->phys_cursor_on_p
= 0;
24393 #endif /* HAVE_WINDOW_SYSTEM */
24396 /************************************************************************
24398 ************************************************************************/
24400 #ifdef HAVE_WINDOW_SYSTEM
24403 Fix the display of area AREA of overlapping row ROW in window W
24404 with respect to the overlapping part OVERLAPS. */
24407 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24408 enum glyph_row_area area
, int overlaps
)
24415 for (i
= 0; i
< row
->used
[area
];)
24417 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24419 int start
= i
, start_x
= x
;
24423 x
+= row
->glyphs
[area
][i
].pixel_width
;
24426 while (i
< row
->used
[area
]
24427 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24429 draw_glyphs (w
, start_x
, row
, area
,
24431 DRAW_NORMAL_TEXT
, overlaps
);
24435 x
+= row
->glyphs
[area
][i
].pixel_width
;
24445 Draw the cursor glyph of window W in glyph row ROW. See the
24446 comment of draw_glyphs for the meaning of HL. */
24449 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24450 enum draw_glyphs_face hl
)
24452 /* If cursor hpos is out of bounds, don't draw garbage. This can
24453 happen in mini-buffer windows when switching between echo area
24454 glyphs and mini-buffer. */
24455 if ((row
->reversed_p
24456 ? (w
->phys_cursor
.hpos
>= 0)
24457 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24459 int on_p
= w
->phys_cursor_on_p
;
24461 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24462 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24464 w
->phys_cursor_on_p
= on_p
;
24466 if (hl
== DRAW_CURSOR
)
24467 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24468 /* When we erase the cursor, and ROW is overlapped by other
24469 rows, make sure that these overlapping parts of other rows
24471 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24473 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24475 if (row
> w
->current_matrix
->rows
24476 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24477 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24478 OVERLAPS_ERASED_CURSOR
);
24480 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24481 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24482 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24483 OVERLAPS_ERASED_CURSOR
);
24490 Erase the image of a cursor of window W from the screen. */
24493 erase_phys_cursor (struct window
*w
)
24495 struct frame
*f
= XFRAME (w
->frame
);
24496 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24497 int hpos
= w
->phys_cursor
.hpos
;
24498 int vpos
= w
->phys_cursor
.vpos
;
24499 int mouse_face_here_p
= 0;
24500 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24501 struct glyph_row
*cursor_row
;
24502 struct glyph
*cursor_glyph
;
24503 enum draw_glyphs_face hl
;
24505 /* No cursor displayed or row invalidated => nothing to do on the
24507 if (w
->phys_cursor_type
== NO_CURSOR
)
24508 goto mark_cursor_off
;
24510 /* VPOS >= active_glyphs->nrows means that window has been resized.
24511 Don't bother to erase the cursor. */
24512 if (vpos
>= active_glyphs
->nrows
)
24513 goto mark_cursor_off
;
24515 /* If row containing cursor is marked invalid, there is nothing we
24517 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24518 if (!cursor_row
->enabled_p
)
24519 goto mark_cursor_off
;
24521 /* If line spacing is > 0, old cursor may only be partially visible in
24522 window after split-window. So adjust visible height. */
24523 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24524 window_text_bottom_y (w
) - cursor_row
->y
);
24526 /* If row is completely invisible, don't attempt to delete a cursor which
24527 isn't there. This can happen if cursor is at top of a window, and
24528 we switch to a buffer with a header line in that window. */
24529 if (cursor_row
->visible_height
<= 0)
24530 goto mark_cursor_off
;
24532 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24533 if (cursor_row
->cursor_in_fringe_p
)
24535 cursor_row
->cursor_in_fringe_p
= 0;
24536 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24537 goto mark_cursor_off
;
24540 /* This can happen when the new row is shorter than the old one.
24541 In this case, either draw_glyphs or clear_end_of_line
24542 should have cleared the cursor. Note that we wouldn't be
24543 able to erase the cursor in this case because we don't have a
24544 cursor glyph at hand. */
24545 if ((cursor_row
->reversed_p
24546 ? (w
->phys_cursor
.hpos
< 0)
24547 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24548 goto mark_cursor_off
;
24550 /* If the cursor is in the mouse face area, redisplay that when
24551 we clear the cursor. */
24552 if (! NILP (hlinfo
->mouse_face_window
)
24553 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24554 /* Don't redraw the cursor's spot in mouse face if it is at the
24555 end of a line (on a newline). The cursor appears there, but
24556 mouse highlighting does not. */
24557 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24558 mouse_face_here_p
= 1;
24560 /* Maybe clear the display under the cursor. */
24561 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24564 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24567 cursor_glyph
= get_phys_cursor_glyph (w
);
24568 if (cursor_glyph
== NULL
)
24569 goto mark_cursor_off
;
24571 width
= cursor_glyph
->pixel_width
;
24572 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24573 x
= w
->phys_cursor
.x
;
24575 width
-= left_x
- x
;
24576 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24577 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24578 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24581 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24584 /* Erase the cursor by redrawing the character underneath it. */
24585 if (mouse_face_here_p
)
24586 hl
= DRAW_MOUSE_FACE
;
24588 hl
= DRAW_NORMAL_TEXT
;
24589 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24592 w
->phys_cursor_on_p
= 0;
24593 w
->phys_cursor_type
= NO_CURSOR
;
24598 Display or clear cursor of window W. If ON is zero, clear the
24599 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24600 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24603 display_and_set_cursor (struct window
*w
, int on
,
24604 int hpos
, int vpos
, int x
, int y
)
24606 struct frame
*f
= XFRAME (w
->frame
);
24607 int new_cursor_type
;
24608 int new_cursor_width
;
24610 struct glyph_row
*glyph_row
;
24611 struct glyph
*glyph
;
24613 /* This is pointless on invisible frames, and dangerous on garbaged
24614 windows and frames; in the latter case, the frame or window may
24615 be in the midst of changing its size, and x and y may be off the
24617 if (! FRAME_VISIBLE_P (f
)
24618 || FRAME_GARBAGED_P (f
)
24619 || vpos
>= w
->current_matrix
->nrows
24620 || hpos
>= w
->current_matrix
->matrix_w
)
24623 /* If cursor is off and we want it off, return quickly. */
24624 if (!on
&& !w
->phys_cursor_on_p
)
24627 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24628 /* If cursor row is not enabled, we don't really know where to
24629 display the cursor. */
24630 if (!glyph_row
->enabled_p
)
24632 w
->phys_cursor_on_p
= 0;
24637 if (!glyph_row
->exact_window_width_line_p
24638 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24639 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24641 xassert (interrupt_input_blocked
);
24643 /* Set new_cursor_type to the cursor we want to be displayed. */
24644 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24645 &new_cursor_width
, &active_cursor
);
24647 /* If cursor is currently being shown and we don't want it to be or
24648 it is in the wrong place, or the cursor type is not what we want,
24650 if (w
->phys_cursor_on_p
24652 || w
->phys_cursor
.x
!= x
24653 || w
->phys_cursor
.y
!= y
24654 || new_cursor_type
!= w
->phys_cursor_type
24655 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24656 && new_cursor_width
!= w
->phys_cursor_width
)))
24657 erase_phys_cursor (w
);
24659 /* Don't check phys_cursor_on_p here because that flag is only set
24660 to zero in some cases where we know that the cursor has been
24661 completely erased, to avoid the extra work of erasing the cursor
24662 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24663 still not be visible, or it has only been partly erased. */
24666 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24667 w
->phys_cursor_height
= glyph_row
->height
;
24669 /* Set phys_cursor_.* before x_draw_.* is called because some
24670 of them may need the information. */
24671 w
->phys_cursor
.x
= x
;
24672 w
->phys_cursor
.y
= glyph_row
->y
;
24673 w
->phys_cursor
.hpos
= hpos
;
24674 w
->phys_cursor
.vpos
= vpos
;
24677 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24678 new_cursor_type
, new_cursor_width
,
24679 on
, active_cursor
);
24683 /* Switch the display of W's cursor on or off, according to the value
24687 update_window_cursor (struct window
*w
, int on
)
24689 /* Don't update cursor in windows whose frame is in the process
24690 of being deleted. */
24691 if (w
->current_matrix
)
24694 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24695 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24701 /* Call update_window_cursor with parameter ON_P on all leaf windows
24702 in the window tree rooted at W. */
24705 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24709 if (!NILP (w
->hchild
))
24710 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24711 else if (!NILP (w
->vchild
))
24712 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24714 update_window_cursor (w
, on_p
);
24716 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24722 Display the cursor on window W, or clear it, according to ON_P.
24723 Don't change the cursor's position. */
24726 x_update_cursor (struct frame
*f
, int on_p
)
24728 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24733 Clear the cursor of window W to background color, and mark the
24734 cursor as not shown. This is used when the text where the cursor
24735 is about to be rewritten. */
24738 x_clear_cursor (struct window
*w
)
24740 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24741 update_window_cursor (w
, 0);
24744 #endif /* HAVE_WINDOW_SYSTEM */
24746 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24749 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24750 int start_hpos
, int end_hpos
,
24751 enum draw_glyphs_face draw
)
24753 #ifdef HAVE_WINDOW_SYSTEM
24754 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24756 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24760 #if defined (HAVE_GPM) || defined (MSDOS)
24761 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24765 /* Display the active region described by mouse_face_* according to DRAW. */
24768 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24770 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24771 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24773 if (/* If window is in the process of being destroyed, don't bother
24775 w
->current_matrix
!= NULL
24776 /* Don't update mouse highlight if hidden */
24777 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24778 /* Recognize when we are called to operate on rows that don't exist
24779 anymore. This can happen when a window is split. */
24780 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24782 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24783 struct glyph_row
*row
, *first
, *last
;
24785 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24786 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24788 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24790 int start_hpos
, end_hpos
, start_x
;
24792 /* For all but the first row, the highlight starts at column 0. */
24795 /* R2L rows have BEG and END in reversed order, but the
24796 screen drawing geometry is always left to right. So
24797 we need to mirror the beginning and end of the
24798 highlighted area in R2L rows. */
24799 if (!row
->reversed_p
)
24801 start_hpos
= hlinfo
->mouse_face_beg_col
;
24802 start_x
= hlinfo
->mouse_face_beg_x
;
24804 else if (row
== last
)
24806 start_hpos
= hlinfo
->mouse_face_end_col
;
24807 start_x
= hlinfo
->mouse_face_end_x
;
24815 else if (row
->reversed_p
&& row
== last
)
24817 start_hpos
= hlinfo
->mouse_face_end_col
;
24818 start_x
= hlinfo
->mouse_face_end_x
;
24828 if (!row
->reversed_p
)
24829 end_hpos
= hlinfo
->mouse_face_end_col
;
24830 else if (row
== first
)
24831 end_hpos
= hlinfo
->mouse_face_beg_col
;
24834 end_hpos
= row
->used
[TEXT_AREA
];
24835 if (draw
== DRAW_NORMAL_TEXT
)
24836 row
->fill_line_p
= 1; /* Clear to end of line */
24839 else if (row
->reversed_p
&& row
== first
)
24840 end_hpos
= hlinfo
->mouse_face_beg_col
;
24843 end_hpos
= row
->used
[TEXT_AREA
];
24844 if (draw
== DRAW_NORMAL_TEXT
)
24845 row
->fill_line_p
= 1; /* Clear to end of line */
24848 if (end_hpos
> start_hpos
)
24850 draw_row_with_mouse_face (w
, start_x
, row
,
24851 start_hpos
, end_hpos
, draw
);
24854 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24858 #ifdef HAVE_WINDOW_SYSTEM
24859 /* When we've written over the cursor, arrange for it to
24860 be displayed again. */
24861 if (FRAME_WINDOW_P (f
)
24862 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24865 display_and_set_cursor (w
, 1,
24866 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24867 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24870 #endif /* HAVE_WINDOW_SYSTEM */
24873 #ifdef HAVE_WINDOW_SYSTEM
24874 /* Change the mouse cursor. */
24875 if (FRAME_WINDOW_P (f
))
24877 if (draw
== DRAW_NORMAL_TEXT
24878 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24879 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24880 else if (draw
== DRAW_MOUSE_FACE
)
24881 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24883 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24885 #endif /* HAVE_WINDOW_SYSTEM */
24889 Clear out the mouse-highlighted active region.
24890 Redraw it un-highlighted first. Value is non-zero if mouse
24891 face was actually drawn unhighlighted. */
24894 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24898 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24900 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24904 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24905 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24906 hlinfo
->mouse_face_window
= Qnil
;
24907 hlinfo
->mouse_face_overlay
= Qnil
;
24911 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24912 within the mouse face on that window. */
24914 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24916 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24918 /* Quickly resolve the easy cases. */
24919 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24920 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24922 if (vpos
< hlinfo
->mouse_face_beg_row
24923 || vpos
> hlinfo
->mouse_face_end_row
)
24925 if (vpos
> hlinfo
->mouse_face_beg_row
24926 && vpos
< hlinfo
->mouse_face_end_row
)
24929 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24931 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24933 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24936 else if ((vpos
== hlinfo
->mouse_face_beg_row
24937 && hpos
>= hlinfo
->mouse_face_beg_col
)
24938 || (vpos
== hlinfo
->mouse_face_end_row
24939 && hpos
< hlinfo
->mouse_face_end_col
))
24944 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24946 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24949 else if ((vpos
== hlinfo
->mouse_face_beg_row
24950 && hpos
<= hlinfo
->mouse_face_beg_col
)
24951 || (vpos
== hlinfo
->mouse_face_end_row
24952 && hpos
> hlinfo
->mouse_face_end_col
))
24960 Non-zero if physical cursor of window W is within mouse face. */
24963 cursor_in_mouse_face_p (struct window
*w
)
24965 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24970 /* Find the glyph rows START_ROW and END_ROW of window W that display
24971 characters between buffer positions START_CHARPOS and END_CHARPOS
24972 (excluding END_CHARPOS). This is similar to row_containing_pos,
24973 but is more accurate when bidi reordering makes buffer positions
24974 change non-linearly with glyph rows. */
24976 rows_from_pos_range (struct window
*w
,
24977 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24978 struct glyph_row
**start
, struct glyph_row
**end
)
24980 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24981 int last_y
= window_text_bottom_y (w
);
24982 struct glyph_row
*row
;
24987 while (!first
->enabled_p
24988 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24991 /* Find the START row. */
24993 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24996 /* A row can potentially be the START row if the range of the
24997 characters it displays intersects the range
24998 [START_CHARPOS..END_CHARPOS). */
24999 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25000 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25001 /* See the commentary in row_containing_pos, for the
25002 explanation of the complicated way to check whether
25003 some position is beyond the end of the characters
25004 displayed by a row. */
25005 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25006 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25007 && !row
->ends_at_zv_p
25008 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25009 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25010 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25011 && !row
->ends_at_zv_p
25012 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25014 /* Found a candidate row. Now make sure at least one of the
25015 glyphs it displays has a charpos from the range
25016 [START_CHARPOS..END_CHARPOS).
25018 This is not obvious because bidi reordering could make
25019 buffer positions of a row be 1,2,3,102,101,100, and if we
25020 want to highlight characters in [50..60), we don't want
25021 this row, even though [50..60) does intersect [1..103),
25022 the range of character positions given by the row's start
25023 and end positions. */
25024 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25025 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25029 if (BUFFERP (g
->object
)
25030 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25039 /* Find the END row. */
25041 /* If the last row is partially visible, start looking for END
25042 from that row, instead of starting from FIRST. */
25043 && !(row
->enabled_p
25044 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25046 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25048 struct glyph_row
*next
= row
+ 1;
25050 if (!next
->enabled_p
25051 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25052 /* The first row >= START whose range of displayed characters
25053 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25054 is the row END + 1. */
25055 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25056 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25057 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25058 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25059 && !next
->ends_at_zv_p
25060 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25061 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25062 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25063 && !next
->ends_at_zv_p
25064 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25071 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25072 but none of the characters it displays are in the range, it is
25074 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25075 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25079 if (BUFFERP (g
->object
)
25080 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25093 /* This function sets the mouse_face_* elements of HLINFO, assuming
25094 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25095 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25096 for the overlay or run of text properties specifying the mouse
25097 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25098 before-string and after-string that must also be highlighted.
25099 COVER_STRING, if non-nil, is a display string that may cover some
25100 or all of the highlighted text. */
25103 mouse_face_from_buffer_pos (Lisp_Object window
,
25104 Mouse_HLInfo
*hlinfo
,
25105 EMACS_INT mouse_charpos
,
25106 EMACS_INT start_charpos
,
25107 EMACS_INT end_charpos
,
25108 Lisp_Object before_string
,
25109 Lisp_Object after_string
,
25110 Lisp_Object cover_string
)
25112 struct window
*w
= XWINDOW (window
);
25113 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25114 struct glyph_row
*r1
, *r2
;
25115 struct glyph
*glyph
, *end
;
25116 EMACS_INT ignore
, pos
;
25119 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25120 xassert (NILP (before_string
) || STRINGP (before_string
));
25121 xassert (NILP (after_string
) || STRINGP (after_string
));
25123 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25124 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25126 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25127 /* If the before-string or display-string contains newlines,
25128 rows_from_pos_range skips to its last row. Move back. */
25129 if (!NILP (before_string
) || !NILP (cover_string
))
25131 struct glyph_row
*prev
;
25132 while ((prev
= r1
- 1, prev
>= first
)
25133 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25134 && prev
->used
[TEXT_AREA
] > 0)
25136 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25137 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25138 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25140 || !(EQ (glyph
->object
, before_string
)
25141 || EQ (glyph
->object
, cover_string
)))
25148 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25149 hlinfo
->mouse_face_past_end
= 1;
25151 else if (!NILP (after_string
))
25153 /* If the after-string has newlines, advance to its last row. */
25154 struct glyph_row
*next
;
25155 struct glyph_row
*last
25156 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25158 for (next
= r2
+ 1;
25160 && next
->used
[TEXT_AREA
] > 0
25161 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25165 /* The rest of the display engine assumes that mouse_face_beg_row is
25166 either above below mouse_face_end_row or identical to it. But
25167 with bidi-reordered continued lines, the row for START_CHARPOS
25168 could be below the row for END_CHARPOS. If so, swap the rows and
25169 store them in correct order. */
25172 struct glyph_row
*tem
= r2
;
25178 hlinfo
->mouse_face_beg_y
= r1
->y
;
25179 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25180 hlinfo
->mouse_face_end_y
= r2
->y
;
25181 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25183 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25184 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25185 could be anywhere in the row and in any order. The strategy
25186 below is to find the leftmost and the rightmost glyph that
25187 belongs to either of these 3 strings, or whose position is
25188 between START_CHARPOS and END_CHARPOS, and highlight all the
25189 glyphs between those two. This may cover more than just the text
25190 between START_CHARPOS and END_CHARPOS if the range of characters
25191 strides the bidi level boundary, e.g. if the beginning is in R2L
25192 text while the end is in L2R text or vice versa. */
25193 if (!r1
->reversed_p
)
25195 /* This row is in a left to right paragraph. Scan it left to
25197 glyph
= r1
->glyphs
[TEXT_AREA
];
25198 end
= glyph
+ r1
->used
[TEXT_AREA
];
25201 /* Skip truncation glyphs at the start of the glyph row. */
25202 if (r1
->displays_text_p
)
25204 && INTEGERP (glyph
->object
)
25205 && glyph
->charpos
< 0;
25207 x
+= glyph
->pixel_width
;
25209 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25210 or COVER_STRING, and the first glyph from buffer whose
25211 position is between START_CHARPOS and END_CHARPOS. */
25213 && !INTEGERP (glyph
->object
)
25214 && !EQ (glyph
->object
, cover_string
)
25215 && !(BUFFERP (glyph
->object
)
25216 && (glyph
->charpos
>= start_charpos
25217 && glyph
->charpos
< end_charpos
));
25220 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25221 are present at buffer positions between START_CHARPOS and
25222 END_CHARPOS, or if they come from an overlay. */
25223 if (EQ (glyph
->object
, before_string
))
25225 pos
= string_buffer_position (before_string
,
25227 /* If pos == 0, it means before_string came from an
25228 overlay, not from a buffer position. */
25229 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25232 else if (EQ (glyph
->object
, after_string
))
25234 pos
= string_buffer_position (after_string
, end_charpos
);
25235 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25238 x
+= glyph
->pixel_width
;
25240 hlinfo
->mouse_face_beg_x
= x
;
25241 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25245 /* This row is in a right to left paragraph. Scan it right to
25249 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25250 glyph
= end
+ r1
->used
[TEXT_AREA
];
25252 /* Skip truncation glyphs at the start of the glyph row. */
25253 if (r1
->displays_text_p
)
25255 && INTEGERP (glyph
->object
)
25256 && glyph
->charpos
< 0;
25260 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25261 or COVER_STRING, and the first glyph from buffer whose
25262 position is between START_CHARPOS and END_CHARPOS. */
25264 && !INTEGERP (glyph
->object
)
25265 && !EQ (glyph
->object
, cover_string
)
25266 && !(BUFFERP (glyph
->object
)
25267 && (glyph
->charpos
>= start_charpos
25268 && glyph
->charpos
< end_charpos
));
25271 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25272 are present at buffer positions between START_CHARPOS and
25273 END_CHARPOS, or if they come from an overlay. */
25274 if (EQ (glyph
->object
, before_string
))
25276 pos
= string_buffer_position (before_string
, start_charpos
);
25277 /* If pos == 0, it means before_string came from an
25278 overlay, not from a buffer position. */
25279 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25282 else if (EQ (glyph
->object
, after_string
))
25284 pos
= string_buffer_position (after_string
, end_charpos
);
25285 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25290 glyph
++; /* first glyph to the right of the highlighted area */
25291 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25292 x
+= g
->pixel_width
;
25293 hlinfo
->mouse_face_beg_x
= x
;
25294 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25297 /* If the highlight ends in a different row, compute GLYPH and END
25298 for the end row. Otherwise, reuse the values computed above for
25299 the row where the highlight begins. */
25302 if (!r2
->reversed_p
)
25304 glyph
= r2
->glyphs
[TEXT_AREA
];
25305 end
= glyph
+ r2
->used
[TEXT_AREA
];
25310 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25311 glyph
= end
+ r2
->used
[TEXT_AREA
];
25315 if (!r2
->reversed_p
)
25317 /* Skip truncation and continuation glyphs near the end of the
25318 row, and also blanks and stretch glyphs inserted by
25319 extend_face_to_end_of_line. */
25321 && INTEGERP ((end
- 1)->object
)
25322 && (end
- 1)->charpos
<= 0)
25324 /* Scan the rest of the glyph row from the end, looking for the
25325 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25326 COVER_STRING, or whose position is between START_CHARPOS
25330 && !INTEGERP (end
->object
)
25331 && !EQ (end
->object
, cover_string
)
25332 && !(BUFFERP (end
->object
)
25333 && (end
->charpos
>= start_charpos
25334 && end
->charpos
< end_charpos
));
25337 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25338 are present at buffer positions between START_CHARPOS and
25339 END_CHARPOS, or if they come from an overlay. */
25340 if (EQ (end
->object
, before_string
))
25342 pos
= string_buffer_position (before_string
, start_charpos
);
25343 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25346 else if (EQ (end
->object
, after_string
))
25348 pos
= string_buffer_position (after_string
, end_charpos
);
25349 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25353 /* Find the X coordinate of the last glyph to be highlighted. */
25354 for (; glyph
<= end
; ++glyph
)
25355 x
+= glyph
->pixel_width
;
25357 hlinfo
->mouse_face_end_x
= x
;
25358 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25362 /* Skip truncation and continuation glyphs near the end of the
25363 row, and also blanks and stretch glyphs inserted by
25364 extend_face_to_end_of_line. */
25368 && INTEGERP (end
->object
)
25369 && end
->charpos
<= 0)
25371 x
+= end
->pixel_width
;
25374 /* Scan the rest of the glyph row from the end, looking for the
25375 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25376 COVER_STRING, or whose position is between START_CHARPOS
25380 && !INTEGERP (end
->object
)
25381 && !EQ (end
->object
, cover_string
)
25382 && !(BUFFERP (end
->object
)
25383 && (end
->charpos
>= start_charpos
25384 && end
->charpos
< end_charpos
));
25387 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25388 are present at buffer positions between START_CHARPOS and
25389 END_CHARPOS, or if they come from an overlay. */
25390 if (EQ (end
->object
, before_string
))
25392 pos
= string_buffer_position (before_string
, start_charpos
);
25393 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25396 else if (EQ (end
->object
, after_string
))
25398 pos
= string_buffer_position (after_string
, end_charpos
);
25399 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25402 x
+= end
->pixel_width
;
25404 hlinfo
->mouse_face_end_x
= x
;
25405 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25408 hlinfo
->mouse_face_window
= window
;
25409 hlinfo
->mouse_face_face_id
25410 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25412 !hlinfo
->mouse_face_hidden
, -1);
25413 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25416 /* The following function is not used anymore (replaced with
25417 mouse_face_from_string_pos), but I leave it here for the time
25418 being, in case someone would. */
25420 #if 0 /* not used */
25422 /* Find the position of the glyph for position POS in OBJECT in
25423 window W's current matrix, and return in *X, *Y the pixel
25424 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25426 RIGHT_P non-zero means return the position of the right edge of the
25427 glyph, RIGHT_P zero means return the left edge position.
25429 If no glyph for POS exists in the matrix, return the position of
25430 the glyph with the next smaller position that is in the matrix, if
25431 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25432 exists in the matrix, return the position of the glyph with the
25433 next larger position in OBJECT.
25435 Value is non-zero if a glyph was found. */
25438 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25439 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25441 int yb
= window_text_bottom_y (w
);
25442 struct glyph_row
*r
;
25443 struct glyph
*best_glyph
= NULL
;
25444 struct glyph_row
*best_row
= NULL
;
25447 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25448 r
->enabled_p
&& r
->y
< yb
;
25451 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25452 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25455 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25456 if (EQ (g
->object
, object
))
25458 if (g
->charpos
== pos
)
25465 else if (best_glyph
== NULL
25466 || ((eabs (g
->charpos
- pos
)
25467 < eabs (best_glyph
->charpos
- pos
))
25470 : g
->charpos
> pos
)))
25484 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25488 *x
+= best_glyph
->pixel_width
;
25493 *vpos
= best_row
- w
->current_matrix
->rows
;
25496 return best_glyph
!= NULL
;
25498 #endif /* not used */
25500 /* Find the positions of the first and the last glyphs in window W's
25501 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25502 (assumed to be a string), and return in HLINFO's mouse_face_*
25503 members the pixel and column/row coordinates of those glyphs. */
25506 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25507 Lisp_Object object
,
25508 EMACS_INT startpos
, EMACS_INT endpos
)
25510 int yb
= window_text_bottom_y (w
);
25511 struct glyph_row
*r
;
25512 struct glyph
*g
, *e
;
25516 /* Find the glyph row with at least one position in the range
25517 [STARTPOS..ENDPOS], and the first glyph in that row whose
25518 position belongs to that range. */
25519 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25520 r
->enabled_p
&& r
->y
< yb
;
25523 if (!r
->reversed_p
)
25525 g
= r
->glyphs
[TEXT_AREA
];
25526 e
= g
+ r
->used
[TEXT_AREA
];
25527 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25528 if (EQ (g
->object
, object
)
25529 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25531 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25532 hlinfo
->mouse_face_beg_y
= r
->y
;
25533 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25534 hlinfo
->mouse_face_beg_x
= gx
;
25543 e
= r
->glyphs
[TEXT_AREA
];
25544 g
= e
+ r
->used
[TEXT_AREA
];
25545 for ( ; g
> e
; --g
)
25546 if (EQ ((g
-1)->object
, object
)
25547 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25549 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25550 hlinfo
->mouse_face_beg_y
= r
->y
;
25551 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25552 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25553 gx
+= g1
->pixel_width
;
25554 hlinfo
->mouse_face_beg_x
= gx
;
25566 /* Starting with the next row, look for the first row which does NOT
25567 include any glyphs whose positions are in the range. */
25568 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25570 g
= r
->glyphs
[TEXT_AREA
];
25571 e
= g
+ r
->used
[TEXT_AREA
];
25573 for ( ; g
< e
; ++g
)
25574 if (EQ (g
->object
, object
)
25575 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25584 /* The highlighted region ends on the previous row. */
25587 /* Set the end row and its vertical pixel coordinate. */
25588 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25589 hlinfo
->mouse_face_end_y
= r
->y
;
25591 /* Compute and set the end column and the end column's horizontal
25592 pixel coordinate. */
25593 if (!r
->reversed_p
)
25595 g
= r
->glyphs
[TEXT_AREA
];
25596 e
= g
+ r
->used
[TEXT_AREA
];
25597 for ( ; e
> g
; --e
)
25598 if (EQ ((e
-1)->object
, object
)
25599 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25601 hlinfo
->mouse_face_end_col
= e
- g
;
25603 for (gx
= r
->x
; g
< e
; ++g
)
25604 gx
+= g
->pixel_width
;
25605 hlinfo
->mouse_face_end_x
= gx
;
25609 e
= r
->glyphs
[TEXT_AREA
];
25610 g
= e
+ r
->used
[TEXT_AREA
];
25611 for (gx
= r
->x
; e
< g
; ++e
)
25613 if (EQ (e
->object
, object
)
25614 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25616 gx
+= e
->pixel_width
;
25618 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25619 hlinfo
->mouse_face_end_x
= gx
;
25623 #ifdef HAVE_WINDOW_SYSTEM
25625 /* See if position X, Y is within a hot-spot of an image. */
25628 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25630 if (!CONSP (hot_spot
))
25633 if (EQ (XCAR (hot_spot
), Qrect
))
25635 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25636 Lisp_Object rect
= XCDR (hot_spot
);
25640 if (!CONSP (XCAR (rect
)))
25642 if (!CONSP (XCDR (rect
)))
25644 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25646 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25648 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25650 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25654 else if (EQ (XCAR (hot_spot
), Qcircle
))
25656 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25657 Lisp_Object circ
= XCDR (hot_spot
);
25658 Lisp_Object lr
, lx0
, ly0
;
25660 && CONSP (XCAR (circ
))
25661 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25662 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25663 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25665 double r
= XFLOATINT (lr
);
25666 double dx
= XINT (lx0
) - x
;
25667 double dy
= XINT (ly0
) - y
;
25668 return (dx
* dx
+ dy
* dy
<= r
* r
);
25671 else if (EQ (XCAR (hot_spot
), Qpoly
))
25673 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25674 if (VECTORP (XCDR (hot_spot
)))
25676 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25677 Lisp_Object
*poly
= v
->contents
;
25678 int n
= v
->header
.size
;
25681 Lisp_Object lx
, ly
;
25684 /* Need an even number of coordinates, and at least 3 edges. */
25685 if (n
< 6 || n
& 1)
25688 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25689 If count is odd, we are inside polygon. Pixels on edges
25690 may or may not be included depending on actual geometry of the
25692 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25693 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25695 x0
= XINT (lx
), y0
= XINT (ly
);
25696 for (i
= 0; i
< n
; i
+= 2)
25698 int x1
= x0
, y1
= y0
;
25699 if ((lx
= poly
[i
], !INTEGERP (lx
))
25700 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25702 x0
= XINT (lx
), y0
= XINT (ly
);
25704 /* Does this segment cross the X line? */
25712 if (y
> y0
&& y
> y1
)
25714 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25724 find_hot_spot (Lisp_Object map
, int x
, int y
)
25726 while (CONSP (map
))
25728 if (CONSP (XCAR (map
))
25729 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25737 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25739 doc
: /* Lookup in image map MAP coordinates X and Y.
25740 An image map is an alist where each element has the format (AREA ID PLIST).
25741 An AREA is specified as either a rectangle, a circle, or a polygon:
25742 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25743 pixel coordinates of the upper left and bottom right corners.
25744 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25745 and the radius of the circle; r may be a float or integer.
25746 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25747 vector describes one corner in the polygon.
25748 Returns the alist element for the first matching AREA in MAP. */)
25749 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25757 return find_hot_spot (map
, XINT (x
), XINT (y
));
25761 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25763 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25765 /* Do not change cursor shape while dragging mouse. */
25766 if (!NILP (do_mouse_tracking
))
25769 if (!NILP (pointer
))
25771 if (EQ (pointer
, Qarrow
))
25772 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25773 else if (EQ (pointer
, Qhand
))
25774 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25775 else if (EQ (pointer
, Qtext
))
25776 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25777 else if (EQ (pointer
, intern ("hdrag")))
25778 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25779 #ifdef HAVE_X_WINDOWS
25780 else if (EQ (pointer
, intern ("vdrag")))
25781 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25783 else if (EQ (pointer
, intern ("hourglass")))
25784 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25785 else if (EQ (pointer
, Qmodeline
))
25786 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25788 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25791 if (cursor
!= No_Cursor
)
25792 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25795 #endif /* HAVE_WINDOW_SYSTEM */
25797 /* Take proper action when mouse has moved to the mode or header line
25798 or marginal area AREA of window W, x-position X and y-position Y.
25799 X is relative to the start of the text display area of W, so the
25800 width of bitmap areas and scroll bars must be subtracted to get a
25801 position relative to the start of the mode line. */
25804 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25805 enum window_part area
)
25807 struct window
*w
= XWINDOW (window
);
25808 struct frame
*f
= XFRAME (w
->frame
);
25809 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25810 #ifdef HAVE_WINDOW_SYSTEM
25811 Display_Info
*dpyinfo
;
25813 Cursor cursor
= No_Cursor
;
25814 Lisp_Object pointer
= Qnil
;
25815 int dx
, dy
, width
, height
;
25817 Lisp_Object string
, object
= Qnil
;
25818 Lisp_Object pos
, help
;
25820 Lisp_Object mouse_face
;
25821 int original_x_pixel
= x
;
25822 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25823 struct glyph_row
*row
;
25825 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25830 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25831 returns them in row/column units! */
25832 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25833 &object
, &dx
, &dy
, &width
, &height
);
25835 row
= (area
== ON_MODE_LINE
25836 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25837 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25839 /* Find the glyph under the mouse pointer. */
25840 if (row
->mode_line_p
&& row
->enabled_p
)
25842 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25843 end
= glyph
+ row
->used
[TEXT_AREA
];
25845 for (x0
= original_x_pixel
;
25846 glyph
< end
&& x0
>= glyph
->pixel_width
;
25848 x0
-= glyph
->pixel_width
;
25856 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25857 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25858 returns them in row/column units! */
25859 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25860 &object
, &dx
, &dy
, &width
, &height
);
25865 #ifdef HAVE_WINDOW_SYSTEM
25866 if (IMAGEP (object
))
25868 Lisp_Object image_map
, hotspot
;
25869 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25871 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25873 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25877 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25878 If so, we could look for mouse-enter, mouse-leave
25879 properties in PLIST (and do something...). */
25880 hotspot
= XCDR (hotspot
);
25881 if (CONSP (hotspot
)
25882 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25884 pointer
= Fplist_get (plist
, Qpointer
);
25885 if (NILP (pointer
))
25887 help
= Fplist_get (plist
, Qhelp_echo
);
25890 help_echo_string
= help
;
25891 /* Is this correct? ++kfs */
25892 XSETWINDOW (help_echo_window
, w
);
25893 help_echo_object
= w
->buffer
;
25894 help_echo_pos
= charpos
;
25898 if (NILP (pointer
))
25899 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25901 #endif /* HAVE_WINDOW_SYSTEM */
25903 if (STRINGP (string
))
25905 pos
= make_number (charpos
);
25906 /* If we're on a string with `help-echo' text property, arrange
25907 for the help to be displayed. This is done by setting the
25908 global variable help_echo_string to the help string. */
25911 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25914 help_echo_string
= help
;
25915 XSETWINDOW (help_echo_window
, w
);
25916 help_echo_object
= string
;
25917 help_echo_pos
= charpos
;
25921 #ifdef HAVE_WINDOW_SYSTEM
25922 if (FRAME_WINDOW_P (f
))
25924 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25925 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25926 if (NILP (pointer
))
25927 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25929 /* Change the mouse pointer according to what is under X/Y. */
25931 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25934 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25935 if (!KEYMAPP (map
))
25936 map
= Fget_text_property (pos
, Qkeymap
, string
);
25937 if (!KEYMAPP (map
))
25938 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25943 /* Change the mouse face according to what is under X/Y. */
25944 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25945 if (!NILP (mouse_face
)
25946 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25951 struct glyph
* tmp_glyph
;
25955 int total_pixel_width
;
25956 EMACS_INT begpos
, endpos
, ignore
;
25960 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25961 Qmouse_face
, string
, Qnil
);
25967 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25969 endpos
= SCHARS (string
);
25973 /* Calculate the glyph position GPOS of GLYPH in the
25974 displayed string, relative to the beginning of the
25975 highlighted part of the string.
25977 Note: GPOS is different from CHARPOS. CHARPOS is the
25978 position of GLYPH in the internal string object. A mode
25979 line string format has structures which are converted to
25980 a flattened string by the Emacs Lisp interpreter. The
25981 internal string is an element of those structures. The
25982 displayed string is the flattened string. */
25983 tmp_glyph
= row_start_glyph
;
25984 while (tmp_glyph
< glyph
25985 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25986 && begpos
<= tmp_glyph
->charpos
25987 && tmp_glyph
->charpos
< endpos
)))
25989 gpos
= glyph
- tmp_glyph
;
25991 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25992 the highlighted part of the displayed string to which
25993 GLYPH belongs. Note: GSEQ_LENGTH is different from
25994 SCHARS (STRING), because the latter returns the length of
25995 the internal string. */
25996 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25998 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25999 && begpos
<= tmp_glyph
->charpos
26000 && tmp_glyph
->charpos
< endpos
));
26003 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26005 /* Calculate the total pixel width of all the glyphs between
26006 the beginning of the highlighted area and GLYPH. */
26007 total_pixel_width
= 0;
26008 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26009 total_pixel_width
+= tmp_glyph
->pixel_width
;
26011 /* Pre calculation of re-rendering position. Note: X is in
26012 column units here, after the call to mode_line_string or
26013 marginal_area_string. */
26015 vpos
= (area
== ON_MODE_LINE
26016 ? (w
->current_matrix
)->nrows
- 1
26019 /* If GLYPH's position is included in the region that is
26020 already drawn in mouse face, we have nothing to do. */
26021 if ( EQ (window
, hlinfo
->mouse_face_window
)
26022 && (!row
->reversed_p
26023 ? (hlinfo
->mouse_face_beg_col
<= hpos
26024 && hpos
< hlinfo
->mouse_face_end_col
)
26025 /* In R2L rows we swap BEG and END, see below. */
26026 : (hlinfo
->mouse_face_end_col
<= hpos
26027 && hpos
< hlinfo
->mouse_face_beg_col
))
26028 && hlinfo
->mouse_face_beg_row
== vpos
)
26031 if (clear_mouse_face (hlinfo
))
26032 cursor
= No_Cursor
;
26034 if (!row
->reversed_p
)
26036 hlinfo
->mouse_face_beg_col
= hpos
;
26037 hlinfo
->mouse_face_beg_x
= original_x_pixel
26038 - (total_pixel_width
+ dx
);
26039 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26040 hlinfo
->mouse_face_end_x
= 0;
26044 /* In R2L rows, show_mouse_face expects BEG and END
26045 coordinates to be swapped. */
26046 hlinfo
->mouse_face_end_col
= hpos
;
26047 hlinfo
->mouse_face_end_x
= original_x_pixel
26048 - (total_pixel_width
+ dx
);
26049 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26050 hlinfo
->mouse_face_beg_x
= 0;
26053 hlinfo
->mouse_face_beg_row
= vpos
;
26054 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26055 hlinfo
->mouse_face_beg_y
= 0;
26056 hlinfo
->mouse_face_end_y
= 0;
26057 hlinfo
->mouse_face_past_end
= 0;
26058 hlinfo
->mouse_face_window
= window
;
26060 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26066 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26068 if (NILP (pointer
))
26071 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26072 clear_mouse_face (hlinfo
);
26074 #ifdef HAVE_WINDOW_SYSTEM
26075 if (FRAME_WINDOW_P (f
))
26076 define_frame_cursor1 (f
, cursor
, pointer
);
26082 Take proper action when the mouse has moved to position X, Y on
26083 frame F as regards highlighting characters that have mouse-face
26084 properties. Also de-highlighting chars where the mouse was before.
26085 X and Y can be negative or out of range. */
26088 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26090 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26091 enum window_part part
;
26092 Lisp_Object window
;
26094 Cursor cursor
= No_Cursor
;
26095 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26098 /* When a menu is active, don't highlight because this looks odd. */
26099 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26100 if (popup_activated ())
26104 if (NILP (Vmouse_highlight
)
26105 || !f
->glyphs_initialized_p
26106 || f
->pointer_invisible
)
26109 hlinfo
->mouse_face_mouse_x
= x
;
26110 hlinfo
->mouse_face_mouse_y
= y
;
26111 hlinfo
->mouse_face_mouse_frame
= f
;
26113 if (hlinfo
->mouse_face_defer
)
26116 if (gc_in_progress
)
26118 hlinfo
->mouse_face_deferred_gc
= 1;
26122 /* Which window is that in? */
26123 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26125 /* If we were displaying active text in another window, clear that.
26126 Also clear if we move out of text area in same window. */
26127 if (! EQ (window
, hlinfo
->mouse_face_window
)
26128 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26129 && !NILP (hlinfo
->mouse_face_window
)))
26130 clear_mouse_face (hlinfo
);
26132 /* Not on a window -> return. */
26133 if (!WINDOWP (window
))
26136 /* Reset help_echo_string. It will get recomputed below. */
26137 help_echo_string
= Qnil
;
26139 /* Convert to window-relative pixel coordinates. */
26140 w
= XWINDOW (window
);
26141 frame_to_window_pixel_xy (w
, &x
, &y
);
26143 #ifdef HAVE_WINDOW_SYSTEM
26144 /* Handle tool-bar window differently since it doesn't display a
26146 if (EQ (window
, f
->tool_bar_window
))
26148 note_tool_bar_highlight (f
, x
, y
);
26153 /* Mouse is on the mode, header line or margin? */
26154 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26155 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26157 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26161 #ifdef HAVE_WINDOW_SYSTEM
26162 if (part
== ON_VERTICAL_BORDER
)
26164 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26165 help_echo_string
= build_string ("drag-mouse-1: resize");
26167 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26168 || part
== ON_SCROLL_BAR
)
26169 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26171 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26174 /* Are we in a window whose display is up to date?
26175 And verify the buffer's text has not changed. */
26176 b
= XBUFFER (w
->buffer
);
26177 if (part
== ON_TEXT
26178 && EQ (w
->window_end_valid
, w
->buffer
)
26179 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26180 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26182 int hpos
, vpos
, dx
, dy
, area
;
26184 struct glyph
*glyph
;
26185 Lisp_Object object
;
26186 Lisp_Object mouse_face
= Qnil
, position
;
26187 Lisp_Object
*overlay_vec
= NULL
;
26188 ptrdiff_t i
, noverlays
;
26189 struct buffer
*obuf
;
26190 EMACS_INT obegv
, ozv
;
26193 /* Find the glyph under X/Y. */
26194 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26196 #ifdef HAVE_WINDOW_SYSTEM
26197 /* Look for :pointer property on image. */
26198 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26200 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26201 if (img
!= NULL
&& IMAGEP (img
->spec
))
26203 Lisp_Object image_map
, hotspot
;
26204 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26206 && (hotspot
= find_hot_spot (image_map
,
26207 glyph
->slice
.img
.x
+ dx
,
26208 glyph
->slice
.img
.y
+ dy
),
26210 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26214 /* Could check XCAR (hotspot) to see if we enter/leave
26216 If so, we could look for mouse-enter, mouse-leave
26217 properties in PLIST (and do something...). */
26218 hotspot
= XCDR (hotspot
);
26219 if (CONSP (hotspot
)
26220 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26222 pointer
= Fplist_get (plist
, Qpointer
);
26223 if (NILP (pointer
))
26225 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26226 if (!NILP (help_echo_string
))
26228 help_echo_window
= window
;
26229 help_echo_object
= glyph
->object
;
26230 help_echo_pos
= glyph
->charpos
;
26234 if (NILP (pointer
))
26235 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26238 #endif /* HAVE_WINDOW_SYSTEM */
26240 /* Clear mouse face if X/Y not over text. */
26242 || area
!= TEXT_AREA
26243 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26244 /* Glyph's OBJECT is an integer for glyphs inserted by the
26245 display engine for its internal purposes, like truncation
26246 and continuation glyphs and blanks beyond the end of
26247 line's text on text terminals. If we are over such a
26248 glyph, we are not over any text. */
26249 || INTEGERP (glyph
->object
)
26250 /* R2L rows have a stretch glyph at their front, which
26251 stands for no text, whereas L2R rows have no glyphs at
26252 all beyond the end of text. Treat such stretch glyphs
26253 like we do with NULL glyphs in L2R rows. */
26254 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26255 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26256 && glyph
->type
== STRETCH_GLYPH
26257 && glyph
->avoid_cursor_p
))
26259 if (clear_mouse_face (hlinfo
))
26260 cursor
= No_Cursor
;
26261 #ifdef HAVE_WINDOW_SYSTEM
26262 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26264 if (area
!= TEXT_AREA
)
26265 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26267 pointer
= Vvoid_text_area_pointer
;
26273 pos
= glyph
->charpos
;
26274 object
= glyph
->object
;
26275 if (!STRINGP (object
) && !BUFFERP (object
))
26278 /* If we get an out-of-range value, return now; avoid an error. */
26279 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26282 /* Make the window's buffer temporarily current for
26283 overlays_at and compute_char_face. */
26284 obuf
= current_buffer
;
26285 current_buffer
= b
;
26291 /* Is this char mouse-active or does it have help-echo? */
26292 position
= make_number (pos
);
26294 if (BUFFERP (object
))
26296 /* Put all the overlays we want in a vector in overlay_vec. */
26297 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26298 /* Sort overlays into increasing priority order. */
26299 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26304 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26307 cursor
= No_Cursor
;
26309 /* Check mouse-face highlighting. */
26311 /* If there exists an overlay with mouse-face overlapping
26312 the one we are currently highlighting, we have to
26313 check if we enter the overlapping overlay, and then
26314 highlight only that. */
26315 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26316 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26318 /* Find the highest priority overlay with a mouse-face. */
26319 Lisp_Object overlay
= Qnil
;
26320 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26322 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26323 if (!NILP (mouse_face
))
26324 overlay
= overlay_vec
[i
];
26327 /* If we're highlighting the same overlay as before, there's
26328 no need to do that again. */
26329 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26330 goto check_help_echo
;
26331 hlinfo
->mouse_face_overlay
= overlay
;
26333 /* Clear the display of the old active region, if any. */
26334 if (clear_mouse_face (hlinfo
))
26335 cursor
= No_Cursor
;
26337 /* If no overlay applies, get a text property. */
26338 if (NILP (overlay
))
26339 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26341 /* Next, compute the bounds of the mouse highlighting and
26343 if (!NILP (mouse_face
) && STRINGP (object
))
26345 /* The mouse-highlighting comes from a display string
26346 with a mouse-face. */
26350 s
= Fprevious_single_property_change
26351 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26352 e
= Fnext_single_property_change
26353 (position
, Qmouse_face
, object
, Qnil
);
26355 s
= make_number (0);
26357 e
= make_number (SCHARS (object
) - 1);
26358 mouse_face_from_string_pos (w
, hlinfo
, object
,
26359 XINT (s
), XINT (e
));
26360 hlinfo
->mouse_face_past_end
= 0;
26361 hlinfo
->mouse_face_window
= window
;
26362 hlinfo
->mouse_face_face_id
26363 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26364 glyph
->face_id
, 1);
26365 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26366 cursor
= No_Cursor
;
26370 /* The mouse-highlighting, if any, comes from an overlay
26371 or text property in the buffer. */
26372 Lisp_Object buffer
IF_LINT (= Qnil
);
26373 Lisp_Object cover_string
IF_LINT (= Qnil
);
26375 if (STRINGP (object
))
26377 /* If we are on a display string with no mouse-face,
26378 check if the text under it has one. */
26379 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26380 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26381 pos
= string_buffer_position (object
, start
);
26384 mouse_face
= get_char_property_and_overlay
26385 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26386 buffer
= w
->buffer
;
26387 cover_string
= object
;
26393 cover_string
= Qnil
;
26396 if (!NILP (mouse_face
))
26398 Lisp_Object before
, after
;
26399 Lisp_Object before_string
, after_string
;
26400 /* To correctly find the limits of mouse highlight
26401 in a bidi-reordered buffer, we must not use the
26402 optimization of limiting the search in
26403 previous-single-property-change and
26404 next-single-property-change, because
26405 rows_from_pos_range needs the real start and end
26406 positions to DTRT in this case. That's because
26407 the first row visible in a window does not
26408 necessarily display the character whose position
26409 is the smallest. */
26411 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26412 ? Fmarker_position (w
->start
)
26415 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26416 ? make_number (BUF_Z (XBUFFER (buffer
))
26417 - XFASTINT (w
->window_end_pos
))
26420 if (NILP (overlay
))
26422 /* Handle the text property case. */
26423 before
= Fprevious_single_property_change
26424 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26425 after
= Fnext_single_property_change
26426 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26427 before_string
= after_string
= Qnil
;
26431 /* Handle the overlay case. */
26432 before
= Foverlay_start (overlay
);
26433 after
= Foverlay_end (overlay
);
26434 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26435 after_string
= Foverlay_get (overlay
, Qafter_string
);
26437 if (!STRINGP (before_string
)) before_string
= Qnil
;
26438 if (!STRINGP (after_string
)) after_string
= Qnil
;
26441 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26444 before_string
, after_string
,
26446 cursor
= No_Cursor
;
26453 /* Look for a `help-echo' property. */
26454 if (NILP (help_echo_string
)) {
26455 Lisp_Object help
, overlay
;
26457 /* Check overlays first. */
26458 help
= overlay
= Qnil
;
26459 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26461 overlay
= overlay_vec
[i
];
26462 help
= Foverlay_get (overlay
, Qhelp_echo
);
26467 help_echo_string
= help
;
26468 help_echo_window
= window
;
26469 help_echo_object
= overlay
;
26470 help_echo_pos
= pos
;
26474 Lisp_Object obj
= glyph
->object
;
26475 EMACS_INT charpos
= glyph
->charpos
;
26477 /* Try text properties. */
26480 && charpos
< SCHARS (obj
))
26482 help
= Fget_text_property (make_number (charpos
),
26486 /* If the string itself doesn't specify a help-echo,
26487 see if the buffer text ``under'' it does. */
26488 struct glyph_row
*r
26489 = MATRIX_ROW (w
->current_matrix
, vpos
);
26490 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26491 EMACS_INT p
= string_buffer_position (obj
, start
);
26494 help
= Fget_char_property (make_number (p
),
26495 Qhelp_echo
, w
->buffer
);
26504 else if (BUFFERP (obj
)
26507 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26512 help_echo_string
= help
;
26513 help_echo_window
= window
;
26514 help_echo_object
= obj
;
26515 help_echo_pos
= charpos
;
26520 #ifdef HAVE_WINDOW_SYSTEM
26521 /* Look for a `pointer' property. */
26522 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26524 /* Check overlays first. */
26525 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26526 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26528 if (NILP (pointer
))
26530 Lisp_Object obj
= glyph
->object
;
26531 EMACS_INT charpos
= glyph
->charpos
;
26533 /* Try text properties. */
26536 && charpos
< SCHARS (obj
))
26538 pointer
= Fget_text_property (make_number (charpos
),
26540 if (NILP (pointer
))
26542 /* If the string itself doesn't specify a pointer,
26543 see if the buffer text ``under'' it does. */
26544 struct glyph_row
*r
26545 = MATRIX_ROW (w
->current_matrix
, vpos
);
26546 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26547 EMACS_INT p
= string_buffer_position (obj
, start
);
26549 pointer
= Fget_char_property (make_number (p
),
26550 Qpointer
, w
->buffer
);
26553 else if (BUFFERP (obj
)
26556 pointer
= Fget_text_property (make_number (charpos
),
26560 #endif /* HAVE_WINDOW_SYSTEM */
26564 current_buffer
= obuf
;
26569 #ifdef HAVE_WINDOW_SYSTEM
26570 if (FRAME_WINDOW_P (f
))
26571 define_frame_cursor1 (f
, cursor
, pointer
);
26573 /* This is here to prevent a compiler error, about "label at end of
26574 compound statement". */
26581 Clear any mouse-face on window W. This function is part of the
26582 redisplay interface, and is called from try_window_id and similar
26583 functions to ensure the mouse-highlight is off. */
26586 x_clear_window_mouse_face (struct window
*w
)
26588 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26589 Lisp_Object window
;
26592 XSETWINDOW (window
, w
);
26593 if (EQ (window
, hlinfo
->mouse_face_window
))
26594 clear_mouse_face (hlinfo
);
26600 Just discard the mouse face information for frame F, if any.
26601 This is used when the size of F is changed. */
26604 cancel_mouse_face (struct frame
*f
)
26606 Lisp_Object window
;
26607 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26609 window
= hlinfo
->mouse_face_window
;
26610 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26612 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26613 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26614 hlinfo
->mouse_face_window
= Qnil
;
26620 /***********************************************************************
26622 ***********************************************************************/
26624 #ifdef HAVE_WINDOW_SYSTEM
26626 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26627 which intersects rectangle R. R is in window-relative coordinates. */
26630 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26631 enum glyph_row_area area
)
26633 struct glyph
*first
= row
->glyphs
[area
];
26634 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26635 struct glyph
*last
;
26636 int first_x
, start_x
, x
;
26638 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26639 /* If row extends face to end of line write the whole line. */
26640 draw_glyphs (w
, 0, row
, area
,
26641 0, row
->used
[area
],
26642 DRAW_NORMAL_TEXT
, 0);
26645 /* Set START_X to the window-relative start position for drawing glyphs of
26646 AREA. The first glyph of the text area can be partially visible.
26647 The first glyphs of other areas cannot. */
26648 start_x
= window_box_left_offset (w
, area
);
26650 if (area
== TEXT_AREA
)
26653 /* Find the first glyph that must be redrawn. */
26655 && x
+ first
->pixel_width
< r
->x
)
26657 x
+= first
->pixel_width
;
26661 /* Find the last one. */
26665 && x
< r
->x
+ r
->width
)
26667 x
+= last
->pixel_width
;
26673 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26674 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26675 DRAW_NORMAL_TEXT
, 0);
26680 /* Redraw the parts of the glyph row ROW on window W intersecting
26681 rectangle R. R is in window-relative coordinates. Value is
26682 non-zero if mouse-face was overwritten. */
26685 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26687 xassert (row
->enabled_p
);
26689 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26690 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26691 0, row
->used
[TEXT_AREA
],
26692 DRAW_NORMAL_TEXT
, 0);
26695 if (row
->used
[LEFT_MARGIN_AREA
])
26696 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26697 if (row
->used
[TEXT_AREA
])
26698 expose_area (w
, row
, r
, TEXT_AREA
);
26699 if (row
->used
[RIGHT_MARGIN_AREA
])
26700 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26701 draw_row_fringe_bitmaps (w
, row
);
26704 return row
->mouse_face_p
;
26708 /* Redraw those parts of glyphs rows during expose event handling that
26709 overlap other rows. Redrawing of an exposed line writes over parts
26710 of lines overlapping that exposed line; this function fixes that.
26712 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26713 row in W's current matrix that is exposed and overlaps other rows.
26714 LAST_OVERLAPPING_ROW is the last such row. */
26717 expose_overlaps (struct window
*w
,
26718 struct glyph_row
*first_overlapping_row
,
26719 struct glyph_row
*last_overlapping_row
,
26722 struct glyph_row
*row
;
26724 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26725 if (row
->overlapping_p
)
26727 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26730 if (row
->used
[LEFT_MARGIN_AREA
])
26731 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26733 if (row
->used
[TEXT_AREA
])
26734 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26736 if (row
->used
[RIGHT_MARGIN_AREA
])
26737 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26743 /* Return non-zero if W's cursor intersects rectangle R. */
26746 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26748 XRectangle cr
, result
;
26749 struct glyph
*cursor_glyph
;
26750 struct glyph_row
*row
;
26752 if (w
->phys_cursor
.vpos
>= 0
26753 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26754 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26756 && row
->cursor_in_fringe_p
)
26758 /* Cursor is in the fringe. */
26759 cr
.x
= window_box_right_offset (w
,
26760 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26761 ? RIGHT_MARGIN_AREA
26764 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26765 cr
.height
= row
->height
;
26766 return x_intersect_rectangles (&cr
, r
, &result
);
26769 cursor_glyph
= get_phys_cursor_glyph (w
);
26772 /* r is relative to W's box, but w->phys_cursor.x is relative
26773 to left edge of W's TEXT area. Adjust it. */
26774 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26775 cr
.y
= w
->phys_cursor
.y
;
26776 cr
.width
= cursor_glyph
->pixel_width
;
26777 cr
.height
= w
->phys_cursor_height
;
26778 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26779 I assume the effect is the same -- and this is portable. */
26780 return x_intersect_rectangles (&cr
, r
, &result
);
26782 /* If we don't understand the format, pretend we're not in the hot-spot. */
26788 Draw a vertical window border to the right of window W if W doesn't
26789 have vertical scroll bars. */
26792 x_draw_vertical_border (struct window
*w
)
26794 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26796 /* We could do better, if we knew what type of scroll-bar the adjacent
26797 windows (on either side) have... But we don't :-(
26798 However, I think this works ok. ++KFS 2003-04-25 */
26800 /* Redraw borders between horizontally adjacent windows. Don't
26801 do it for frames with vertical scroll bars because either the
26802 right scroll bar of a window, or the left scroll bar of its
26803 neighbor will suffice as a border. */
26804 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26807 if (!WINDOW_RIGHTMOST_P (w
)
26808 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26810 int x0
, x1
, y0
, y1
;
26812 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26815 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26818 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26820 else if (!WINDOW_LEFTMOST_P (w
)
26821 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26823 int x0
, x1
, y0
, y1
;
26825 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26828 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26831 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26836 /* Redraw the part of window W intersection rectangle FR. Pixel
26837 coordinates in FR are frame-relative. Call this function with
26838 input blocked. Value is non-zero if the exposure overwrites
26842 expose_window (struct window
*w
, XRectangle
*fr
)
26844 struct frame
*f
= XFRAME (w
->frame
);
26846 int mouse_face_overwritten_p
= 0;
26848 /* If window is not yet fully initialized, do nothing. This can
26849 happen when toolkit scroll bars are used and a window is split.
26850 Reconfiguring the scroll bar will generate an expose for a newly
26852 if (w
->current_matrix
== NULL
)
26855 /* When we're currently updating the window, display and current
26856 matrix usually don't agree. Arrange for a thorough display
26858 if (w
== updated_window
)
26860 SET_FRAME_GARBAGED (f
);
26864 /* Frame-relative pixel rectangle of W. */
26865 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26866 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26867 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26868 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26870 if (x_intersect_rectangles (fr
, &wr
, &r
))
26872 int yb
= window_text_bottom_y (w
);
26873 struct glyph_row
*row
;
26874 int cursor_cleared_p
;
26875 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26877 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26878 r
.x
, r
.y
, r
.width
, r
.height
));
26880 /* Convert to window coordinates. */
26881 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26882 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26884 /* Turn off the cursor. */
26885 if (!w
->pseudo_window_p
26886 && phys_cursor_in_rect_p (w
, &r
))
26888 x_clear_cursor (w
);
26889 cursor_cleared_p
= 1;
26892 cursor_cleared_p
= 0;
26894 /* Update lines intersecting rectangle R. */
26895 first_overlapping_row
= last_overlapping_row
= NULL
;
26896 for (row
= w
->current_matrix
->rows
;
26901 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26903 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26904 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26905 || (r
.y
>= y0
&& r
.y
< y1
)
26906 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26908 /* A header line may be overlapping, but there is no need
26909 to fix overlapping areas for them. KFS 2005-02-12 */
26910 if (row
->overlapping_p
&& !row
->mode_line_p
)
26912 if (first_overlapping_row
== NULL
)
26913 first_overlapping_row
= row
;
26914 last_overlapping_row
= row
;
26918 if (expose_line (w
, row
, &r
))
26919 mouse_face_overwritten_p
= 1;
26922 else if (row
->overlapping_p
)
26924 /* We must redraw a row overlapping the exposed area. */
26926 ? y0
+ row
->phys_height
> r
.y
26927 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26929 if (first_overlapping_row
== NULL
)
26930 first_overlapping_row
= row
;
26931 last_overlapping_row
= row
;
26939 /* Display the mode line if there is one. */
26940 if (WINDOW_WANTS_MODELINE_P (w
)
26941 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26943 && row
->y
< r
.y
+ r
.height
)
26945 if (expose_line (w
, row
, &r
))
26946 mouse_face_overwritten_p
= 1;
26949 if (!w
->pseudo_window_p
)
26951 /* Fix the display of overlapping rows. */
26952 if (first_overlapping_row
)
26953 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26956 /* Draw border between windows. */
26957 x_draw_vertical_border (w
);
26959 /* Turn the cursor on again. */
26960 if (cursor_cleared_p
)
26961 update_window_cursor (w
, 1);
26965 return mouse_face_overwritten_p
;
26970 /* Redraw (parts) of all windows in the window tree rooted at W that
26971 intersect R. R contains frame pixel coordinates. Value is
26972 non-zero if the exposure overwrites mouse-face. */
26975 expose_window_tree (struct window
*w
, XRectangle
*r
)
26977 struct frame
*f
= XFRAME (w
->frame
);
26978 int mouse_face_overwritten_p
= 0;
26980 while (w
&& !FRAME_GARBAGED_P (f
))
26982 if (!NILP (w
->hchild
))
26983 mouse_face_overwritten_p
26984 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26985 else if (!NILP (w
->vchild
))
26986 mouse_face_overwritten_p
26987 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26989 mouse_face_overwritten_p
|= expose_window (w
, r
);
26991 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26994 return mouse_face_overwritten_p
;
26999 Redisplay an exposed area of frame F. X and Y are the upper-left
27000 corner of the exposed rectangle. W and H are width and height of
27001 the exposed area. All are pixel values. W or H zero means redraw
27002 the entire frame. */
27005 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27008 int mouse_face_overwritten_p
= 0;
27010 TRACE ((stderr
, "expose_frame "));
27012 /* No need to redraw if frame will be redrawn soon. */
27013 if (FRAME_GARBAGED_P (f
))
27015 TRACE ((stderr
, " garbaged\n"));
27019 /* If basic faces haven't been realized yet, there is no point in
27020 trying to redraw anything. This can happen when we get an expose
27021 event while Emacs is starting, e.g. by moving another window. */
27022 if (FRAME_FACE_CACHE (f
) == NULL
27023 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27025 TRACE ((stderr
, " no faces\n"));
27029 if (w
== 0 || h
== 0)
27032 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27033 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27043 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27044 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27046 if (WINDOWP (f
->tool_bar_window
))
27047 mouse_face_overwritten_p
27048 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27050 #ifdef HAVE_X_WINDOWS
27052 #ifndef USE_X_TOOLKIT
27053 if (WINDOWP (f
->menu_bar_window
))
27054 mouse_face_overwritten_p
27055 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27056 #endif /* not USE_X_TOOLKIT */
27060 /* Some window managers support a focus-follows-mouse style with
27061 delayed raising of frames. Imagine a partially obscured frame,
27062 and moving the mouse into partially obscured mouse-face on that
27063 frame. The visible part of the mouse-face will be highlighted,
27064 then the WM raises the obscured frame. With at least one WM, KDE
27065 2.1, Emacs is not getting any event for the raising of the frame
27066 (even tried with SubstructureRedirectMask), only Expose events.
27067 These expose events will draw text normally, i.e. not
27068 highlighted. Which means we must redo the highlight here.
27069 Subsume it under ``we love X''. --gerd 2001-08-15 */
27070 /* Included in Windows version because Windows most likely does not
27071 do the right thing if any third party tool offers
27072 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27073 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27075 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27076 if (f
== hlinfo
->mouse_face_mouse_frame
)
27078 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27079 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27080 clear_mouse_face (hlinfo
);
27081 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27088 Determine the intersection of two rectangles R1 and R2. Return
27089 the intersection in *RESULT. Value is non-zero if RESULT is not
27093 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27095 XRectangle
*left
, *right
;
27096 XRectangle
*upper
, *lower
;
27097 int intersection_p
= 0;
27099 /* Rearrange so that R1 is the left-most rectangle. */
27101 left
= r1
, right
= r2
;
27103 left
= r2
, right
= r1
;
27105 /* X0 of the intersection is right.x0, if this is inside R1,
27106 otherwise there is no intersection. */
27107 if (right
->x
<= left
->x
+ left
->width
)
27109 result
->x
= right
->x
;
27111 /* The right end of the intersection is the minimum of
27112 the right ends of left and right. */
27113 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27116 /* Same game for Y. */
27118 upper
= r1
, lower
= r2
;
27120 upper
= r2
, lower
= r1
;
27122 /* The upper end of the intersection is lower.y0, if this is inside
27123 of upper. Otherwise, there is no intersection. */
27124 if (lower
->y
<= upper
->y
+ upper
->height
)
27126 result
->y
= lower
->y
;
27128 /* The lower end of the intersection is the minimum of the lower
27129 ends of upper and lower. */
27130 result
->height
= (min (lower
->y
+ lower
->height
,
27131 upper
->y
+ upper
->height
)
27133 intersection_p
= 1;
27137 return intersection_p
;
27140 #endif /* HAVE_WINDOW_SYSTEM */
27143 /***********************************************************************
27145 ***********************************************************************/
27148 syms_of_xdisp (void)
27150 Vwith_echo_area_save_vector
= Qnil
;
27151 staticpro (&Vwith_echo_area_save_vector
);
27153 Vmessage_stack
= Qnil
;
27154 staticpro (&Vmessage_stack
);
27156 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27158 message_dolog_marker1
= Fmake_marker ();
27159 staticpro (&message_dolog_marker1
);
27160 message_dolog_marker2
= Fmake_marker ();
27161 staticpro (&message_dolog_marker2
);
27162 message_dolog_marker3
= Fmake_marker ();
27163 staticpro (&message_dolog_marker3
);
27166 defsubr (&Sdump_frame_glyph_matrix
);
27167 defsubr (&Sdump_glyph_matrix
);
27168 defsubr (&Sdump_glyph_row
);
27169 defsubr (&Sdump_tool_bar_row
);
27170 defsubr (&Strace_redisplay
);
27171 defsubr (&Strace_to_stderr
);
27173 #ifdef HAVE_WINDOW_SYSTEM
27174 defsubr (&Stool_bar_lines_needed
);
27175 defsubr (&Slookup_image_map
);
27177 defsubr (&Sformat_mode_line
);
27178 defsubr (&Sinvisible_p
);
27179 defsubr (&Scurrent_bidi_paragraph_direction
);
27181 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27182 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27183 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27184 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27185 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27186 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27187 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27188 DEFSYM (Qeval
, "eval");
27189 DEFSYM (QCdata
, ":data");
27190 DEFSYM (Qdisplay
, "display");
27191 DEFSYM (Qspace_width
, "space-width");
27192 DEFSYM (Qraise
, "raise");
27193 DEFSYM (Qslice
, "slice");
27194 DEFSYM (Qspace
, "space");
27195 DEFSYM (Qmargin
, "margin");
27196 DEFSYM (Qpointer
, "pointer");
27197 DEFSYM (Qleft_margin
, "left-margin");
27198 DEFSYM (Qright_margin
, "right-margin");
27199 DEFSYM (Qcenter
, "center");
27200 DEFSYM (Qline_height
, "line-height");
27201 DEFSYM (QCalign_to
, ":align-to");
27202 DEFSYM (QCrelative_width
, ":relative-width");
27203 DEFSYM (QCrelative_height
, ":relative-height");
27204 DEFSYM (QCeval
, ":eval");
27205 DEFSYM (QCpropertize
, ":propertize");
27206 DEFSYM (QCfile
, ":file");
27207 DEFSYM (Qfontified
, "fontified");
27208 DEFSYM (Qfontification_functions
, "fontification-functions");
27209 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27210 DEFSYM (Qescape_glyph
, "escape-glyph");
27211 DEFSYM (Qnobreak_space
, "nobreak-space");
27212 DEFSYM (Qimage
, "image");
27213 DEFSYM (Qtext
, "text");
27214 DEFSYM (Qboth
, "both");
27215 DEFSYM (Qboth_horiz
, "both-horiz");
27216 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27217 DEFSYM (QCmap
, ":map");
27218 DEFSYM (QCpointer
, ":pointer");
27219 DEFSYM (Qrect
, "rect");
27220 DEFSYM (Qcircle
, "circle");
27221 DEFSYM (Qpoly
, "poly");
27222 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27223 DEFSYM (Qgrow_only
, "grow-only");
27224 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27225 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27226 DEFSYM (Qposition
, "position");
27227 DEFSYM (Qbuffer_position
, "buffer-position");
27228 DEFSYM (Qobject
, "object");
27229 DEFSYM (Qbar
, "bar");
27230 DEFSYM (Qhbar
, "hbar");
27231 DEFSYM (Qbox
, "box");
27232 DEFSYM (Qhollow
, "hollow");
27233 DEFSYM (Qhand
, "hand");
27234 DEFSYM (Qarrow
, "arrow");
27235 DEFSYM (Qtext
, "text");
27236 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27238 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27239 Fcons (intern_c_string ("void-variable"), Qnil
)),
27241 staticpro (&list_of_error
);
27243 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27244 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27245 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27246 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27248 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27249 staticpro (&echo_buffer
[0]);
27250 staticpro (&echo_buffer
[1]);
27252 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27253 staticpro (&echo_area_buffer
[0]);
27254 staticpro (&echo_area_buffer
[1]);
27256 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27257 staticpro (&Vmessages_buffer_name
);
27259 mode_line_proptrans_alist
= Qnil
;
27260 staticpro (&mode_line_proptrans_alist
);
27261 mode_line_string_list
= Qnil
;
27262 staticpro (&mode_line_string_list
);
27263 mode_line_string_face
= Qnil
;
27264 staticpro (&mode_line_string_face
);
27265 mode_line_string_face_prop
= Qnil
;
27266 staticpro (&mode_line_string_face_prop
);
27267 Vmode_line_unwind_vector
= Qnil
;
27268 staticpro (&Vmode_line_unwind_vector
);
27270 help_echo_string
= Qnil
;
27271 staticpro (&help_echo_string
);
27272 help_echo_object
= Qnil
;
27273 staticpro (&help_echo_object
);
27274 help_echo_window
= Qnil
;
27275 staticpro (&help_echo_window
);
27276 previous_help_echo_string
= Qnil
;
27277 staticpro (&previous_help_echo_string
);
27278 help_echo_pos
= -1;
27280 DEFSYM (Qright_to_left
, "right-to-left");
27281 DEFSYM (Qleft_to_right
, "left-to-right");
27283 #ifdef HAVE_WINDOW_SYSTEM
27284 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27285 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27286 For example, if a block cursor is over a tab, it will be drawn as
27287 wide as that tab on the display. */);
27288 x_stretch_cursor_p
= 0;
27291 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27292 doc
: /* *Non-nil means highlight trailing whitespace.
27293 The face used for trailing whitespace is `trailing-whitespace'. */);
27294 Vshow_trailing_whitespace
= Qnil
;
27296 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27297 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27298 A value of t means highlight the character itself (for nobreak space,
27299 use face `nobreak-space').
27300 A value of nil means no highlighting.
27301 Other values mean display the escape glyph followed by an ordinary
27302 space or ordinary hyphen. */);
27303 Vnobreak_char_display
= Qt
;
27305 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27306 doc
: /* *The pointer shape to show in void text areas.
27307 A value of nil means to show the text pointer. Other options are `arrow',
27308 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27309 Vvoid_text_area_pointer
= Qarrow
;
27311 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27312 doc
: /* Non-nil means don't actually do any redisplay.
27313 This is used for internal purposes. */);
27314 Vinhibit_redisplay
= Qnil
;
27316 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27317 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27318 Vglobal_mode_string
= Qnil
;
27320 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27321 doc
: /* Marker for where to display an arrow on top of the buffer text.
27322 This must be the beginning of a line in order to work.
27323 See also `overlay-arrow-string'. */);
27324 Voverlay_arrow_position
= Qnil
;
27326 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27327 doc
: /* String to display as an arrow in non-window frames.
27328 See also `overlay-arrow-position'. */);
27329 Voverlay_arrow_string
= make_pure_c_string ("=>");
27331 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27332 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27333 The symbols on this list are examined during redisplay to determine
27334 where to display overlay arrows. */);
27335 Voverlay_arrow_variable_list
27336 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27338 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27339 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27340 If that fails to bring point back on frame, point is centered instead.
27341 If this is zero, point is always centered after it moves off frame.
27342 If you want scrolling to always be a line at a time, you should set
27343 `scroll-conservatively' to a large value rather than set this to 1. */);
27345 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27346 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27347 If point moves off-screen, redisplay will scroll by up to
27348 `scroll-conservatively' lines in order to bring point just barely
27349 onto the screen again. If that cannot be done, then redisplay
27350 recenters point as usual.
27352 If the value is greater than 100, redisplay will never recenter point,
27353 but will always scroll just enough text to bring point into view, even
27354 if you move far away.
27356 A value of zero means always recenter point if it moves off screen. */);
27357 scroll_conservatively
= 0;
27359 DEFVAR_INT ("scroll-margin", scroll_margin
,
27360 doc
: /* *Number of lines of margin at the top and bottom of a window.
27361 Recenter the window whenever point gets within this many lines
27362 of the top or bottom of the window. */);
27365 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27366 doc
: /* Pixels per inch value for non-window system displays.
27367 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27368 Vdisplay_pixels_per_inch
= make_float (72.0);
27371 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27374 DEFVAR_LISP ("truncate-partial-width-windows",
27375 Vtruncate_partial_width_windows
,
27376 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27377 For an integer value, truncate lines in each window narrower than the
27378 full frame width, provided the window width is less than that integer;
27379 otherwise, respect the value of `truncate-lines'.
27381 For any other non-nil value, truncate lines in all windows that do
27382 not span the full frame width.
27384 A value of nil means to respect the value of `truncate-lines'.
27386 If `word-wrap' is enabled, you might want to reduce this. */);
27387 Vtruncate_partial_width_windows
= make_number (50);
27389 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27390 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27391 Any other value means to use the appropriate face, `mode-line',
27392 `header-line', or `menu' respectively. */);
27393 mode_line_inverse_video
= 1;
27395 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27396 doc
: /* *Maximum buffer size for which line number should be displayed.
27397 If the buffer is bigger than this, the line number does not appear
27398 in the mode line. A value of nil means no limit. */);
27399 Vline_number_display_limit
= Qnil
;
27401 DEFVAR_INT ("line-number-display-limit-width",
27402 line_number_display_limit_width
,
27403 doc
: /* *Maximum line width (in characters) for line number display.
27404 If the average length of the lines near point is bigger than this, then the
27405 line number may be omitted from the mode line. */);
27406 line_number_display_limit_width
= 200;
27408 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27409 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27410 highlight_nonselected_windows
= 0;
27412 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27413 doc
: /* Non-nil if more than one frame is visible on this display.
27414 Minibuffer-only frames don't count, but iconified frames do.
27415 This variable is not guaranteed to be accurate except while processing
27416 `frame-title-format' and `icon-title-format'. */);
27418 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27419 doc
: /* Template for displaying the title bar of visible frames.
27420 \(Assuming the window manager supports this feature.)
27422 This variable has the same structure as `mode-line-format', except that
27423 the %c and %l constructs are ignored. It is used only on frames for
27424 which no explicit name has been set \(see `modify-frame-parameters'). */);
27426 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27427 doc
: /* Template for displaying the title bar of an iconified frame.
27428 \(Assuming the window manager supports this feature.)
27429 This variable has the same structure as `mode-line-format' (which see),
27430 and is used only on frames for which no explicit name has been set
27431 \(see `modify-frame-parameters'). */);
27433 = Vframe_title_format
27434 = pure_cons (intern_c_string ("multiple-frames"),
27435 pure_cons (make_pure_c_string ("%b"),
27436 pure_cons (pure_cons (empty_unibyte_string
,
27437 pure_cons (intern_c_string ("invocation-name"),
27438 pure_cons (make_pure_c_string ("@"),
27439 pure_cons (intern_c_string ("system-name"),
27443 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27444 doc
: /* Maximum number of lines to keep in the message log buffer.
27445 If nil, disable message logging. If t, log messages but don't truncate
27446 the buffer when it becomes large. */);
27447 Vmessage_log_max
= make_number (100);
27449 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27450 doc
: /* Functions called before redisplay, if window sizes have changed.
27451 The value should be a list of functions that take one argument.
27452 Just before redisplay, for each frame, if any of its windows have changed
27453 size since the last redisplay, or have been split or deleted,
27454 all the functions in the list are called, with the frame as argument. */);
27455 Vwindow_size_change_functions
= Qnil
;
27457 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27458 doc
: /* List of functions to call before redisplaying a window with scrolling.
27459 Each function is called with two arguments, the window and its new
27460 display-start position. Note that these functions are also called by
27461 `set-window-buffer'. Also note that the value of `window-end' is not
27462 valid when these functions are called. */);
27463 Vwindow_scroll_functions
= Qnil
;
27465 DEFVAR_LISP ("window-text-change-functions",
27466 Vwindow_text_change_functions
,
27467 doc
: /* Functions to call in redisplay when text in the window might change. */);
27468 Vwindow_text_change_functions
= Qnil
;
27470 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27471 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27472 Each function is called with two arguments, the window and the end trigger value.
27473 See `set-window-redisplay-end-trigger'. */);
27474 Vredisplay_end_trigger_functions
= Qnil
;
27476 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27477 doc
: /* *Non-nil means autoselect window with mouse pointer.
27478 If nil, do not autoselect windows.
27479 A positive number means delay autoselection by that many seconds: a
27480 window is autoselected only after the mouse has remained in that
27481 window for the duration of the delay.
27482 A negative number has a similar effect, but causes windows to be
27483 autoselected only after the mouse has stopped moving. \(Because of
27484 the way Emacs compares mouse events, you will occasionally wait twice
27485 that time before the window gets selected.\)
27486 Any other value means to autoselect window instantaneously when the
27487 mouse pointer enters it.
27489 Autoselection selects the minibuffer only if it is active, and never
27490 unselects the minibuffer if it is active.
27492 When customizing this variable make sure that the actual value of
27493 `focus-follows-mouse' matches the behavior of your window manager. */);
27494 Vmouse_autoselect_window
= Qnil
;
27496 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27497 doc
: /* *Non-nil means automatically resize tool-bars.
27498 This dynamically changes the tool-bar's height to the minimum height
27499 that is needed to make all tool-bar items visible.
27500 If value is `grow-only', the tool-bar's height is only increased
27501 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27502 Vauto_resize_tool_bars
= Qt
;
27504 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27505 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27506 auto_raise_tool_bar_buttons_p
= 1;
27508 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27509 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27510 make_cursor_line_fully_visible_p
= 1;
27512 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27513 doc
: /* *Border below tool-bar in pixels.
27514 If an integer, use it as the height of the border.
27515 If it is one of `internal-border-width' or `border-width', use the
27516 value of the corresponding frame parameter.
27517 Otherwise, no border is added below the tool-bar. */);
27518 Vtool_bar_border
= Qinternal_border_width
;
27520 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27521 doc
: /* *Margin around tool-bar buttons in pixels.
27522 If an integer, use that for both horizontal and vertical margins.
27523 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27524 HORZ specifying the horizontal margin, and VERT specifying the
27525 vertical margin. */);
27526 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27528 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27529 doc
: /* *Relief thickness of tool-bar buttons. */);
27530 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27532 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27533 doc
: /* Tool bar style to use.
27535 image - show images only
27536 text - show text only
27537 both - show both, text below image
27538 both-horiz - show text to the right of the image
27539 text-image-horiz - show text to the left of the image
27540 any other - use system default or image if no system default. */);
27541 Vtool_bar_style
= Qnil
;
27543 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27544 doc
: /* *Maximum number of characters a label can have to be shown.
27545 The tool bar style must also show labels for this to have any effect, see
27546 `tool-bar-style'. */);
27547 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27549 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27550 doc
: /* List of functions to call to fontify regions of text.
27551 Each function is called with one argument POS. Functions must
27552 fontify a region starting at POS in the current buffer, and give
27553 fontified regions the property `fontified'. */);
27554 Vfontification_functions
= Qnil
;
27555 Fmake_variable_buffer_local (Qfontification_functions
);
27557 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27558 unibyte_display_via_language_environment
,
27559 doc
: /* *Non-nil means display unibyte text according to language environment.
27560 Specifically, this means that raw bytes in the range 160-255 decimal
27561 are displayed by converting them to the equivalent multibyte characters
27562 according to the current language environment. As a result, they are
27563 displayed according to the current fontset.
27565 Note that this variable affects only how these bytes are displayed,
27566 but does not change the fact they are interpreted as raw bytes. */);
27567 unibyte_display_via_language_environment
= 0;
27569 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27570 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27571 If a float, it specifies a fraction of the mini-window frame's height.
27572 If an integer, it specifies a number of lines. */);
27573 Vmax_mini_window_height
= make_float (0.25);
27575 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27576 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27577 A value of nil means don't automatically resize mini-windows.
27578 A value of t means resize them to fit the text displayed in them.
27579 A value of `grow-only', the default, means let mini-windows grow only;
27580 they return to their normal size when the minibuffer is closed, or the
27581 echo area becomes empty. */);
27582 Vresize_mini_windows
= Qgrow_only
;
27584 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27585 doc
: /* Alist specifying how to blink the cursor off.
27586 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27587 `cursor-type' frame-parameter or variable equals ON-STATE,
27588 comparing using `equal', Emacs uses OFF-STATE to specify
27589 how to blink it off. ON-STATE and OFF-STATE are values for
27590 the `cursor-type' frame parameter.
27592 If a frame's ON-STATE has no entry in this list,
27593 the frame's other specifications determine how to blink the cursor off. */);
27594 Vblink_cursor_alist
= Qnil
;
27596 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27597 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27598 If non-nil, windows are automatically scrolled horizontally to make
27599 point visible. */);
27600 automatic_hscrolling_p
= 1;
27601 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27603 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27604 doc
: /* *How many columns away from the window edge point is allowed to get
27605 before automatic hscrolling will horizontally scroll the window. */);
27606 hscroll_margin
= 5;
27608 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27609 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27610 When point is less than `hscroll-margin' columns from the window
27611 edge, automatic hscrolling will scroll the window by the amount of columns
27612 determined by this variable. If its value is a positive integer, scroll that
27613 many columns. If it's a positive floating-point number, it specifies the
27614 fraction of the window's width to scroll. If it's nil or zero, point will be
27615 centered horizontally after the scroll. Any other value, including negative
27616 numbers, are treated as if the value were zero.
27618 Automatic hscrolling always moves point outside the scroll margin, so if
27619 point was more than scroll step columns inside the margin, the window will
27620 scroll more than the value given by the scroll step.
27622 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27623 and `scroll-right' overrides this variable's effect. */);
27624 Vhscroll_step
= make_number (0);
27626 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27627 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27628 Bind this around calls to `message' to let it take effect. */);
27629 message_truncate_lines
= 0;
27631 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27632 doc
: /* Normal hook run to update the menu bar definitions.
27633 Redisplay runs this hook before it redisplays the menu bar.
27634 This is used to update submenus such as Buffers,
27635 whose contents depend on various data. */);
27636 Vmenu_bar_update_hook
= Qnil
;
27638 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27639 doc
: /* Frame for which we are updating a menu.
27640 The enable predicate for a menu binding should check this variable. */);
27641 Vmenu_updating_frame
= Qnil
;
27643 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27644 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27645 inhibit_menubar_update
= 0;
27647 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27648 doc
: /* Prefix prepended to all continuation lines at display time.
27649 The value may be a string, an image, or a stretch-glyph; it is
27650 interpreted in the same way as the value of a `display' text property.
27652 This variable is overridden by any `wrap-prefix' text or overlay
27655 To add a prefix to non-continuation lines, use `line-prefix'. */);
27656 Vwrap_prefix
= Qnil
;
27657 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27658 Fmake_variable_buffer_local (Qwrap_prefix
);
27660 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27661 doc
: /* Prefix prepended to all non-continuation lines at display time.
27662 The value may be a string, an image, or a stretch-glyph; it is
27663 interpreted in the same way as the value of a `display' text property.
27665 This variable is overridden by any `line-prefix' text or overlay
27668 To add a prefix to continuation lines, use `wrap-prefix'. */);
27669 Vline_prefix
= Qnil
;
27670 DEFSYM (Qline_prefix
, "line-prefix");
27671 Fmake_variable_buffer_local (Qline_prefix
);
27673 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27674 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27675 inhibit_eval_during_redisplay
= 0;
27677 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27678 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27679 inhibit_free_realized_faces
= 0;
27682 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27683 doc
: /* Inhibit try_window_id display optimization. */);
27684 inhibit_try_window_id
= 0;
27686 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27687 doc
: /* Inhibit try_window_reusing display optimization. */);
27688 inhibit_try_window_reusing
= 0;
27690 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27691 doc
: /* Inhibit try_cursor_movement display optimization. */);
27692 inhibit_try_cursor_movement
= 0;
27693 #endif /* GLYPH_DEBUG */
27695 DEFVAR_INT ("overline-margin", overline_margin
,
27696 doc
: /* *Space between overline and text, in pixels.
27697 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27698 margin to the caracter height. */);
27699 overline_margin
= 2;
27701 DEFVAR_INT ("underline-minimum-offset",
27702 underline_minimum_offset
,
27703 doc
: /* Minimum distance between baseline and underline.
27704 This can improve legibility of underlined text at small font sizes,
27705 particularly when using variable `x-use-underline-position-properties'
27706 with fonts that specify an UNDERLINE_POSITION relatively close to the
27707 baseline. The default value is 1. */);
27708 underline_minimum_offset
= 1;
27710 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27711 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27712 This feature only works when on a window system that can change
27713 cursor shapes. */);
27714 display_hourglass_p
= 1;
27716 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27717 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27718 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27720 hourglass_atimer
= NULL
;
27721 hourglass_shown_p
= 0;
27723 DEFSYM (Qglyphless_char
, "glyphless-char");
27724 DEFSYM (Qhex_code
, "hex-code");
27725 DEFSYM (Qempty_box
, "empty-box");
27726 DEFSYM (Qthin_space
, "thin-space");
27727 DEFSYM (Qzero_width
, "zero-width");
27729 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27730 /* Intern this now in case it isn't already done.
27731 Setting this variable twice is harmless.
27732 But don't staticpro it here--that is done in alloc.c. */
27733 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27734 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27736 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27737 doc
: /* Char-table defining glyphless characters.
27738 Each element, if non-nil, should be one of the following:
27739 an ASCII acronym string: display this string in a box
27740 `hex-code': display the hexadecimal code of a character in a box
27741 `empty-box': display as an empty box
27742 `thin-space': display as 1-pixel width space
27743 `zero-width': don't display
27744 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27745 display method for graphical terminals and text terminals respectively.
27746 GRAPHICAL and TEXT should each have one of the values listed above.
27748 The char-table has one extra slot to control the display of a character for
27749 which no font is found. This slot only takes effect on graphical terminals.
27750 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27751 `thin-space'. The default is `empty-box'. */);
27752 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27753 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27758 /* Initialize this module when Emacs starts. */
27763 current_header_line_height
= current_mode_line_height
= -1;
27765 CHARPOS (this_line_start_pos
) = 0;
27767 if (!noninteractive
)
27769 struct window
*m
= XWINDOW (minibuf_window
);
27770 Lisp_Object frame
= m
->frame
;
27771 struct frame
*f
= XFRAME (frame
);
27772 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27773 struct window
*r
= XWINDOW (root
);
27776 echo_area_window
= minibuf_window
;
27778 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27779 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27780 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27781 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27782 XSETFASTINT (m
->total_lines
, 1);
27783 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27785 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27786 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27787 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27789 /* The default ellipsis glyphs `...'. */
27790 for (i
= 0; i
< 3; ++i
)
27791 default_invis_vector
[i
] = make_number ('.');
27795 /* Allocate the buffer for frame titles.
27796 Also used for `format-mode-line'. */
27798 mode_line_noprop_buf
= (char *) xmalloc (size
);
27799 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27800 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27801 mode_line_target
= MODE_LINE_DISPLAY
;
27804 help_echo_showing_p
= 0;
27807 /* Since w32 does not support atimers, it defines its own implementation of
27808 the following three functions in w32fns.c. */
27811 /* Platform-independent portion of hourglass implementation. */
27813 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27815 hourglass_started (void)
27817 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27820 /* Cancel a currently active hourglass timer, and start a new one. */
27822 start_hourglass (void)
27824 #if defined (HAVE_WINDOW_SYSTEM)
27826 int secs
, usecs
= 0;
27828 cancel_hourglass ();
27830 if (INTEGERP (Vhourglass_delay
)
27831 && XINT (Vhourglass_delay
) > 0)
27832 secs
= XFASTINT (Vhourglass_delay
);
27833 else if (FLOATP (Vhourglass_delay
)
27834 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27837 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27838 secs
= XFASTINT (tem
);
27839 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27842 secs
= DEFAULT_HOURGLASS_DELAY
;
27844 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27845 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27846 show_hourglass
, NULL
);
27851 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27854 cancel_hourglass (void)
27856 #if defined (HAVE_WINDOW_SYSTEM)
27857 if (hourglass_atimer
)
27859 cancel_atimer (hourglass_atimer
);
27860 hourglass_atimer
= NULL
;
27863 if (hourglass_shown_p
)
27867 #endif /* ! WINDOWSNT */