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 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 unsigned long int 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 struct text_pos top
;
1227 struct buffer
*old_buffer
= NULL
;
1229 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1232 if (XBUFFER (w
->buffer
) != current_buffer
)
1234 old_buffer
= current_buffer
;
1235 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1238 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1240 /* Compute exact mode line heights. */
1241 if (WINDOW_WANTS_MODELINE_P (w
))
1242 current_mode_line_height
1243 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1244 BVAR (current_buffer
, mode_line_format
));
1246 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1247 current_header_line_height
1248 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1249 BVAR (current_buffer
, header_line_format
));
1251 start_display (&it
, w
, top
);
1252 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1253 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1255 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1257 /* We have reached CHARPOS, or passed it. How the call to
1258 move_it_to can overshoot: (i) If CHARPOS is on invisible
1259 text, move_it_to stops at the end of the invisible text,
1260 after CHARPOS. (ii) If CHARPOS is in a display vector,
1261 move_it_to stops on its last glyph. */
1262 int top_x
= it
.current_x
;
1263 int top_y
= it
.current_y
;
1264 enum it_method it_method
= it
.method
;
1265 /* Calling line_bottom_y may change it.method, it.position, etc. */
1266 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1267 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1269 if (top_y
< window_top_y
)
1270 visible_p
= bottom_y
> window_top_y
;
1271 else if (top_y
< it
.last_visible_y
)
1275 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1277 /* We stopped on the last glyph of a display vector.
1278 Try and recompute. Hack alert! */
1279 if (charpos
< 2 || top
.charpos
>= charpos
)
1280 top_x
= it
.glyph_row
->x
;
1284 start_display (&it2
, w
, top
);
1285 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1286 get_next_display_element (&it2
);
1287 PRODUCE_GLYPHS (&it2
);
1288 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1289 || it2
.current_x
> it2
.last_visible_x
)
1290 top_x
= it
.glyph_row
->x
;
1293 top_x
= it2
.current_x
;
1294 top_y
= it2
.current_y
;
1300 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1301 *rtop
= max (0, window_top_y
- top_y
);
1302 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1303 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1304 - max (top_y
, window_top_y
)));
1311 void *it2data
= NULL
;
1313 SAVE_IT (it2
, it
, it2data
);
1314 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1315 move_it_by_lines (&it
, 1);
1316 if (charpos
< IT_CHARPOS (it
)
1317 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1320 RESTORE_IT (&it2
, &it2
, it2data
);
1321 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1323 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1324 *rtop
= max (0, -it2
.current_y
);
1325 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1326 - it
.last_visible_y
));
1327 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1329 - max (it2
.current_y
,
1330 WINDOW_HEADER_LINE_HEIGHT (w
))));
1338 set_buffer_internal_1 (old_buffer
);
1340 current_header_line_height
= current_mode_line_height
= -1;
1342 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1343 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1346 /* Debugging code. */
1348 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1349 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1351 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1358 /* Return the next character from STR. Return in *LEN the length of
1359 the character. This is like STRING_CHAR_AND_LENGTH but never
1360 returns an invalid character. If we find one, we return a `?', but
1361 with the length of the invalid character. */
1364 string_char_and_length (const unsigned char *str
, int *len
)
1368 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1369 if (!CHAR_VALID_P (c
, 1))
1370 /* We may not change the length here because other places in Emacs
1371 don't use this function, i.e. they silently accept invalid
1380 /* Given a position POS containing a valid character and byte position
1381 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1383 static struct text_pos
1384 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1386 xassert (STRINGP (string
) && nchars
>= 0);
1388 if (STRING_MULTIBYTE (string
))
1390 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1395 string_char_and_length (p
, &len
);
1398 BYTEPOS (pos
) += len
;
1402 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1408 /* Value is the text position, i.e. character and byte position,
1409 for character position CHARPOS in STRING. */
1411 static INLINE
struct text_pos
1412 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1414 struct text_pos pos
;
1415 xassert (STRINGP (string
));
1416 xassert (charpos
>= 0);
1417 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1422 /* Value is a text position, i.e. character and byte position, for
1423 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1424 means recognize multibyte characters. */
1426 static struct text_pos
1427 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1429 struct text_pos pos
;
1431 xassert (s
!= NULL
);
1432 xassert (charpos
>= 0);
1438 SET_TEXT_POS (pos
, 0, 0);
1441 string_char_and_length ((const unsigned char *) s
, &len
);
1444 BYTEPOS (pos
) += len
;
1448 SET_TEXT_POS (pos
, charpos
, charpos
);
1454 /* Value is the number of characters in C string S. MULTIBYTE_P
1455 non-zero means recognize multibyte characters. */
1458 number_of_chars (const char *s
, int multibyte_p
)
1464 EMACS_INT rest
= strlen (s
);
1466 const unsigned char *p
= (const unsigned char *) s
;
1468 for (nchars
= 0; rest
> 0; ++nchars
)
1470 string_char_and_length (p
, &len
);
1471 rest
-= len
, p
+= len
;
1475 nchars
= strlen (s
);
1481 /* Compute byte position NEWPOS->bytepos corresponding to
1482 NEWPOS->charpos. POS is a known position in string STRING.
1483 NEWPOS->charpos must be >= POS.charpos. */
1486 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1488 xassert (STRINGP (string
));
1489 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1491 if (STRING_MULTIBYTE (string
))
1492 *newpos
= string_pos_nchars_ahead (pos
, string
,
1493 CHARPOS (*newpos
) - CHARPOS (pos
));
1495 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1499 Return an estimation of the pixel height of mode or header lines on
1500 frame F. FACE_ID specifies what line's height to estimate. */
1503 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1505 #ifdef HAVE_WINDOW_SYSTEM
1506 if (FRAME_WINDOW_P (f
))
1508 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1510 /* This function is called so early when Emacs starts that the face
1511 cache and mode line face are not yet initialized. */
1512 if (FRAME_FACE_CACHE (f
))
1514 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1518 height
= FONT_HEIGHT (face
->font
);
1519 if (face
->box_line_width
> 0)
1520 height
+= 2 * face
->box_line_width
;
1531 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1532 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1533 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1534 not force the value into range. */
1537 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1538 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1541 #ifdef HAVE_WINDOW_SYSTEM
1542 if (FRAME_WINDOW_P (f
))
1544 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1545 even for negative values. */
1547 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1549 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1551 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1552 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1555 STORE_NATIVE_RECT (*bounds
,
1556 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1557 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1558 FRAME_COLUMN_WIDTH (f
) - 1,
1559 FRAME_LINE_HEIGHT (f
) - 1);
1565 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1566 pix_x
= FRAME_TOTAL_COLS (f
);
1570 else if (pix_y
> FRAME_LINES (f
))
1571 pix_y
= FRAME_LINES (f
);
1581 /* Find the glyph under window-relative coordinates X/Y in window W.
1582 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1583 strings. Return in *HPOS and *VPOS the row and column number of
1584 the glyph found. Return in *AREA the glyph area containing X.
1585 Value is a pointer to the glyph found or null if X/Y is not on
1586 text, or we can't tell because W's current matrix is not up to
1591 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1592 int *dx
, int *dy
, int *area
)
1594 struct glyph
*glyph
, *end
;
1595 struct glyph_row
*row
= NULL
;
1598 /* Find row containing Y. Give up if some row is not enabled. */
1599 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1601 row
= MATRIX_ROW (w
->current_matrix
, i
);
1602 if (!row
->enabled_p
)
1604 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1611 /* Give up if Y is not in the window. */
1612 if (i
== w
->current_matrix
->nrows
)
1615 /* Get the glyph area containing X. */
1616 if (w
->pseudo_window_p
)
1623 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1625 *area
= LEFT_MARGIN_AREA
;
1626 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1628 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1631 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1635 *area
= RIGHT_MARGIN_AREA
;
1636 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1640 /* Find glyph containing X. */
1641 glyph
= row
->glyphs
[*area
];
1642 end
= glyph
+ row
->used
[*area
];
1644 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1646 x
-= glyph
->pixel_width
;
1656 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1659 *hpos
= glyph
- row
->glyphs
[*area
];
1663 /* Convert frame-relative x/y to coordinates relative to window W.
1664 Takes pseudo-windows into account. */
1667 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1669 if (w
->pseudo_window_p
)
1671 /* A pseudo-window is always full-width, and starts at the
1672 left edge of the frame, plus a frame border. */
1673 struct frame
*f
= XFRAME (w
->frame
);
1674 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1675 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1679 *x
-= WINDOW_LEFT_EDGE_X (w
);
1680 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1684 #ifdef HAVE_WINDOW_SYSTEM
1687 Return in RECTS[] at most N clipping rectangles for glyph string S.
1688 Return the number of stored rectangles. */
1691 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1698 if (s
->row
->full_width_p
)
1700 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1701 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1702 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1704 /* Unless displaying a mode or menu bar line, which are always
1705 fully visible, clip to the visible part of the row. */
1706 if (s
->w
->pseudo_window_p
)
1707 r
.height
= s
->row
->visible_height
;
1709 r
.height
= s
->height
;
1713 /* This is a text line that may be partially visible. */
1714 r
.x
= window_box_left (s
->w
, s
->area
);
1715 r
.width
= window_box_width (s
->w
, s
->area
);
1716 r
.height
= s
->row
->visible_height
;
1720 if (r
.x
< s
->clip_head
->x
)
1722 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1723 r
.width
-= s
->clip_head
->x
- r
.x
;
1726 r
.x
= s
->clip_head
->x
;
1729 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1731 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1732 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1737 /* If S draws overlapping rows, it's sufficient to use the top and
1738 bottom of the window for clipping because this glyph string
1739 intentionally draws over other lines. */
1740 if (s
->for_overlaps
)
1742 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1743 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1745 /* Alas, the above simple strategy does not work for the
1746 environments with anti-aliased text: if the same text is
1747 drawn onto the same place multiple times, it gets thicker.
1748 If the overlap we are processing is for the erased cursor, we
1749 take the intersection with the rectagle of the cursor. */
1750 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1752 XRectangle rc
, r_save
= r
;
1754 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1755 rc
.y
= s
->w
->phys_cursor
.y
;
1756 rc
.width
= s
->w
->phys_cursor_width
;
1757 rc
.height
= s
->w
->phys_cursor_height
;
1759 x_intersect_rectangles (&r_save
, &rc
, &r
);
1764 /* Don't use S->y for clipping because it doesn't take partially
1765 visible lines into account. For example, it can be negative for
1766 partially visible lines at the top of a window. */
1767 if (!s
->row
->full_width_p
1768 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1769 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1771 r
.y
= max (0, s
->row
->y
);
1774 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1776 /* If drawing the cursor, don't let glyph draw outside its
1777 advertised boundaries. Cleartype does this under some circumstances. */
1778 if (s
->hl
== DRAW_CURSOR
)
1780 struct glyph
*glyph
= s
->first_glyph
;
1785 r
.width
-= s
->x
- r
.x
;
1788 r
.width
= min (r
.width
, glyph
->pixel_width
);
1790 /* If r.y is below window bottom, ensure that we still see a cursor. */
1791 height
= min (glyph
->ascent
+ glyph
->descent
,
1792 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1793 max_y
= window_text_bottom_y (s
->w
) - height
;
1794 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1795 if (s
->ybase
- glyph
->ascent
> max_y
)
1802 /* Don't draw cursor glyph taller than our actual glyph. */
1803 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1804 if (height
< r
.height
)
1806 max_y
= r
.y
+ r
.height
;
1807 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1808 r
.height
= min (max_y
- r
.y
, height
);
1815 XRectangle r_save
= r
;
1817 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1821 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1822 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1824 #ifdef CONVERT_FROM_XRECT
1825 CONVERT_FROM_XRECT (r
, *rects
);
1833 /* If we are processing overlapping and allowed to return
1834 multiple clipping rectangles, we exclude the row of the glyph
1835 string from the clipping rectangle. This is to avoid drawing
1836 the same text on the environment with anti-aliasing. */
1837 #ifdef CONVERT_FROM_XRECT
1840 XRectangle
*rs
= rects
;
1842 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1844 if (s
->for_overlaps
& OVERLAPS_PRED
)
1847 if (r
.y
+ r
.height
> row_y
)
1850 rs
[i
].height
= row_y
- r
.y
;
1856 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1859 if (r
.y
< row_y
+ s
->row
->visible_height
)
1861 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1863 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1864 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1873 #ifdef CONVERT_FROM_XRECT
1874 for (i
= 0; i
< n
; i
++)
1875 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1882 Return in *NR the clipping rectangle for glyph string S. */
1885 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1887 get_glyph_string_clip_rects (s
, nr
, 1);
1892 Return the position and height of the phys cursor in window W.
1893 Set w->phys_cursor_width to width of phys cursor.
1897 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1898 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1900 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1901 int x
, y
, wd
, h
, h0
, y0
;
1903 /* Compute the width of the rectangle to draw. If on a stretch
1904 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1905 rectangle as wide as the glyph, but use a canonical character
1907 wd
= glyph
->pixel_width
- 1;
1908 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1912 x
= w
->phys_cursor
.x
;
1919 if (glyph
->type
== STRETCH_GLYPH
1920 && !x_stretch_cursor_p
)
1921 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1922 w
->phys_cursor_width
= wd
;
1924 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1926 /* If y is below window bottom, ensure that we still see a cursor. */
1927 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1929 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1930 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1932 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1935 h
= max (h
- (y0
- y
) + 1, h0
);
1940 y0
= window_text_bottom_y (w
) - h0
;
1948 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1949 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1954 * Remember which glyph the mouse is over.
1958 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1962 struct glyph_row
*r
, *gr
, *end_row
;
1963 enum window_part part
;
1964 enum glyph_row_area area
;
1965 int x
, y
, width
, height
;
1967 /* Try to determine frame pixel position and size of the glyph under
1968 frame pixel coordinates X/Y on frame F. */
1970 if (!f
->glyphs_initialized_p
1971 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1974 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1975 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1979 w
= XWINDOW (window
);
1980 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1981 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1983 x
= window_relative_x_coord (w
, part
, gx
);
1984 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1986 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1987 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1989 if (w
->pseudo_window_p
)
1992 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1998 case ON_LEFT_MARGIN
:
1999 area
= LEFT_MARGIN_AREA
;
2002 case ON_RIGHT_MARGIN
:
2003 area
= RIGHT_MARGIN_AREA
;
2006 case ON_HEADER_LINE
:
2008 gr
= (part
== ON_HEADER_LINE
2009 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2010 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2013 goto text_glyph_row_found
;
2020 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2021 if (r
->y
+ r
->height
> y
)
2027 text_glyph_row_found
:
2030 struct glyph
*g
= gr
->glyphs
[area
];
2031 struct glyph
*end
= g
+ gr
->used
[area
];
2033 height
= gr
->height
;
2034 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2035 if (gx
+ g
->pixel_width
> x
)
2040 if (g
->type
== IMAGE_GLYPH
)
2042 /* Don't remember when mouse is over image, as
2043 image may have hot-spots. */
2044 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2047 width
= g
->pixel_width
;
2051 /* Use nominal char spacing at end of line. */
2053 gx
+= (x
/ width
) * width
;
2056 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2057 gx
+= window_box_left_offset (w
, area
);
2061 /* Use nominal line height at end of window. */
2062 gx
= (x
/ width
) * width
;
2064 gy
+= (y
/ height
) * height
;
2068 case ON_LEFT_FRINGE
:
2069 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2070 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2071 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2072 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2075 case ON_RIGHT_FRINGE
:
2076 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2077 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2078 : window_box_right_offset (w
, TEXT_AREA
));
2079 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2083 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2085 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2086 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2087 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2089 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2093 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2094 if (r
->y
+ r
->height
> y
)
2101 height
= gr
->height
;
2104 /* Use nominal line height at end of window. */
2106 gy
+= (y
/ height
) * height
;
2113 /* If there is no glyph under the mouse, then we divide the screen
2114 into a grid of the smallest glyph in the frame, and use that
2117 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2118 round down even for negative values. */
2124 gx
= (gx
/ width
) * width
;
2125 gy
= (gy
/ height
) * height
;
2130 gx
+= WINDOW_LEFT_EDGE_X (w
);
2131 gy
+= WINDOW_TOP_EDGE_Y (w
);
2134 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2136 /* Visible feedback for debugging. */
2139 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2140 f
->output_data
.x
->normal_gc
,
2141 gx
, gy
, width
, height
);
2147 #endif /* HAVE_WINDOW_SYSTEM */
2150 /***********************************************************************
2151 Lisp form evaluation
2152 ***********************************************************************/
2154 /* Error handler for safe_eval and safe_call. */
2157 safe_eval_handler (Lisp_Object arg
)
2159 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2164 /* Evaluate SEXPR and return the result, or nil if something went
2165 wrong. Prevent redisplay during the evaluation. */
2167 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2168 Return the result, or nil if something went wrong. Prevent
2169 redisplay during the evaluation. */
2172 safe_call (size_t nargs
, Lisp_Object
*args
)
2176 if (inhibit_eval_during_redisplay
)
2180 int count
= SPECPDL_INDEX ();
2181 struct gcpro gcpro1
;
2184 gcpro1
.nvars
= nargs
;
2185 specbind (Qinhibit_redisplay
, Qt
);
2186 /* Use Qt to ensure debugger does not run,
2187 so there is no possibility of wanting to redisplay. */
2188 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2191 val
= unbind_to (count
, val
);
2198 /* Call function FN with one argument ARG.
2199 Return the result, or nil if something went wrong. */
2202 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2204 Lisp_Object args
[2];
2207 return safe_call (2, args
);
2210 static Lisp_Object Qeval
;
2213 safe_eval (Lisp_Object sexpr
)
2215 return safe_call1 (Qeval
, sexpr
);
2218 /* Call function FN with one argument ARG.
2219 Return the result, or nil if something went wrong. */
2222 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2224 Lisp_Object args
[3];
2228 return safe_call (3, args
);
2233 /***********************************************************************
2235 ***********************************************************************/
2239 /* Define CHECK_IT to perform sanity checks on iterators.
2240 This is for debugging. It is too slow to do unconditionally. */
2246 if (it
->method
== GET_FROM_STRING
)
2248 xassert (STRINGP (it
->string
));
2249 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2253 xassert (IT_STRING_CHARPOS (*it
) < 0);
2254 if (it
->method
== GET_FROM_BUFFER
)
2256 /* Check that character and byte positions agree. */
2257 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2262 xassert (it
->current
.dpvec_index
>= 0);
2264 xassert (it
->current
.dpvec_index
< 0);
2267 #define CHECK_IT(IT) check_it ((IT))
2271 #define CHECK_IT(IT) (void) 0
2278 /* Check that the window end of window W is what we expect it
2279 to be---the last row in the current matrix displaying text. */
2282 check_window_end (w
)
2285 if (!MINI_WINDOW_P (w
)
2286 && !NILP (w
->window_end_valid
))
2288 struct glyph_row
*row
;
2289 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2290 XFASTINT (w
->window_end_vpos
)),
2292 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2293 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2297 #define CHECK_WINDOW_END(W) check_window_end ((W))
2299 #else /* not GLYPH_DEBUG */
2301 #define CHECK_WINDOW_END(W) (void) 0
2303 #endif /* not GLYPH_DEBUG */
2307 /***********************************************************************
2308 Iterator initialization
2309 ***********************************************************************/
2311 /* Initialize IT for displaying current_buffer in window W, starting
2312 at character position CHARPOS. CHARPOS < 0 means that no buffer
2313 position is specified which is useful when the iterator is assigned
2314 a position later. BYTEPOS is the byte position corresponding to
2315 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2317 If ROW is not null, calls to produce_glyphs with IT as parameter
2318 will produce glyphs in that row.
2320 BASE_FACE_ID is the id of a base face to use. It must be one of
2321 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2322 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2323 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2325 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2326 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2327 will be initialized to use the corresponding mode line glyph row of
2328 the desired matrix of W. */
2331 init_iterator (struct it
*it
, struct window
*w
,
2332 EMACS_INT charpos
, EMACS_INT bytepos
,
2333 struct glyph_row
*row
, enum face_id base_face_id
)
2335 int highlight_region_p
;
2336 enum face_id remapped_base_face_id
= base_face_id
;
2338 /* Some precondition checks. */
2339 xassert (w
!= NULL
&& it
!= NULL
);
2340 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2343 /* If face attributes have been changed since the last redisplay,
2344 free realized faces now because they depend on face definitions
2345 that might have changed. Don't free faces while there might be
2346 desired matrices pending which reference these faces. */
2347 if (face_change_count
&& !inhibit_free_realized_faces
)
2349 face_change_count
= 0;
2350 free_all_realized_faces (Qnil
);
2353 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2354 if (! NILP (Vface_remapping_alist
))
2355 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2357 /* Use one of the mode line rows of W's desired matrix if
2361 if (base_face_id
== MODE_LINE_FACE_ID
2362 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2363 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2364 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2365 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2369 memset (it
, 0, sizeof *it
);
2370 it
->current
.overlay_string_index
= -1;
2371 it
->current
.dpvec_index
= -1;
2372 it
->base_face_id
= remapped_base_face_id
;
2374 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2375 it
->paragraph_embedding
= L2R
;
2376 it
->bidi_it
.string
.lstring
= Qnil
;
2377 it
->bidi_it
.string
.s
= NULL
;
2378 it
->bidi_it
.string
.bufpos
= 0;
2380 /* The window in which we iterate over current_buffer: */
2381 XSETWINDOW (it
->window
, w
);
2383 it
->f
= XFRAME (w
->frame
);
2387 /* Extra space between lines (on window systems only). */
2388 if (base_face_id
== DEFAULT_FACE_ID
2389 && FRAME_WINDOW_P (it
->f
))
2391 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2392 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2393 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2394 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2395 * FRAME_LINE_HEIGHT (it
->f
));
2396 else if (it
->f
->extra_line_spacing
> 0)
2397 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2398 it
->max_extra_line_spacing
= 0;
2401 /* If realized faces have been removed, e.g. because of face
2402 attribute changes of named faces, recompute them. When running
2403 in batch mode, the face cache of the initial frame is null. If
2404 we happen to get called, make a dummy face cache. */
2405 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2406 init_frame_faces (it
->f
);
2407 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2408 recompute_basic_faces (it
->f
);
2410 /* Current value of the `slice', `space-width', and 'height' properties. */
2411 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2412 it
->space_width
= Qnil
;
2413 it
->font_height
= Qnil
;
2414 it
->override_ascent
= -1;
2416 /* Are control characters displayed as `^C'? */
2417 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2419 /* -1 means everything between a CR and the following line end
2420 is invisible. >0 means lines indented more than this value are
2422 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2423 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2424 : (!NILP (BVAR (current_buffer
, selective_display
))
2426 it
->selective_display_ellipsis_p
2427 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2429 /* Display table to use. */
2430 it
->dp
= window_display_table (w
);
2432 /* Are multibyte characters enabled in current_buffer? */
2433 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2435 /* Non-zero if we should highlight the region. */
2437 = (!NILP (Vtransient_mark_mode
)
2438 && !NILP (BVAR (current_buffer
, mark_active
))
2439 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2441 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2442 start and end of a visible region in window IT->w. Set both to
2443 -1 to indicate no region. */
2444 if (highlight_region_p
2445 /* Maybe highlight only in selected window. */
2446 && (/* Either show region everywhere. */
2447 highlight_nonselected_windows
2448 /* Or show region in the selected window. */
2449 || w
== XWINDOW (selected_window
)
2450 /* Or show the region if we are in the mini-buffer and W is
2451 the window the mini-buffer refers to. */
2452 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2453 && WINDOWP (minibuf_selected_window
)
2454 && w
== XWINDOW (minibuf_selected_window
))))
2456 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2457 it
->region_beg_charpos
= min (PT
, markpos
);
2458 it
->region_end_charpos
= max (PT
, markpos
);
2461 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2463 /* Get the position at which the redisplay_end_trigger hook should
2464 be run, if it is to be run at all. */
2465 if (MARKERP (w
->redisplay_end_trigger
)
2466 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2467 it
->redisplay_end_trigger_charpos
2468 = marker_position (w
->redisplay_end_trigger
);
2469 else if (INTEGERP (w
->redisplay_end_trigger
))
2470 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2472 /* Correct bogus values of tab_width. */
2473 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2474 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2477 /* Are lines in the display truncated? */
2478 if (base_face_id
!= DEFAULT_FACE_ID
2479 || XINT (it
->w
->hscroll
)
2480 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2481 && ((!NILP (Vtruncate_partial_width_windows
)
2482 && !INTEGERP (Vtruncate_partial_width_windows
))
2483 || (INTEGERP (Vtruncate_partial_width_windows
)
2484 && (WINDOW_TOTAL_COLS (it
->w
)
2485 < XINT (Vtruncate_partial_width_windows
))))))
2486 it
->line_wrap
= TRUNCATE
;
2487 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2488 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2489 ? WINDOW_WRAP
: WORD_WRAP
;
2491 it
->line_wrap
= TRUNCATE
;
2493 /* Get dimensions of truncation and continuation glyphs. These are
2494 displayed as fringe bitmaps under X, so we don't need them for such
2496 if (!FRAME_WINDOW_P (it
->f
))
2498 if (it
->line_wrap
== TRUNCATE
)
2500 /* We will need the truncation glyph. */
2501 xassert (it
->glyph_row
== NULL
);
2502 produce_special_glyphs (it
, IT_TRUNCATION
);
2503 it
->truncation_pixel_width
= it
->pixel_width
;
2507 /* We will need the continuation glyph. */
2508 xassert (it
->glyph_row
== NULL
);
2509 produce_special_glyphs (it
, IT_CONTINUATION
);
2510 it
->continuation_pixel_width
= it
->pixel_width
;
2513 /* Reset these values to zero because the produce_special_glyphs
2514 above has changed them. */
2515 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2516 it
->phys_ascent
= it
->phys_descent
= 0;
2519 /* Set this after getting the dimensions of truncation and
2520 continuation glyphs, so that we don't produce glyphs when calling
2521 produce_special_glyphs, above. */
2522 it
->glyph_row
= row
;
2523 it
->area
= TEXT_AREA
;
2525 /* Forget any previous info about this row being reversed. */
2527 it
->glyph_row
->reversed_p
= 0;
2529 /* Get the dimensions of the display area. The display area
2530 consists of the visible window area plus a horizontally scrolled
2531 part to the left of the window. All x-values are relative to the
2532 start of this total display area. */
2533 if (base_face_id
!= DEFAULT_FACE_ID
)
2535 /* Mode lines, menu bar in terminal frames. */
2536 it
->first_visible_x
= 0;
2537 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2542 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2543 it
->last_visible_x
= (it
->first_visible_x
2544 + window_box_width (w
, TEXT_AREA
));
2546 /* If we truncate lines, leave room for the truncator glyph(s) at
2547 the right margin. Otherwise, leave room for the continuation
2548 glyph(s). Truncation and continuation glyphs are not inserted
2549 for window-based redisplay. */
2550 if (!FRAME_WINDOW_P (it
->f
))
2552 if (it
->line_wrap
== TRUNCATE
)
2553 it
->last_visible_x
-= it
->truncation_pixel_width
;
2555 it
->last_visible_x
-= it
->continuation_pixel_width
;
2558 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2559 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2562 /* Leave room for a border glyph. */
2563 if (!FRAME_WINDOW_P (it
->f
)
2564 && !WINDOW_RIGHTMOST_P (it
->w
))
2565 it
->last_visible_x
-= 1;
2567 it
->last_visible_y
= window_text_bottom_y (w
);
2569 /* For mode lines and alike, arrange for the first glyph having a
2570 left box line if the face specifies a box. */
2571 if (base_face_id
!= DEFAULT_FACE_ID
)
2575 it
->face_id
= remapped_base_face_id
;
2577 /* If we have a boxed mode line, make the first character appear
2578 with a left box line. */
2579 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2580 if (face
->box
!= FACE_NO_BOX
)
2581 it
->start_of_box_run_p
= 1;
2584 /* If a buffer position was specified, set the iterator there,
2585 getting overlays and face properties from that position. */
2586 if (charpos
>= BUF_BEG (current_buffer
))
2588 it
->end_charpos
= ZV
;
2590 IT_CHARPOS (*it
) = charpos
;
2592 /* Compute byte position if not specified. */
2593 if (bytepos
< charpos
)
2594 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2596 IT_BYTEPOS (*it
) = bytepos
;
2598 it
->start
= it
->current
;
2599 /* Do we need to reorder bidirectional text? Not if this is a
2600 unibyte buffer: by definition, none of the single-byte
2601 characters are strong R2L, so no reordering is needed. And
2602 bidi.c doesn't support unibyte buffers anyway. */
2604 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2607 /* If we are to reorder bidirectional text, init the bidi
2611 /* Note the paragraph direction that this buffer wants to
2613 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2615 it
->paragraph_embedding
= L2R
;
2616 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2618 it
->paragraph_embedding
= R2L
;
2620 it
->paragraph_embedding
= NEUTRAL_DIR
;
2621 bidi_unshelve_cache (NULL
);
2622 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2626 /* Compute faces etc. */
2627 reseat (it
, it
->current
.pos
, 1);
2634 /* Initialize IT for the display of window W with window start POS. */
2637 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2639 struct glyph_row
*row
;
2640 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2642 row
= w
->desired_matrix
->rows
+ first_vpos
;
2643 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2644 it
->first_vpos
= first_vpos
;
2646 /* Don't reseat to previous visible line start if current start
2647 position is in a string or image. */
2648 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2650 int start_at_line_beg_p
;
2651 int first_y
= it
->current_y
;
2653 /* If window start is not at a line start, skip forward to POS to
2654 get the correct continuation lines width. */
2655 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2656 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2657 if (!start_at_line_beg_p
)
2661 reseat_at_previous_visible_line_start (it
);
2662 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2664 new_x
= it
->current_x
+ it
->pixel_width
;
2666 /* If lines are continued, this line may end in the middle
2667 of a multi-glyph character (e.g. a control character
2668 displayed as \003, or in the middle of an overlay
2669 string). In this case move_it_to above will not have
2670 taken us to the start of the continuation line but to the
2671 end of the continued line. */
2672 if (it
->current_x
> 0
2673 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2674 && (/* And glyph doesn't fit on the line. */
2675 new_x
> it
->last_visible_x
2676 /* Or it fits exactly and we're on a window
2678 || (new_x
== it
->last_visible_x
2679 && FRAME_WINDOW_P (it
->f
))))
2681 if (it
->current
.dpvec_index
>= 0
2682 || it
->current
.overlay_string_index
>= 0)
2684 set_iterator_to_next (it
, 1);
2685 move_it_in_display_line_to (it
, -1, -1, 0);
2688 it
->continuation_lines_width
+= it
->current_x
;
2691 /* We're starting a new display line, not affected by the
2692 height of the continued line, so clear the appropriate
2693 fields in the iterator structure. */
2694 it
->max_ascent
= it
->max_descent
= 0;
2695 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2697 it
->current_y
= first_y
;
2699 it
->current_x
= it
->hpos
= 0;
2705 /* Return 1 if POS is a position in ellipses displayed for invisible
2706 text. W is the window we display, for text property lookup. */
2709 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2711 Lisp_Object prop
, window
;
2713 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2715 /* If POS specifies a position in a display vector, this might
2716 be for an ellipsis displayed for invisible text. We won't
2717 get the iterator set up for delivering that ellipsis unless
2718 we make sure that it gets aware of the invisible text. */
2719 if (pos
->dpvec_index
>= 0
2720 && pos
->overlay_string_index
< 0
2721 && CHARPOS (pos
->string_pos
) < 0
2723 && (XSETWINDOW (window
, w
),
2724 prop
= Fget_char_property (make_number (charpos
),
2725 Qinvisible
, window
),
2726 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2728 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2730 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2737 /* Initialize IT for stepping through current_buffer in window W,
2738 starting at position POS that includes overlay string and display
2739 vector/ control character translation position information. Value
2740 is zero if there are overlay strings with newlines at POS. */
2743 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2745 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2746 int i
, overlay_strings_with_newlines
= 0;
2748 /* If POS specifies a position in a display vector, this might
2749 be for an ellipsis displayed for invisible text. We won't
2750 get the iterator set up for delivering that ellipsis unless
2751 we make sure that it gets aware of the invisible text. */
2752 if (in_ellipses_for_invisible_text_p (pos
, w
))
2758 /* Keep in mind: the call to reseat in init_iterator skips invisible
2759 text, so we might end up at a position different from POS. This
2760 is only a problem when POS is a row start after a newline and an
2761 overlay starts there with an after-string, and the overlay has an
2762 invisible property. Since we don't skip invisible text in
2763 display_line and elsewhere immediately after consuming the
2764 newline before the row start, such a POS will not be in a string,
2765 but the call to init_iterator below will move us to the
2767 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2769 /* This only scans the current chunk -- it should scan all chunks.
2770 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2771 to 16 in 22.1 to make this a lesser problem. */
2772 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2774 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2775 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2777 while (s
< e
&& *s
!= '\n')
2782 overlay_strings_with_newlines
= 1;
2787 /* If position is within an overlay string, set up IT to the right
2789 if (pos
->overlay_string_index
>= 0)
2793 /* If the first overlay string happens to have a `display'
2794 property for an image, the iterator will be set up for that
2795 image, and we have to undo that setup first before we can
2796 correct the overlay string index. */
2797 if (it
->method
== GET_FROM_IMAGE
)
2800 /* We already have the first chunk of overlay strings in
2801 IT->overlay_strings. Load more until the one for
2802 pos->overlay_string_index is in IT->overlay_strings. */
2803 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2805 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2806 it
->current
.overlay_string_index
= 0;
2809 load_overlay_strings (it
, 0);
2810 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2814 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2815 relative_index
= (it
->current
.overlay_string_index
2816 % OVERLAY_STRING_CHUNK_SIZE
);
2817 it
->string
= it
->overlay_strings
[relative_index
];
2818 xassert (STRINGP (it
->string
));
2819 it
->current
.string_pos
= pos
->string_pos
;
2820 it
->method
= GET_FROM_STRING
;
2823 if (CHARPOS (pos
->string_pos
) >= 0)
2825 /* Recorded position is not in an overlay string, but in another
2826 string. This can only be a string from a `display' property.
2827 IT should already be filled with that string. */
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 xassert (STRINGP (it
->string
));
2832 /* Restore position in display vector translations, control
2833 character translations or ellipses. */
2834 if (pos
->dpvec_index
>= 0)
2836 if (it
->dpvec
== NULL
)
2837 get_next_display_element (it
);
2838 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2839 it
->current
.dpvec_index
= pos
->dpvec_index
;
2843 return !overlay_strings_with_newlines
;
2847 /* Initialize IT for stepping through current_buffer in window W
2848 starting at ROW->start. */
2851 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2853 init_from_display_pos (it
, w
, &row
->start
);
2854 it
->start
= row
->start
;
2855 it
->continuation_lines_width
= row
->continuation_lines_width
;
2860 /* Initialize IT for stepping through current_buffer in window W
2861 starting in the line following ROW, i.e. starting at ROW->end.
2862 Value is zero if there are overlay strings with newlines at ROW's
2866 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2870 if (init_from_display_pos (it
, w
, &row
->end
))
2872 if (row
->continued_p
)
2873 it
->continuation_lines_width
2874 = row
->continuation_lines_width
+ row
->pixel_width
;
2885 /***********************************************************************
2887 ***********************************************************************/
2889 /* Called when IT reaches IT->stop_charpos. Handle text property and
2890 overlay changes. Set IT->stop_charpos to the next position where
2894 handle_stop (struct it
*it
)
2896 enum prop_handled handled
;
2897 int handle_overlay_change_p
;
2901 it
->current
.dpvec_index
= -1;
2902 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2903 it
->ignore_overlay_strings_at_pos_p
= 0;
2906 /* Use face of preceding text for ellipsis (if invisible) */
2907 if (it
->selective_display_ellipsis_p
)
2908 it
->saved_face_id
= it
->face_id
;
2912 handled
= HANDLED_NORMALLY
;
2914 /* Call text property handlers. */
2915 for (p
= it_props
; p
->handler
; ++p
)
2917 handled
= p
->handler (it
);
2919 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2921 else if (handled
== HANDLED_RETURN
)
2923 /* We still want to show before and after strings from
2924 overlays even if the actual buffer text is replaced. */
2925 if (!handle_overlay_change_p
2927 || !get_overlay_strings_1 (it
, 0, 0))
2930 setup_for_ellipsis (it
, 0);
2931 /* When handling a display spec, we might load an
2932 empty string. In that case, discard it here. We
2933 used to discard it in handle_single_display_spec,
2934 but that causes get_overlay_strings_1, above, to
2935 ignore overlay strings that we must check. */
2936 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2940 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2944 it
->ignore_overlay_strings_at_pos_p
= 1;
2945 it
->string_from_display_prop_p
= 0;
2946 it
->from_disp_prop_p
= 0;
2947 handle_overlay_change_p
= 0;
2949 handled
= HANDLED_RECOMPUTE_PROPS
;
2952 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2953 handle_overlay_change_p
= 0;
2956 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2958 /* Don't check for overlay strings below when set to deliver
2959 characters from a display vector. */
2960 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2961 handle_overlay_change_p
= 0;
2963 /* Handle overlay changes.
2964 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2965 if it finds overlays. */
2966 if (handle_overlay_change_p
)
2967 handled
= handle_overlay_change (it
);
2972 setup_for_ellipsis (it
, 0);
2976 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2978 /* Determine where to stop next. */
2979 if (handled
== HANDLED_NORMALLY
)
2980 compute_stop_pos (it
);
2984 /* Compute IT->stop_charpos from text property and overlay change
2985 information for IT's current position. */
2988 compute_stop_pos (struct it
*it
)
2990 register INTERVAL iv
, next_iv
;
2991 Lisp_Object object
, limit
, position
;
2992 EMACS_INT charpos
, bytepos
;
2994 /* If nowhere else, stop at the end. */
2995 it
->stop_charpos
= it
->end_charpos
;
2997 if (STRINGP (it
->string
))
2999 /* Strings are usually short, so don't limit the search for
3001 object
= it
->string
;
3003 charpos
= IT_STRING_CHARPOS (*it
);
3004 bytepos
= IT_STRING_BYTEPOS (*it
);
3010 /* If next overlay change is in front of the current stop pos
3011 (which is IT->end_charpos), stop there. Note: value of
3012 next_overlay_change is point-max if no overlay change
3014 charpos
= IT_CHARPOS (*it
);
3015 bytepos
= IT_BYTEPOS (*it
);
3016 pos
= next_overlay_change (charpos
);
3017 if (pos
< it
->stop_charpos
)
3018 it
->stop_charpos
= pos
;
3020 /* If showing the region, we have to stop at the region
3021 start or end because the face might change there. */
3022 if (it
->region_beg_charpos
> 0)
3024 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3025 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3026 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3027 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3030 /* Set up variables for computing the stop position from text
3031 property changes. */
3032 XSETBUFFER (object
, current_buffer
);
3033 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3036 /* Get the interval containing IT's position. Value is a null
3037 interval if there isn't such an interval. */
3038 position
= make_number (charpos
);
3039 iv
= validate_interval_range (object
, &position
, &position
, 0);
3040 if (!NULL_INTERVAL_P (iv
))
3042 Lisp_Object values_here
[LAST_PROP_IDX
];
3045 /* Get properties here. */
3046 for (p
= it_props
; p
->handler
; ++p
)
3047 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3049 /* Look for an interval following iv that has different
3051 for (next_iv
= next_interval (iv
);
3052 (!NULL_INTERVAL_P (next_iv
)
3054 || XFASTINT (limit
) > next_iv
->position
));
3055 next_iv
= next_interval (next_iv
))
3057 for (p
= it_props
; p
->handler
; ++p
)
3059 Lisp_Object new_value
;
3061 new_value
= textget (next_iv
->plist
, *p
->name
);
3062 if (!EQ (values_here
[p
->idx
], new_value
))
3070 if (!NULL_INTERVAL_P (next_iv
))
3072 if (INTEGERP (limit
)
3073 && next_iv
->position
>= XFASTINT (limit
))
3074 /* No text property change up to limit. */
3075 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3077 /* Text properties change in next_iv. */
3078 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3082 if (it
->cmp_it
.id
< 0)
3084 EMACS_INT stoppos
= it
->end_charpos
;
3086 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3088 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3089 stoppos
, it
->string
);
3092 xassert (STRINGP (it
->string
)
3093 || (it
->stop_charpos
>= BEGV
3094 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3098 /* Return the position of the next overlay change after POS in
3099 current_buffer. Value is point-max if no overlay change
3100 follows. This is like `next-overlay-change' but doesn't use
3104 next_overlay_change (EMACS_INT pos
)
3108 Lisp_Object
*overlays
;
3111 /* Get all overlays at the given position. */
3112 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3114 /* If any of these overlays ends before endpos,
3115 use its ending point instead. */
3116 for (i
= 0; i
< noverlays
; ++i
)
3121 oend
= OVERLAY_END (overlays
[i
]);
3122 oendpos
= OVERLAY_POSITION (oend
);
3123 endpos
= min (endpos
, oendpos
);
3129 /* Return the character position of a display string at or after
3130 position specified by POSITION. If no display string exists at or
3131 after POSITION, return ZV. A display string is either an overlay
3132 with `display' property whose value is a string, or a `display'
3133 text property whose value is a string. STRING is data about the
3134 string to iterate; if STRING->lstring is nil, we are iterating a
3135 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3138 compute_display_string_pos (struct text_pos
*position
,
3139 struct bidi_string_data
*string
, int frame_window_p
)
3141 /* OBJECT = nil means current buffer. */
3142 Lisp_Object object
=
3143 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3144 Lisp_Object pos
, spec
;
3145 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3146 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3147 EMACS_INT begb
= string_p
? 0 : BEGV
;
3148 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3149 struct text_pos tpos
;
3152 /* We don't support display properties whose values are strings
3153 that have display string properties. */
3154 || string
->from_disp_str
3155 /* C strings cannot have display properties. */
3156 || (string
->s
&& !STRINGP (object
)))
3159 /* If the character at CHARPOS is where the display string begins,
3161 pos
= make_number (charpos
);
3162 if (STRINGP (object
))
3163 bufpos
= string
->bufpos
;
3167 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3169 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3172 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3176 /* Look forward for the first character with a `display' property
3177 that will replace the underlying text when displayed. */
3179 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3180 CHARPOS (tpos
) = XFASTINT (pos
);
3181 if (STRINGP (object
))
3182 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3184 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3185 if (CHARPOS (tpos
) >= eob
)
3187 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3188 if (!STRINGP (object
))
3189 bufpos
= CHARPOS (tpos
);
3190 } while (NILP (spec
)
3191 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3194 return CHARPOS (tpos
);
3197 /* Return the character position of the end of the display string that
3198 started at CHARPOS. A display string is either an overlay with
3199 `display' property whose value is a string or a `display' text
3200 property whose value is a string. */
3202 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3204 /* OBJECT = nil means current buffer. */
3205 Lisp_Object object
=
3206 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3207 Lisp_Object pos
= make_number (charpos
);
3209 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3211 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3214 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3217 /* Look forward for the first character where the `display' property
3219 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3221 return XFASTINT (pos
);
3226 /***********************************************************************
3228 ***********************************************************************/
3230 /* Handle changes in the `fontified' property of the current buffer by
3231 calling hook functions from Qfontification_functions to fontify
3234 static enum prop_handled
3235 handle_fontified_prop (struct it
*it
)
3237 Lisp_Object prop
, pos
;
3238 enum prop_handled handled
= HANDLED_NORMALLY
;
3240 if (!NILP (Vmemory_full
))
3243 /* Get the value of the `fontified' property at IT's current buffer
3244 position. (The `fontified' property doesn't have a special
3245 meaning in strings.) If the value is nil, call functions from
3246 Qfontification_functions. */
3247 if (!STRINGP (it
->string
)
3249 && !NILP (Vfontification_functions
)
3250 && !NILP (Vrun_hooks
)
3251 && (pos
= make_number (IT_CHARPOS (*it
)),
3252 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3253 /* Ignore the special cased nil value always present at EOB since
3254 no amount of fontifying will be able to change it. */
3255 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3257 int count
= SPECPDL_INDEX ();
3259 struct buffer
*obuf
= current_buffer
;
3260 int begv
= BEGV
, zv
= ZV
;
3261 int old_clip_changed
= current_buffer
->clip_changed
;
3263 val
= Vfontification_functions
;
3264 specbind (Qfontification_functions
, Qnil
);
3266 xassert (it
->end_charpos
== ZV
);
3268 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3269 safe_call1 (val
, pos
);
3272 Lisp_Object fns
, fn
;
3273 struct gcpro gcpro1
, gcpro2
;
3278 for (; CONSP (val
); val
= XCDR (val
))
3284 /* A value of t indicates this hook has a local
3285 binding; it means to run the global binding too.
3286 In a global value, t should not occur. If it
3287 does, we must ignore it to avoid an endless
3289 for (fns
= Fdefault_value (Qfontification_functions
);
3295 safe_call1 (fn
, pos
);
3299 safe_call1 (fn
, pos
);
3305 unbind_to (count
, Qnil
);
3307 /* Fontification functions routinely call `save-restriction'.
3308 Normally, this tags clip_changed, which can confuse redisplay
3309 (see discussion in Bug#6671). Since we don't perform any
3310 special handling of fontification changes in the case where
3311 `save-restriction' isn't called, there's no point doing so in
3312 this case either. So, if the buffer's restrictions are
3313 actually left unchanged, reset clip_changed. */
3314 if (obuf
== current_buffer
)
3316 if (begv
== BEGV
&& zv
== ZV
)
3317 current_buffer
->clip_changed
= old_clip_changed
;
3319 /* There isn't much we can reasonably do to protect against
3320 misbehaving fontification, but here's a fig leaf. */
3321 else if (!NILP (BVAR (obuf
, name
)))
3322 set_buffer_internal_1 (obuf
);
3324 /* The fontification code may have added/removed text.
3325 It could do even a lot worse, but let's at least protect against
3326 the most obvious case where only the text past `pos' gets changed',
3327 as is/was done in grep.el where some escapes sequences are turned
3328 into face properties (bug#7876). */
3329 it
->end_charpos
= ZV
;
3331 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3332 something. This avoids an endless loop if they failed to
3333 fontify the text for which reason ever. */
3334 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3335 handled
= HANDLED_RECOMPUTE_PROPS
;
3343 /***********************************************************************
3345 ***********************************************************************/
3347 /* Set up iterator IT from face properties at its current position.
3348 Called from handle_stop. */
3350 static enum prop_handled
3351 handle_face_prop (struct it
*it
)
3354 EMACS_INT next_stop
;
3356 if (!STRINGP (it
->string
))
3359 = face_at_buffer_position (it
->w
,
3361 it
->region_beg_charpos
,
3362 it
->region_end_charpos
,
3365 + TEXT_PROP_DISTANCE_LIMIT
),
3366 0, it
->base_face_id
);
3368 /* Is this a start of a run of characters with box face?
3369 Caveat: this can be called for a freshly initialized
3370 iterator; face_id is -1 in this case. We know that the new
3371 face will not change until limit, i.e. if the new face has a
3372 box, all characters up to limit will have one. But, as
3373 usual, we don't know whether limit is really the end. */
3374 if (new_face_id
!= it
->face_id
)
3376 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3378 /* If new face has a box but old face has not, this is
3379 the start of a run of characters with box, i.e. it has
3380 a shadow on the left side. The value of face_id of the
3381 iterator will be -1 if this is the initial call that gets
3382 the face. In this case, we have to look in front of IT's
3383 position and see whether there is a face != new_face_id. */
3384 it
->start_of_box_run_p
3385 = (new_face
->box
!= FACE_NO_BOX
3386 && (it
->face_id
>= 0
3387 || IT_CHARPOS (*it
) == BEG
3388 || new_face_id
!= face_before_it_pos (it
)));
3389 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3397 Lisp_Object from_overlay
3398 = (it
->current
.overlay_string_index
>= 0
3399 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3402 /* See if we got to this string directly or indirectly from
3403 an overlay property. That includes the before-string or
3404 after-string of an overlay, strings in display properties
3405 provided by an overlay, their text properties, etc.
3407 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3408 if (! NILP (from_overlay
))
3409 for (i
= it
->sp
- 1; i
>= 0; i
--)
3411 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3413 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3414 else if (! NILP (it
->stack
[i
].from_overlay
))
3415 from_overlay
= it
->stack
[i
].from_overlay
;
3417 if (!NILP (from_overlay
))
3421 if (! NILP (from_overlay
))
3423 bufpos
= IT_CHARPOS (*it
);
3424 /* For a string from an overlay, the base face depends
3425 only on text properties and ignores overlays. */
3427 = face_for_overlay_string (it
->w
,
3429 it
->region_beg_charpos
,
3430 it
->region_end_charpos
,
3433 + TEXT_PROP_DISTANCE_LIMIT
),
3441 /* For strings from a `display' property, use the face at
3442 IT's current buffer position as the base face to merge
3443 with, so that overlay strings appear in the same face as
3444 surrounding text, unless they specify their own
3446 base_face_id
= underlying_face_id (it
);
3449 new_face_id
= face_at_string_position (it
->w
,
3451 IT_STRING_CHARPOS (*it
),
3453 it
->region_beg_charpos
,
3454 it
->region_end_charpos
,
3458 /* Is this a start of a run of characters with box? Caveat:
3459 this can be called for a freshly allocated iterator; face_id
3460 is -1 is this case. We know that the new face will not
3461 change until the next check pos, i.e. if the new face has a
3462 box, all characters up to that position will have a
3463 box. But, as usual, we don't know whether that position
3464 is really the end. */
3465 if (new_face_id
!= it
->face_id
)
3467 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3468 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3470 /* If new face has a box but old face hasn't, this is the
3471 start of a run of characters with box, i.e. it has a
3472 shadow on the left side. */
3473 it
->start_of_box_run_p
3474 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3475 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3479 it
->face_id
= new_face_id
;
3480 return HANDLED_NORMALLY
;
3484 /* Return the ID of the face ``underlying'' IT's current position,
3485 which is in a string. If the iterator is associated with a
3486 buffer, return the face at IT's current buffer position.
3487 Otherwise, use the iterator's base_face_id. */
3490 underlying_face_id (struct it
*it
)
3492 int face_id
= it
->base_face_id
, i
;
3494 xassert (STRINGP (it
->string
));
3496 for (i
= it
->sp
- 1; i
>= 0; --i
)
3497 if (NILP (it
->stack
[i
].string
))
3498 face_id
= it
->stack
[i
].face_id
;
3504 /* Compute the face one character before or after the current position
3505 of IT, in the visual order. BEFORE_P non-zero means get the face
3506 in front (to the left in L2R paragraphs, to the right in R2L
3507 paragraphs) of IT's screen position. Value is the ID of the face. */
3510 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3513 EMACS_INT next_check_charpos
;
3515 void *it_copy_data
= NULL
;
3517 xassert (it
->s
== NULL
);
3519 if (STRINGP (it
->string
))
3521 EMACS_INT bufpos
, charpos
;
3524 /* No face change past the end of the string (for the case
3525 we are padding with spaces). No face change before the
3527 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3528 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3533 /* Set charpos to the position before or after IT's current
3534 position, in the logical order, which in the non-bidi
3535 case is the same as the visual order. */
3537 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3538 else if (it
->what
== IT_COMPOSITION
)
3539 /* For composition, we must check the character after the
3541 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3543 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3549 /* With bidi iteration, the character before the current
3550 in the visual order cannot be found by simple
3551 iteration, because "reverse" reordering is not
3552 supported. Instead, we need to use the move_it_*
3553 family of functions. */
3554 /* Ignore face changes before the first visible
3555 character on this display line. */
3556 if (it
->current_x
<= it
->first_visible_x
)
3558 SAVE_IT (it_copy
, *it
, it_copy_data
);
3559 /* Implementation note: Since move_it_in_display_line
3560 works in the iterator geometry, and thinks the first
3561 character is always the leftmost, even in R2L lines,
3562 we don't need to distinguish between the R2L and L2R
3564 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3565 it_copy
.current_x
- 1, MOVE_TO_X
);
3566 charpos
= IT_STRING_CHARPOS (it_copy
);
3567 RESTORE_IT (it
, it
, it_copy_data
);
3571 /* Set charpos to the string position of the character
3572 that comes after IT's current position in the visual
3574 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3578 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3580 charpos
= it_copy
.bidi_it
.charpos
;
3583 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3585 if (it
->current
.overlay_string_index
>= 0)
3586 bufpos
= IT_CHARPOS (*it
);
3590 base_face_id
= underlying_face_id (it
);
3592 /* Get the face for ASCII, or unibyte. */
3593 face_id
= face_at_string_position (it
->w
,
3597 it
->region_beg_charpos
,
3598 it
->region_end_charpos
,
3599 &next_check_charpos
,
3602 /* Correct the face for charsets different from ASCII. Do it
3603 for the multibyte case only. The face returned above is
3604 suitable for unibyte text if IT->string is unibyte. */
3605 if (STRING_MULTIBYTE (it
->string
))
3607 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3608 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3610 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3612 c
= string_char_and_length (p
, &len
);
3613 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3618 struct text_pos pos
;
3620 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3621 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3624 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3625 pos
= it
->current
.pos
;
3630 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3633 if (it
->what
== IT_COMPOSITION
)
3635 /* For composition, we must check the position after
3637 pos
.charpos
+= it
->cmp_it
.nchars
;
3638 pos
.bytepos
+= it
->len
;
3641 INC_TEXT_POS (pos
, it
->multibyte_p
);
3648 /* With bidi iteration, the character before the current
3649 in the visual order cannot be found by simple
3650 iteration, because "reverse" reordering is not
3651 supported. Instead, we need to use the move_it_*
3652 family of functions. */
3653 /* Ignore face changes before the first visible
3654 character on this display line. */
3655 if (it
->current_x
<= it
->first_visible_x
)
3657 SAVE_IT (it_copy
, *it
, it_copy_data
);
3658 /* Implementation note: Since move_it_in_display_line
3659 works in the iterator geometry, and thinks the first
3660 character is always the leftmost, even in R2L lines,
3661 we don't need to distinguish between the R2L and L2R
3663 move_it_in_display_line (&it_copy
, ZV
,
3664 it_copy
.current_x
- 1, MOVE_TO_X
);
3665 pos
= it_copy
.current
.pos
;
3666 RESTORE_IT (it
, it
, it_copy_data
);
3670 /* Set charpos to the buffer position of the character
3671 that comes after IT's current position in the visual
3673 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3677 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3680 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3683 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3685 /* Determine face for CHARSET_ASCII, or unibyte. */
3686 face_id
= face_at_buffer_position (it
->w
,
3688 it
->region_beg_charpos
,
3689 it
->region_end_charpos
,
3690 &next_check_charpos
,
3693 /* Correct the face for charsets different from ASCII. Do it
3694 for the multibyte case only. The face returned above is
3695 suitable for unibyte text if current_buffer is unibyte. */
3696 if (it
->multibyte_p
)
3698 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3699 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3700 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3709 /***********************************************************************
3711 ***********************************************************************/
3713 /* Set up iterator IT from invisible properties at its current
3714 position. Called from handle_stop. */
3716 static enum prop_handled
3717 handle_invisible_prop (struct it
*it
)
3719 enum prop_handled handled
= HANDLED_NORMALLY
;
3721 if (STRINGP (it
->string
))
3723 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3725 /* Get the value of the invisible text property at the
3726 current position. Value will be nil if there is no such
3728 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3729 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3732 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3736 handled
= HANDLED_RECOMPUTE_PROPS
;
3738 /* Get the position at which the next change of the
3739 invisible text property can be found in IT->string.
3740 Value will be nil if the property value is the same for
3741 all the rest of IT->string. */
3742 XSETINT (limit
, SCHARS (it
->string
));
3743 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3746 /* Text at current position is invisible. The next
3747 change in the property is at position end_charpos.
3748 Move IT's current position to that position. */
3749 if (INTEGERP (end_charpos
)
3750 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3752 struct text_pos old
;
3755 old
= it
->current
.string_pos
;
3756 oldpos
= CHARPOS (old
);
3759 if (it
->bidi_it
.first_elt
3760 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3761 bidi_paragraph_init (it
->paragraph_embedding
,
3763 /* Bidi-iterate out of the invisible text. */
3766 bidi_move_to_visually_next (&it
->bidi_it
);
3768 while (oldpos
<= it
->bidi_it
.charpos
3769 && it
->bidi_it
.charpos
< endpos
);
3771 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3772 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3773 if (IT_CHARPOS (*it
) >= endpos
)
3774 it
->prev_stop
= endpos
;
3778 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3779 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3784 /* The rest of the string is invisible. If this is an
3785 overlay string, proceed with the next overlay string
3786 or whatever comes and return a character from there. */
3787 if (it
->current
.overlay_string_index
>= 0)
3789 next_overlay_string (it
);
3790 /* Don't check for overlay strings when we just
3791 finished processing them. */
3792 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3796 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3797 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3805 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3806 Lisp_Object pos
, prop
, overlay
;
3808 /* First of all, is there invisible text at this position? */
3809 tem
= start_charpos
= IT_CHARPOS (*it
);
3810 pos
= make_number (tem
);
3811 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3813 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3815 /* If we are on invisible text, skip over it. */
3816 if (invis_p
&& start_charpos
< it
->end_charpos
)
3818 /* Record whether we have to display an ellipsis for the
3820 int display_ellipsis_p
= invis_p
== 2;
3822 handled
= HANDLED_RECOMPUTE_PROPS
;
3824 /* Loop skipping over invisible text. The loop is left at
3825 ZV or with IT on the first char being visible again. */
3828 /* Try to skip some invisible text. Return value is the
3829 position reached which can be equal to where we start
3830 if there is nothing invisible there. This skips both
3831 over invisible text properties and overlays with
3832 invisible property. */
3833 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3835 /* If we skipped nothing at all we weren't at invisible
3836 text in the first place. If everything to the end of
3837 the buffer was skipped, end the loop. */
3838 if (newpos
== tem
|| newpos
>= ZV
)
3842 /* We skipped some characters but not necessarily
3843 all there are. Check if we ended up on visible
3844 text. Fget_char_property returns the property of
3845 the char before the given position, i.e. if we
3846 get invis_p = 0, this means that the char at
3847 newpos is visible. */
3848 pos
= make_number (newpos
);
3849 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3850 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3853 /* If we ended up on invisible text, proceed to
3854 skip starting with next_stop. */
3858 /* If there are adjacent invisible texts, don't lose the
3859 second one's ellipsis. */
3861 display_ellipsis_p
= 1;
3865 /* The position newpos is now either ZV or on visible text. */
3866 if (it
->bidi_p
&& newpos
< ZV
)
3868 /* With bidi iteration, the region of invisible text
3869 could start and/or end in the middle of a non-base
3870 embedding level. Therefore, we need to skip
3871 invisible text using the bidi iterator, starting at
3872 IT's current position, until we find ourselves
3873 outside the invisible text. Skipping invisible text
3874 _after_ bidi iteration avoids affecting the visual
3875 order of the displayed text when invisible properties
3876 are added or removed. */
3877 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3879 /* If we were `reseat'ed to a new paragraph,
3880 determine the paragraph base direction. We need
3881 to do it now because next_element_from_buffer may
3882 not have a chance to do it, if we are going to
3883 skip any text at the beginning, which resets the
3885 bidi_paragraph_init (it
->paragraph_embedding
,
3890 bidi_move_to_visually_next (&it
->bidi_it
);
3892 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3893 && it
->bidi_it
.charpos
< newpos
);
3894 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3895 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3896 /* If we overstepped NEWPOS, record its position in the
3897 iterator, so that we skip invisible text if later the
3898 bidi iteration lands us in the invisible region
3900 if (IT_CHARPOS (*it
) >= newpos
)
3901 it
->prev_stop
= newpos
;
3905 IT_CHARPOS (*it
) = newpos
;
3906 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3909 /* If there are before-strings at the start of invisible
3910 text, and the text is invisible because of a text
3911 property, arrange to show before-strings because 20.x did
3912 it that way. (If the text is invisible because of an
3913 overlay property instead of a text property, this is
3914 already handled in the overlay code.) */
3916 && get_overlay_strings (it
, it
->stop_charpos
))
3918 handled
= HANDLED_RECOMPUTE_PROPS
;
3919 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3921 else if (display_ellipsis_p
)
3923 /* Make sure that the glyphs of the ellipsis will get
3924 correct `charpos' values. If we would not update
3925 it->position here, the glyphs would belong to the
3926 last visible character _before_ the invisible
3927 text, which confuses `set_cursor_from_row'.
3929 We use the last invisible position instead of the
3930 first because this way the cursor is always drawn on
3931 the first "." of the ellipsis, whenever PT is inside
3932 the invisible text. Otherwise the cursor would be
3933 placed _after_ the ellipsis when the point is after the
3934 first invisible character. */
3935 if (!STRINGP (it
->object
))
3937 it
->position
.charpos
= newpos
- 1;
3938 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3941 /* Let the ellipsis display before
3942 considering any properties of the following char.
3943 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3944 handled
= HANDLED_RETURN
;
3953 /* Make iterator IT return `...' next.
3954 Replaces LEN characters from buffer. */
3957 setup_for_ellipsis (struct it
*it
, int len
)
3959 /* Use the display table definition for `...'. Invalid glyphs
3960 will be handled by the method returning elements from dpvec. */
3961 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3963 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3964 it
->dpvec
= v
->contents
;
3965 it
->dpend
= v
->contents
+ v
->header
.size
;
3969 /* Default `...'. */
3970 it
->dpvec
= default_invis_vector
;
3971 it
->dpend
= default_invis_vector
+ 3;
3974 it
->dpvec_char_len
= len
;
3975 it
->current
.dpvec_index
= 0;
3976 it
->dpvec_face_id
= -1;
3978 /* Remember the current face id in case glyphs specify faces.
3979 IT's face is restored in set_iterator_to_next.
3980 saved_face_id was set to preceding char's face in handle_stop. */
3981 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3982 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3984 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3990 /***********************************************************************
3992 ***********************************************************************/
3994 /* Set up iterator IT from `display' property at its current position.
3995 Called from handle_stop.
3996 We return HANDLED_RETURN if some part of the display property
3997 overrides the display of the buffer text itself.
3998 Otherwise we return HANDLED_NORMALLY. */
4000 static enum prop_handled
4001 handle_display_prop (struct it
*it
)
4003 Lisp_Object propval
, object
, overlay
;
4004 struct text_pos
*position
;
4006 /* Nonzero if some property replaces the display of the text itself. */
4007 int display_replaced_p
= 0;
4009 if (STRINGP (it
->string
))
4011 object
= it
->string
;
4012 position
= &it
->current
.string_pos
;
4013 bufpos
= CHARPOS (it
->current
.pos
);
4017 XSETWINDOW (object
, it
->w
);
4018 position
= &it
->current
.pos
;
4019 bufpos
= CHARPOS (*position
);
4022 /* Reset those iterator values set from display property values. */
4023 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4024 it
->space_width
= Qnil
;
4025 it
->font_height
= Qnil
;
4028 /* We don't support recursive `display' properties, i.e. string
4029 values that have a string `display' property, that have a string
4030 `display' property etc. */
4031 if (!it
->string_from_display_prop_p
)
4032 it
->area
= TEXT_AREA
;
4034 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4035 Qdisplay
, object
, &overlay
);
4037 return HANDLED_NORMALLY
;
4038 /* Now OVERLAY is the overlay that gave us this property, or nil
4039 if it was a text property. */
4041 if (!STRINGP (it
->string
))
4042 object
= it
->w
->buffer
;
4044 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4046 FRAME_WINDOW_P (it
->f
));
4048 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4051 /* Subroutine of handle_display_prop. Returns non-zero if the display
4052 specification in SPEC is a replacing specification, i.e. it would
4053 replace the text covered by `display' property with something else,
4054 such as an image or a display string.
4056 See handle_single_display_spec for documentation of arguments.
4057 frame_window_p is non-zero if the window being redisplayed is on a
4058 GUI frame; this argument is used only if IT is NULL, see below.
4060 IT can be NULL, if this is called by the bidi reordering code
4061 through compute_display_string_pos, which see. In that case, this
4062 function only examines SPEC, but does not otherwise "handle" it, in
4063 the sense that it doesn't set up members of IT from the display
4066 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4067 Lisp_Object overlay
, struct text_pos
*position
,
4068 EMACS_INT bufpos
, int frame_window_p
)
4070 int replacing_p
= 0;
4073 /* Simple specerties. */
4074 && !EQ (XCAR (spec
), Qimage
)
4075 && !EQ (XCAR (spec
), Qspace
)
4076 && !EQ (XCAR (spec
), Qwhen
)
4077 && !EQ (XCAR (spec
), Qslice
)
4078 && !EQ (XCAR (spec
), Qspace_width
)
4079 && !EQ (XCAR (spec
), Qheight
)
4080 && !EQ (XCAR (spec
), Qraise
)
4081 /* Marginal area specifications. */
4082 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4083 && !EQ (XCAR (spec
), Qleft_fringe
)
4084 && !EQ (XCAR (spec
), Qright_fringe
)
4085 && !NILP (XCAR (spec
)))
4087 for (; CONSP (spec
); spec
= XCDR (spec
))
4089 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4090 position
, bufpos
, replacing_p
,
4094 /* If some text in a string is replaced, `position' no
4095 longer points to the position of `object'. */
4096 if (!it
|| STRINGP (object
))
4101 else if (VECTORP (spec
))
4104 for (i
= 0; i
< ASIZE (spec
); ++i
)
4105 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4106 position
, bufpos
, replacing_p
,
4110 /* If some text in a string is replaced, `position' no
4111 longer points to the position of `object'. */
4112 if (!it
|| STRINGP (object
))
4118 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4119 position
, bufpos
, 0, frame_window_p
))
4126 /* Value is the position of the end of the `display' property starting
4127 at START_POS in OBJECT. */
4129 static struct text_pos
4130 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4133 struct text_pos end_pos
;
4135 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4136 Qdisplay
, object
, Qnil
);
4137 CHARPOS (end_pos
) = XFASTINT (end
);
4138 if (STRINGP (object
))
4139 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4141 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4147 /* Set up IT from a single `display' property specification SPEC. OBJECT
4148 is the object in which the `display' property was found. *POSITION
4149 is the position in OBJECT at which the `display' property was found.
4150 BUFPOS is the buffer position of OBJECT (different from POSITION if
4151 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4152 previously saw a display specification which already replaced text
4153 display with something else, for example an image; we ignore such
4154 properties after the first one has been processed.
4156 OVERLAY is the overlay this `display' property came from,
4157 or nil if it was a text property.
4159 If SPEC is a `space' or `image' specification, and in some other
4160 cases too, set *POSITION to the position where the `display'
4163 If IT is NULL, only examine the property specification in SPEC, but
4164 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4165 is intended to be displayed in a window on a GUI frame.
4167 Value is non-zero if something was found which replaces the display
4168 of buffer or string text. */
4171 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4172 Lisp_Object overlay
, struct text_pos
*position
,
4173 EMACS_INT bufpos
, int display_replaced_p
,
4177 Lisp_Object location
, value
;
4178 struct text_pos start_pos
= *position
;
4181 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4182 If the result is non-nil, use VALUE instead of SPEC. */
4184 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4193 if (!NILP (form
) && !EQ (form
, Qt
))
4195 int count
= SPECPDL_INDEX ();
4196 struct gcpro gcpro1
;
4198 /* Bind `object' to the object having the `display' property, a
4199 buffer or string. Bind `position' to the position in the
4200 object where the property was found, and `buffer-position'
4201 to the current position in the buffer. */
4204 XSETBUFFER (object
, current_buffer
);
4205 specbind (Qobject
, object
);
4206 specbind (Qposition
, make_number (CHARPOS (*position
)));
4207 specbind (Qbuffer_position
, make_number (bufpos
));
4209 form
= safe_eval (form
);
4211 unbind_to (count
, Qnil
);
4217 /* Handle `(height HEIGHT)' specifications. */
4219 && EQ (XCAR (spec
), Qheight
)
4220 && CONSP (XCDR (spec
)))
4224 if (!FRAME_WINDOW_P (it
->f
))
4227 it
->font_height
= XCAR (XCDR (spec
));
4228 if (!NILP (it
->font_height
))
4230 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4231 int new_height
= -1;
4233 if (CONSP (it
->font_height
)
4234 && (EQ (XCAR (it
->font_height
), Qplus
)
4235 || EQ (XCAR (it
->font_height
), Qminus
))
4236 && CONSP (XCDR (it
->font_height
))
4237 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4239 /* `(+ N)' or `(- N)' where N is an integer. */
4240 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4241 if (EQ (XCAR (it
->font_height
), Qplus
))
4243 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4245 else if (FUNCTIONP (it
->font_height
))
4247 /* Call function with current height as argument.
4248 Value is the new height. */
4250 height
= safe_call1 (it
->font_height
,
4251 face
->lface
[LFACE_HEIGHT_INDEX
]);
4252 if (NUMBERP (height
))
4253 new_height
= XFLOATINT (height
);
4255 else if (NUMBERP (it
->font_height
))
4257 /* Value is a multiple of the canonical char height. */
4260 f
= FACE_FROM_ID (it
->f
,
4261 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4262 new_height
= (XFLOATINT (it
->font_height
)
4263 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4267 /* Evaluate IT->font_height with `height' bound to the
4268 current specified height to get the new height. */
4269 int count
= SPECPDL_INDEX ();
4271 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4272 value
= safe_eval (it
->font_height
);
4273 unbind_to (count
, Qnil
);
4275 if (NUMBERP (value
))
4276 new_height
= XFLOATINT (value
);
4280 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4287 /* Handle `(space-width WIDTH)'. */
4289 && EQ (XCAR (spec
), Qspace_width
)
4290 && CONSP (XCDR (spec
)))
4294 if (!FRAME_WINDOW_P (it
->f
))
4297 value
= XCAR (XCDR (spec
));
4298 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4299 it
->space_width
= value
;
4305 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4307 && EQ (XCAR (spec
), Qslice
))
4313 if (!FRAME_WINDOW_P (it
->f
))
4316 if (tem
= XCDR (spec
), CONSP (tem
))
4318 it
->slice
.x
= XCAR (tem
);
4319 if (tem
= XCDR (tem
), CONSP (tem
))
4321 it
->slice
.y
= XCAR (tem
);
4322 if (tem
= XCDR (tem
), CONSP (tem
))
4324 it
->slice
.width
= XCAR (tem
);
4325 if (tem
= XCDR (tem
), CONSP (tem
))
4326 it
->slice
.height
= XCAR (tem
);
4335 /* Handle `(raise FACTOR)'. */
4337 && EQ (XCAR (spec
), Qraise
)
4338 && CONSP (XCDR (spec
)))
4342 if (!FRAME_WINDOW_P (it
->f
))
4345 #ifdef HAVE_WINDOW_SYSTEM
4346 value
= XCAR (XCDR (spec
));
4347 if (NUMBERP (value
))
4349 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4350 it
->voffset
= - (XFLOATINT (value
)
4351 * (FONT_HEIGHT (face
->font
)));
4353 #endif /* HAVE_WINDOW_SYSTEM */
4359 /* Don't handle the other kinds of display specifications
4360 inside a string that we got from a `display' property. */
4361 if (it
&& it
->string_from_display_prop_p
)
4364 /* Characters having this form of property are not displayed, so
4365 we have to find the end of the property. */
4368 start_pos
= *position
;
4369 *position
= display_prop_end (it
, object
, start_pos
);
4373 /* Stop the scan at that end position--we assume that all
4374 text properties change there. */
4376 it
->stop_charpos
= position
->charpos
;
4378 /* Handle `(left-fringe BITMAP [FACE])'
4379 and `(right-fringe BITMAP [FACE])'. */
4381 && (EQ (XCAR (spec
), Qleft_fringe
)
4382 || EQ (XCAR (spec
), Qright_fringe
))
4383 && CONSP (XCDR (spec
)))
4389 if (!FRAME_WINDOW_P (it
->f
))
4390 /* If we return here, POSITION has been advanced
4391 across the text with this property. */
4394 else if (!frame_window_p
)
4397 #ifdef HAVE_WINDOW_SYSTEM
4398 value
= XCAR (XCDR (spec
));
4399 if (!SYMBOLP (value
)
4400 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4401 /* If we return here, POSITION has been advanced
4402 across the text with this property. */
4407 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4409 if (CONSP (XCDR (XCDR (spec
))))
4411 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4412 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4418 /* Save current settings of IT so that we can restore them
4419 when we are finished with the glyph property value. */
4420 push_it (it
, position
);
4422 it
->area
= TEXT_AREA
;
4423 it
->what
= IT_IMAGE
;
4424 it
->image_id
= -1; /* no image */
4425 it
->position
= start_pos
;
4426 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4427 it
->method
= GET_FROM_IMAGE
;
4428 it
->from_overlay
= Qnil
;
4429 it
->face_id
= face_id
;
4430 it
->from_disp_prop_p
= 1;
4432 /* Say that we haven't consumed the characters with
4433 `display' property yet. The call to pop_it in
4434 set_iterator_to_next will clean this up. */
4435 *position
= start_pos
;
4437 if (EQ (XCAR (spec
), Qleft_fringe
))
4439 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4440 it
->left_user_fringe_face_id
= face_id
;
4444 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4445 it
->right_user_fringe_face_id
= face_id
;
4448 #endif /* HAVE_WINDOW_SYSTEM */
4452 /* Prepare to handle `((margin left-margin) ...)',
4453 `((margin right-margin) ...)' and `((margin nil) ...)'
4454 prefixes for display specifications. */
4455 location
= Qunbound
;
4456 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4460 value
= XCDR (spec
);
4462 value
= XCAR (value
);
4465 if (EQ (XCAR (tem
), Qmargin
)
4466 && (tem
= XCDR (tem
),
4467 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4469 || EQ (tem
, Qleft_margin
)
4470 || EQ (tem
, Qright_margin
))))
4474 if (EQ (location
, Qunbound
))
4480 /* After this point, VALUE is the property after any
4481 margin prefix has been stripped. It must be a string,
4482 an image specification, or `(space ...)'.
4484 LOCATION specifies where to display: `left-margin',
4485 `right-margin' or nil. */
4487 valid_p
= (STRINGP (value
)
4488 #ifdef HAVE_WINDOW_SYSTEM
4489 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4490 && valid_image_p (value
))
4491 #endif /* not HAVE_WINDOW_SYSTEM */
4492 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4494 if (valid_p
&& !display_replaced_p
)
4499 /* Save current settings of IT so that we can restore them
4500 when we are finished with the glyph property value. */
4501 push_it (it
, position
);
4502 it
->from_overlay
= overlay
;
4503 it
->from_disp_prop_p
= 1;
4505 if (NILP (location
))
4506 it
->area
= TEXT_AREA
;
4507 else if (EQ (location
, Qleft_margin
))
4508 it
->area
= LEFT_MARGIN_AREA
;
4510 it
->area
= RIGHT_MARGIN_AREA
;
4512 if (STRINGP (value
))
4515 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4516 it
->current
.overlay_string_index
= -1;
4517 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4518 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4519 it
->method
= GET_FROM_STRING
;
4520 it
->stop_charpos
= 0;
4522 it
->base_level_stop
= 0;
4523 it
->string_from_display_prop_p
= 1;
4524 /* Say that we haven't consumed the characters with
4525 `display' property yet. The call to pop_it in
4526 set_iterator_to_next will clean this up. */
4527 if (BUFFERP (object
))
4528 *position
= start_pos
;
4530 /* Force paragraph direction to be that of the parent
4531 object. If the parent object's paragraph direction is
4532 not yet determined, default to L2R. */
4533 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4534 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4536 it
->paragraph_embedding
= L2R
;
4538 /* Set up the bidi iterator for this display string. */
4541 it
->bidi_it
.string
.lstring
= it
->string
;
4542 it
->bidi_it
.string
.s
= NULL
;
4543 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4544 it
->bidi_it
.string
.bufpos
= bufpos
;
4545 it
->bidi_it
.string
.from_disp_str
= 1;
4546 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4547 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4550 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4552 it
->method
= GET_FROM_STRETCH
;
4554 *position
= it
->position
= start_pos
;
4556 #ifdef HAVE_WINDOW_SYSTEM
4559 it
->what
= IT_IMAGE
;
4560 it
->image_id
= lookup_image (it
->f
, value
);
4561 it
->position
= start_pos
;
4562 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4563 it
->method
= GET_FROM_IMAGE
;
4565 /* Say that we haven't consumed the characters with
4566 `display' property yet. The call to pop_it in
4567 set_iterator_to_next will clean this up. */
4568 *position
= start_pos
;
4570 #endif /* HAVE_WINDOW_SYSTEM */
4575 /* Invalid property or property not supported. Restore
4576 POSITION to what it was before. */
4577 *position
= start_pos
;
4581 /* Check if PROP is a display property value whose text should be
4582 treated as intangible. OVERLAY is the overlay from which PROP
4583 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4584 specify the buffer position covered by PROP. */
4587 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4588 EMACS_INT charpos
, EMACS_INT bytepos
)
4590 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4591 struct text_pos position
;
4593 SET_TEXT_POS (position
, charpos
, bytepos
);
4594 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4595 &position
, charpos
, frame_window_p
);
4599 /* Return 1 if PROP is a display sub-property value containing STRING.
4601 Implementation note: this and the following function are really
4602 special cases of handle_display_spec and
4603 handle_single_display_spec, and should ideally use the same code.
4604 Until they do, these two pairs must be consistent and must be
4605 modified in sync. */
4608 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4610 if (EQ (string
, prop
))
4613 /* Skip over `when FORM'. */
4614 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4619 /* Actually, the condition following `when' should be eval'ed,
4620 like handle_single_display_spec does, and we should return
4621 zero if it evaluates to nil. However, this function is
4622 called only when the buffer was already displayed and some
4623 glyph in the glyph matrix was found to come from a display
4624 string. Therefore, the condition was already evaluated, and
4625 the result was non-nil, otherwise the display string wouldn't
4626 have been displayed and we would have never been called for
4627 this property. Thus, we can skip the evaluation and assume
4628 its result is non-nil. */
4633 /* Skip over `margin LOCATION'. */
4634 if (EQ (XCAR (prop
), Qmargin
))
4645 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4649 /* Return 1 if STRING appears in the `display' property PROP. */
4652 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4655 && !EQ (XCAR (prop
), Qwhen
)
4656 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4658 /* A list of sub-properties. */
4659 while (CONSP (prop
))
4661 if (single_display_spec_string_p (XCAR (prop
), string
))
4666 else if (VECTORP (prop
))
4668 /* A vector of sub-properties. */
4670 for (i
= 0; i
< ASIZE (prop
); ++i
)
4671 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4675 return single_display_spec_string_p (prop
, string
);
4680 /* Look for STRING in overlays and text properties in the current
4681 buffer, between character positions FROM and TO (excluding TO).
4682 BACK_P non-zero means look back (in this case, TO is supposed to be
4684 Value is the first character position where STRING was found, or
4685 zero if it wasn't found before hitting TO.
4687 This function may only use code that doesn't eval because it is
4688 called asynchronously from note_mouse_highlight. */
4691 string_buffer_position_lim (Lisp_Object string
,
4692 EMACS_INT from
, EMACS_INT to
, int back_p
)
4694 Lisp_Object limit
, prop
, pos
;
4697 pos
= make_number (from
);
4699 if (!back_p
) /* looking forward */
4701 limit
= make_number (min (to
, ZV
));
4702 while (!found
&& !EQ (pos
, limit
))
4704 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4705 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4708 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4712 else /* looking back */
4714 limit
= make_number (max (to
, BEGV
));
4715 while (!found
&& !EQ (pos
, limit
))
4717 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4718 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4721 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4726 return found
? XINT (pos
) : 0;
4729 /* Determine which buffer position in current buffer STRING comes from.
4730 AROUND_CHARPOS is an approximate position where it could come from.
4731 Value is the buffer position or 0 if it couldn't be determined.
4733 This function is necessary because we don't record buffer positions
4734 in glyphs generated from strings (to keep struct glyph small).
4735 This function may only use code that doesn't eval because it is
4736 called asynchronously from note_mouse_highlight. */
4739 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4741 const int MAX_DISTANCE
= 1000;
4742 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4743 around_charpos
+ MAX_DISTANCE
,
4747 found
= string_buffer_position_lim (string
, around_charpos
,
4748 around_charpos
- MAX_DISTANCE
, 1);
4754 /***********************************************************************
4755 `composition' property
4756 ***********************************************************************/
4758 /* Set up iterator IT from `composition' property at its current
4759 position. Called from handle_stop. */
4761 static enum prop_handled
4762 handle_composition_prop (struct it
*it
)
4764 Lisp_Object prop
, string
;
4765 EMACS_INT pos
, pos_byte
, start
, end
;
4767 if (STRINGP (it
->string
))
4771 pos
= IT_STRING_CHARPOS (*it
);
4772 pos_byte
= IT_STRING_BYTEPOS (*it
);
4773 string
= it
->string
;
4774 s
= SDATA (string
) + pos_byte
;
4775 it
->c
= STRING_CHAR (s
);
4779 pos
= IT_CHARPOS (*it
);
4780 pos_byte
= IT_BYTEPOS (*it
);
4782 it
->c
= FETCH_CHAR (pos_byte
);
4785 /* If there's a valid composition and point is not inside of the
4786 composition (in the case that the composition is from the current
4787 buffer), draw a glyph composed from the composition components. */
4788 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4789 && COMPOSITION_VALID_P (start
, end
, prop
)
4790 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4794 if (STRINGP (it
->string
))
4795 pos_byte
= string_char_to_byte (it
->string
, start
);
4797 pos_byte
= CHAR_TO_BYTE (start
);
4799 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4802 if (it
->cmp_it
.id
>= 0)
4805 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4806 it
->cmp_it
.nglyphs
= -1;
4810 return HANDLED_NORMALLY
;
4815 /***********************************************************************
4817 ***********************************************************************/
4819 /* The following structure is used to record overlay strings for
4820 later sorting in load_overlay_strings. */
4822 struct overlay_entry
4824 Lisp_Object overlay
;
4831 /* Set up iterator IT from overlay strings at its current position.
4832 Called from handle_stop. */
4834 static enum prop_handled
4835 handle_overlay_change (struct it
*it
)
4837 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4838 return HANDLED_RECOMPUTE_PROPS
;
4840 return HANDLED_NORMALLY
;
4844 /* Set up the next overlay string for delivery by IT, if there is an
4845 overlay string to deliver. Called by set_iterator_to_next when the
4846 end of the current overlay string is reached. If there are more
4847 overlay strings to display, IT->string and
4848 IT->current.overlay_string_index are set appropriately here.
4849 Otherwise IT->string is set to nil. */
4852 next_overlay_string (struct it
*it
)
4854 ++it
->current
.overlay_string_index
;
4855 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4857 /* No more overlay strings. Restore IT's settings to what
4858 they were before overlay strings were processed, and
4859 continue to deliver from current_buffer. */
4861 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4864 || (NILP (it
->string
)
4865 && it
->method
== GET_FROM_BUFFER
4866 && it
->stop_charpos
>= BEGV
4867 && it
->stop_charpos
<= it
->end_charpos
));
4868 it
->current
.overlay_string_index
= -1;
4869 it
->n_overlay_strings
= 0;
4870 it
->overlay_strings_charpos
= -1;
4872 /* If we're at the end of the buffer, record that we have
4873 processed the overlay strings there already, so that
4874 next_element_from_buffer doesn't try it again. */
4875 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4876 it
->overlay_strings_at_end_processed_p
= 1;
4880 /* There are more overlay strings to process. If
4881 IT->current.overlay_string_index has advanced to a position
4882 where we must load IT->overlay_strings with more strings, do
4883 it. We must load at the IT->overlay_strings_charpos where
4884 IT->n_overlay_strings was originally computed; when invisible
4885 text is present, this might not be IT_CHARPOS (Bug#7016). */
4886 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4888 if (it
->current
.overlay_string_index
&& i
== 0)
4889 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4891 /* Initialize IT to deliver display elements from the overlay
4893 it
->string
= it
->overlay_strings
[i
];
4894 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4895 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4896 it
->method
= GET_FROM_STRING
;
4897 it
->stop_charpos
= 0;
4898 if (it
->cmp_it
.stop_pos
>= 0)
4899 it
->cmp_it
.stop_pos
= 0;
4901 it
->base_level_stop
= 0;
4903 /* Set up the bidi iterator for this overlay string. */
4906 it
->bidi_it
.string
.lstring
= it
->string
;
4907 it
->bidi_it
.string
.s
= NULL
;
4908 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4909 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4910 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4911 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4912 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4920 /* Compare two overlay_entry structures E1 and E2. Used as a
4921 comparison function for qsort in load_overlay_strings. Overlay
4922 strings for the same position are sorted so that
4924 1. All after-strings come in front of before-strings, except
4925 when they come from the same overlay.
4927 2. Within after-strings, strings are sorted so that overlay strings
4928 from overlays with higher priorities come first.
4930 2. Within before-strings, strings are sorted so that overlay
4931 strings from overlays with higher priorities come last.
4933 Value is analogous to strcmp. */
4937 compare_overlay_entries (const void *e1
, const void *e2
)
4939 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4940 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4943 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4945 /* Let after-strings appear in front of before-strings if
4946 they come from different overlays. */
4947 if (EQ (entry1
->overlay
, entry2
->overlay
))
4948 result
= entry1
->after_string_p
? 1 : -1;
4950 result
= entry1
->after_string_p
? -1 : 1;
4952 else if (entry1
->after_string_p
)
4953 /* After-strings sorted in order of decreasing priority. */
4954 result
= entry2
->priority
- entry1
->priority
;
4956 /* Before-strings sorted in order of increasing priority. */
4957 result
= entry1
->priority
- entry2
->priority
;
4963 /* Load the vector IT->overlay_strings with overlay strings from IT's
4964 current buffer position, or from CHARPOS if that is > 0. Set
4965 IT->n_overlays to the total number of overlay strings found.
4967 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4968 a time. On entry into load_overlay_strings,
4969 IT->current.overlay_string_index gives the number of overlay
4970 strings that have already been loaded by previous calls to this
4973 IT->add_overlay_start contains an additional overlay start
4974 position to consider for taking overlay strings from, if non-zero.
4975 This position comes into play when the overlay has an `invisible'
4976 property, and both before and after-strings. When we've skipped to
4977 the end of the overlay, because of its `invisible' property, we
4978 nevertheless want its before-string to appear.
4979 IT->add_overlay_start will contain the overlay start position
4982 Overlay strings are sorted so that after-string strings come in
4983 front of before-string strings. Within before and after-strings,
4984 strings are sorted by overlay priority. See also function
4985 compare_overlay_entries. */
4988 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4990 Lisp_Object overlay
, window
, str
, invisible
;
4991 struct Lisp_Overlay
*ov
;
4992 EMACS_INT start
, end
;
4994 int n
= 0, i
, j
, invis_p
;
4995 struct overlay_entry
*entries
4996 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4999 charpos
= IT_CHARPOS (*it
);
5001 /* Append the overlay string STRING of overlay OVERLAY to vector
5002 `entries' which has size `size' and currently contains `n'
5003 elements. AFTER_P non-zero means STRING is an after-string of
5005 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5008 Lisp_Object priority; \
5012 int new_size = 2 * size; \
5013 struct overlay_entry *old = entries; \
5015 (struct overlay_entry *) alloca (new_size \
5016 * sizeof *entries); \
5017 memcpy (entries, old, size * sizeof *entries); \
5021 entries[n].string = (STRING); \
5022 entries[n].overlay = (OVERLAY); \
5023 priority = Foverlay_get ((OVERLAY), Qpriority); \
5024 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5025 entries[n].after_string_p = (AFTER_P); \
5030 /* Process overlay before the overlay center. */
5031 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5033 XSETMISC (overlay
, ov
);
5034 xassert (OVERLAYP (overlay
));
5035 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5036 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5041 /* Skip this overlay if it doesn't start or end at IT's current
5043 if (end
!= charpos
&& start
!= charpos
)
5046 /* Skip this overlay if it doesn't apply to IT->w. */
5047 window
= Foverlay_get (overlay
, Qwindow
);
5048 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5051 /* If the text ``under'' the overlay is invisible, both before-
5052 and after-strings from this overlay are visible; start and
5053 end position are indistinguishable. */
5054 invisible
= Foverlay_get (overlay
, Qinvisible
);
5055 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5057 /* If overlay has a non-empty before-string, record it. */
5058 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5059 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5061 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5063 /* If overlay has a non-empty after-string, record it. */
5064 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5065 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5067 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5070 /* Process overlays after the overlay center. */
5071 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5073 XSETMISC (overlay
, ov
);
5074 xassert (OVERLAYP (overlay
));
5075 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5076 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5078 if (start
> charpos
)
5081 /* Skip this overlay if it doesn't start or end at IT's current
5083 if (end
!= charpos
&& start
!= charpos
)
5086 /* Skip this overlay if it doesn't apply to IT->w. */
5087 window
= Foverlay_get (overlay
, Qwindow
);
5088 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5091 /* If the text ``under'' the overlay is invisible, it has a zero
5092 dimension, and both before- and after-strings apply. */
5093 invisible
= Foverlay_get (overlay
, Qinvisible
);
5094 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5096 /* If overlay has a non-empty before-string, record it. */
5097 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5098 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5100 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5102 /* If overlay has a non-empty after-string, record it. */
5103 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5104 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5106 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5109 #undef RECORD_OVERLAY_STRING
5113 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5115 /* Record number of overlay strings, and where we computed it. */
5116 it
->n_overlay_strings
= n
;
5117 it
->overlay_strings_charpos
= charpos
;
5119 /* IT->current.overlay_string_index is the number of overlay strings
5120 that have already been consumed by IT. Copy some of the
5121 remaining overlay strings to IT->overlay_strings. */
5123 j
= it
->current
.overlay_string_index
;
5124 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5126 it
->overlay_strings
[i
] = entries
[j
].string
;
5127 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5134 /* Get the first chunk of overlay strings at IT's current buffer
5135 position, or at CHARPOS if that is > 0. Value is non-zero if at
5136 least one overlay string was found. */
5139 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5141 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5142 process. This fills IT->overlay_strings with strings, and sets
5143 IT->n_overlay_strings to the total number of strings to process.
5144 IT->pos.overlay_string_index has to be set temporarily to zero
5145 because load_overlay_strings needs this; it must be set to -1
5146 when no overlay strings are found because a zero value would
5147 indicate a position in the first overlay string. */
5148 it
->current
.overlay_string_index
= 0;
5149 load_overlay_strings (it
, charpos
);
5151 /* If we found overlay strings, set up IT to deliver display
5152 elements from the first one. Otherwise set up IT to deliver
5153 from current_buffer. */
5154 if (it
->n_overlay_strings
)
5156 /* Make sure we know settings in current_buffer, so that we can
5157 restore meaningful values when we're done with the overlay
5160 compute_stop_pos (it
);
5161 xassert (it
->face_id
>= 0);
5163 /* Save IT's settings. They are restored after all overlay
5164 strings have been processed. */
5165 xassert (!compute_stop_p
|| it
->sp
== 0);
5167 /* When called from handle_stop, there might be an empty display
5168 string loaded. In that case, don't bother saving it. */
5169 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5172 /* Set up IT to deliver display elements from the first overlay
5174 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5175 it
->string
= it
->overlay_strings
[0];
5176 it
->from_overlay
= Qnil
;
5177 it
->stop_charpos
= 0;
5178 xassert (STRINGP (it
->string
));
5179 it
->end_charpos
= SCHARS (it
->string
);
5181 it
->base_level_stop
= 0;
5182 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5183 it
->method
= GET_FROM_STRING
;
5184 it
->from_disp_prop_p
= 0;
5186 /* Force paragraph direction to be that of the parent
5188 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5189 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5191 it
->paragraph_embedding
= L2R
;
5193 /* Set up the bidi iterator for this overlay string. */
5196 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5198 it
->bidi_it
.string
.lstring
= it
->string
;
5199 it
->bidi_it
.string
.s
= NULL
;
5200 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5201 it
->bidi_it
.string
.bufpos
= pos
;
5202 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5203 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5204 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5209 it
->current
.overlay_string_index
= -1;
5214 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5217 it
->method
= GET_FROM_BUFFER
;
5219 (void) get_overlay_strings_1 (it
, charpos
, 1);
5223 /* Value is non-zero if we found at least one overlay string. */
5224 return STRINGP (it
->string
);
5229 /***********************************************************************
5230 Saving and restoring state
5231 ***********************************************************************/
5233 /* Save current settings of IT on IT->stack. Called, for example,
5234 before setting up IT for an overlay string, to be able to restore
5235 IT's settings to what they were after the overlay string has been
5236 processed. If POSITION is non-NULL, it is the position to save on
5237 the stack instead of IT->position. */
5240 push_it (struct it
*it
, struct text_pos
*position
)
5242 struct iterator_stack_entry
*p
;
5244 xassert (it
->sp
< IT_STACK_SIZE
);
5245 p
= it
->stack
+ it
->sp
;
5247 p
->stop_charpos
= it
->stop_charpos
;
5248 p
->prev_stop
= it
->prev_stop
;
5249 p
->base_level_stop
= it
->base_level_stop
;
5250 p
->cmp_it
= it
->cmp_it
;
5251 xassert (it
->face_id
>= 0);
5252 p
->face_id
= it
->face_id
;
5253 p
->string
= it
->string
;
5254 p
->method
= it
->method
;
5255 p
->from_overlay
= it
->from_overlay
;
5258 case GET_FROM_IMAGE
:
5259 p
->u
.image
.object
= it
->object
;
5260 p
->u
.image
.image_id
= it
->image_id
;
5261 p
->u
.image
.slice
= it
->slice
;
5263 case GET_FROM_STRETCH
:
5264 p
->u
.stretch
.object
= it
->object
;
5267 p
->position
= position
? *position
: it
->position
;
5268 p
->current
= it
->current
;
5269 p
->end_charpos
= it
->end_charpos
;
5270 p
->string_nchars
= it
->string_nchars
;
5272 p
->multibyte_p
= it
->multibyte_p
;
5273 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5274 p
->space_width
= it
->space_width
;
5275 p
->font_height
= it
->font_height
;
5276 p
->voffset
= it
->voffset
;
5277 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5278 p
->display_ellipsis_p
= 0;
5279 p
->line_wrap
= it
->line_wrap
;
5280 p
->bidi_p
= it
->bidi_p
;
5281 p
->paragraph_embedding
= it
->paragraph_embedding
;
5282 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5285 /* Save the state of the bidi iterator as well. */
5287 bidi_push_it (&it
->bidi_it
);
5291 iterate_out_of_display_property (struct it
*it
)
5293 int buffer_p
= BUFFERP (it
->object
);
5294 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5295 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5297 /* Maybe initialize paragraph direction. If we are at the beginning
5298 of a new paragraph, next_element_from_buffer may not have a
5299 chance to do that. */
5300 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5301 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5302 /* prev_stop can be zero, so check against BEGV as well. */
5303 while (it
->bidi_it
.charpos
>= bob
5304 && it
->prev_stop
<= it
->bidi_it
.charpos
5305 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5306 bidi_move_to_visually_next (&it
->bidi_it
);
5307 /* Record the stop_pos we just crossed, for when we cross it
5309 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5310 it
->prev_stop
= CHARPOS (it
->position
);
5311 /* If we ended up not where pop_it put us, resync IT's
5312 positional members with the bidi iterator. */
5313 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5315 SET_TEXT_POS (it
->position
,
5316 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5318 it
->current
.pos
= it
->position
;
5320 it
->current
.string_pos
= it
->position
;
5324 /* Restore IT's settings from IT->stack. Called, for example, when no
5325 more overlay strings must be processed, and we return to delivering
5326 display elements from a buffer, or when the end of a string from a
5327 `display' property is reached and we return to delivering display
5328 elements from an overlay string, or from a buffer. */
5331 pop_it (struct it
*it
)
5333 struct iterator_stack_entry
*p
;
5334 int from_display_prop
= it
->from_disp_prop_p
;
5336 xassert (it
->sp
> 0);
5338 p
= it
->stack
+ it
->sp
;
5339 it
->stop_charpos
= p
->stop_charpos
;
5340 it
->prev_stop
= p
->prev_stop
;
5341 it
->base_level_stop
= p
->base_level_stop
;
5342 it
->cmp_it
= p
->cmp_it
;
5343 it
->face_id
= p
->face_id
;
5344 it
->current
= p
->current
;
5345 it
->position
= p
->position
;
5346 it
->string
= p
->string
;
5347 it
->from_overlay
= p
->from_overlay
;
5348 if (NILP (it
->string
))
5349 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5350 it
->method
= p
->method
;
5353 case GET_FROM_IMAGE
:
5354 it
->image_id
= p
->u
.image
.image_id
;
5355 it
->object
= p
->u
.image
.object
;
5356 it
->slice
= p
->u
.image
.slice
;
5358 case GET_FROM_STRETCH
:
5359 it
->object
= p
->u
.stretch
.object
;
5361 case GET_FROM_BUFFER
:
5362 it
->object
= it
->w
->buffer
;
5364 case GET_FROM_STRING
:
5365 it
->object
= it
->string
;
5367 case GET_FROM_DISPLAY_VECTOR
:
5369 it
->method
= GET_FROM_C_STRING
;
5370 else if (STRINGP (it
->string
))
5371 it
->method
= GET_FROM_STRING
;
5374 it
->method
= GET_FROM_BUFFER
;
5375 it
->object
= it
->w
->buffer
;
5378 it
->end_charpos
= p
->end_charpos
;
5379 it
->string_nchars
= p
->string_nchars
;
5381 it
->multibyte_p
= p
->multibyte_p
;
5382 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5383 it
->space_width
= p
->space_width
;
5384 it
->font_height
= p
->font_height
;
5385 it
->voffset
= p
->voffset
;
5386 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5387 it
->line_wrap
= p
->line_wrap
;
5388 it
->bidi_p
= p
->bidi_p
;
5389 it
->paragraph_embedding
= p
->paragraph_embedding
;
5390 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5393 bidi_pop_it (&it
->bidi_it
);
5394 /* Bidi-iterate until we get out of the portion of text, if any,
5395 covered by a `display' text property or by an overlay with
5396 `display' property. (We cannot just jump there, because the
5397 internal coherency of the bidi iterator state can not be
5398 preserved across such jumps.) We also must determine the
5399 paragraph base direction if the overlay we just processed is
5400 at the beginning of a new paragraph. */
5401 if (from_display_prop
5402 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5403 iterate_out_of_display_property (it
);
5405 xassert ((BUFFERP (it
->object
)
5406 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5407 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5408 || (STRINGP (it
->object
)
5409 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5410 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5416 /***********************************************************************
5418 ***********************************************************************/
5420 /* Set IT's current position to the previous line start. */
5423 back_to_previous_line_start (struct it
*it
)
5425 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5426 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5430 /* Move IT to the next line start.
5432 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5433 we skipped over part of the text (as opposed to moving the iterator
5434 continuously over the text). Otherwise, don't change the value
5437 Newlines may come from buffer text, overlay strings, or strings
5438 displayed via the `display' property. That's the reason we can't
5439 simply use find_next_newline_no_quit.
5441 Note that this function may not skip over invisible text that is so
5442 because of text properties and immediately follows a newline. If
5443 it would, function reseat_at_next_visible_line_start, when called
5444 from set_iterator_to_next, would effectively make invisible
5445 characters following a newline part of the wrong glyph row, which
5446 leads to wrong cursor motion. */
5449 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5451 int old_selective
, newline_found_p
, n
;
5452 const int MAX_NEWLINE_DISTANCE
= 500;
5454 /* If already on a newline, just consume it to avoid unintended
5455 skipping over invisible text below. */
5456 if (it
->what
== IT_CHARACTER
5458 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5460 set_iterator_to_next (it
, 0);
5465 /* Don't handle selective display in the following. It's (a)
5466 unnecessary because it's done by the caller, and (b) leads to an
5467 infinite recursion because next_element_from_ellipsis indirectly
5468 calls this function. */
5469 old_selective
= it
->selective
;
5472 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5473 from buffer text. */
5474 for (n
= newline_found_p
= 0;
5475 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5476 n
+= STRINGP (it
->string
) ? 0 : 1)
5478 if (!get_next_display_element (it
))
5480 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5481 set_iterator_to_next (it
, 0);
5484 /* If we didn't find a newline near enough, see if we can use a
5486 if (!newline_found_p
)
5488 EMACS_INT start
= IT_CHARPOS (*it
);
5489 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5492 xassert (!STRINGP (it
->string
));
5494 /* If we are not bidi-reordering, and there isn't any `display'
5495 property in sight, and no overlays, we can just use the
5496 position of the newline in buffer text. */
5498 && (it
->stop_charpos
>= limit
5499 || ((pos
= Fnext_single_property_change (make_number (start
),
5501 make_number (limit
)),
5503 && next_overlay_change (start
) == ZV
)))
5505 IT_CHARPOS (*it
) = limit
;
5506 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5507 *skipped_p
= newline_found_p
= 1;
5511 while (get_next_display_element (it
)
5512 && !newline_found_p
)
5514 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5515 set_iterator_to_next (it
, 0);
5520 it
->selective
= old_selective
;
5521 return newline_found_p
;
5525 /* Set IT's current position to the previous visible line start. Skip
5526 invisible text that is so either due to text properties or due to
5527 selective display. Caution: this does not change IT->current_x and
5531 back_to_previous_visible_line_start (struct it
*it
)
5533 while (IT_CHARPOS (*it
) > BEGV
)
5535 back_to_previous_line_start (it
);
5537 if (IT_CHARPOS (*it
) <= BEGV
)
5540 /* If selective > 0, then lines indented more than its value are
5542 if (it
->selective
> 0
5543 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5544 (double) it
->selective
)) /* iftc */
5547 /* Check the newline before point for invisibility. */
5550 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5551 Qinvisible
, it
->window
);
5552 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5556 if (IT_CHARPOS (*it
) <= BEGV
)
5561 void *it2data
= NULL
;
5564 Lisp_Object val
, overlay
;
5566 SAVE_IT (it2
, *it
, it2data
);
5568 /* If newline is part of a composition, continue from start of composition */
5569 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5570 && beg
< IT_CHARPOS (*it
))
5573 /* If newline is replaced by a display property, find start of overlay
5574 or interval and continue search from that point. */
5575 pos
= --IT_CHARPOS (it2
);
5578 bidi_unshelve_cache (NULL
);
5579 it2
.string_from_display_prop_p
= 0;
5580 it2
.from_disp_prop_p
= 0;
5581 if (handle_display_prop (&it2
) == HANDLED_RETURN
5582 && !NILP (val
= get_char_property_and_overlay
5583 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5584 && (OVERLAYP (overlay
)
5585 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5586 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5588 RESTORE_IT (it
, it
, it2data
);
5592 /* Newline is not replaced by anything -- so we are done. */
5593 RESTORE_IT (it
, it
, it2data
);
5599 IT_CHARPOS (*it
) = beg
;
5600 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5604 it
->continuation_lines_width
= 0;
5606 xassert (IT_CHARPOS (*it
) >= BEGV
);
5607 xassert (IT_CHARPOS (*it
) == BEGV
5608 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5613 /* Reseat iterator IT at the previous visible line start. Skip
5614 invisible text that is so either due to text properties or due to
5615 selective display. At the end, update IT's overlay information,
5616 face information etc. */
5619 reseat_at_previous_visible_line_start (struct it
*it
)
5621 back_to_previous_visible_line_start (it
);
5622 reseat (it
, it
->current
.pos
, 1);
5627 /* Reseat iterator IT on the next visible line start in the current
5628 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5629 preceding the line start. Skip over invisible text that is so
5630 because of selective display. Compute faces, overlays etc at the
5631 new position. Note that this function does not skip over text that
5632 is invisible because of text properties. */
5635 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5637 int newline_found_p
, skipped_p
= 0;
5639 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5641 /* Skip over lines that are invisible because they are indented
5642 more than the value of IT->selective. */
5643 if (it
->selective
> 0)
5644 while (IT_CHARPOS (*it
) < ZV
5645 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5646 (double) it
->selective
)) /* iftc */
5648 xassert (IT_BYTEPOS (*it
) == BEGV
5649 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5650 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5653 /* Position on the newline if that's what's requested. */
5654 if (on_newline_p
&& newline_found_p
)
5656 if (STRINGP (it
->string
))
5658 if (IT_STRING_CHARPOS (*it
) > 0)
5662 --IT_STRING_CHARPOS (*it
);
5663 --IT_STRING_BYTEPOS (*it
);
5666 /* Setting this flag will cause
5667 bidi_move_to_visually_next not to advance, but
5668 instead deliver the current character (newline),
5669 which is what the ON_NEWLINE_P flag wants. */
5670 it
->bidi_it
.first_elt
= 1;
5673 else if (IT_CHARPOS (*it
) > BEGV
)
5680 /* With bidi iteration, the call to `reseat' will cause
5681 bidi_move_to_visually_next deliver the current character,
5682 the newline, instead of advancing. */
5683 reseat (it
, it
->current
.pos
, 0);
5687 reseat (it
, it
->current
.pos
, 0);
5694 /***********************************************************************
5695 Changing an iterator's position
5696 ***********************************************************************/
5698 /* Change IT's current position to POS in current_buffer. If FORCE_P
5699 is non-zero, always check for text properties at the new position.
5700 Otherwise, text properties are only looked up if POS >=
5701 IT->check_charpos of a property. */
5704 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5706 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5708 reseat_1 (it
, pos
, 0);
5710 /* Determine where to check text properties. Avoid doing it
5711 where possible because text property lookup is very expensive. */
5713 || CHARPOS (pos
) > it
->stop_charpos
5714 || CHARPOS (pos
) < original_pos
)
5718 /* For bidi iteration, we need to prime prev_stop and
5719 base_level_stop with our best estimations. */
5720 if (CHARPOS (pos
) < it
->prev_stop
)
5722 handle_stop_backwards (it
, BEGV
);
5723 if (CHARPOS (pos
) < it
->base_level_stop
)
5724 it
->base_level_stop
= 0;
5726 else if (CHARPOS (pos
) > it
->stop_charpos
5727 && it
->stop_charpos
>= BEGV
)
5728 handle_stop_backwards (it
, it
->stop_charpos
);
5735 it
->prev_stop
= it
->base_level_stop
= 0;
5744 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5745 IT->stop_pos to POS, also. */
5748 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5750 /* Don't call this function when scanning a C string. */
5751 xassert (it
->s
== NULL
);
5753 /* POS must be a reasonable value. */
5754 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5756 it
->current
.pos
= it
->position
= pos
;
5757 it
->end_charpos
= ZV
;
5759 it
->current
.dpvec_index
= -1;
5760 it
->current
.overlay_string_index
= -1;
5761 IT_STRING_CHARPOS (*it
) = -1;
5762 IT_STRING_BYTEPOS (*it
) = -1;
5764 it
->method
= GET_FROM_BUFFER
;
5765 it
->object
= it
->w
->buffer
;
5766 it
->area
= TEXT_AREA
;
5767 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5769 it
->string_from_display_prop_p
= 0;
5770 it
->from_disp_prop_p
= 0;
5771 it
->face_before_selective_p
= 0;
5774 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5776 bidi_unshelve_cache (NULL
);
5777 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5778 it
->bidi_it
.string
.s
= NULL
;
5779 it
->bidi_it
.string
.lstring
= Qnil
;
5780 it
->bidi_it
.string
.bufpos
= 0;
5781 it
->bidi_it
.string
.unibyte
= 0;
5786 it
->stop_charpos
= CHARPOS (pos
);
5787 it
->base_level_stop
= CHARPOS (pos
);
5792 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5793 If S is non-null, it is a C string to iterate over. Otherwise,
5794 STRING gives a Lisp string to iterate over.
5796 If PRECISION > 0, don't return more then PRECISION number of
5797 characters from the string.
5799 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5800 characters have been returned. FIELD_WIDTH < 0 means an infinite
5803 MULTIBYTE = 0 means disable processing of multibyte characters,
5804 MULTIBYTE > 0 means enable it,
5805 MULTIBYTE < 0 means use IT->multibyte_p.
5807 IT must be initialized via a prior call to init_iterator before
5808 calling this function. */
5811 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5812 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5815 /* No region in strings. */
5816 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5818 /* No text property checks performed by default, but see below. */
5819 it
->stop_charpos
= -1;
5821 /* Set iterator position and end position. */
5822 memset (&it
->current
, 0, sizeof it
->current
);
5823 it
->current
.overlay_string_index
= -1;
5824 it
->current
.dpvec_index
= -1;
5825 xassert (charpos
>= 0);
5827 /* If STRING is specified, use its multibyteness, otherwise use the
5828 setting of MULTIBYTE, if specified. */
5830 it
->multibyte_p
= multibyte
> 0;
5832 /* Bidirectional reordering of strings is controlled by the default
5833 value of bidi-display-reordering. */
5834 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5838 xassert (STRINGP (string
));
5839 it
->string
= string
;
5841 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5842 it
->method
= GET_FROM_STRING
;
5843 it
->current
.string_pos
= string_pos (charpos
, string
);
5847 it
->bidi_it
.string
.lstring
= string
;
5848 it
->bidi_it
.string
.s
= NULL
;
5849 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5850 it
->bidi_it
.string
.bufpos
= 0;
5851 it
->bidi_it
.string
.from_disp_str
= 0;
5852 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5853 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5854 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5859 it
->s
= (const unsigned char *) s
;
5862 /* Note that we use IT->current.pos, not it->current.string_pos,
5863 for displaying C strings. */
5864 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5865 if (it
->multibyte_p
)
5867 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5868 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5872 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5873 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5878 it
->bidi_it
.string
.lstring
= Qnil
;
5879 it
->bidi_it
.string
.s
= s
;
5880 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5881 it
->bidi_it
.string
.bufpos
= 0;
5882 it
->bidi_it
.string
.from_disp_str
= 0;
5883 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5884 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5887 it
->method
= GET_FROM_C_STRING
;
5890 /* PRECISION > 0 means don't return more than PRECISION characters
5892 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5894 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5896 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5899 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5900 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5901 FIELD_WIDTH < 0 means infinite field width. This is useful for
5902 padding with `-' at the end of a mode line. */
5903 if (field_width
< 0)
5904 field_width
= INFINITY
;
5905 /* Implementation note: We deliberately don't enlarge
5906 it->bidi_it.string.schars here to fit it->end_charpos, because
5907 the bidi iterator cannot produce characters out of thin air. */
5908 if (field_width
> it
->end_charpos
- charpos
)
5909 it
->end_charpos
= charpos
+ field_width
;
5911 /* Use the standard display table for displaying strings. */
5912 if (DISP_TABLE_P (Vstandard_display_table
))
5913 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5915 it
->stop_charpos
= charpos
;
5916 it
->prev_stop
= charpos
;
5917 it
->base_level_stop
= 0;
5920 it
->bidi_it
.first_elt
= 1;
5921 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5922 it
->bidi_it
.disp_pos
= -1;
5924 if (s
== NULL
&& it
->multibyte_p
)
5926 EMACS_INT endpos
= SCHARS (it
->string
);
5927 if (endpos
> it
->end_charpos
)
5928 endpos
= it
->end_charpos
;
5929 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5937 /***********************************************************************
5939 ***********************************************************************/
5941 /* Map enum it_method value to corresponding next_element_from_* function. */
5943 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5945 next_element_from_buffer
,
5946 next_element_from_display_vector
,
5947 next_element_from_string
,
5948 next_element_from_c_string
,
5949 next_element_from_image
,
5950 next_element_from_stretch
5953 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5956 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5957 (possibly with the following characters). */
5959 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5960 ((IT)->cmp_it.id >= 0 \
5961 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5962 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5963 END_CHARPOS, (IT)->w, \
5964 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5968 /* Lookup the char-table Vglyphless_char_display for character C (-1
5969 if we want information for no-font case), and return the display
5970 method symbol. By side-effect, update it->what and
5971 it->glyphless_method. This function is called from
5972 get_next_display_element for each character element, and from
5973 x_produce_glyphs when no suitable font was found. */
5976 lookup_glyphless_char_display (int c
, struct it
*it
)
5978 Lisp_Object glyphless_method
= Qnil
;
5980 if (CHAR_TABLE_P (Vglyphless_char_display
)
5981 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5985 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5986 if (CONSP (glyphless_method
))
5987 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5988 ? XCAR (glyphless_method
)
5989 : XCDR (glyphless_method
);
5992 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5996 if (NILP (glyphless_method
))
5999 /* The default is to display the character by a proper font. */
6001 /* The default for the no-font case is to display an empty box. */
6002 glyphless_method
= Qempty_box
;
6004 if (EQ (glyphless_method
, Qzero_width
))
6007 return glyphless_method
;
6008 /* This method can't be used for the no-font case. */
6009 glyphless_method
= Qempty_box
;
6011 if (EQ (glyphless_method
, Qthin_space
))
6012 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6013 else if (EQ (glyphless_method
, Qempty_box
))
6014 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6015 else if (EQ (glyphless_method
, Qhex_code
))
6016 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6017 else if (STRINGP (glyphless_method
))
6018 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6021 /* Invalid value. We use the default method. */
6022 glyphless_method
= Qnil
;
6025 it
->what
= IT_GLYPHLESS
;
6026 return glyphless_method
;
6029 /* Load IT's display element fields with information about the next
6030 display element from the current position of IT. Value is zero if
6031 end of buffer (or C string) is reached. */
6033 static struct frame
*last_escape_glyph_frame
= NULL
;
6034 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6035 static int last_escape_glyph_merged_face_id
= 0;
6037 struct frame
*last_glyphless_glyph_frame
= NULL
;
6038 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6039 int last_glyphless_glyph_merged_face_id
= 0;
6042 get_next_display_element (struct it
*it
)
6044 /* Non-zero means that we found a display element. Zero means that
6045 we hit the end of what we iterate over. Performance note: the
6046 function pointer `method' used here turns out to be faster than
6047 using a sequence of if-statements. */
6051 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6053 if (it
->what
== IT_CHARACTER
)
6055 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6056 and only if (a) the resolved directionality of that character
6058 /* FIXME: Do we need an exception for characters from display
6060 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6061 it
->c
= bidi_mirror_char (it
->c
);
6062 /* Map via display table or translate control characters.
6063 IT->c, IT->len etc. have been set to the next character by
6064 the function call above. If we have a display table, and it
6065 contains an entry for IT->c, translate it. Don't do this if
6066 IT->c itself comes from a display table, otherwise we could
6067 end up in an infinite recursion. (An alternative could be to
6068 count the recursion depth of this function and signal an
6069 error when a certain maximum depth is reached.) Is it worth
6071 if (success_p
&& it
->dpvec
== NULL
)
6074 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6075 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6076 nbsp_or_shy
= char_is_other
;
6077 int c
= it
->c
; /* This is the character to display. */
6079 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6081 xassert (SINGLE_BYTE_CHAR_P (c
));
6082 if (unibyte_display_via_language_environment
)
6084 c
= DECODE_CHAR (unibyte
, c
);
6086 c
= BYTE8_TO_CHAR (it
->c
);
6089 c
= BYTE8_TO_CHAR (it
->c
);
6093 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6096 struct Lisp_Vector
*v
= XVECTOR (dv
);
6098 /* Return the first character from the display table
6099 entry, if not empty. If empty, don't display the
6100 current character. */
6103 it
->dpvec_char_len
= it
->len
;
6104 it
->dpvec
= v
->contents
;
6105 it
->dpend
= v
->contents
+ v
->header
.size
;
6106 it
->current
.dpvec_index
= 0;
6107 it
->dpvec_face_id
= -1;
6108 it
->saved_face_id
= it
->face_id
;
6109 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6114 set_iterator_to_next (it
, 0);
6119 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6121 if (it
->what
== IT_GLYPHLESS
)
6123 /* Don't display this character. */
6124 set_iterator_to_next (it
, 0);
6128 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6129 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6130 : c
== 0xAD ? char_is_soft_hyphen
6133 /* Translate control characters into `\003' or `^C' form.
6134 Control characters coming from a display table entry are
6135 currently not translated because we use IT->dpvec to hold
6136 the translation. This could easily be changed but I
6137 don't believe that it is worth doing.
6139 NBSP and SOFT-HYPEN are property translated too.
6141 Non-printable characters and raw-byte characters are also
6142 translated to octal form. */
6143 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6144 ? (it
->area
!= TEXT_AREA
6145 /* In mode line, treat \n, \t like other crl chars. */
6148 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6149 || (c
!= '\n' && c
!= '\t'))
6152 || ! CHAR_PRINTABLE_P (c
))))
6154 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6155 or a non-printable character which must be displayed
6156 either as '\003' or as `^C' where the '\\' and '^'
6157 can be defined in the display table. Fill
6158 IT->ctl_chars with glyphs for what we have to
6159 display. Then, set IT->dpvec to these glyphs. */
6162 int face_id
, lface_id
= 0 ;
6165 /* Handle control characters with ^. */
6167 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6171 g
= '^'; /* default glyph for Control */
6172 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6174 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6175 && GLYPH_CODE_CHAR_VALID_P (gc
))
6177 g
= GLYPH_CODE_CHAR (gc
);
6178 lface_id
= GLYPH_CODE_FACE (gc
);
6182 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6184 else if (it
->f
== last_escape_glyph_frame
6185 && it
->face_id
== last_escape_glyph_face_id
)
6187 face_id
= last_escape_glyph_merged_face_id
;
6191 /* Merge the escape-glyph face into the current face. */
6192 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6194 last_escape_glyph_frame
= it
->f
;
6195 last_escape_glyph_face_id
= it
->face_id
;
6196 last_escape_glyph_merged_face_id
= face_id
;
6199 XSETINT (it
->ctl_chars
[0], g
);
6200 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6202 goto display_control
;
6205 /* Handle non-break space in the mode where it only gets
6208 if (EQ (Vnobreak_char_display
, Qt
)
6209 && nbsp_or_shy
== char_is_nbsp
)
6211 /* Merge the no-break-space face into the current face. */
6212 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6216 XSETINT (it
->ctl_chars
[0], ' ');
6218 goto display_control
;
6221 /* Handle sequences that start with the "escape glyph". */
6223 /* the default escape glyph is \. */
6224 escape_glyph
= '\\';
6227 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6228 && GLYPH_CODE_CHAR_VALID_P (gc
))
6230 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6231 lface_id
= GLYPH_CODE_FACE (gc
);
6235 /* The display table specified a face.
6236 Merge it into face_id and also into escape_glyph. */
6237 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6240 else if (it
->f
== last_escape_glyph_frame
6241 && it
->face_id
== last_escape_glyph_face_id
)
6243 face_id
= last_escape_glyph_merged_face_id
;
6247 /* Merge the escape-glyph face into the current face. */
6248 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6250 last_escape_glyph_frame
= it
->f
;
6251 last_escape_glyph_face_id
= it
->face_id
;
6252 last_escape_glyph_merged_face_id
= face_id
;
6255 /* Handle soft hyphens in the mode where they only get
6258 if (EQ (Vnobreak_char_display
, Qt
)
6259 && nbsp_or_shy
== char_is_soft_hyphen
)
6261 XSETINT (it
->ctl_chars
[0], '-');
6263 goto display_control
;
6266 /* Handle non-break space and soft hyphen
6267 with the escape glyph. */
6271 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6272 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6273 XSETINT (it
->ctl_chars
[1], c
);
6275 goto display_control
;
6282 if (CHAR_BYTE8_P (c
))
6283 /* Display \200 instead of \17777600. */
6284 c
= CHAR_TO_BYTE8 (c
);
6285 len
= sprintf (str
, "%03o", c
);
6287 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6288 for (i
= 0; i
< len
; i
++)
6289 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6294 /* Set up IT->dpvec and return first character from it. */
6295 it
->dpvec_char_len
= it
->len
;
6296 it
->dpvec
= it
->ctl_chars
;
6297 it
->dpend
= it
->dpvec
+ ctl_len
;
6298 it
->current
.dpvec_index
= 0;
6299 it
->dpvec_face_id
= face_id
;
6300 it
->saved_face_id
= it
->face_id
;
6301 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6305 it
->char_to_display
= c
;
6309 it
->char_to_display
= it
->c
;
6313 /* Adjust face id for a multibyte character. There are no multibyte
6314 character in unibyte text. */
6315 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6318 && FRAME_WINDOW_P (it
->f
))
6320 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6322 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6324 /* Automatic composition with glyph-string. */
6325 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6327 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6331 EMACS_INT pos
= (it
->s
? -1
6332 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6333 : IT_CHARPOS (*it
));
6335 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6341 /* Is this character the last one of a run of characters with
6342 box? If yes, set IT->end_of_box_run_p to 1. */
6346 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6348 int face_id
= underlying_face_id (it
);
6349 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6353 if (face
->box
== FACE_NO_BOX
)
6355 /* If the box comes from face properties in a
6356 display string, check faces in that string. */
6357 int string_face_id
= face_after_it_pos (it
);
6358 it
->end_of_box_run_p
6359 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6362 /* Otherwise, the box comes from the underlying face.
6363 If this is the last string character displayed, check
6364 the next buffer location. */
6365 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6366 && (it
->current
.overlay_string_index
6367 == it
->n_overlay_strings
- 1))
6371 struct text_pos pos
= it
->current
.pos
;
6372 INC_TEXT_POS (pos
, it
->multibyte_p
);
6374 next_face_id
= face_at_buffer_position
6375 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6376 it
->region_end_charpos
, &ignore
,
6377 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6379 it
->end_of_box_run_p
6380 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6387 int face_id
= face_after_it_pos (it
);
6388 it
->end_of_box_run_p
6389 = (face_id
!= it
->face_id
6390 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6394 /* Value is 0 if end of buffer or string reached. */
6399 /* Move IT to the next display element.
6401 RESEAT_P non-zero means if called on a newline in buffer text,
6402 skip to the next visible line start.
6404 Functions get_next_display_element and set_iterator_to_next are
6405 separate because I find this arrangement easier to handle than a
6406 get_next_display_element function that also increments IT's
6407 position. The way it is we can first look at an iterator's current
6408 display element, decide whether it fits on a line, and if it does,
6409 increment the iterator position. The other way around we probably
6410 would either need a flag indicating whether the iterator has to be
6411 incremented the next time, or we would have to implement a
6412 decrement position function which would not be easy to write. */
6415 set_iterator_to_next (struct it
*it
, int reseat_p
)
6417 /* Reset flags indicating start and end of a sequence of characters
6418 with box. Reset them at the start of this function because
6419 moving the iterator to a new position might set them. */
6420 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6424 case GET_FROM_BUFFER
:
6425 /* The current display element of IT is a character from
6426 current_buffer. Advance in the buffer, and maybe skip over
6427 invisible lines that are so because of selective display. */
6428 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6429 reseat_at_next_visible_line_start (it
, 0);
6430 else if (it
->cmp_it
.id
>= 0)
6432 /* We are currently getting glyphs from a composition. */
6437 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6438 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6439 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6441 it
->cmp_it
.from
= it
->cmp_it
.to
;
6446 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6448 it
->end_charpos
, Qnil
);
6451 else if (! it
->cmp_it
.reversed_p
)
6453 /* Composition created while scanning forward. */
6454 /* Update IT's char/byte positions to point to the first
6455 character of the next grapheme cluster, or to the
6456 character visually after the current composition. */
6457 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6458 bidi_move_to_visually_next (&it
->bidi_it
);
6459 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6460 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6462 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6464 /* Proceed to the next grapheme cluster. */
6465 it
->cmp_it
.from
= it
->cmp_it
.to
;
6469 /* No more grapheme clusters in this composition.
6470 Find the next stop position. */
6471 EMACS_INT stop
= it
->end_charpos
;
6472 if (it
->bidi_it
.scan_dir
< 0)
6473 /* Now we are scanning backward and don't know
6476 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6477 IT_BYTEPOS (*it
), stop
, Qnil
);
6482 /* Composition created while scanning backward. */
6483 /* Update IT's char/byte positions to point to the last
6484 character of the previous grapheme cluster, or the
6485 character visually after the current composition. */
6486 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6487 bidi_move_to_visually_next (&it
->bidi_it
);
6488 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6489 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6490 if (it
->cmp_it
.from
> 0)
6492 /* Proceed to the previous grapheme cluster. */
6493 it
->cmp_it
.to
= it
->cmp_it
.from
;
6497 /* No more grapheme clusters in this composition.
6498 Find the next stop position. */
6499 EMACS_INT stop
= it
->end_charpos
;
6500 if (it
->bidi_it
.scan_dir
< 0)
6501 /* Now we are scanning backward and don't know
6504 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6505 IT_BYTEPOS (*it
), stop
, Qnil
);
6511 xassert (it
->len
!= 0);
6515 IT_BYTEPOS (*it
) += it
->len
;
6516 IT_CHARPOS (*it
) += 1;
6520 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6521 /* If this is a new paragraph, determine its base
6522 direction (a.k.a. its base embedding level). */
6523 if (it
->bidi_it
.new_paragraph
)
6524 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6525 bidi_move_to_visually_next (&it
->bidi_it
);
6526 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6527 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6528 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6530 /* As the scan direction was changed, we must
6531 re-compute the stop position for composition. */
6532 EMACS_INT stop
= it
->end_charpos
;
6533 if (it
->bidi_it
.scan_dir
< 0)
6535 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6536 IT_BYTEPOS (*it
), stop
, Qnil
);
6539 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6543 case GET_FROM_C_STRING
:
6544 /* Current display element of IT is from a C string. */
6546 /* If the string position is beyond string's end, it means
6547 next_element_from_c_string is padding the string with
6548 blanks, in which case we bypass the bidi iterator,
6549 because it cannot deal with such virtual characters. */
6550 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6552 IT_BYTEPOS (*it
) += it
->len
;
6553 IT_CHARPOS (*it
) += 1;
6557 bidi_move_to_visually_next (&it
->bidi_it
);
6558 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6559 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6563 case GET_FROM_DISPLAY_VECTOR
:
6564 /* Current display element of IT is from a display table entry.
6565 Advance in the display table definition. Reset it to null if
6566 end reached, and continue with characters from buffers/
6568 ++it
->current
.dpvec_index
;
6570 /* Restore face of the iterator to what they were before the
6571 display vector entry (these entries may contain faces). */
6572 it
->face_id
= it
->saved_face_id
;
6574 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6576 int recheck_faces
= it
->ellipsis_p
;
6579 it
->method
= GET_FROM_C_STRING
;
6580 else if (STRINGP (it
->string
))
6581 it
->method
= GET_FROM_STRING
;
6584 it
->method
= GET_FROM_BUFFER
;
6585 it
->object
= it
->w
->buffer
;
6589 it
->current
.dpvec_index
= -1;
6591 /* Skip over characters which were displayed via IT->dpvec. */
6592 if (it
->dpvec_char_len
< 0)
6593 reseat_at_next_visible_line_start (it
, 1);
6594 else if (it
->dpvec_char_len
> 0)
6596 if (it
->method
== GET_FROM_STRING
6597 && it
->n_overlay_strings
> 0)
6598 it
->ignore_overlay_strings_at_pos_p
= 1;
6599 it
->len
= it
->dpvec_char_len
;
6600 set_iterator_to_next (it
, reseat_p
);
6603 /* Maybe recheck faces after display vector */
6605 it
->stop_charpos
= IT_CHARPOS (*it
);
6609 case GET_FROM_STRING
:
6610 /* Current display element is a character from a Lisp string. */
6611 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6612 if (it
->cmp_it
.id
>= 0)
6618 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6619 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6620 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6621 it
->cmp_it
.from
= it
->cmp_it
.to
;
6625 composition_compute_stop_pos (&it
->cmp_it
,
6626 IT_STRING_CHARPOS (*it
),
6627 IT_STRING_BYTEPOS (*it
),
6628 it
->end_charpos
, it
->string
);
6631 else if (! it
->cmp_it
.reversed_p
)
6633 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6634 bidi_move_to_visually_next (&it
->bidi_it
);
6635 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6636 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6638 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6639 it
->cmp_it
.from
= it
->cmp_it
.to
;
6642 EMACS_INT stop
= it
->end_charpos
;
6643 if (it
->bidi_it
.scan_dir
< 0)
6645 composition_compute_stop_pos (&it
->cmp_it
,
6646 IT_STRING_CHARPOS (*it
),
6647 IT_STRING_BYTEPOS (*it
), stop
,
6653 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6654 bidi_move_to_visually_next (&it
->bidi_it
);
6655 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6656 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6657 if (it
->cmp_it
.from
> 0)
6658 it
->cmp_it
.to
= it
->cmp_it
.from
;
6661 EMACS_INT stop
= it
->end_charpos
;
6662 if (it
->bidi_it
.scan_dir
< 0)
6664 composition_compute_stop_pos (&it
->cmp_it
,
6665 IT_STRING_CHARPOS (*it
),
6666 IT_STRING_BYTEPOS (*it
), stop
,
6674 /* If the string position is beyond string's end, it
6675 means next_element_from_string is padding the string
6676 with blanks, in which case we bypass the bidi
6677 iterator, because it cannot deal with such virtual
6679 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6681 IT_STRING_BYTEPOS (*it
) += it
->len
;
6682 IT_STRING_CHARPOS (*it
) += 1;
6686 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6688 bidi_move_to_visually_next (&it
->bidi_it
);
6689 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6690 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6691 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6693 EMACS_INT stop
= it
->end_charpos
;
6695 if (it
->bidi_it
.scan_dir
< 0)
6697 composition_compute_stop_pos (&it
->cmp_it
,
6698 IT_STRING_CHARPOS (*it
),
6699 IT_STRING_BYTEPOS (*it
), stop
,
6705 consider_string_end
:
6707 if (it
->current
.overlay_string_index
>= 0)
6709 /* IT->string is an overlay string. Advance to the
6710 next, if there is one. */
6711 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6714 next_overlay_string (it
);
6716 setup_for_ellipsis (it
, 0);
6721 /* IT->string is not an overlay string. If we reached
6722 its end, and there is something on IT->stack, proceed
6723 with what is on the stack. This can be either another
6724 string, this time an overlay string, or a buffer. */
6725 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6729 if (it
->method
== GET_FROM_STRING
)
6730 goto consider_string_end
;
6735 case GET_FROM_IMAGE
:
6736 case GET_FROM_STRETCH
:
6737 /* The position etc with which we have to proceed are on
6738 the stack. The position may be at the end of a string,
6739 if the `display' property takes up the whole string. */
6740 xassert (it
->sp
> 0);
6742 if (it
->method
== GET_FROM_STRING
)
6743 goto consider_string_end
;
6747 /* There are no other methods defined, so this should be a bug. */
6751 xassert (it
->method
!= GET_FROM_STRING
6752 || (STRINGP (it
->string
)
6753 && IT_STRING_CHARPOS (*it
) >= 0));
6756 /* Load IT's display element fields with information about the next
6757 display element which comes from a display table entry or from the
6758 result of translating a control character to one of the forms `^C'
6761 IT->dpvec holds the glyphs to return as characters.
6762 IT->saved_face_id holds the face id before the display vector--it
6763 is restored into IT->face_id in set_iterator_to_next. */
6766 next_element_from_display_vector (struct it
*it
)
6771 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6773 it
->face_id
= it
->saved_face_id
;
6775 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6776 That seemed totally bogus - so I changed it... */
6777 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6779 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6781 it
->c
= GLYPH_CODE_CHAR (gc
);
6782 it
->len
= CHAR_BYTES (it
->c
);
6784 /* The entry may contain a face id to use. Such a face id is
6785 the id of a Lisp face, not a realized face. A face id of
6786 zero means no face is specified. */
6787 if (it
->dpvec_face_id
>= 0)
6788 it
->face_id
= it
->dpvec_face_id
;
6791 int lface_id
= GLYPH_CODE_FACE (gc
);
6793 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6798 /* Display table entry is invalid. Return a space. */
6799 it
->c
= ' ', it
->len
= 1;
6801 /* Don't change position and object of the iterator here. They are
6802 still the values of the character that had this display table
6803 entry or was translated, and that's what we want. */
6804 it
->what
= IT_CHARACTER
;
6808 /* Get the first element of string/buffer in the visual order, after
6809 being reseated to a new position in a string or a buffer. */
6811 get_visually_first_element (struct it
*it
)
6813 int string_p
= STRINGP (it
->string
) || it
->s
;
6814 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6815 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6817 if (STRINGP (it
->string
))
6819 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6820 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6824 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6825 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6828 if (it
->bidi_it
.charpos
== eob
)
6830 /* Nothing to do, but reset the FIRST_ELT flag, like
6831 bidi_paragraph_init does, because we are not going to
6833 it
->bidi_it
.first_elt
= 0;
6835 else if (it
->bidi_it
.charpos
== bob
6837 /* FIXME: Should support all Unicode line separators. */
6838 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6839 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6841 /* If we are at the beginning of a line/string, we can produce
6842 the next element right away. */
6843 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6844 bidi_move_to_visually_next (&it
->bidi_it
);
6848 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6850 /* We need to prime the bidi iterator starting at the line's or
6851 string's beginning, before we will be able to produce the
6854 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6857 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6859 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6861 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6864 /* Now return to buffer/string position where we were asked
6865 to get the next display element, and produce that. */
6866 bidi_move_to_visually_next (&it
->bidi_it
);
6868 while (it
->bidi_it
.bytepos
!= orig_bytepos
6869 && it
->bidi_it
.charpos
< eob
);
6872 /* Adjust IT's position information to where we ended up. */
6873 if (STRINGP (it
->string
))
6875 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6876 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6880 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6881 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6884 if (STRINGP (it
->string
) || !it
->s
)
6886 EMACS_INT stop
, charpos
, bytepos
;
6888 if (STRINGP (it
->string
))
6891 stop
= SCHARS (it
->string
);
6892 if (stop
> it
->end_charpos
)
6893 stop
= it
->end_charpos
;
6894 charpos
= IT_STRING_CHARPOS (*it
);
6895 bytepos
= IT_STRING_BYTEPOS (*it
);
6899 stop
= it
->end_charpos
;
6900 charpos
= IT_CHARPOS (*it
);
6901 bytepos
= IT_BYTEPOS (*it
);
6903 if (it
->bidi_it
.scan_dir
< 0)
6905 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6910 /* Load IT with the next display element from Lisp string IT->string.
6911 IT->current.string_pos is the current position within the string.
6912 If IT->current.overlay_string_index >= 0, the Lisp string is an
6916 next_element_from_string (struct it
*it
)
6918 struct text_pos position
;
6920 xassert (STRINGP (it
->string
));
6921 xassert (!it
->bidi_p
|| it
->string
== it
->bidi_it
.string
.lstring
);
6922 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6923 position
= it
->current
.string_pos
;
6925 /* With bidi reordering, the character to display might not be the
6926 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6927 that we were reseat()ed to a new string, whose paragraph
6928 direction is not known. */
6929 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6931 get_visually_first_element (it
);
6932 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
6935 /* Time to check for invisible text? */
6936 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
6938 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
6941 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6942 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
6944 /* With bidi non-linear iteration, we could find
6945 ourselves far beyond the last computed stop_charpos,
6946 with several other stop positions in between that we
6947 missed. Scan them all now, in buffer's logical
6948 order, until we find and handle the last stop_charpos
6949 that precedes our current position. */
6950 handle_stop_backwards (it
, it
->stop_charpos
);
6951 return GET_NEXT_DISPLAY_ELEMENT (it
);
6957 /* Take note of the stop position we just moved
6958 across, for when we will move back across it. */
6959 it
->prev_stop
= it
->stop_charpos
;
6960 /* If we are at base paragraph embedding level, take
6961 note of the last stop position seen at this
6963 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6964 it
->base_level_stop
= it
->stop_charpos
;
6968 /* Since a handler may have changed IT->method, we must
6970 return GET_NEXT_DISPLAY_ELEMENT (it
);
6974 /* If we are before prev_stop, we may have overstepped
6975 on our way backwards a stop_pos, and if so, we need
6976 to handle that stop_pos. */
6977 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
6978 /* We can sometimes back up for reasons that have nothing
6979 to do with bidi reordering. E.g., compositions. The
6980 code below is only needed when we are above the base
6981 embedding level, so test for that explicitly. */
6982 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6984 /* If we lost track of base_level_stop, we have no better place
6985 for handle_stop_backwards to start from than BEGV. This
6986 happens, e.g., when we were reseated to the previous
6987 screenful of text by vertical-motion. */
6988 if (it
->base_level_stop
<= 0
6989 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
6990 it
->base_level_stop
= 0;
6991 handle_stop_backwards (it
, it
->base_level_stop
);
6992 return GET_NEXT_DISPLAY_ELEMENT (it
);
6996 if (it
->current
.overlay_string_index
>= 0)
6998 /* Get the next character from an overlay string. In overlay
6999 strings, There is no field width or padding with spaces to
7001 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7006 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7007 IT_STRING_BYTEPOS (*it
),
7008 it
->bidi_it
.scan_dir
< 0
7010 : SCHARS (it
->string
))
7011 && next_element_from_composition (it
))
7015 else if (STRING_MULTIBYTE (it
->string
))
7017 const unsigned char *s
= (SDATA (it
->string
)
7018 + IT_STRING_BYTEPOS (*it
));
7019 it
->c
= string_char_and_length (s
, &it
->len
);
7023 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7029 /* Get the next character from a Lisp string that is not an
7030 overlay string. Such strings come from the mode line, for
7031 example. We may have to pad with spaces, or truncate the
7032 string. See also next_element_from_c_string. */
7033 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7038 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7040 /* Pad with spaces. */
7041 it
->c
= ' ', it
->len
= 1;
7042 CHARPOS (position
) = BYTEPOS (position
) = -1;
7044 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7045 IT_STRING_BYTEPOS (*it
),
7046 it
->bidi_it
.scan_dir
< 0
7048 : it
->string_nchars
)
7049 && next_element_from_composition (it
))
7053 else if (STRING_MULTIBYTE (it
->string
))
7055 const unsigned char *s
= (SDATA (it
->string
)
7056 + IT_STRING_BYTEPOS (*it
));
7057 it
->c
= string_char_and_length (s
, &it
->len
);
7061 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7066 /* Record what we have and where it came from. */
7067 it
->what
= IT_CHARACTER
;
7068 it
->object
= it
->string
;
7069 it
->position
= position
;
7074 /* Load IT with next display element from C string IT->s.
7075 IT->string_nchars is the maximum number of characters to return
7076 from the string. IT->end_charpos may be greater than
7077 IT->string_nchars when this function is called, in which case we
7078 may have to return padding spaces. Value is zero if end of string
7079 reached, including padding spaces. */
7082 next_element_from_c_string (struct it
*it
)
7087 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7088 it
->what
= IT_CHARACTER
;
7089 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7092 /* With bidi reordering, the character to display might not be the
7093 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7094 we were reseated to a new string, whose paragraph direction is
7096 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7097 get_visually_first_element (it
);
7099 /* IT's position can be greater than IT->string_nchars in case a
7100 field width or precision has been specified when the iterator was
7102 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7104 /* End of the game. */
7108 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7110 /* Pad with spaces. */
7111 it
->c
= ' ', it
->len
= 1;
7112 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7114 else if (it
->multibyte_p
)
7115 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7117 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7123 /* Set up IT to return characters from an ellipsis, if appropriate.
7124 The definition of the ellipsis glyphs may come from a display table
7125 entry. This function fills IT with the first glyph from the
7126 ellipsis if an ellipsis is to be displayed. */
7129 next_element_from_ellipsis (struct it
*it
)
7131 if (it
->selective_display_ellipsis_p
)
7132 setup_for_ellipsis (it
, it
->len
);
7135 /* The face at the current position may be different from the
7136 face we find after the invisible text. Remember what it
7137 was in IT->saved_face_id, and signal that it's there by
7138 setting face_before_selective_p. */
7139 it
->saved_face_id
= it
->face_id
;
7140 it
->method
= GET_FROM_BUFFER
;
7141 it
->object
= it
->w
->buffer
;
7142 reseat_at_next_visible_line_start (it
, 1);
7143 it
->face_before_selective_p
= 1;
7146 return GET_NEXT_DISPLAY_ELEMENT (it
);
7150 /* Deliver an image display element. The iterator IT is already
7151 filled with image information (done in handle_display_prop). Value
7156 next_element_from_image (struct it
*it
)
7158 it
->what
= IT_IMAGE
;
7159 it
->ignore_overlay_strings_at_pos_p
= 0;
7164 /* Fill iterator IT with next display element from a stretch glyph
7165 property. IT->object is the value of the text property. Value is
7169 next_element_from_stretch (struct it
*it
)
7171 it
->what
= IT_STRETCH
;
7175 /* Scan forward from CHARPOS in the current buffer/string, until we
7176 find a stop position > current IT's position. Then handle the stop
7177 position before that. This is called when we bump into a stop
7178 position while reordering bidirectional text. CHARPOS should be
7179 the last previously processed stop_pos (or BEGV/0, if none were
7180 processed yet) whose position is less that IT's current
7184 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7186 int bufp
= !STRINGP (it
->string
);
7187 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7188 struct display_pos save_current
= it
->current
;
7189 struct text_pos save_position
= it
->position
;
7190 struct text_pos pos1
;
7191 EMACS_INT next_stop
;
7193 /* Scan in strict logical order. */
7197 it
->prev_stop
= charpos
;
7200 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7201 reseat_1 (it
, pos1
, 0);
7204 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7205 compute_stop_pos (it
);
7206 /* We must advance forward, right? */
7207 if (it
->stop_charpos
<= it
->prev_stop
)
7209 charpos
= it
->stop_charpos
;
7211 while (charpos
<= where_we_are
);
7213 next_stop
= it
->stop_charpos
;
7214 it
->stop_charpos
= it
->prev_stop
;
7216 it
->current
= save_current
;
7217 it
->position
= save_position
;
7219 it
->stop_charpos
= next_stop
;
7222 /* Load IT with the next display element from current_buffer. Value
7223 is zero if end of buffer reached. IT->stop_charpos is the next
7224 position at which to stop and check for text properties or buffer
7228 next_element_from_buffer (struct it
*it
)
7232 xassert (IT_CHARPOS (*it
) >= BEGV
);
7233 xassert (NILP (it
->string
) && !it
->s
);
7234 xassert (!it
->bidi_p
7235 || (it
->bidi_it
.string
.lstring
== Qnil
7236 && it
->bidi_it
.string
.s
== NULL
));
7238 /* With bidi reordering, the character to display might not be the
7239 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7240 we were reseat()ed to a new buffer position, which is potentially
7241 a different paragraph. */
7242 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7244 get_visually_first_element (it
);
7245 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7248 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7250 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7252 int overlay_strings_follow_p
;
7254 /* End of the game, except when overlay strings follow that
7255 haven't been returned yet. */
7256 if (it
->overlay_strings_at_end_processed_p
)
7257 overlay_strings_follow_p
= 0;
7260 it
->overlay_strings_at_end_processed_p
= 1;
7261 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7264 if (overlay_strings_follow_p
)
7265 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7269 it
->position
= it
->current
.pos
;
7273 else if (!(!it
->bidi_p
7274 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7275 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7277 /* With bidi non-linear iteration, we could find ourselves
7278 far beyond the last computed stop_charpos, with several
7279 other stop positions in between that we missed. Scan
7280 them all now, in buffer's logical order, until we find
7281 and handle the last stop_charpos that precedes our
7282 current position. */
7283 handle_stop_backwards (it
, it
->stop_charpos
);
7284 return GET_NEXT_DISPLAY_ELEMENT (it
);
7290 /* Take note of the stop position we just moved across,
7291 for when we will move back across it. */
7292 it
->prev_stop
= it
->stop_charpos
;
7293 /* If we are at base paragraph embedding level, take
7294 note of the last stop position seen at this
7296 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7297 it
->base_level_stop
= it
->stop_charpos
;
7300 return GET_NEXT_DISPLAY_ELEMENT (it
);
7304 /* If we are before prev_stop, we may have overstepped on
7305 our way backwards a stop_pos, and if so, we need to
7306 handle that stop_pos. */
7307 && IT_CHARPOS (*it
) < it
->prev_stop
7308 /* We can sometimes back up for reasons that have nothing
7309 to do with bidi reordering. E.g., compositions. The
7310 code below is only needed when we are above the base
7311 embedding level, so test for that explicitly. */
7312 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7314 /* If we lost track of base_level_stop, we have no better place
7315 for handle_stop_backwards to start from than BEGV. This
7316 happens, e.g., when we were reseated to the previous
7317 screenful of text by vertical-motion. */
7318 if (it
->base_level_stop
<= 0
7319 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7320 it
->base_level_stop
= BEGV
;
7321 handle_stop_backwards (it
, it
->base_level_stop
);
7322 return GET_NEXT_DISPLAY_ELEMENT (it
);
7326 /* No face changes, overlays etc. in sight, so just return a
7327 character from current_buffer. */
7331 /* Maybe run the redisplay end trigger hook. Performance note:
7332 This doesn't seem to cost measurable time. */
7333 if (it
->redisplay_end_trigger_charpos
7335 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7336 run_redisplay_end_trigger_hook (it
);
7338 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7339 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7341 && next_element_from_composition (it
))
7346 /* Get the next character, maybe multibyte. */
7347 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7348 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7349 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7351 it
->c
= *p
, it
->len
= 1;
7353 /* Record what we have and where it came from. */
7354 it
->what
= IT_CHARACTER
;
7355 it
->object
= it
->w
->buffer
;
7356 it
->position
= it
->current
.pos
;
7358 /* Normally we return the character found above, except when we
7359 really want to return an ellipsis for selective display. */
7364 /* A value of selective > 0 means hide lines indented more
7365 than that number of columns. */
7366 if (it
->selective
> 0
7367 && IT_CHARPOS (*it
) + 1 < ZV
7368 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7369 IT_BYTEPOS (*it
) + 1,
7370 (double) it
->selective
)) /* iftc */
7372 success_p
= next_element_from_ellipsis (it
);
7373 it
->dpvec_char_len
= -1;
7376 else if (it
->c
== '\r' && it
->selective
== -1)
7378 /* A value of selective == -1 means that everything from the
7379 CR to the end of the line is invisible, with maybe an
7380 ellipsis displayed for it. */
7381 success_p
= next_element_from_ellipsis (it
);
7382 it
->dpvec_char_len
= -1;
7387 /* Value is zero if end of buffer reached. */
7388 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7393 /* Run the redisplay end trigger hook for IT. */
7396 run_redisplay_end_trigger_hook (struct it
*it
)
7398 Lisp_Object args
[3];
7400 /* IT->glyph_row should be non-null, i.e. we should be actually
7401 displaying something, or otherwise we should not run the hook. */
7402 xassert (it
->glyph_row
);
7404 /* Set up hook arguments. */
7405 args
[0] = Qredisplay_end_trigger_functions
;
7406 args
[1] = it
->window
;
7407 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7408 it
->redisplay_end_trigger_charpos
= 0;
7410 /* Since we are *trying* to run these functions, don't try to run
7411 them again, even if they get an error. */
7412 it
->w
->redisplay_end_trigger
= Qnil
;
7413 Frun_hook_with_args (3, args
);
7415 /* Notice if it changed the face of the character we are on. */
7416 handle_face_prop (it
);
7420 /* Deliver a composition display element. Unlike the other
7421 next_element_from_XXX, this function is not registered in the array
7422 get_next_element[]. It is called from next_element_from_buffer and
7423 next_element_from_string when necessary. */
7426 next_element_from_composition (struct it
*it
)
7428 it
->what
= IT_COMPOSITION
;
7429 it
->len
= it
->cmp_it
.nbytes
;
7430 if (STRINGP (it
->string
))
7434 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7435 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7438 it
->position
= it
->current
.string_pos
;
7439 it
->object
= it
->string
;
7440 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7441 IT_STRING_BYTEPOS (*it
), it
->string
);
7447 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7448 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7451 if (it
->bidi_it
.new_paragraph
)
7452 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7453 /* Resync the bidi iterator with IT's new position.
7454 FIXME: this doesn't support bidirectional text. */
7455 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7456 bidi_move_to_visually_next (&it
->bidi_it
);
7460 it
->position
= it
->current
.pos
;
7461 it
->object
= it
->w
->buffer
;
7462 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7463 IT_BYTEPOS (*it
), Qnil
);
7470 /***********************************************************************
7471 Moving an iterator without producing glyphs
7472 ***********************************************************************/
7474 /* Check if iterator is at a position corresponding to a valid buffer
7475 position after some move_it_ call. */
7477 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7478 ((it)->method == GET_FROM_STRING \
7479 ? IT_STRING_CHARPOS (*it) == 0 \
7483 /* Move iterator IT to a specified buffer or X position within one
7484 line on the display without producing glyphs.
7486 OP should be a bit mask including some or all of these bits:
7487 MOVE_TO_X: Stop upon reaching x-position TO_X.
7488 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7489 Regardless of OP's value, stop upon reaching the end of the display line.
7491 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7492 This means, in particular, that TO_X includes window's horizontal
7495 The return value has several possible values that
7496 say what condition caused the scan to stop:
7498 MOVE_POS_MATCH_OR_ZV
7499 - when TO_POS or ZV was reached.
7502 -when TO_X was reached before TO_POS or ZV were reached.
7505 - when we reached the end of the display area and the line must
7509 - when we reached the end of the display area and the line is
7513 - when we stopped at a line end, i.e. a newline or a CR and selective
7516 static enum move_it_result
7517 move_it_in_display_line_to (struct it
*it
,
7518 EMACS_INT to_charpos
, int to_x
,
7519 enum move_operation_enum op
)
7521 enum move_it_result result
= MOVE_UNDEFINED
;
7522 struct glyph_row
*saved_glyph_row
;
7523 struct it wrap_it
, atpos_it
, atx_it
;
7524 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7526 enum it_method prev_method
= it
->method
;
7527 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7529 /* Don't produce glyphs in produce_glyphs. */
7530 saved_glyph_row
= it
->glyph_row
;
7531 it
->glyph_row
= NULL
;
7533 /* Use wrap_it to save a copy of IT wherever a word wrap could
7534 occur. Use atpos_it to save a copy of IT at the desired buffer
7535 position, if found, so that we can scan ahead and check if the
7536 word later overshoots the window edge. Use atx_it similarly, for
7542 #define BUFFER_POS_REACHED_P() \
7543 ((op & MOVE_TO_POS) != 0 \
7544 && BUFFERP (it->object) \
7545 && (IT_CHARPOS (*it) == to_charpos \
7546 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7547 && (it->method == GET_FROM_BUFFER \
7548 || (it->method == GET_FROM_DISPLAY_VECTOR \
7549 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7551 /* If there's a line-/wrap-prefix, handle it. */
7552 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7553 && it
->current_y
< it
->last_visible_y
)
7554 handle_line_prefix (it
);
7556 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7557 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7561 int x
, i
, ascent
= 0, descent
= 0;
7563 /* Utility macro to reset an iterator with x, ascent, and descent. */
7564 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7565 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7566 (IT)->max_descent = descent)
7568 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7570 if ((op
& MOVE_TO_POS
) != 0
7571 && BUFFERP (it
->object
)
7572 && it
->method
== GET_FROM_BUFFER
7573 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7575 && (prev_method
== GET_FROM_IMAGE
7576 || prev_method
== GET_FROM_STRETCH
)
7577 /* Passed TO_CHARPOS from left to right. */
7578 && ((prev_pos
< to_charpos
7579 && IT_CHARPOS (*it
) > to_charpos
)
7580 /* Passed TO_CHARPOS from right to left. */
7581 || (prev_pos
> to_charpos
7582 && IT_CHARPOS (*it
) < to_charpos
)))))
7584 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7586 result
= MOVE_POS_MATCH_OR_ZV
;
7589 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7590 /* If wrap_it is valid, the current position might be in a
7591 word that is wrapped. So, save the iterator in
7592 atpos_it and continue to see if wrapping happens. */
7593 SAVE_IT (atpos_it
, *it
, atpos_data
);
7596 prev_method
= it
->method
;
7597 if (it
->method
== GET_FROM_BUFFER
)
7598 prev_pos
= IT_CHARPOS (*it
);
7599 /* Stop when ZV reached.
7600 We used to stop here when TO_CHARPOS reached as well, but that is
7601 too soon if this glyph does not fit on this line. So we handle it
7602 explicitly below. */
7603 if (!get_next_display_element (it
))
7605 result
= MOVE_POS_MATCH_OR_ZV
;
7609 if (it
->line_wrap
== TRUNCATE
)
7611 if (BUFFER_POS_REACHED_P ())
7613 result
= MOVE_POS_MATCH_OR_ZV
;
7619 if (it
->line_wrap
== WORD_WRAP
)
7621 if (IT_DISPLAYING_WHITESPACE (it
))
7625 /* We have reached a glyph that follows one or more
7626 whitespace characters. If the position is
7627 already found, we are done. */
7628 if (atpos_it
.sp
>= 0)
7630 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7631 result
= MOVE_POS_MATCH_OR_ZV
;
7636 RESTORE_IT (it
, &atx_it
, atx_data
);
7637 result
= MOVE_X_REACHED
;
7640 /* Otherwise, we can wrap here. */
7641 SAVE_IT (wrap_it
, *it
, wrap_data
);
7647 /* Remember the line height for the current line, in case
7648 the next element doesn't fit on the line. */
7649 ascent
= it
->max_ascent
;
7650 descent
= it
->max_descent
;
7652 /* The call to produce_glyphs will get the metrics of the
7653 display element IT is loaded with. Record the x-position
7654 before this display element, in case it doesn't fit on the
7658 PRODUCE_GLYPHS (it
);
7660 if (it
->area
!= TEXT_AREA
)
7662 set_iterator_to_next (it
, 1);
7663 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7664 SET_TEXT_POS (this_line_min_pos
,
7665 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7669 /* The number of glyphs we get back in IT->nglyphs will normally
7670 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7671 character on a terminal frame, or (iii) a line end. For the
7672 second case, IT->nglyphs - 1 padding glyphs will be present.
7673 (On X frames, there is only one glyph produced for a
7674 composite character.)
7676 The behavior implemented below means, for continuation lines,
7677 that as many spaces of a TAB as fit on the current line are
7678 displayed there. For terminal frames, as many glyphs of a
7679 multi-glyph character are displayed in the current line, too.
7680 This is what the old redisplay code did, and we keep it that
7681 way. Under X, the whole shape of a complex character must
7682 fit on the line or it will be completely displayed in the
7685 Note that both for tabs and padding glyphs, all glyphs have
7689 /* More than one glyph or glyph doesn't fit on line. All
7690 glyphs have the same width. */
7691 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7693 int x_before_this_char
= x
;
7694 int hpos_before_this_char
= it
->hpos
;
7696 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7698 new_x
= x
+ single_glyph_width
;
7700 /* We want to leave anything reaching TO_X to the caller. */
7701 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7703 if (BUFFER_POS_REACHED_P ())
7705 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7706 goto buffer_pos_reached
;
7707 if (atpos_it
.sp
< 0)
7709 SAVE_IT (atpos_it
, *it
, atpos_data
);
7710 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7715 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7718 result
= MOVE_X_REACHED
;
7723 SAVE_IT (atx_it
, *it
, atx_data
);
7724 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7729 if (/* Lines are continued. */
7730 it
->line_wrap
!= TRUNCATE
7731 && (/* And glyph doesn't fit on the line. */
7732 new_x
> it
->last_visible_x
7733 /* Or it fits exactly and we're on a window
7735 || (new_x
== it
->last_visible_x
7736 && FRAME_WINDOW_P (it
->f
))))
7738 if (/* IT->hpos == 0 means the very first glyph
7739 doesn't fit on the line, e.g. a wide image. */
7741 || (new_x
== it
->last_visible_x
7742 && FRAME_WINDOW_P (it
->f
)))
7745 it
->current_x
= new_x
;
7747 /* The character's last glyph just barely fits
7749 if (i
== it
->nglyphs
- 1)
7751 /* If this is the destination position,
7752 return a position *before* it in this row,
7753 now that we know it fits in this row. */
7754 if (BUFFER_POS_REACHED_P ())
7756 if (it
->line_wrap
!= WORD_WRAP
7759 it
->hpos
= hpos_before_this_char
;
7760 it
->current_x
= x_before_this_char
;
7761 result
= MOVE_POS_MATCH_OR_ZV
;
7764 if (it
->line_wrap
== WORD_WRAP
7767 SAVE_IT (atpos_it
, *it
, atpos_data
);
7768 atpos_it
.current_x
= x_before_this_char
;
7769 atpos_it
.hpos
= hpos_before_this_char
;
7773 set_iterator_to_next (it
, 1);
7774 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7775 SET_TEXT_POS (this_line_min_pos
,
7776 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7777 /* On graphical terminals, newlines may
7778 "overflow" into the fringe if
7779 overflow-newline-into-fringe is non-nil.
7780 On text-only terminals, newlines may
7781 overflow into the last glyph on the
7783 if (!FRAME_WINDOW_P (it
->f
)
7784 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7786 if (!get_next_display_element (it
))
7788 result
= MOVE_POS_MATCH_OR_ZV
;
7791 if (BUFFER_POS_REACHED_P ())
7793 if (ITERATOR_AT_END_OF_LINE_P (it
))
7794 result
= MOVE_POS_MATCH_OR_ZV
;
7796 result
= MOVE_LINE_CONTINUED
;
7799 if (ITERATOR_AT_END_OF_LINE_P (it
))
7801 result
= MOVE_NEWLINE_OR_CR
;
7808 IT_RESET_X_ASCENT_DESCENT (it
);
7810 if (wrap_it
.sp
>= 0)
7812 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7817 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7819 result
= MOVE_LINE_CONTINUED
;
7823 if (BUFFER_POS_REACHED_P ())
7825 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7826 goto buffer_pos_reached
;
7827 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7829 SAVE_IT (atpos_it
, *it
, atpos_data
);
7830 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7834 if (new_x
> it
->first_visible_x
)
7836 /* Glyph is visible. Increment number of glyphs that
7837 would be displayed. */
7842 if (result
!= MOVE_UNDEFINED
)
7845 else if (BUFFER_POS_REACHED_P ())
7848 IT_RESET_X_ASCENT_DESCENT (it
);
7849 result
= MOVE_POS_MATCH_OR_ZV
;
7852 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7854 /* Stop when TO_X specified and reached. This check is
7855 necessary here because of lines consisting of a line end,
7856 only. The line end will not produce any glyphs and we
7857 would never get MOVE_X_REACHED. */
7858 xassert (it
->nglyphs
== 0);
7859 result
= MOVE_X_REACHED
;
7863 /* Is this a line end? If yes, we're done. */
7864 if (ITERATOR_AT_END_OF_LINE_P (it
))
7866 result
= MOVE_NEWLINE_OR_CR
;
7870 if (it
->method
== GET_FROM_BUFFER
)
7871 prev_pos
= IT_CHARPOS (*it
);
7872 /* The current display element has been consumed. Advance
7874 set_iterator_to_next (it
, 1);
7875 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7876 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7878 /* Stop if lines are truncated and IT's current x-position is
7879 past the right edge of the window now. */
7880 if (it
->line_wrap
== TRUNCATE
7881 && it
->current_x
>= it
->last_visible_x
)
7883 if (!FRAME_WINDOW_P (it
->f
)
7884 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7886 if (!get_next_display_element (it
)
7887 || BUFFER_POS_REACHED_P ())
7889 result
= MOVE_POS_MATCH_OR_ZV
;
7892 if (ITERATOR_AT_END_OF_LINE_P (it
))
7894 result
= MOVE_NEWLINE_OR_CR
;
7898 result
= MOVE_LINE_TRUNCATED
;
7901 #undef IT_RESET_X_ASCENT_DESCENT
7904 #undef BUFFER_POS_REACHED_P
7906 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7907 restore the saved iterator. */
7908 if (atpos_it
.sp
>= 0)
7909 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7910 else if (atx_it
.sp
>= 0)
7911 RESTORE_IT (it
, &atx_it
, atx_data
);
7922 /* Restore the iterator settings altered at the beginning of this
7924 it
->glyph_row
= saved_glyph_row
;
7928 /* For external use. */
7930 move_it_in_display_line (struct it
*it
,
7931 EMACS_INT to_charpos
, int to_x
,
7932 enum move_operation_enum op
)
7934 if (it
->line_wrap
== WORD_WRAP
7935 && (op
& MOVE_TO_X
))
7938 void *save_data
= NULL
;
7941 SAVE_IT (save_it
, *it
, save_data
);
7942 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7943 /* When word-wrap is on, TO_X may lie past the end
7944 of a wrapped line. Then it->current is the
7945 character on the next line, so backtrack to the
7946 space before the wrap point. */
7947 if (skip
== MOVE_LINE_CONTINUED
)
7949 int prev_x
= max (it
->current_x
- 1, 0);
7950 RESTORE_IT (it
, &save_it
, save_data
);
7951 move_it_in_display_line_to
7952 (it
, -1, prev_x
, MOVE_TO_X
);
7958 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7962 /* Move IT forward until it satisfies one or more of the criteria in
7963 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7965 OP is a bit-mask that specifies where to stop, and in particular,
7966 which of those four position arguments makes a difference. See the
7967 description of enum move_operation_enum.
7969 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7970 screen line, this function will set IT to the next position >
7974 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7976 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7977 int line_height
, line_start_x
= 0, reached
= 0;
7978 void *backup_data
= NULL
;
7982 if (op
& MOVE_TO_VPOS
)
7984 /* If no TO_CHARPOS and no TO_X specified, stop at the
7985 start of the line TO_VPOS. */
7986 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7988 if (it
->vpos
== to_vpos
)
7994 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7998 /* TO_VPOS >= 0 means stop at TO_X in the line at
7999 TO_VPOS, or at TO_POS, whichever comes first. */
8000 if (it
->vpos
== to_vpos
)
8006 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8008 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8013 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8015 /* We have reached TO_X but not in the line we want. */
8016 skip
= move_it_in_display_line_to (it
, to_charpos
,
8018 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8026 else if (op
& MOVE_TO_Y
)
8028 struct it it_backup
;
8030 if (it
->line_wrap
== WORD_WRAP
)
8031 SAVE_IT (it_backup
, *it
, backup_data
);
8033 /* TO_Y specified means stop at TO_X in the line containing
8034 TO_Y---or at TO_CHARPOS if this is reached first. The
8035 problem is that we can't really tell whether the line
8036 contains TO_Y before we have completely scanned it, and
8037 this may skip past TO_X. What we do is to first scan to
8040 If TO_X is not specified, use a TO_X of zero. The reason
8041 is to make the outcome of this function more predictable.
8042 If we didn't use TO_X == 0, we would stop at the end of
8043 the line which is probably not what a caller would expect
8045 skip
= move_it_in_display_line_to
8046 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8047 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8049 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8050 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8052 else if (skip
== MOVE_X_REACHED
)
8054 /* If TO_X was reached, we want to know whether TO_Y is
8055 in the line. We know this is the case if the already
8056 scanned glyphs make the line tall enough. Otherwise,
8057 we must check by scanning the rest of the line. */
8058 line_height
= it
->max_ascent
+ it
->max_descent
;
8059 if (to_y
>= it
->current_y
8060 && to_y
< it
->current_y
+ line_height
)
8065 SAVE_IT (it_backup
, *it
, backup_data
);
8066 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8067 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8069 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8070 line_height
= it
->max_ascent
+ it
->max_descent
;
8071 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8073 if (to_y
>= it
->current_y
8074 && to_y
< it
->current_y
+ line_height
)
8076 /* If TO_Y is in this line and TO_X was reached
8077 above, we scanned too far. We have to restore
8078 IT's settings to the ones before skipping. */
8079 RESTORE_IT (it
, &it_backup
, backup_data
);
8085 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8091 /* Check whether TO_Y is in this line. */
8092 line_height
= it
->max_ascent
+ it
->max_descent
;
8093 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8095 if (to_y
>= it
->current_y
8096 && to_y
< it
->current_y
+ line_height
)
8098 /* When word-wrap is on, TO_X may lie past the end
8099 of a wrapped line. Then it->current is the
8100 character on the next line, so backtrack to the
8101 space before the wrap point. */
8102 if (skip
== MOVE_LINE_CONTINUED
8103 && it
->line_wrap
== WORD_WRAP
)
8105 int prev_x
= max (it
->current_x
- 1, 0);
8106 RESTORE_IT (it
, &it_backup
, backup_data
);
8107 skip
= move_it_in_display_line_to
8108 (it
, -1, prev_x
, MOVE_TO_X
);
8117 else if (BUFFERP (it
->object
)
8118 && (it
->method
== GET_FROM_BUFFER
8119 || it
->method
== GET_FROM_STRETCH
)
8120 && IT_CHARPOS (*it
) >= to_charpos
)
8121 skip
= MOVE_POS_MATCH_OR_ZV
;
8123 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8127 case MOVE_POS_MATCH_OR_ZV
:
8131 case MOVE_NEWLINE_OR_CR
:
8132 set_iterator_to_next (it
, 1);
8133 it
->continuation_lines_width
= 0;
8136 case MOVE_LINE_TRUNCATED
:
8137 it
->continuation_lines_width
= 0;
8138 reseat_at_next_visible_line_start (it
, 0);
8139 if ((op
& MOVE_TO_POS
) != 0
8140 && IT_CHARPOS (*it
) > to_charpos
)
8147 case MOVE_LINE_CONTINUED
:
8148 /* For continued lines ending in a tab, some of the glyphs
8149 associated with the tab are displayed on the current
8150 line. Since it->current_x does not include these glyphs,
8151 we use it->last_visible_x instead. */
8154 it
->continuation_lines_width
+= it
->last_visible_x
;
8155 /* When moving by vpos, ensure that the iterator really
8156 advances to the next line (bug#847, bug#969). Fixme:
8157 do we need to do this in other circumstances? */
8158 if (it
->current_x
!= it
->last_visible_x
8159 && (op
& MOVE_TO_VPOS
)
8160 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8162 line_start_x
= it
->current_x
+ it
->pixel_width
8163 - it
->last_visible_x
;
8164 set_iterator_to_next (it
, 0);
8168 it
->continuation_lines_width
+= it
->current_x
;
8175 /* Reset/increment for the next run. */
8176 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8177 it
->current_x
= line_start_x
;
8180 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8182 last_height
= it
->max_ascent
+ it
->max_descent
;
8183 last_max_ascent
= it
->max_ascent
;
8184 it
->max_ascent
= it
->max_descent
= 0;
8189 /* On text terminals, we may stop at the end of a line in the middle
8190 of a multi-character glyph. If the glyph itself is continued,
8191 i.e. it is actually displayed on the next line, don't treat this
8192 stopping point as valid; move to the next line instead (unless
8193 that brings us offscreen). */
8194 if (!FRAME_WINDOW_P (it
->f
)
8196 && IT_CHARPOS (*it
) == to_charpos
8197 && it
->what
== IT_CHARACTER
8199 && it
->line_wrap
== WINDOW_WRAP
8200 && it
->current_x
== it
->last_visible_x
- 1
8203 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8205 it
->continuation_lines_width
+= it
->current_x
;
8206 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8207 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8209 last_height
= it
->max_ascent
+ it
->max_descent
;
8210 last_max_ascent
= it
->max_ascent
;
8214 xfree (backup_data
);
8216 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8220 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8222 If DY > 0, move IT backward at least that many pixels. DY = 0
8223 means move IT backward to the preceding line start or BEGV. This
8224 function may move over more than DY pixels if IT->current_y - DY
8225 ends up in the middle of a line; in this case IT->current_y will be
8226 set to the top of the line moved to. */
8229 move_it_vertically_backward (struct it
*it
, int dy
)
8233 void *it2data
= NULL
, *it3data
= NULL
;
8234 EMACS_INT start_pos
;
8239 start_pos
= IT_CHARPOS (*it
);
8241 /* Estimate how many newlines we must move back. */
8242 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8244 /* Set the iterator's position that many lines back. */
8245 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8246 back_to_previous_visible_line_start (it
);
8248 /* Reseat the iterator here. When moving backward, we don't want
8249 reseat to skip forward over invisible text, set up the iterator
8250 to deliver from overlay strings at the new position etc. So,
8251 use reseat_1 here. */
8252 reseat_1 (it
, it
->current
.pos
, 1);
8254 /* We are now surely at a line start. */
8255 it
->current_x
= it
->hpos
= 0;
8256 it
->continuation_lines_width
= 0;
8258 /* Move forward and see what y-distance we moved. First move to the
8259 start of the next line so that we get its height. We need this
8260 height to be able to tell whether we reached the specified
8262 SAVE_IT (it2
, *it
, it2data
);
8263 it2
.max_ascent
= it2
.max_descent
= 0;
8266 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8267 MOVE_TO_POS
| MOVE_TO_VPOS
);
8269 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8270 xassert (IT_CHARPOS (*it
) >= BEGV
);
8271 SAVE_IT (it3
, it2
, it3data
);
8273 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8274 xassert (IT_CHARPOS (*it
) >= BEGV
);
8275 /* H is the actual vertical distance from the position in *IT
8276 and the starting position. */
8277 h
= it2
.current_y
- it
->current_y
;
8278 /* NLINES is the distance in number of lines. */
8279 nlines
= it2
.vpos
- it
->vpos
;
8281 /* Correct IT's y and vpos position
8282 so that they are relative to the starting point. */
8288 /* DY == 0 means move to the start of the screen line. The
8289 value of nlines is > 0 if continuation lines were involved. */
8290 RESTORE_IT (it
, it
, it2data
);
8292 move_it_by_lines (it
, nlines
);
8297 /* The y-position we try to reach, relative to *IT.
8298 Note that H has been subtracted in front of the if-statement. */
8299 int target_y
= it
->current_y
+ h
- dy
;
8300 int y0
= it3
.current_y
;
8304 RESTORE_IT (&it3
, &it3
, it3data
);
8305 y1
= line_bottom_y (&it3
);
8306 line_height
= y1
- y0
;
8307 RESTORE_IT (it
, it
, it2data
);
8308 /* If we did not reach target_y, try to move further backward if
8309 we can. If we moved too far backward, try to move forward. */
8310 if (target_y
< it
->current_y
8311 /* This is heuristic. In a window that's 3 lines high, with
8312 a line height of 13 pixels each, recentering with point
8313 on the bottom line will try to move -39/2 = 19 pixels
8314 backward. Try to avoid moving into the first line. */
8315 && (it
->current_y
- target_y
8316 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8317 && IT_CHARPOS (*it
) > BEGV
)
8319 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8320 target_y
- it
->current_y
));
8321 dy
= it
->current_y
- target_y
;
8322 goto move_further_back
;
8324 else if (target_y
>= it
->current_y
+ line_height
8325 && IT_CHARPOS (*it
) < ZV
)
8327 /* Should move forward by at least one line, maybe more.
8329 Note: Calling move_it_by_lines can be expensive on
8330 terminal frames, where compute_motion is used (via
8331 vmotion) to do the job, when there are very long lines
8332 and truncate-lines is nil. That's the reason for
8333 treating terminal frames specially here. */
8335 if (!FRAME_WINDOW_P (it
->f
))
8336 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8341 move_it_by_lines (it
, 1);
8343 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8350 /* Move IT by a specified amount of pixel lines DY. DY negative means
8351 move backwards. DY = 0 means move to start of screen line. At the
8352 end, IT will be on the start of a screen line. */
8355 move_it_vertically (struct it
*it
, int dy
)
8358 move_it_vertically_backward (it
, -dy
);
8361 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8362 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8363 MOVE_TO_POS
| MOVE_TO_Y
);
8364 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8366 /* If buffer ends in ZV without a newline, move to the start of
8367 the line to satisfy the post-condition. */
8368 if (IT_CHARPOS (*it
) == ZV
8370 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8371 move_it_by_lines (it
, 0);
8376 /* Move iterator IT past the end of the text line it is in. */
8379 move_it_past_eol (struct it
*it
)
8381 enum move_it_result rc
;
8383 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8384 if (rc
== MOVE_NEWLINE_OR_CR
)
8385 set_iterator_to_next (it
, 0);
8389 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8390 negative means move up. DVPOS == 0 means move to the start of the
8393 Optimization idea: If we would know that IT->f doesn't use
8394 a face with proportional font, we could be faster for
8395 truncate-lines nil. */
8398 move_it_by_lines (struct it
*it
, int dvpos
)
8401 /* The commented-out optimization uses vmotion on terminals. This
8402 gives bad results, because elements like it->what, on which
8403 callers such as pos_visible_p rely, aren't updated. */
8404 /* struct position pos;
8405 if (!FRAME_WINDOW_P (it->f))
8407 struct text_pos textpos;
8409 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8410 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8411 reseat (it, textpos, 1);
8412 it->vpos += pos.vpos;
8413 it->current_y += pos.vpos;
8419 /* DVPOS == 0 means move to the start of the screen line. */
8420 move_it_vertically_backward (it
, 0);
8421 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8422 /* Let next call to line_bottom_y calculate real line height */
8427 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8428 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8429 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8434 void *it2data
= NULL
;
8435 EMACS_INT start_charpos
, i
;
8437 /* Start at the beginning of the screen line containing IT's
8438 position. This may actually move vertically backwards,
8439 in case of overlays, so adjust dvpos accordingly. */
8441 move_it_vertically_backward (it
, 0);
8444 /* Go back -DVPOS visible lines and reseat the iterator there. */
8445 start_charpos
= IT_CHARPOS (*it
);
8446 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8447 back_to_previous_visible_line_start (it
);
8448 reseat (it
, it
->current
.pos
, 1);
8450 /* Move further back if we end up in a string or an image. */
8451 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8453 /* First try to move to start of display line. */
8455 move_it_vertically_backward (it
, 0);
8457 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8459 /* If start of line is still in string or image,
8460 move further back. */
8461 back_to_previous_visible_line_start (it
);
8462 reseat (it
, it
->current
.pos
, 1);
8466 it
->current_x
= it
->hpos
= 0;
8468 /* Above call may have moved too far if continuation lines
8469 are involved. Scan forward and see if it did. */
8470 SAVE_IT (it2
, *it
, it2data
);
8471 it2
.vpos
= it2
.current_y
= 0;
8472 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8473 it
->vpos
-= it2
.vpos
;
8474 it
->current_y
-= it2
.current_y
;
8475 it
->current_x
= it
->hpos
= 0;
8477 /* If we moved too far back, move IT some lines forward. */
8478 if (it2
.vpos
> -dvpos
)
8480 int delta
= it2
.vpos
+ dvpos
;
8482 RESTORE_IT (&it2
, &it2
, it2data
);
8483 SAVE_IT (it2
, *it
, it2data
);
8484 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8485 /* Move back again if we got too far ahead. */
8486 if (IT_CHARPOS (*it
) >= start_charpos
)
8487 RESTORE_IT (it
, &it2
, it2data
);
8492 RESTORE_IT (it
, it
, it2data
);
8496 /* Return 1 if IT points into the middle of a display vector. */
8499 in_display_vector_p (struct it
*it
)
8501 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8502 && it
->current
.dpvec_index
> 0
8503 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8507 /***********************************************************************
8509 ***********************************************************************/
8512 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8516 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8518 Lisp_Object args
[3];
8519 Lisp_Object msg
, fmt
;
8522 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8525 /* Do nothing if called asynchronously. Inserting text into
8526 a buffer may call after-change-functions and alike and
8527 that would means running Lisp asynchronously. */
8528 if (handling_signal
)
8532 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8534 args
[0] = fmt
= build_string (format
);
8537 msg
= Fformat (3, args
);
8539 len
= SBYTES (msg
) + 1;
8540 SAFE_ALLOCA (buffer
, char *, len
);
8541 memcpy (buffer
, SDATA (msg
), len
);
8543 message_dolog (buffer
, len
- 1, 1, 0);
8550 /* Output a newline in the *Messages* buffer if "needs" one. */
8553 message_log_maybe_newline (void)
8555 if (message_log_need_newline
)
8556 message_dolog ("", 0, 1, 0);
8560 /* Add a string M of length NBYTES to the message log, optionally
8561 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8562 nonzero, means interpret the contents of M as multibyte. This
8563 function calls low-level routines in order to bypass text property
8564 hooks, etc. which might not be safe to run.
8566 This may GC (insert may run before/after change hooks),
8567 so the buffer M must NOT point to a Lisp string. */
8570 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8572 const unsigned char *msg
= (const unsigned char *) m
;
8574 if (!NILP (Vmemory_full
))
8577 if (!NILP (Vmessage_log_max
))
8579 struct buffer
*oldbuf
;
8580 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8581 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8582 EMACS_INT point_at_end
= 0;
8583 EMACS_INT zv_at_end
= 0;
8584 Lisp_Object old_deactivate_mark
, tem
;
8585 struct gcpro gcpro1
;
8587 old_deactivate_mark
= Vdeactivate_mark
;
8588 oldbuf
= current_buffer
;
8589 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8590 BVAR (current_buffer
, undo_list
) = Qt
;
8592 oldpoint
= message_dolog_marker1
;
8593 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8594 oldbegv
= message_dolog_marker2
;
8595 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8596 oldzv
= message_dolog_marker3
;
8597 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8598 GCPRO1 (old_deactivate_mark
);
8606 BEGV_BYTE
= BEG_BYTE
;
8609 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8611 /* Insert the string--maybe converting multibyte to single byte
8612 or vice versa, so that all the text fits the buffer. */
8614 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8620 /* Convert a multibyte string to single-byte
8621 for the *Message* buffer. */
8622 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8624 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8625 work
[0] = (ASCII_CHAR_P (c
)
8627 : multibyte_char_to_unibyte (c
));
8628 insert_1_both (work
, 1, 1, 1, 0, 0);
8631 else if (! multibyte
8632 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8636 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8637 /* Convert a single-byte string to multibyte
8638 for the *Message* buffer. */
8639 for (i
= 0; i
< nbytes
; i
++)
8642 MAKE_CHAR_MULTIBYTE (c
);
8643 char_bytes
= CHAR_STRING (c
, str
);
8644 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8648 insert_1 (m
, nbytes
, 1, 0, 0);
8652 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8653 unsigned long int dups
;
8654 insert_1 ("\n", 1, 1, 0, 0);
8656 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8658 this_bol_byte
= PT_BYTE
;
8660 /* See if this line duplicates the previous one.
8661 If so, combine duplicates. */
8664 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8666 prev_bol_byte
= PT_BYTE
;
8668 dups
= message_log_check_duplicate (prev_bol_byte
,
8672 del_range_both (prev_bol
, prev_bol_byte
,
8673 this_bol
, this_bol_byte
, 0);
8679 /* If you change this format, don't forget to also
8680 change message_log_check_duplicate. */
8681 sprintf (dupstr
, " [%lu times]", dups
);
8682 duplen
= strlen (dupstr
);
8683 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8684 insert_1 (dupstr
, duplen
, 1, 0, 1);
8689 /* If we have more than the desired maximum number of lines
8690 in the *Messages* buffer now, delete the oldest ones.
8691 This is safe because we don't have undo in this buffer. */
8693 if (NATNUMP (Vmessage_log_max
))
8695 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8696 -XFASTINT (Vmessage_log_max
) - 1, 0);
8697 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8700 BEGV
= XMARKER (oldbegv
)->charpos
;
8701 BEGV_BYTE
= marker_byte_position (oldbegv
);
8710 ZV
= XMARKER (oldzv
)->charpos
;
8711 ZV_BYTE
= marker_byte_position (oldzv
);
8715 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8717 /* We can't do Fgoto_char (oldpoint) because it will run some
8719 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8720 XMARKER (oldpoint
)->bytepos
);
8723 unchain_marker (XMARKER (oldpoint
));
8724 unchain_marker (XMARKER (oldbegv
));
8725 unchain_marker (XMARKER (oldzv
));
8727 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8728 set_buffer_internal (oldbuf
);
8730 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8731 message_log_need_newline
= !nlflag
;
8732 Vdeactivate_mark
= old_deactivate_mark
;
8737 /* We are at the end of the buffer after just having inserted a newline.
8738 (Note: We depend on the fact we won't be crossing the gap.)
8739 Check to see if the most recent message looks a lot like the previous one.
8740 Return 0 if different, 1 if the new one should just replace it, or a
8741 value N > 1 if we should also append " [N times]". */
8743 static unsigned long int
8744 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8747 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8749 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8750 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8752 for (i
= 0; i
< len
; i
++)
8754 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8762 if (*p1
++ == ' ' && *p1
++ == '[')
8765 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8766 if (strncmp (pend
, " times]\n", 8) == 0)
8773 /* Display an echo area message M with a specified length of NBYTES
8774 bytes. The string may include null characters. If M is 0, clear
8775 out any existing message, and let the mini-buffer text show
8778 This may GC, so the buffer M must NOT point to a Lisp string. */
8781 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8783 /* First flush out any partial line written with print. */
8784 message_log_maybe_newline ();
8786 message_dolog (m
, nbytes
, 1, multibyte
);
8787 message2_nolog (m
, nbytes
, multibyte
);
8791 /* The non-logging counterpart of message2. */
8794 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8796 struct frame
*sf
= SELECTED_FRAME ();
8797 message_enable_multibyte
= multibyte
;
8799 if (FRAME_INITIAL_P (sf
))
8801 if (noninteractive_need_newline
)
8802 putc ('\n', stderr
);
8803 noninteractive_need_newline
= 0;
8805 fwrite (m
, nbytes
, 1, stderr
);
8806 if (cursor_in_echo_area
== 0)
8807 fprintf (stderr
, "\n");
8810 /* A null message buffer means that the frame hasn't really been
8811 initialized yet. Error messages get reported properly by
8812 cmd_error, so this must be just an informative message; toss it. */
8813 else if (INTERACTIVE
8814 && sf
->glyphs_initialized_p
8815 && FRAME_MESSAGE_BUF (sf
))
8817 Lisp_Object mini_window
;
8820 /* Get the frame containing the mini-buffer
8821 that the selected frame is using. */
8822 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8823 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8825 FRAME_SAMPLE_VISIBILITY (f
);
8826 if (FRAME_VISIBLE_P (sf
)
8827 && ! FRAME_VISIBLE_P (f
))
8828 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8832 set_message (m
, Qnil
, nbytes
, multibyte
);
8833 if (minibuffer_auto_raise
)
8834 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8837 clear_message (1, 1);
8839 do_pending_window_change (0);
8840 echo_area_display (1);
8841 do_pending_window_change (0);
8842 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8843 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8848 /* Display an echo area message M with a specified length of NBYTES
8849 bytes. The string may include null characters. If M is not a
8850 string, clear out any existing message, and let the mini-buffer
8853 This function cancels echoing. */
8856 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8858 struct gcpro gcpro1
;
8861 clear_message (1,1);
8864 /* First flush out any partial line written with print. */
8865 message_log_maybe_newline ();
8871 SAFE_ALLOCA (buffer
, char *, nbytes
);
8872 memcpy (buffer
, SDATA (m
), nbytes
);
8873 message_dolog (buffer
, nbytes
, 1, multibyte
);
8876 message3_nolog (m
, nbytes
, multibyte
);
8882 /* The non-logging version of message3.
8883 This does not cancel echoing, because it is used for echoing.
8884 Perhaps we need to make a separate function for echoing
8885 and make this cancel echoing. */
8888 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8890 struct frame
*sf
= SELECTED_FRAME ();
8891 message_enable_multibyte
= multibyte
;
8893 if (FRAME_INITIAL_P (sf
))
8895 if (noninteractive_need_newline
)
8896 putc ('\n', stderr
);
8897 noninteractive_need_newline
= 0;
8899 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8900 if (cursor_in_echo_area
== 0)
8901 fprintf (stderr
, "\n");
8904 /* A null message buffer means that the frame hasn't really been
8905 initialized yet. Error messages get reported properly by
8906 cmd_error, so this must be just an informative message; toss it. */
8907 else if (INTERACTIVE
8908 && sf
->glyphs_initialized_p
8909 && FRAME_MESSAGE_BUF (sf
))
8911 Lisp_Object mini_window
;
8915 /* Get the frame containing the mini-buffer
8916 that the selected frame is using. */
8917 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8918 frame
= XWINDOW (mini_window
)->frame
;
8921 FRAME_SAMPLE_VISIBILITY (f
);
8922 if (FRAME_VISIBLE_P (sf
)
8923 && !FRAME_VISIBLE_P (f
))
8924 Fmake_frame_visible (frame
);
8926 if (STRINGP (m
) && SCHARS (m
) > 0)
8928 set_message (NULL
, m
, nbytes
, multibyte
);
8929 if (minibuffer_auto_raise
)
8930 Fraise_frame (frame
);
8931 /* Assume we are not echoing.
8932 (If we are, echo_now will override this.) */
8933 echo_message_buffer
= Qnil
;
8936 clear_message (1, 1);
8938 do_pending_window_change (0);
8939 echo_area_display (1);
8940 do_pending_window_change (0);
8941 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8942 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8947 /* Display a null-terminated echo area message M. If M is 0, clear
8948 out any existing message, and let the mini-buffer text show through.
8950 The buffer M must continue to exist until after the echo area gets
8951 cleared or some other message gets displayed there. Do not pass
8952 text that is stored in a Lisp string. Do not pass text in a buffer
8953 that was alloca'd. */
8956 message1 (const char *m
)
8958 message2 (m
, (m
? strlen (m
) : 0), 0);
8962 /* The non-logging counterpart of message1. */
8965 message1_nolog (const char *m
)
8967 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8970 /* Display a message M which contains a single %s
8971 which gets replaced with STRING. */
8974 message_with_string (const char *m
, Lisp_Object string
, int log
)
8976 CHECK_STRING (string
);
8982 if (noninteractive_need_newline
)
8983 putc ('\n', stderr
);
8984 noninteractive_need_newline
= 0;
8985 fprintf (stderr
, m
, SDATA (string
));
8986 if (!cursor_in_echo_area
)
8987 fprintf (stderr
, "\n");
8991 else if (INTERACTIVE
)
8993 /* The frame whose minibuffer we're going to display the message on.
8994 It may be larger than the selected frame, so we need
8995 to use its buffer, not the selected frame's buffer. */
8996 Lisp_Object mini_window
;
8997 struct frame
*f
, *sf
= SELECTED_FRAME ();
8999 /* Get the frame containing the minibuffer
9000 that the selected frame is using. */
9001 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9002 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9004 /* A null message buffer means that the frame hasn't really been
9005 initialized yet. Error messages get reported properly by
9006 cmd_error, so this must be just an informative message; toss it. */
9007 if (FRAME_MESSAGE_BUF (f
))
9009 Lisp_Object args
[2], msg
;
9010 struct gcpro gcpro1
, gcpro2
;
9012 args
[0] = build_string (m
);
9013 args
[1] = msg
= string
;
9014 GCPRO2 (args
[0], msg
);
9017 msg
= Fformat (2, args
);
9020 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9022 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9026 /* Print should start at the beginning of the message
9027 buffer next time. */
9028 message_buf_print
= 0;
9034 /* Dump an informative message to the minibuf. If M is 0, clear out
9035 any existing message, and let the mini-buffer text show through. */
9038 vmessage (const char *m
, va_list ap
)
9044 if (noninteractive_need_newline
)
9045 putc ('\n', stderr
);
9046 noninteractive_need_newline
= 0;
9047 vfprintf (stderr
, m
, ap
);
9048 if (cursor_in_echo_area
== 0)
9049 fprintf (stderr
, "\n");
9053 else if (INTERACTIVE
)
9055 /* The frame whose mini-buffer we're going to display the message
9056 on. It may be larger than the selected frame, so we need to
9057 use its buffer, not the selected frame's buffer. */
9058 Lisp_Object mini_window
;
9059 struct frame
*f
, *sf
= SELECTED_FRAME ();
9061 /* Get the frame containing the mini-buffer
9062 that the selected frame is using. */
9063 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9064 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9066 /* A null message buffer means that the frame hasn't really been
9067 initialized yet. Error messages get reported properly by
9068 cmd_error, so this must be just an informative message; toss
9070 if (FRAME_MESSAGE_BUF (f
))
9076 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9077 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9079 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9084 /* Print should start at the beginning of the message
9085 buffer next time. */
9086 message_buf_print
= 0;
9092 message (const char *m
, ...)
9102 /* The non-logging version of message. */
9105 message_nolog (const char *m
, ...)
9107 Lisp_Object old_log_max
;
9110 old_log_max
= Vmessage_log_max
;
9111 Vmessage_log_max
= Qnil
;
9113 Vmessage_log_max
= old_log_max
;
9119 /* Display the current message in the current mini-buffer. This is
9120 only called from error handlers in process.c, and is not time
9124 update_echo_area (void)
9126 if (!NILP (echo_area_buffer
[0]))
9129 string
= Fcurrent_message ();
9130 message3 (string
, SBYTES (string
),
9131 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9136 /* Make sure echo area buffers in `echo_buffers' are live.
9137 If they aren't, make new ones. */
9140 ensure_echo_area_buffers (void)
9144 for (i
= 0; i
< 2; ++i
)
9145 if (!BUFFERP (echo_buffer
[i
])
9146 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9149 Lisp_Object old_buffer
;
9152 old_buffer
= echo_buffer
[i
];
9153 sprintf (name
, " *Echo Area %d*", i
);
9154 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9155 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9156 /* to force word wrap in echo area -
9157 it was decided to postpone this*/
9158 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9160 for (j
= 0; j
< 2; ++j
)
9161 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9162 echo_area_buffer
[j
] = echo_buffer
[i
];
9167 /* Call FN with args A1..A4 with either the current or last displayed
9168 echo_area_buffer as current buffer.
9170 WHICH zero means use the current message buffer
9171 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9172 from echo_buffer[] and clear it.
9174 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9175 suitable buffer from echo_buffer[] and clear it.
9177 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9178 that the current message becomes the last displayed one, make
9179 choose a suitable buffer for echo_area_buffer[0], and clear it.
9181 Value is what FN returns. */
9184 with_echo_area_buffer (struct window
*w
, int which
,
9185 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9186 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9189 int this_one
, the_other
, clear_buffer_p
, rc
;
9190 int count
= SPECPDL_INDEX ();
9192 /* If buffers aren't live, make new ones. */
9193 ensure_echo_area_buffers ();
9198 this_one
= 0, the_other
= 1;
9200 this_one
= 1, the_other
= 0;
9203 this_one
= 0, the_other
= 1;
9206 /* We need a fresh one in case the current echo buffer equals
9207 the one containing the last displayed echo area message. */
9208 if (!NILP (echo_area_buffer
[this_one
])
9209 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9210 echo_area_buffer
[this_one
] = Qnil
;
9213 /* Choose a suitable buffer from echo_buffer[] is we don't
9215 if (NILP (echo_area_buffer
[this_one
]))
9217 echo_area_buffer
[this_one
]
9218 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9219 ? echo_buffer
[the_other
]
9220 : echo_buffer
[this_one
]);
9224 buffer
= echo_area_buffer
[this_one
];
9226 /* Don't get confused by reusing the buffer used for echoing
9227 for a different purpose. */
9228 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9231 record_unwind_protect (unwind_with_echo_area_buffer
,
9232 with_echo_area_buffer_unwind_data (w
));
9234 /* Make the echo area buffer current. Note that for display
9235 purposes, it is not necessary that the displayed window's buffer
9236 == current_buffer, except for text property lookup. So, let's
9237 only set that buffer temporarily here without doing a full
9238 Fset_window_buffer. We must also change w->pointm, though,
9239 because otherwise an assertions in unshow_buffer fails, and Emacs
9241 set_buffer_internal_1 (XBUFFER (buffer
));
9245 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9248 BVAR (current_buffer
, undo_list
) = Qt
;
9249 BVAR (current_buffer
, read_only
) = Qnil
;
9250 specbind (Qinhibit_read_only
, Qt
);
9251 specbind (Qinhibit_modification_hooks
, Qt
);
9253 if (clear_buffer_p
&& Z
> BEG
)
9256 xassert (BEGV
>= BEG
);
9257 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9259 rc
= fn (a1
, a2
, a3
, a4
);
9261 xassert (BEGV
>= BEG
);
9262 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9264 unbind_to (count
, Qnil
);
9269 /* Save state that should be preserved around the call to the function
9270 FN called in with_echo_area_buffer. */
9273 with_echo_area_buffer_unwind_data (struct window
*w
)
9276 Lisp_Object vector
, tmp
;
9278 /* Reduce consing by keeping one vector in
9279 Vwith_echo_area_save_vector. */
9280 vector
= Vwith_echo_area_save_vector
;
9281 Vwith_echo_area_save_vector
= Qnil
;
9284 vector
= Fmake_vector (make_number (7), Qnil
);
9286 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9287 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9288 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9292 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9293 ASET (vector
, i
, w
->buffer
); ++i
;
9294 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9295 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9300 for (; i
< end
; ++i
)
9301 ASET (vector
, i
, Qnil
);
9304 xassert (i
== ASIZE (vector
));
9309 /* Restore global state from VECTOR which was created by
9310 with_echo_area_buffer_unwind_data. */
9313 unwind_with_echo_area_buffer (Lisp_Object vector
)
9315 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9316 Vdeactivate_mark
= AREF (vector
, 1);
9317 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9319 if (WINDOWP (AREF (vector
, 3)))
9322 Lisp_Object buffer
, charpos
, bytepos
;
9324 w
= XWINDOW (AREF (vector
, 3));
9325 buffer
= AREF (vector
, 4);
9326 charpos
= AREF (vector
, 5);
9327 bytepos
= AREF (vector
, 6);
9330 set_marker_both (w
->pointm
, buffer
,
9331 XFASTINT (charpos
), XFASTINT (bytepos
));
9334 Vwith_echo_area_save_vector
= vector
;
9339 /* Set up the echo area for use by print functions. MULTIBYTE_P
9340 non-zero means we will print multibyte. */
9343 setup_echo_area_for_printing (int multibyte_p
)
9345 /* If we can't find an echo area any more, exit. */
9346 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9349 ensure_echo_area_buffers ();
9351 if (!message_buf_print
)
9353 /* A message has been output since the last time we printed.
9354 Choose a fresh echo area buffer. */
9355 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9356 echo_area_buffer
[0] = echo_buffer
[1];
9358 echo_area_buffer
[0] = echo_buffer
[0];
9360 /* Switch to that buffer and clear it. */
9361 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9362 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9366 int count
= SPECPDL_INDEX ();
9367 specbind (Qinhibit_read_only
, Qt
);
9368 /* Note that undo recording is always disabled. */
9370 unbind_to (count
, Qnil
);
9372 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9374 /* Set up the buffer for the multibyteness we need. */
9376 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9377 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9379 /* Raise the frame containing the echo area. */
9380 if (minibuffer_auto_raise
)
9382 struct frame
*sf
= SELECTED_FRAME ();
9383 Lisp_Object mini_window
;
9384 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9385 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9388 message_log_maybe_newline ();
9389 message_buf_print
= 1;
9393 if (NILP (echo_area_buffer
[0]))
9395 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9396 echo_area_buffer
[0] = echo_buffer
[1];
9398 echo_area_buffer
[0] = echo_buffer
[0];
9401 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9403 /* Someone switched buffers between print requests. */
9404 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9405 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9411 /* Display an echo area message in window W. Value is non-zero if W's
9412 height is changed. If display_last_displayed_message_p is
9413 non-zero, display the message that was last displayed, otherwise
9414 display the current message. */
9417 display_echo_area (struct window
*w
)
9419 int i
, no_message_p
, window_height_changed_p
, count
;
9421 /* Temporarily disable garbage collections while displaying the echo
9422 area. This is done because a GC can print a message itself.
9423 That message would modify the echo area buffer's contents while a
9424 redisplay of the buffer is going on, and seriously confuse
9426 count
= inhibit_garbage_collection ();
9428 /* If there is no message, we must call display_echo_area_1
9429 nevertheless because it resizes the window. But we will have to
9430 reset the echo_area_buffer in question to nil at the end because
9431 with_echo_area_buffer will sets it to an empty buffer. */
9432 i
= display_last_displayed_message_p
? 1 : 0;
9433 no_message_p
= NILP (echo_area_buffer
[i
]);
9435 window_height_changed_p
9436 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9437 display_echo_area_1
,
9438 (intptr_t) w
, Qnil
, 0, 0);
9441 echo_area_buffer
[i
] = Qnil
;
9443 unbind_to (count
, Qnil
);
9444 return window_height_changed_p
;
9448 /* Helper for display_echo_area. Display the current buffer which
9449 contains the current echo area message in window W, a mini-window,
9450 a pointer to which is passed in A1. A2..A4 are currently not used.
9451 Change the height of W so that all of the message is displayed.
9452 Value is non-zero if height of W was changed. */
9455 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9458 struct window
*w
= (struct window
*) i1
;
9460 struct text_pos start
;
9461 int window_height_changed_p
= 0;
9463 /* Do this before displaying, so that we have a large enough glyph
9464 matrix for the display. If we can't get enough space for the
9465 whole text, display the last N lines. That works by setting w->start. */
9466 window_height_changed_p
= resize_mini_window (w
, 0);
9468 /* Use the starting position chosen by resize_mini_window. */
9469 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9472 clear_glyph_matrix (w
->desired_matrix
);
9473 XSETWINDOW (window
, w
);
9474 try_window (window
, start
, 0);
9476 return window_height_changed_p
;
9480 /* Resize the echo area window to exactly the size needed for the
9481 currently displayed message, if there is one. If a mini-buffer
9482 is active, don't shrink it. */
9485 resize_echo_area_exactly (void)
9487 if (BUFFERP (echo_area_buffer
[0])
9488 && WINDOWP (echo_area_window
))
9490 struct window
*w
= XWINDOW (echo_area_window
);
9492 Lisp_Object resize_exactly
;
9494 if (minibuf_level
== 0)
9495 resize_exactly
= Qt
;
9497 resize_exactly
= Qnil
;
9499 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9500 (intptr_t) w
, resize_exactly
,
9504 ++windows_or_buffers_changed
;
9505 ++update_mode_lines
;
9506 redisplay_internal ();
9512 /* Callback function for with_echo_area_buffer, when used from
9513 resize_echo_area_exactly. A1 contains a pointer to the window to
9514 resize, EXACTLY non-nil means resize the mini-window exactly to the
9515 size of the text displayed. A3 and A4 are not used. Value is what
9516 resize_mini_window returns. */
9519 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9522 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9526 /* Resize mini-window W to fit the size of its contents. EXACT_P
9527 means size the window exactly to the size needed. Otherwise, it's
9528 only enlarged until W's buffer is empty.
9530 Set W->start to the right place to begin display. If the whole
9531 contents fit, start at the beginning. Otherwise, start so as
9532 to make the end of the contents appear. This is particularly
9533 important for y-or-n-p, but seems desirable generally.
9535 Value is non-zero if the window height has been changed. */
9538 resize_mini_window (struct window
*w
, int exact_p
)
9540 struct frame
*f
= XFRAME (w
->frame
);
9541 int window_height_changed_p
= 0;
9543 xassert (MINI_WINDOW_P (w
));
9545 /* By default, start display at the beginning. */
9546 set_marker_both (w
->start
, w
->buffer
,
9547 BUF_BEGV (XBUFFER (w
->buffer
)),
9548 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9550 /* Don't resize windows while redisplaying a window; it would
9551 confuse redisplay functions when the size of the window they are
9552 displaying changes from under them. Such a resizing can happen,
9553 for instance, when which-func prints a long message while
9554 we are running fontification-functions. We're running these
9555 functions with safe_call which binds inhibit-redisplay to t. */
9556 if (!NILP (Vinhibit_redisplay
))
9559 /* Nil means don't try to resize. */
9560 if (NILP (Vresize_mini_windows
)
9561 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9564 if (!FRAME_MINIBUF_ONLY_P (f
))
9567 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9568 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9569 int height
, max_height
;
9570 int unit
= FRAME_LINE_HEIGHT (f
);
9571 struct text_pos start
;
9572 struct buffer
*old_current_buffer
= NULL
;
9574 if (current_buffer
!= XBUFFER (w
->buffer
))
9576 old_current_buffer
= current_buffer
;
9577 set_buffer_internal (XBUFFER (w
->buffer
));
9580 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9582 /* Compute the max. number of lines specified by the user. */
9583 if (FLOATP (Vmax_mini_window_height
))
9584 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9585 else if (INTEGERP (Vmax_mini_window_height
))
9586 max_height
= XINT (Vmax_mini_window_height
);
9588 max_height
= total_height
/ 4;
9590 /* Correct that max. height if it's bogus. */
9591 max_height
= max (1, max_height
);
9592 max_height
= min (total_height
, max_height
);
9594 /* Find out the height of the text in the window. */
9595 if (it
.line_wrap
== TRUNCATE
)
9600 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9601 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9602 height
= it
.current_y
+ last_height
;
9604 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9605 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9606 height
= (height
+ unit
- 1) / unit
;
9609 /* Compute a suitable window start. */
9610 if (height
> max_height
)
9612 height
= max_height
;
9613 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9614 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9615 start
= it
.current
.pos
;
9618 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9619 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9621 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9623 /* Let it grow only, until we display an empty message, in which
9624 case the window shrinks again. */
9625 if (height
> WINDOW_TOTAL_LINES (w
))
9627 int old_height
= WINDOW_TOTAL_LINES (w
);
9628 freeze_window_starts (f
, 1);
9629 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9630 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9632 else if (height
< WINDOW_TOTAL_LINES (w
)
9633 && (exact_p
|| BEGV
== ZV
))
9635 int old_height
= WINDOW_TOTAL_LINES (w
);
9636 freeze_window_starts (f
, 0);
9637 shrink_mini_window (w
);
9638 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9643 /* Always resize to exact size needed. */
9644 if (height
> WINDOW_TOTAL_LINES (w
))
9646 int old_height
= WINDOW_TOTAL_LINES (w
);
9647 freeze_window_starts (f
, 1);
9648 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9649 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9651 else if (height
< WINDOW_TOTAL_LINES (w
))
9653 int old_height
= WINDOW_TOTAL_LINES (w
);
9654 freeze_window_starts (f
, 0);
9655 shrink_mini_window (w
);
9659 freeze_window_starts (f
, 1);
9660 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9663 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9667 if (old_current_buffer
)
9668 set_buffer_internal (old_current_buffer
);
9671 return window_height_changed_p
;
9675 /* Value is the current message, a string, or nil if there is no
9679 current_message (void)
9683 if (!BUFFERP (echo_area_buffer
[0]))
9687 with_echo_area_buffer (0, 0, current_message_1
,
9688 (intptr_t) &msg
, Qnil
, 0, 0);
9690 echo_area_buffer
[0] = Qnil
;
9698 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9701 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9704 *msg
= make_buffer_string (BEG
, Z
, 1);
9711 /* Push the current message on Vmessage_stack for later restauration
9712 by restore_message. Value is non-zero if the current message isn't
9713 empty. This is a relatively infrequent operation, so it's not
9714 worth optimizing. */
9720 msg
= current_message ();
9721 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9722 return STRINGP (msg
);
9726 /* Restore message display from the top of Vmessage_stack. */
9729 restore_message (void)
9733 xassert (CONSP (Vmessage_stack
));
9734 msg
= XCAR (Vmessage_stack
);
9736 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9738 message3_nolog (msg
, 0, 0);
9742 /* Handler for record_unwind_protect calling pop_message. */
9745 pop_message_unwind (Lisp_Object dummy
)
9751 /* Pop the top-most entry off Vmessage_stack. */
9756 xassert (CONSP (Vmessage_stack
));
9757 Vmessage_stack
= XCDR (Vmessage_stack
);
9761 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9762 exits. If the stack is not empty, we have a missing pop_message
9766 check_message_stack (void)
9768 if (!NILP (Vmessage_stack
))
9773 /* Truncate to NCHARS what will be displayed in the echo area the next
9774 time we display it---but don't redisplay it now. */
9777 truncate_echo_area (EMACS_INT nchars
)
9780 echo_area_buffer
[0] = Qnil
;
9781 /* A null message buffer means that the frame hasn't really been
9782 initialized yet. Error messages get reported properly by
9783 cmd_error, so this must be just an informative message; toss it. */
9784 else if (!noninteractive
9786 && !NILP (echo_area_buffer
[0]))
9788 struct frame
*sf
= SELECTED_FRAME ();
9789 if (FRAME_MESSAGE_BUF (sf
))
9790 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9795 /* Helper function for truncate_echo_area. Truncate the current
9796 message to at most NCHARS characters. */
9799 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9801 if (BEG
+ nchars
< Z
)
9802 del_range (BEG
+ nchars
, Z
);
9804 echo_area_buffer
[0] = Qnil
;
9809 /* Set the current message to a substring of S or STRING.
9811 If STRING is a Lisp string, set the message to the first NBYTES
9812 bytes from STRING. NBYTES zero means use the whole string. If
9813 STRING is multibyte, the message will be displayed multibyte.
9815 If S is not null, set the message to the first LEN bytes of S. LEN
9816 zero means use the whole string. MULTIBYTE_P non-zero means S is
9817 multibyte. Display the message multibyte in that case.
9819 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9820 to t before calling set_message_1 (which calls insert).
9824 set_message (const char *s
, Lisp_Object string
,
9825 EMACS_INT nbytes
, int multibyte_p
)
9827 message_enable_multibyte
9828 = ((s
&& multibyte_p
)
9829 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9831 with_echo_area_buffer (0, -1, set_message_1
,
9832 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9833 message_buf_print
= 0;
9834 help_echo_showing_p
= 0;
9838 /* Helper function for set_message. Arguments have the same meaning
9839 as there, with A1 corresponding to S and A2 corresponding to STRING
9840 This function is called with the echo area buffer being
9844 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9847 const char *s
= (const char *) i1
;
9848 const unsigned char *msg
= (const unsigned char *) s
;
9849 Lisp_Object string
= a2
;
9851 /* Change multibyteness of the echo buffer appropriately. */
9852 if (message_enable_multibyte
9853 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9854 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9856 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9857 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9858 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9860 /* Insert new message at BEG. */
9861 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9863 if (STRINGP (string
))
9868 nbytes
= SBYTES (string
);
9869 nchars
= string_byte_to_char (string
, nbytes
);
9871 /* This function takes care of single/multibyte conversion. We
9872 just have to ensure that the echo area buffer has the right
9873 setting of enable_multibyte_characters. */
9874 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9879 nbytes
= strlen (s
);
9881 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9883 /* Convert from multi-byte to single-byte. */
9888 /* Convert a multibyte string to single-byte. */
9889 for (i
= 0; i
< nbytes
; i
+= n
)
9891 c
= string_char_and_length (msg
+ i
, &n
);
9892 work
[0] = (ASCII_CHAR_P (c
)
9894 : multibyte_char_to_unibyte (c
));
9895 insert_1_both (work
, 1, 1, 1, 0, 0);
9898 else if (!multibyte_p
9899 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9901 /* Convert from single-byte to multi-byte. */
9904 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9906 /* Convert a single-byte string to multibyte. */
9907 for (i
= 0; i
< nbytes
; i
++)
9910 MAKE_CHAR_MULTIBYTE (c
);
9911 n
= CHAR_STRING (c
, str
);
9912 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9916 insert_1 (s
, nbytes
, 1, 0, 0);
9923 /* Clear messages. CURRENT_P non-zero means clear the current
9924 message. LAST_DISPLAYED_P non-zero means clear the message
9928 clear_message (int current_p
, int last_displayed_p
)
9932 echo_area_buffer
[0] = Qnil
;
9933 message_cleared_p
= 1;
9936 if (last_displayed_p
)
9937 echo_area_buffer
[1] = Qnil
;
9939 message_buf_print
= 0;
9942 /* Clear garbaged frames.
9944 This function is used where the old redisplay called
9945 redraw_garbaged_frames which in turn called redraw_frame which in
9946 turn called clear_frame. The call to clear_frame was a source of
9947 flickering. I believe a clear_frame is not necessary. It should
9948 suffice in the new redisplay to invalidate all current matrices,
9949 and ensure a complete redisplay of all windows. */
9952 clear_garbaged_frames (void)
9956 Lisp_Object tail
, frame
;
9957 int changed_count
= 0;
9959 FOR_EACH_FRAME (tail
, frame
)
9961 struct frame
*f
= XFRAME (frame
);
9963 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9967 Fredraw_frame (frame
);
9968 f
->force_flush_display_p
= 1;
9970 clear_current_matrices (f
);
9979 ++windows_or_buffers_changed
;
9984 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9985 is non-zero update selected_frame. Value is non-zero if the
9986 mini-windows height has been changed. */
9989 echo_area_display (int update_frame_p
)
9991 Lisp_Object mini_window
;
9994 int window_height_changed_p
= 0;
9995 struct frame
*sf
= SELECTED_FRAME ();
9997 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9998 w
= XWINDOW (mini_window
);
9999 f
= XFRAME (WINDOW_FRAME (w
));
10001 /* Don't display if frame is invisible or not yet initialized. */
10002 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10005 #ifdef HAVE_WINDOW_SYSTEM
10006 /* When Emacs starts, selected_frame may be the initial terminal
10007 frame. If we let this through, a message would be displayed on
10009 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10011 #endif /* HAVE_WINDOW_SYSTEM */
10013 /* Redraw garbaged frames. */
10014 if (frame_garbaged
)
10015 clear_garbaged_frames ();
10017 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10019 echo_area_window
= mini_window
;
10020 window_height_changed_p
= display_echo_area (w
);
10021 w
->must_be_updated_p
= 1;
10023 /* Update the display, unless called from redisplay_internal.
10024 Also don't update the screen during redisplay itself. The
10025 update will happen at the end of redisplay, and an update
10026 here could cause confusion. */
10027 if (update_frame_p
&& !redisplaying_p
)
10031 /* If the display update has been interrupted by pending
10032 input, update mode lines in the frame. Due to the
10033 pending input, it might have been that redisplay hasn't
10034 been called, so that mode lines above the echo area are
10035 garbaged. This looks odd, so we prevent it here. */
10036 if (!display_completed
)
10037 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10039 if (window_height_changed_p
10040 /* Don't do this if Emacs is shutting down. Redisplay
10041 needs to run hooks. */
10042 && !NILP (Vrun_hooks
))
10044 /* Must update other windows. Likewise as in other
10045 cases, don't let this update be interrupted by
10047 int count
= SPECPDL_INDEX ();
10048 specbind (Qredisplay_dont_pause
, Qt
);
10049 windows_or_buffers_changed
= 1;
10050 redisplay_internal ();
10051 unbind_to (count
, Qnil
);
10053 else if (FRAME_WINDOW_P (f
) && n
== 0)
10055 /* Window configuration is the same as before.
10056 Can do with a display update of the echo area,
10057 unless we displayed some mode lines. */
10058 update_single_window (w
, 1);
10059 FRAME_RIF (f
)->flush_display (f
);
10062 update_frame (f
, 1, 1);
10064 /* If cursor is in the echo area, make sure that the next
10065 redisplay displays the minibuffer, so that the cursor will
10066 be replaced with what the minibuffer wants. */
10067 if (cursor_in_echo_area
)
10068 ++windows_or_buffers_changed
;
10071 else if (!EQ (mini_window
, selected_window
))
10072 windows_or_buffers_changed
++;
10074 /* Last displayed message is now the current message. */
10075 echo_area_buffer
[1] = echo_area_buffer
[0];
10076 /* Inform read_char that we're not echoing. */
10077 echo_message_buffer
= Qnil
;
10079 /* Prevent redisplay optimization in redisplay_internal by resetting
10080 this_line_start_pos. This is done because the mini-buffer now
10081 displays the message instead of its buffer text. */
10082 if (EQ (mini_window
, selected_window
))
10083 CHARPOS (this_line_start_pos
) = 0;
10085 return window_height_changed_p
;
10090 /***********************************************************************
10091 Mode Lines and Frame Titles
10092 ***********************************************************************/
10094 /* A buffer for constructing non-propertized mode-line strings and
10095 frame titles in it; allocated from the heap in init_xdisp and
10096 resized as needed in store_mode_line_noprop_char. */
10098 static char *mode_line_noprop_buf
;
10100 /* The buffer's end, and a current output position in it. */
10102 static char *mode_line_noprop_buf_end
;
10103 static char *mode_line_noprop_ptr
;
10105 #define MODE_LINE_NOPROP_LEN(start) \
10106 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10109 MODE_LINE_DISPLAY
= 0,
10113 } mode_line_target
;
10115 /* Alist that caches the results of :propertize.
10116 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10117 static Lisp_Object mode_line_proptrans_alist
;
10119 /* List of strings making up the mode-line. */
10120 static Lisp_Object mode_line_string_list
;
10122 /* Base face property when building propertized mode line string. */
10123 static Lisp_Object mode_line_string_face
;
10124 static Lisp_Object mode_line_string_face_prop
;
10127 /* Unwind data for mode line strings */
10129 static Lisp_Object Vmode_line_unwind_vector
;
10132 format_mode_line_unwind_data (struct buffer
*obuf
,
10134 int save_proptrans
)
10136 Lisp_Object vector
, tmp
;
10138 /* Reduce consing by keeping one vector in
10139 Vwith_echo_area_save_vector. */
10140 vector
= Vmode_line_unwind_vector
;
10141 Vmode_line_unwind_vector
= Qnil
;
10144 vector
= Fmake_vector (make_number (8), Qnil
);
10146 ASET (vector
, 0, make_number (mode_line_target
));
10147 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10148 ASET (vector
, 2, mode_line_string_list
);
10149 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10150 ASET (vector
, 4, mode_line_string_face
);
10151 ASET (vector
, 5, mode_line_string_face_prop
);
10154 XSETBUFFER (tmp
, obuf
);
10157 ASET (vector
, 6, tmp
);
10158 ASET (vector
, 7, owin
);
10164 unwind_format_mode_line (Lisp_Object vector
)
10166 mode_line_target
= XINT (AREF (vector
, 0));
10167 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10168 mode_line_string_list
= AREF (vector
, 2);
10169 if (! EQ (AREF (vector
, 3), Qt
))
10170 mode_line_proptrans_alist
= AREF (vector
, 3);
10171 mode_line_string_face
= AREF (vector
, 4);
10172 mode_line_string_face_prop
= AREF (vector
, 5);
10174 if (!NILP (AREF (vector
, 7)))
10175 /* Select window before buffer, since it may change the buffer. */
10176 Fselect_window (AREF (vector
, 7), Qt
);
10178 if (!NILP (AREF (vector
, 6)))
10180 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10181 ASET (vector
, 6, Qnil
);
10184 Vmode_line_unwind_vector
= vector
;
10189 /* Store a single character C for the frame title in mode_line_noprop_buf.
10190 Re-allocate mode_line_noprop_buf if necessary. */
10193 store_mode_line_noprop_char (char c
)
10195 /* If output position has reached the end of the allocated buffer,
10196 double the buffer's size. */
10197 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10199 int len
= MODE_LINE_NOPROP_LEN (0);
10200 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10201 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10202 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10203 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10206 *mode_line_noprop_ptr
++ = c
;
10210 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10211 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10212 characters that yield more columns than PRECISION; PRECISION <= 0
10213 means copy the whole string. Pad with spaces until FIELD_WIDTH
10214 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10215 pad. Called from display_mode_element when it is used to build a
10219 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10221 const unsigned char *str
= (const unsigned char *) string
;
10223 EMACS_INT dummy
, nbytes
;
10225 /* Copy at most PRECISION chars from STR. */
10226 nbytes
= strlen (string
);
10227 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10229 store_mode_line_noprop_char (*str
++);
10231 /* Fill up with spaces until FIELD_WIDTH reached. */
10232 while (field_width
> 0
10233 && n
< field_width
)
10235 store_mode_line_noprop_char (' ');
10242 /***********************************************************************
10244 ***********************************************************************/
10246 #ifdef HAVE_WINDOW_SYSTEM
10248 /* Set the title of FRAME, if it has changed. The title format is
10249 Vicon_title_format if FRAME is iconified, otherwise it is
10250 frame_title_format. */
10253 x_consider_frame_title (Lisp_Object frame
)
10255 struct frame
*f
= XFRAME (frame
);
10257 if (FRAME_WINDOW_P (f
)
10258 || FRAME_MINIBUF_ONLY_P (f
)
10259 || f
->explicit_name
)
10261 /* Do we have more than one visible frame on this X display? */
10268 int count
= SPECPDL_INDEX ();
10270 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10272 Lisp_Object other_frame
= XCAR (tail
);
10273 struct frame
*tf
= XFRAME (other_frame
);
10276 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10277 && !FRAME_MINIBUF_ONLY_P (tf
)
10278 && !EQ (other_frame
, tip_frame
)
10279 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10283 /* Set global variable indicating that multiple frames exist. */
10284 multiple_frames
= CONSP (tail
);
10286 /* Switch to the buffer of selected window of the frame. Set up
10287 mode_line_target so that display_mode_element will output into
10288 mode_line_noprop_buf; then display the title. */
10289 record_unwind_protect (unwind_format_mode_line
,
10290 format_mode_line_unwind_data
10291 (current_buffer
, selected_window
, 0));
10293 Fselect_window (f
->selected_window
, Qt
);
10294 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10295 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10297 mode_line_target
= MODE_LINE_TITLE
;
10298 title_start
= MODE_LINE_NOPROP_LEN (0);
10299 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10300 NULL
, DEFAULT_FACE_ID
);
10301 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10302 len
= MODE_LINE_NOPROP_LEN (title_start
);
10303 title
= mode_line_noprop_buf
+ title_start
;
10304 unbind_to (count
, Qnil
);
10306 /* Set the title only if it's changed. This avoids consing in
10307 the common case where it hasn't. (If it turns out that we've
10308 already wasted too much time by walking through the list with
10309 display_mode_element, then we might need to optimize at a
10310 higher level than this.) */
10311 if (! STRINGP (f
->name
)
10312 || SBYTES (f
->name
) != len
10313 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10314 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10318 #endif /* not HAVE_WINDOW_SYSTEM */
10323 /***********************************************************************
10325 ***********************************************************************/
10328 /* Prepare for redisplay by updating menu-bar item lists when
10329 appropriate. This can call eval. */
10332 prepare_menu_bars (void)
10335 struct gcpro gcpro1
, gcpro2
;
10337 Lisp_Object tooltip_frame
;
10339 #ifdef HAVE_WINDOW_SYSTEM
10340 tooltip_frame
= tip_frame
;
10342 tooltip_frame
= Qnil
;
10345 /* Update all frame titles based on their buffer names, etc. We do
10346 this before the menu bars so that the buffer-menu will show the
10347 up-to-date frame titles. */
10348 #ifdef HAVE_WINDOW_SYSTEM
10349 if (windows_or_buffers_changed
|| update_mode_lines
)
10351 Lisp_Object tail
, frame
;
10353 FOR_EACH_FRAME (tail
, frame
)
10355 f
= XFRAME (frame
);
10356 if (!EQ (frame
, tooltip_frame
)
10357 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10358 x_consider_frame_title (frame
);
10361 #endif /* HAVE_WINDOW_SYSTEM */
10363 /* Update the menu bar item lists, if appropriate. This has to be
10364 done before any actual redisplay or generation of display lines. */
10365 all_windows
= (update_mode_lines
10366 || buffer_shared
> 1
10367 || windows_or_buffers_changed
);
10370 Lisp_Object tail
, frame
;
10371 int count
= SPECPDL_INDEX ();
10372 /* 1 means that update_menu_bar has run its hooks
10373 so any further calls to update_menu_bar shouldn't do so again. */
10374 int menu_bar_hooks_run
= 0;
10376 record_unwind_save_match_data ();
10378 FOR_EACH_FRAME (tail
, frame
)
10380 f
= XFRAME (frame
);
10382 /* Ignore tooltip frame. */
10383 if (EQ (frame
, tooltip_frame
))
10386 /* If a window on this frame changed size, report that to
10387 the user and clear the size-change flag. */
10388 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10390 Lisp_Object functions
;
10392 /* Clear flag first in case we get an error below. */
10393 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10394 functions
= Vwindow_size_change_functions
;
10395 GCPRO2 (tail
, functions
);
10397 while (CONSP (functions
))
10399 if (!EQ (XCAR (functions
), Qt
))
10400 call1 (XCAR (functions
), frame
);
10401 functions
= XCDR (functions
);
10407 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10408 #ifdef HAVE_WINDOW_SYSTEM
10409 update_tool_bar (f
, 0);
10412 if (windows_or_buffers_changed
10414 ns_set_doc_edited (f
, Fbuffer_modified_p
10415 (XWINDOW (f
->selected_window
)->buffer
));
10420 unbind_to (count
, Qnil
);
10424 struct frame
*sf
= SELECTED_FRAME ();
10425 update_menu_bar (sf
, 1, 0);
10426 #ifdef HAVE_WINDOW_SYSTEM
10427 update_tool_bar (sf
, 1);
10433 /* Update the menu bar item list for frame F. This has to be done
10434 before we start to fill in any display lines, because it can call
10437 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10439 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10440 already ran the menu bar hooks for this redisplay, so there
10441 is no need to run them again. The return value is the
10442 updated value of this flag, to pass to the next call. */
10445 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10447 Lisp_Object window
;
10448 register struct window
*w
;
10450 /* If called recursively during a menu update, do nothing. This can
10451 happen when, for instance, an activate-menubar-hook causes a
10453 if (inhibit_menubar_update
)
10456 window
= FRAME_SELECTED_WINDOW (f
);
10457 w
= XWINDOW (window
);
10459 if (FRAME_WINDOW_P (f
)
10461 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10462 || defined (HAVE_NS) || defined (USE_GTK)
10463 FRAME_EXTERNAL_MENU_BAR (f
)
10465 FRAME_MENU_BAR_LINES (f
) > 0
10467 : FRAME_MENU_BAR_LINES (f
) > 0)
10469 /* If the user has switched buffers or windows, we need to
10470 recompute to reflect the new bindings. But we'll
10471 recompute when update_mode_lines is set too; that means
10472 that people can use force-mode-line-update to request
10473 that the menu bar be recomputed. The adverse effect on
10474 the rest of the redisplay algorithm is about the same as
10475 windows_or_buffers_changed anyway. */
10476 if (windows_or_buffers_changed
10477 /* This used to test w->update_mode_line, but we believe
10478 there is no need to recompute the menu in that case. */
10479 || update_mode_lines
10480 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10481 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10482 != !NILP (w
->last_had_star
))
10483 || ((!NILP (Vtransient_mark_mode
)
10484 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10485 != !NILP (w
->region_showing
)))
10487 struct buffer
*prev
= current_buffer
;
10488 int count
= SPECPDL_INDEX ();
10490 specbind (Qinhibit_menubar_update
, Qt
);
10492 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10493 if (save_match_data
)
10494 record_unwind_save_match_data ();
10495 if (NILP (Voverriding_local_map_menu_flag
))
10497 specbind (Qoverriding_terminal_local_map
, Qnil
);
10498 specbind (Qoverriding_local_map
, Qnil
);
10503 /* Run the Lucid hook. */
10504 safe_run_hooks (Qactivate_menubar_hook
);
10506 /* If it has changed current-menubar from previous value,
10507 really recompute the menu-bar from the value. */
10508 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10509 call0 (Qrecompute_lucid_menubar
);
10511 safe_run_hooks (Qmenu_bar_update_hook
);
10516 XSETFRAME (Vmenu_updating_frame
, f
);
10517 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10519 /* Redisplay the menu bar in case we changed it. */
10520 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10521 || defined (HAVE_NS) || defined (USE_GTK)
10522 if (FRAME_WINDOW_P (f
))
10524 #if defined (HAVE_NS)
10525 /* All frames on Mac OS share the same menubar. So only
10526 the selected frame should be allowed to set it. */
10527 if (f
== SELECTED_FRAME ())
10529 set_frame_menubar (f
, 0, 0);
10532 /* On a terminal screen, the menu bar is an ordinary screen
10533 line, and this makes it get updated. */
10534 w
->update_mode_line
= Qt
;
10535 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10536 /* In the non-toolkit version, the menu bar is an ordinary screen
10537 line, and this makes it get updated. */
10538 w
->update_mode_line
= Qt
;
10539 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10541 unbind_to (count
, Qnil
);
10542 set_buffer_internal_1 (prev
);
10551 /***********************************************************************
10553 ***********************************************************************/
10555 #ifdef HAVE_WINDOW_SYSTEM
10558 Nominal cursor position -- where to draw output.
10559 HPOS and VPOS are window relative glyph matrix coordinates.
10560 X and Y are window relative pixel coordinates. */
10562 struct cursor_pos output_cursor
;
10566 Set the global variable output_cursor to CURSOR. All cursor
10567 positions are relative to updated_window. */
10570 set_output_cursor (struct cursor_pos
*cursor
)
10572 output_cursor
.hpos
= cursor
->hpos
;
10573 output_cursor
.vpos
= cursor
->vpos
;
10574 output_cursor
.x
= cursor
->x
;
10575 output_cursor
.y
= cursor
->y
;
10580 Set a nominal cursor position.
10582 HPOS and VPOS are column/row positions in a window glyph matrix. X
10583 and Y are window text area relative pixel positions.
10585 If this is done during an update, updated_window will contain the
10586 window that is being updated and the position is the future output
10587 cursor position for that window. If updated_window is null, use
10588 selected_window and display the cursor at the given position. */
10591 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10595 /* If updated_window is not set, work on selected_window. */
10596 if (updated_window
)
10597 w
= updated_window
;
10599 w
= XWINDOW (selected_window
);
10601 /* Set the output cursor. */
10602 output_cursor
.hpos
= hpos
;
10603 output_cursor
.vpos
= vpos
;
10604 output_cursor
.x
= x
;
10605 output_cursor
.y
= y
;
10607 /* If not called as part of an update, really display the cursor.
10608 This will also set the cursor position of W. */
10609 if (updated_window
== NULL
)
10612 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10613 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10614 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10619 #endif /* HAVE_WINDOW_SYSTEM */
10622 /***********************************************************************
10624 ***********************************************************************/
10626 #ifdef HAVE_WINDOW_SYSTEM
10628 /* Where the mouse was last time we reported a mouse event. */
10630 FRAME_PTR last_mouse_frame
;
10632 /* Tool-bar item index of the item on which a mouse button was pressed
10635 int last_tool_bar_item
;
10639 update_tool_bar_unwind (Lisp_Object frame
)
10641 selected_frame
= frame
;
10645 /* Update the tool-bar item list for frame F. This has to be done
10646 before we start to fill in any display lines. Called from
10647 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10648 and restore it here. */
10651 update_tool_bar (struct frame
*f
, int save_match_data
)
10653 #if defined (USE_GTK) || defined (HAVE_NS)
10654 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10656 int do_update
= WINDOWP (f
->tool_bar_window
)
10657 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10662 Lisp_Object window
;
10665 window
= FRAME_SELECTED_WINDOW (f
);
10666 w
= XWINDOW (window
);
10668 /* If the user has switched buffers or windows, we need to
10669 recompute to reflect the new bindings. But we'll
10670 recompute when update_mode_lines is set too; that means
10671 that people can use force-mode-line-update to request
10672 that the menu bar be recomputed. The adverse effect on
10673 the rest of the redisplay algorithm is about the same as
10674 windows_or_buffers_changed anyway. */
10675 if (windows_or_buffers_changed
10676 || !NILP (w
->update_mode_line
)
10677 || update_mode_lines
10678 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10679 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10680 != !NILP (w
->last_had_star
))
10681 || ((!NILP (Vtransient_mark_mode
)
10682 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10683 != !NILP (w
->region_showing
)))
10685 struct buffer
*prev
= current_buffer
;
10686 int count
= SPECPDL_INDEX ();
10687 Lisp_Object frame
, new_tool_bar
;
10688 int new_n_tool_bar
;
10689 struct gcpro gcpro1
;
10691 /* Set current_buffer to the buffer of the selected
10692 window of the frame, so that we get the right local
10694 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10696 /* Save match data, if we must. */
10697 if (save_match_data
)
10698 record_unwind_save_match_data ();
10700 /* Make sure that we don't accidentally use bogus keymaps. */
10701 if (NILP (Voverriding_local_map_menu_flag
))
10703 specbind (Qoverriding_terminal_local_map
, Qnil
);
10704 specbind (Qoverriding_local_map
, Qnil
);
10707 GCPRO1 (new_tool_bar
);
10709 /* We must temporarily set the selected frame to this frame
10710 before calling tool_bar_items, because the calculation of
10711 the tool-bar keymap uses the selected frame (see
10712 `tool-bar-make-keymap' in tool-bar.el). */
10713 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10714 XSETFRAME (frame
, f
);
10715 selected_frame
= frame
;
10717 /* Build desired tool-bar items from keymaps. */
10718 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10721 /* Redisplay the tool-bar if we changed it. */
10722 if (new_n_tool_bar
!= f
->n_tool_bar_items
10723 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10725 /* Redisplay that happens asynchronously due to an expose event
10726 may access f->tool_bar_items. Make sure we update both
10727 variables within BLOCK_INPUT so no such event interrupts. */
10729 f
->tool_bar_items
= new_tool_bar
;
10730 f
->n_tool_bar_items
= new_n_tool_bar
;
10731 w
->update_mode_line
= Qt
;
10737 unbind_to (count
, Qnil
);
10738 set_buffer_internal_1 (prev
);
10744 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10745 F's desired tool-bar contents. F->tool_bar_items must have
10746 been set up previously by calling prepare_menu_bars. */
10749 build_desired_tool_bar_string (struct frame
*f
)
10751 int i
, size
, size_needed
;
10752 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10753 Lisp_Object image
, plist
, props
;
10755 image
= plist
= props
= Qnil
;
10756 GCPRO3 (image
, plist
, props
);
10758 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10759 Otherwise, make a new string. */
10761 /* The size of the string we might be able to reuse. */
10762 size
= (STRINGP (f
->desired_tool_bar_string
)
10763 ? SCHARS (f
->desired_tool_bar_string
)
10766 /* We need one space in the string for each image. */
10767 size_needed
= f
->n_tool_bar_items
;
10769 /* Reuse f->desired_tool_bar_string, if possible. */
10770 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10771 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10772 make_number (' '));
10775 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10776 Fremove_text_properties (make_number (0), make_number (size
),
10777 props
, f
->desired_tool_bar_string
);
10780 /* Put a `display' property on the string for the images to display,
10781 put a `menu_item' property on tool-bar items with a value that
10782 is the index of the item in F's tool-bar item vector. */
10783 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10785 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10787 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10788 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10789 int hmargin
, vmargin
, relief
, idx
, end
;
10791 /* If image is a vector, choose the image according to the
10793 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10794 if (VECTORP (image
))
10798 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10799 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10802 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10803 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10805 xassert (ASIZE (image
) >= idx
);
10806 image
= AREF (image
, idx
);
10811 /* Ignore invalid image specifications. */
10812 if (!valid_image_p (image
))
10815 /* Display the tool-bar button pressed, or depressed. */
10816 plist
= Fcopy_sequence (XCDR (image
));
10818 /* Compute margin and relief to draw. */
10819 relief
= (tool_bar_button_relief
>= 0
10820 ? tool_bar_button_relief
10821 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10822 hmargin
= vmargin
= relief
;
10824 if (INTEGERP (Vtool_bar_button_margin
)
10825 && XINT (Vtool_bar_button_margin
) > 0)
10827 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10828 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10830 else if (CONSP (Vtool_bar_button_margin
))
10832 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10833 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10834 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10836 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10837 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10838 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10841 if (auto_raise_tool_bar_buttons_p
)
10843 /* Add a `:relief' property to the image spec if the item is
10847 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10854 /* If image is selected, display it pressed, i.e. with a
10855 negative relief. If it's not selected, display it with a
10857 plist
= Fplist_put (plist
, QCrelief
,
10859 ? make_number (-relief
)
10860 : make_number (relief
)));
10865 /* Put a margin around the image. */
10866 if (hmargin
|| vmargin
)
10868 if (hmargin
== vmargin
)
10869 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10871 plist
= Fplist_put (plist
, QCmargin
,
10872 Fcons (make_number (hmargin
),
10873 make_number (vmargin
)));
10876 /* If button is not enabled, and we don't have special images
10877 for the disabled state, make the image appear disabled by
10878 applying an appropriate algorithm to it. */
10879 if (!enabled_p
&& idx
< 0)
10880 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10882 /* Put a `display' text property on the string for the image to
10883 display. Put a `menu-item' property on the string that gives
10884 the start of this item's properties in the tool-bar items
10886 image
= Fcons (Qimage
, plist
);
10887 props
= list4 (Qdisplay
, image
,
10888 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10890 /* Let the last image hide all remaining spaces in the tool bar
10891 string. The string can be longer than needed when we reuse a
10892 previous string. */
10893 if (i
+ 1 == f
->n_tool_bar_items
)
10894 end
= SCHARS (f
->desired_tool_bar_string
);
10897 Fadd_text_properties (make_number (i
), make_number (end
),
10898 props
, f
->desired_tool_bar_string
);
10906 /* Display one line of the tool-bar of frame IT->f.
10908 HEIGHT specifies the desired height of the tool-bar line.
10909 If the actual height of the glyph row is less than HEIGHT, the
10910 row's height is increased to HEIGHT, and the icons are centered
10911 vertically in the new height.
10913 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10914 count a final empty row in case the tool-bar width exactly matches
10919 display_tool_bar_line (struct it
*it
, int height
)
10921 struct glyph_row
*row
= it
->glyph_row
;
10922 int max_x
= it
->last_visible_x
;
10923 struct glyph
*last
;
10925 prepare_desired_row (row
);
10926 row
->y
= it
->current_y
;
10928 /* Note that this isn't made use of if the face hasn't a box,
10929 so there's no need to check the face here. */
10930 it
->start_of_box_run_p
= 1;
10932 while (it
->current_x
< max_x
)
10934 int x
, n_glyphs_before
, i
, nglyphs
;
10935 struct it it_before
;
10937 /* Get the next display element. */
10938 if (!get_next_display_element (it
))
10940 /* Don't count empty row if we are counting needed tool-bar lines. */
10941 if (height
< 0 && !it
->hpos
)
10946 /* Produce glyphs. */
10947 n_glyphs_before
= row
->used
[TEXT_AREA
];
10950 PRODUCE_GLYPHS (it
);
10952 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10954 x
= it_before
.current_x
;
10955 while (i
< nglyphs
)
10957 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10959 if (x
+ glyph
->pixel_width
> max_x
)
10961 /* Glyph doesn't fit on line. Backtrack. */
10962 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10964 /* If this is the only glyph on this line, it will never fit on the
10965 tool-bar, so skip it. But ensure there is at least one glyph,
10966 so we don't accidentally disable the tool-bar. */
10967 if (n_glyphs_before
== 0
10968 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10974 x
+= glyph
->pixel_width
;
10978 /* Stop at line end. */
10979 if (ITERATOR_AT_END_OF_LINE_P (it
))
10982 set_iterator_to_next (it
, 1);
10987 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10989 /* Use default face for the border below the tool bar.
10991 FIXME: When auto-resize-tool-bars is grow-only, there is
10992 no additional border below the possibly empty tool-bar lines.
10993 So to make the extra empty lines look "normal", we have to
10994 use the tool-bar face for the border too. */
10995 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10996 it
->face_id
= DEFAULT_FACE_ID
;
10998 extend_face_to_end_of_line (it
);
10999 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11000 last
->right_box_line_p
= 1;
11001 if (last
== row
->glyphs
[TEXT_AREA
])
11002 last
->left_box_line_p
= 1;
11004 /* Make line the desired height and center it vertically. */
11005 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11007 /* Don't add more than one line height. */
11008 height
%= FRAME_LINE_HEIGHT (it
->f
);
11009 it
->max_ascent
+= height
/ 2;
11010 it
->max_descent
+= (height
+ 1) / 2;
11013 compute_line_metrics (it
);
11015 /* If line is empty, make it occupy the rest of the tool-bar. */
11016 if (!row
->displays_text_p
)
11018 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11019 row
->visible_height
= row
->height
;
11020 row
->ascent
= row
->phys_ascent
= 0;
11021 row
->extra_line_spacing
= 0;
11024 row
->full_width_p
= 1;
11025 row
->continued_p
= 0;
11026 row
->truncated_on_left_p
= 0;
11027 row
->truncated_on_right_p
= 0;
11029 it
->current_x
= it
->hpos
= 0;
11030 it
->current_y
+= row
->height
;
11036 /* Max tool-bar height. */
11038 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11039 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11041 /* Value is the number of screen lines needed to make all tool-bar
11042 items of frame F visible. The number of actual rows needed is
11043 returned in *N_ROWS if non-NULL. */
11046 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11048 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11050 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11051 the desired matrix, so use (unused) mode-line row as temporary row to
11052 avoid destroying the first tool-bar row. */
11053 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11055 /* Initialize an iterator for iteration over
11056 F->desired_tool_bar_string in the tool-bar window of frame F. */
11057 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11058 it
.first_visible_x
= 0;
11059 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11060 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11061 it
.paragraph_embedding
= L2R
;
11063 while (!ITERATOR_AT_END_P (&it
))
11065 clear_glyph_row (temp_row
);
11066 it
.glyph_row
= temp_row
;
11067 display_tool_bar_line (&it
, -1);
11069 clear_glyph_row (temp_row
);
11071 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11073 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11075 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11079 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11081 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11082 (Lisp_Object frame
)
11089 frame
= selected_frame
;
11091 CHECK_FRAME (frame
);
11092 f
= XFRAME (frame
);
11094 if (WINDOWP (f
->tool_bar_window
)
11095 || (w
= XWINDOW (f
->tool_bar_window
),
11096 WINDOW_TOTAL_LINES (w
) > 0))
11098 update_tool_bar (f
, 1);
11099 if (f
->n_tool_bar_items
)
11101 build_desired_tool_bar_string (f
);
11102 nlines
= tool_bar_lines_needed (f
, NULL
);
11106 return make_number (nlines
);
11110 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11111 height should be changed. */
11114 redisplay_tool_bar (struct frame
*f
)
11118 struct glyph_row
*row
;
11120 #if defined (USE_GTK) || defined (HAVE_NS)
11121 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11122 update_frame_tool_bar (f
);
11126 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11127 do anything. This means you must start with tool-bar-lines
11128 non-zero to get the auto-sizing effect. Or in other words, you
11129 can turn off tool-bars by specifying tool-bar-lines zero. */
11130 if (!WINDOWP (f
->tool_bar_window
)
11131 || (w
= XWINDOW (f
->tool_bar_window
),
11132 WINDOW_TOTAL_LINES (w
) == 0))
11135 /* Set up an iterator for the tool-bar window. */
11136 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11137 it
.first_visible_x
= 0;
11138 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11139 row
= it
.glyph_row
;
11141 /* Build a string that represents the contents of the tool-bar. */
11142 build_desired_tool_bar_string (f
);
11143 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11144 /* FIXME: This should be controlled by a user option. But it
11145 doesn't make sense to have an R2L tool bar if the menu bar cannot
11146 be drawn also R2L, and making the menu bar R2L is tricky due
11147 toolkit-specific code that implements it. If an R2L tool bar is
11148 ever supported, display_tool_bar_line should also be augmented to
11149 call unproduce_glyphs like display_line and display_string
11151 it
.paragraph_embedding
= L2R
;
11153 if (f
->n_tool_bar_rows
== 0)
11157 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11158 nlines
!= WINDOW_TOTAL_LINES (w
)))
11161 int old_height
= WINDOW_TOTAL_LINES (w
);
11163 XSETFRAME (frame
, f
);
11164 Fmodify_frame_parameters (frame
,
11165 Fcons (Fcons (Qtool_bar_lines
,
11166 make_number (nlines
)),
11168 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11170 clear_glyph_matrix (w
->desired_matrix
);
11171 fonts_changed_p
= 1;
11177 /* Display as many lines as needed to display all tool-bar items. */
11179 if (f
->n_tool_bar_rows
> 0)
11181 int border
, rows
, height
, extra
;
11183 if (INTEGERP (Vtool_bar_border
))
11184 border
= XINT (Vtool_bar_border
);
11185 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11186 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11187 else if (EQ (Vtool_bar_border
, Qborder_width
))
11188 border
= f
->border_width
;
11194 rows
= f
->n_tool_bar_rows
;
11195 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11196 extra
= it
.last_visible_y
- border
- height
* rows
;
11198 while (it
.current_y
< it
.last_visible_y
)
11201 if (extra
> 0 && rows
-- > 0)
11203 h
= (extra
+ rows
- 1) / rows
;
11206 display_tool_bar_line (&it
, height
+ h
);
11211 while (it
.current_y
< it
.last_visible_y
)
11212 display_tool_bar_line (&it
, 0);
11215 /* It doesn't make much sense to try scrolling in the tool-bar
11216 window, so don't do it. */
11217 w
->desired_matrix
->no_scrolling_p
= 1;
11218 w
->must_be_updated_p
= 1;
11220 if (!NILP (Vauto_resize_tool_bars
))
11222 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11223 int change_height_p
= 0;
11225 /* If we couldn't display everything, change the tool-bar's
11226 height if there is room for more. */
11227 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11228 && it
.current_y
< max_tool_bar_height
)
11229 change_height_p
= 1;
11231 row
= it
.glyph_row
- 1;
11233 /* If there are blank lines at the end, except for a partially
11234 visible blank line at the end that is smaller than
11235 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11236 if (!row
->displays_text_p
11237 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11238 change_height_p
= 1;
11240 /* If row displays tool-bar items, but is partially visible,
11241 change the tool-bar's height. */
11242 if (row
->displays_text_p
11243 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11244 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11245 change_height_p
= 1;
11247 /* Resize windows as needed by changing the `tool-bar-lines'
11248 frame parameter. */
11249 if (change_height_p
)
11252 int old_height
= WINDOW_TOTAL_LINES (w
);
11254 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11256 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11257 && !f
->minimize_tool_bar_window_p
)
11258 ? (nlines
> old_height
)
11259 : (nlines
!= old_height
));
11260 f
->minimize_tool_bar_window_p
= 0;
11262 if (change_height_p
)
11264 XSETFRAME (frame
, f
);
11265 Fmodify_frame_parameters (frame
,
11266 Fcons (Fcons (Qtool_bar_lines
,
11267 make_number (nlines
)),
11269 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11271 clear_glyph_matrix (w
->desired_matrix
);
11272 f
->n_tool_bar_rows
= nrows
;
11273 fonts_changed_p
= 1;
11280 f
->minimize_tool_bar_window_p
= 0;
11285 /* Get information about the tool-bar item which is displayed in GLYPH
11286 on frame F. Return in *PROP_IDX the index where tool-bar item
11287 properties start in F->tool_bar_items. Value is zero if
11288 GLYPH doesn't display a tool-bar item. */
11291 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11297 /* This function can be called asynchronously, which means we must
11298 exclude any possibility that Fget_text_property signals an
11300 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11301 charpos
= max (0, charpos
);
11303 /* Get the text property `menu-item' at pos. The value of that
11304 property is the start index of this item's properties in
11305 F->tool_bar_items. */
11306 prop
= Fget_text_property (make_number (charpos
),
11307 Qmenu_item
, f
->current_tool_bar_string
);
11308 if (INTEGERP (prop
))
11310 *prop_idx
= XINT (prop
);
11320 /* Get information about the tool-bar item at position X/Y on frame F.
11321 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11322 the current matrix of the tool-bar window of F, or NULL if not
11323 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11324 item in F->tool_bar_items. Value is
11326 -1 if X/Y is not on a tool-bar item
11327 0 if X/Y is on the same item that was highlighted before.
11331 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11332 int *hpos
, int *vpos
, int *prop_idx
)
11334 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11335 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11338 /* Find the glyph under X/Y. */
11339 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11340 if (*glyph
== NULL
)
11343 /* Get the start of this tool-bar item's properties in
11344 f->tool_bar_items. */
11345 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11348 /* Is mouse on the highlighted item? */
11349 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11350 && *vpos
>= hlinfo
->mouse_face_beg_row
11351 && *vpos
<= hlinfo
->mouse_face_end_row
11352 && (*vpos
> hlinfo
->mouse_face_beg_row
11353 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11354 && (*vpos
< hlinfo
->mouse_face_end_row
11355 || *hpos
< hlinfo
->mouse_face_end_col
11356 || hlinfo
->mouse_face_past_end
))
11364 Handle mouse button event on the tool-bar of frame F, at
11365 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11366 0 for button release. MODIFIERS is event modifiers for button
11370 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11371 unsigned int modifiers
)
11373 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11374 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11375 int hpos
, vpos
, prop_idx
;
11376 struct glyph
*glyph
;
11377 Lisp_Object enabled_p
;
11379 /* If not on the highlighted tool-bar item, return. */
11380 frame_to_window_pixel_xy (w
, &x
, &y
);
11381 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11384 /* If item is disabled, do nothing. */
11385 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11386 if (NILP (enabled_p
))
11391 /* Show item in pressed state. */
11392 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11393 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11394 last_tool_bar_item
= prop_idx
;
11398 Lisp_Object key
, frame
;
11399 struct input_event event
;
11400 EVENT_INIT (event
);
11402 /* Show item in released state. */
11403 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11404 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11406 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11408 XSETFRAME (frame
, f
);
11409 event
.kind
= TOOL_BAR_EVENT
;
11410 event
.frame_or_window
= frame
;
11412 kbd_buffer_store_event (&event
);
11414 event
.kind
= TOOL_BAR_EVENT
;
11415 event
.frame_or_window
= frame
;
11417 event
.modifiers
= modifiers
;
11418 kbd_buffer_store_event (&event
);
11419 last_tool_bar_item
= -1;
11424 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11425 tool-bar window-relative coordinates X/Y. Called from
11426 note_mouse_highlight. */
11429 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11431 Lisp_Object window
= f
->tool_bar_window
;
11432 struct window
*w
= XWINDOW (window
);
11433 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11434 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11436 struct glyph
*glyph
;
11437 struct glyph_row
*row
;
11439 Lisp_Object enabled_p
;
11441 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11442 int mouse_down_p
, rc
;
11444 /* Function note_mouse_highlight is called with negative X/Y
11445 values when mouse moves outside of the frame. */
11446 if (x
<= 0 || y
<= 0)
11448 clear_mouse_face (hlinfo
);
11452 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11455 /* Not on tool-bar item. */
11456 clear_mouse_face (hlinfo
);
11460 /* On same tool-bar item as before. */
11461 goto set_help_echo
;
11463 clear_mouse_face (hlinfo
);
11465 /* Mouse is down, but on different tool-bar item? */
11466 mouse_down_p
= (dpyinfo
->grabbed
11467 && f
== last_mouse_frame
11468 && FRAME_LIVE_P (f
));
11470 && last_tool_bar_item
!= prop_idx
)
11473 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11474 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11476 /* If tool-bar item is not enabled, don't highlight it. */
11477 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11478 if (!NILP (enabled_p
))
11480 /* Compute the x-position of the glyph. In front and past the
11481 image is a space. We include this in the highlighted area. */
11482 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11483 for (i
= x
= 0; i
< hpos
; ++i
)
11484 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11486 /* Record this as the current active region. */
11487 hlinfo
->mouse_face_beg_col
= hpos
;
11488 hlinfo
->mouse_face_beg_row
= vpos
;
11489 hlinfo
->mouse_face_beg_x
= x
;
11490 hlinfo
->mouse_face_beg_y
= row
->y
;
11491 hlinfo
->mouse_face_past_end
= 0;
11493 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11494 hlinfo
->mouse_face_end_row
= vpos
;
11495 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11496 hlinfo
->mouse_face_end_y
= row
->y
;
11497 hlinfo
->mouse_face_window
= window
;
11498 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11500 /* Display it as active. */
11501 show_mouse_face (hlinfo
, draw
);
11502 hlinfo
->mouse_face_image_state
= draw
;
11507 /* Set help_echo_string to a help string to display for this tool-bar item.
11508 XTread_socket does the rest. */
11509 help_echo_object
= help_echo_window
= Qnil
;
11510 help_echo_pos
= -1;
11511 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11512 if (NILP (help_echo_string
))
11513 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11516 #endif /* HAVE_WINDOW_SYSTEM */
11520 /************************************************************************
11521 Horizontal scrolling
11522 ************************************************************************/
11524 static int hscroll_window_tree (Lisp_Object
);
11525 static int hscroll_windows (Lisp_Object
);
11527 /* For all leaf windows in the window tree rooted at WINDOW, set their
11528 hscroll value so that PT is (i) visible in the window, and (ii) so
11529 that it is not within a certain margin at the window's left and
11530 right border. Value is non-zero if any window's hscroll has been
11534 hscroll_window_tree (Lisp_Object window
)
11536 int hscrolled_p
= 0;
11537 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11538 int hscroll_step_abs
= 0;
11539 double hscroll_step_rel
= 0;
11541 if (hscroll_relative_p
)
11543 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11544 if (hscroll_step_rel
< 0)
11546 hscroll_relative_p
= 0;
11547 hscroll_step_abs
= 0;
11550 else if (INTEGERP (Vhscroll_step
))
11552 hscroll_step_abs
= XINT (Vhscroll_step
);
11553 if (hscroll_step_abs
< 0)
11554 hscroll_step_abs
= 0;
11557 hscroll_step_abs
= 0;
11559 while (WINDOWP (window
))
11561 struct window
*w
= XWINDOW (window
);
11563 if (WINDOWP (w
->hchild
))
11564 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11565 else if (WINDOWP (w
->vchild
))
11566 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11567 else if (w
->cursor
.vpos
>= 0)
11570 int text_area_width
;
11571 struct glyph_row
*current_cursor_row
11572 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11573 struct glyph_row
*desired_cursor_row
11574 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11575 struct glyph_row
*cursor_row
11576 = (desired_cursor_row
->enabled_p
11577 ? desired_cursor_row
11578 : current_cursor_row
);
11580 text_area_width
= window_box_width (w
, TEXT_AREA
);
11582 /* Scroll when cursor is inside this scroll margin. */
11583 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11585 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11586 && ((XFASTINT (w
->hscroll
)
11587 && w
->cursor
.x
<= h_margin
)
11588 || (cursor_row
->enabled_p
11589 && cursor_row
->truncated_on_right_p
11590 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11594 struct buffer
*saved_current_buffer
;
11598 /* Find point in a display of infinite width. */
11599 saved_current_buffer
= current_buffer
;
11600 current_buffer
= XBUFFER (w
->buffer
);
11602 if (w
== XWINDOW (selected_window
))
11606 pt
= marker_position (w
->pointm
);
11607 pt
= max (BEGV
, pt
);
11611 /* Move iterator to pt starting at cursor_row->start in
11612 a line with infinite width. */
11613 init_to_row_start (&it
, w
, cursor_row
);
11614 it
.last_visible_x
= INFINITY
;
11615 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11616 current_buffer
= saved_current_buffer
;
11618 /* Position cursor in window. */
11619 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11620 hscroll
= max (0, (it
.current_x
11621 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11622 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11623 : (text_area_width
/ 2))))
11624 / FRAME_COLUMN_WIDTH (it
.f
);
11625 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11627 if (hscroll_relative_p
)
11628 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11631 wanted_x
= text_area_width
11632 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11635 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11639 if (hscroll_relative_p
)
11640 wanted_x
= text_area_width
* hscroll_step_rel
11643 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11646 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11648 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11650 /* Don't call Fset_window_hscroll if value hasn't
11651 changed because it will prevent redisplay
11653 if (XFASTINT (w
->hscroll
) != hscroll
)
11655 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11656 w
->hscroll
= make_number (hscroll
);
11665 /* Value is non-zero if hscroll of any leaf window has been changed. */
11666 return hscrolled_p
;
11670 /* Set hscroll so that cursor is visible and not inside horizontal
11671 scroll margins for all windows in the tree rooted at WINDOW. See
11672 also hscroll_window_tree above. Value is non-zero if any window's
11673 hscroll has been changed. If it has, desired matrices on the frame
11674 of WINDOW are cleared. */
11677 hscroll_windows (Lisp_Object window
)
11679 int hscrolled_p
= hscroll_window_tree (window
);
11681 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11682 return hscrolled_p
;
11687 /************************************************************************
11689 ************************************************************************/
11691 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11692 to a non-zero value. This is sometimes handy to have in a debugger
11697 /* First and last unchanged row for try_window_id. */
11699 int debug_first_unchanged_at_end_vpos
;
11700 int debug_last_unchanged_at_beg_vpos
;
11702 /* Delta vpos and y. */
11704 int debug_dvpos
, debug_dy
;
11706 /* Delta in characters and bytes for try_window_id. */
11708 EMACS_INT debug_delta
, debug_delta_bytes
;
11710 /* Values of window_end_pos and window_end_vpos at the end of
11713 EMACS_INT debug_end_vpos
;
11715 /* Append a string to W->desired_matrix->method. FMT is a printf
11716 format string. A1...A9 are a supplement for a variable-length
11717 argument list. If trace_redisplay_p is non-zero also printf the
11718 resulting string to stderr. */
11721 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11724 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11727 char *method
= w
->desired_matrix
->method
;
11728 int len
= strlen (method
);
11729 int size
= sizeof w
->desired_matrix
->method
;
11730 int remaining
= size
- len
- 1;
11732 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11733 if (len
&& remaining
)
11736 --remaining
, ++len
;
11739 strncpy (method
+ len
, buffer
, remaining
);
11741 if (trace_redisplay_p
)
11742 fprintf (stderr
, "%p (%s): %s\n",
11744 ((BUFFERP (w
->buffer
)
11745 && STRINGP (XBUFFER (w
->buffer
)->name
))
11746 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11751 #endif /* GLYPH_DEBUG */
11754 /* Value is non-zero if all changes in window W, which displays
11755 current_buffer, are in the text between START and END. START is a
11756 buffer position, END is given as a distance from Z. Used in
11757 redisplay_internal for display optimization. */
11760 text_outside_line_unchanged_p (struct window
*w
,
11761 EMACS_INT start
, EMACS_INT end
)
11763 int unchanged_p
= 1;
11765 /* If text or overlays have changed, see where. */
11766 if (XFASTINT (w
->last_modified
) < MODIFF
11767 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11769 /* Gap in the line? */
11770 if (GPT
< start
|| Z
- GPT
< end
)
11773 /* Changes start in front of the line, or end after it? */
11775 && (BEG_UNCHANGED
< start
- 1
11776 || END_UNCHANGED
< end
))
11779 /* If selective display, can't optimize if changes start at the
11780 beginning of the line. */
11782 && INTEGERP (BVAR (current_buffer
, selective_display
))
11783 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11784 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11787 /* If there are overlays at the start or end of the line, these
11788 may have overlay strings with newlines in them. A change at
11789 START, for instance, may actually concern the display of such
11790 overlay strings as well, and they are displayed on different
11791 lines. So, quickly rule out this case. (For the future, it
11792 might be desirable to implement something more telling than
11793 just BEG/END_UNCHANGED.) */
11796 if (BEG
+ BEG_UNCHANGED
== start
11797 && overlay_touches_p (start
))
11799 if (END_UNCHANGED
== end
11800 && overlay_touches_p (Z
- end
))
11804 /* Under bidi reordering, adding or deleting a character in the
11805 beginning of a paragraph, before the first strong directional
11806 character, can change the base direction of the paragraph (unless
11807 the buffer specifies a fixed paragraph direction), which will
11808 require to redisplay the whole paragraph. It might be worthwhile
11809 to find the paragraph limits and widen the range of redisplayed
11810 lines to that, but for now just give up this optimization. */
11811 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11812 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11816 return unchanged_p
;
11820 /* Do a frame update, taking possible shortcuts into account. This is
11821 the main external entry point for redisplay.
11823 If the last redisplay displayed an echo area message and that message
11824 is no longer requested, we clear the echo area or bring back the
11825 mini-buffer if that is in use. */
11830 redisplay_internal ();
11835 overlay_arrow_string_or_property (Lisp_Object var
)
11839 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11842 return Voverlay_arrow_string
;
11845 /* Return 1 if there are any overlay-arrows in current_buffer. */
11847 overlay_arrow_in_current_buffer_p (void)
11851 for (vlist
= Voverlay_arrow_variable_list
;
11853 vlist
= XCDR (vlist
))
11855 Lisp_Object var
= XCAR (vlist
);
11858 if (!SYMBOLP (var
))
11860 val
= find_symbol_value (var
);
11862 && current_buffer
== XMARKER (val
)->buffer
)
11869 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11873 overlay_arrows_changed_p (void)
11877 for (vlist
= Voverlay_arrow_variable_list
;
11879 vlist
= XCDR (vlist
))
11881 Lisp_Object var
= XCAR (vlist
);
11882 Lisp_Object val
, pstr
;
11884 if (!SYMBOLP (var
))
11886 val
= find_symbol_value (var
);
11887 if (!MARKERP (val
))
11889 if (! EQ (COERCE_MARKER (val
),
11890 Fget (var
, Qlast_arrow_position
))
11891 || ! (pstr
= overlay_arrow_string_or_property (var
),
11892 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11898 /* Mark overlay arrows to be updated on next redisplay. */
11901 update_overlay_arrows (int up_to_date
)
11905 for (vlist
= Voverlay_arrow_variable_list
;
11907 vlist
= XCDR (vlist
))
11909 Lisp_Object var
= XCAR (vlist
);
11911 if (!SYMBOLP (var
))
11914 if (up_to_date
> 0)
11916 Lisp_Object val
= find_symbol_value (var
);
11917 Fput (var
, Qlast_arrow_position
,
11918 COERCE_MARKER (val
));
11919 Fput (var
, Qlast_arrow_string
,
11920 overlay_arrow_string_or_property (var
));
11922 else if (up_to_date
< 0
11923 || !NILP (Fget (var
, Qlast_arrow_position
)))
11925 Fput (var
, Qlast_arrow_position
, Qt
);
11926 Fput (var
, Qlast_arrow_string
, Qt
);
11932 /* Return overlay arrow string to display at row.
11933 Return integer (bitmap number) for arrow bitmap in left fringe.
11934 Return nil if no overlay arrow. */
11937 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11941 for (vlist
= Voverlay_arrow_variable_list
;
11943 vlist
= XCDR (vlist
))
11945 Lisp_Object var
= XCAR (vlist
);
11948 if (!SYMBOLP (var
))
11951 val
= find_symbol_value (var
);
11954 && current_buffer
== XMARKER (val
)->buffer
11955 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11957 if (FRAME_WINDOW_P (it
->f
)
11958 /* FIXME: if ROW->reversed_p is set, this should test
11959 the right fringe, not the left one. */
11960 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11962 #ifdef HAVE_WINDOW_SYSTEM
11963 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11966 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11967 return make_number (fringe_bitmap
);
11970 return make_number (-1); /* Use default arrow bitmap */
11972 return overlay_arrow_string_or_property (var
);
11979 /* Return 1 if point moved out of or into a composition. Otherwise
11980 return 0. PREV_BUF and PREV_PT are the last point buffer and
11981 position. BUF and PT are the current point buffer and position. */
11984 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11985 struct buffer
*buf
, EMACS_INT pt
)
11987 EMACS_INT start
, end
;
11989 Lisp_Object buffer
;
11991 XSETBUFFER (buffer
, buf
);
11992 /* Check a composition at the last point if point moved within the
11994 if (prev_buf
== buf
)
11997 /* Point didn't move. */
12000 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12001 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12002 && COMPOSITION_VALID_P (start
, end
, prop
)
12003 && start
< prev_pt
&& end
> prev_pt
)
12004 /* The last point was within the composition. Return 1 iff
12005 point moved out of the composition. */
12006 return (pt
<= start
|| pt
>= end
);
12009 /* Check a composition at the current point. */
12010 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12011 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12012 && COMPOSITION_VALID_P (start
, end
, prop
)
12013 && start
< pt
&& end
> pt
);
12017 /* Reconsider the setting of B->clip_changed which is displayed
12021 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12023 if (b
->clip_changed
12024 && !NILP (w
->window_end_valid
)
12025 && w
->current_matrix
->buffer
== b
12026 && w
->current_matrix
->zv
== BUF_ZV (b
)
12027 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12028 b
->clip_changed
= 0;
12030 /* If display wasn't paused, and W is not a tool bar window, see if
12031 point has been moved into or out of a composition. In that case,
12032 we set b->clip_changed to 1 to force updating the screen. If
12033 b->clip_changed has already been set to 1, we can skip this
12035 if (!b
->clip_changed
12036 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12040 if (w
== XWINDOW (selected_window
))
12043 pt
= marker_position (w
->pointm
);
12045 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12046 || pt
!= XINT (w
->last_point
))
12047 && check_point_in_composition (w
->current_matrix
->buffer
,
12048 XINT (w
->last_point
),
12049 XBUFFER (w
->buffer
), pt
))
12050 b
->clip_changed
= 1;
12055 /* Select FRAME to forward the values of frame-local variables into C
12056 variables so that the redisplay routines can access those values
12060 select_frame_for_redisplay (Lisp_Object frame
)
12062 Lisp_Object tail
, tem
;
12063 Lisp_Object old
= selected_frame
;
12064 struct Lisp_Symbol
*sym
;
12066 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12068 selected_frame
= frame
;
12071 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12072 if (CONSP (XCAR (tail
))
12073 && (tem
= XCAR (XCAR (tail
)),
12075 && (sym
= indirect_variable (XSYMBOL (tem
)),
12076 sym
->redirect
== SYMBOL_LOCALIZED
)
12077 && sym
->val
.blv
->frame_local
)
12078 /* Use find_symbol_value rather than Fsymbol_value
12079 to avoid an error if it is void. */
12080 find_symbol_value (tem
);
12081 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12085 #define STOP_POLLING \
12086 do { if (! polling_stopped_here) stop_polling (); \
12087 polling_stopped_here = 1; } while (0)
12089 #define RESUME_POLLING \
12090 do { if (polling_stopped_here) start_polling (); \
12091 polling_stopped_here = 0; } while (0)
12094 /* Perhaps in the future avoid recentering windows if it
12095 is not necessary; currently that causes some problems. */
12098 redisplay_internal (void)
12100 struct window
*w
= XWINDOW (selected_window
);
12104 int must_finish
= 0;
12105 struct text_pos tlbufpos
, tlendpos
;
12106 int number_of_visible_frames
;
12109 int polling_stopped_here
= 0;
12110 Lisp_Object old_frame
= selected_frame
;
12112 /* Non-zero means redisplay has to consider all windows on all
12113 frames. Zero means, only selected_window is considered. */
12114 int consider_all_windows_p
;
12116 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12118 /* No redisplay if running in batch mode or frame is not yet fully
12119 initialized, or redisplay is explicitly turned off by setting
12120 Vinhibit_redisplay. */
12121 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12122 || !NILP (Vinhibit_redisplay
))
12125 /* Don't examine these until after testing Vinhibit_redisplay.
12126 When Emacs is shutting down, perhaps because its connection to
12127 X has dropped, we should not look at them at all. */
12128 fr
= XFRAME (w
->frame
);
12129 sf
= SELECTED_FRAME ();
12131 if (!fr
->glyphs_initialized_p
)
12134 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12135 if (popup_activated ())
12139 /* I don't think this happens but let's be paranoid. */
12140 if (redisplaying_p
)
12143 /* Record a function that resets redisplaying_p to its old value
12144 when we leave this function. */
12145 count
= SPECPDL_INDEX ();
12146 record_unwind_protect (unwind_redisplay
,
12147 Fcons (make_number (redisplaying_p
), selected_frame
));
12149 specbind (Qinhibit_free_realized_faces
, Qnil
);
12152 Lisp_Object tail
, frame
;
12154 FOR_EACH_FRAME (tail
, frame
)
12156 struct frame
*f
= XFRAME (frame
);
12157 f
->already_hscrolled_p
= 0;
12162 /* Remember the currently selected window. */
12165 if (!EQ (old_frame
, selected_frame
)
12166 && FRAME_LIVE_P (XFRAME (old_frame
)))
12167 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12168 selected_frame and selected_window to be temporarily out-of-sync so
12169 when we come back here via `goto retry', we need to resync because we
12170 may need to run Elisp code (via prepare_menu_bars). */
12171 select_frame_for_redisplay (old_frame
);
12174 reconsider_clip_changes (w
, current_buffer
);
12175 last_escape_glyph_frame
= NULL
;
12176 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12177 last_glyphless_glyph_frame
= NULL
;
12178 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12180 /* If new fonts have been loaded that make a glyph matrix adjustment
12181 necessary, do it. */
12182 if (fonts_changed_p
)
12184 adjust_glyphs (NULL
);
12185 ++windows_or_buffers_changed
;
12186 fonts_changed_p
= 0;
12189 /* If face_change_count is non-zero, init_iterator will free all
12190 realized faces, which includes the faces referenced from current
12191 matrices. So, we can't reuse current matrices in this case. */
12192 if (face_change_count
)
12193 ++windows_or_buffers_changed
;
12195 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12196 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12198 /* Since frames on a single ASCII terminal share the same
12199 display area, displaying a different frame means redisplay
12200 the whole thing. */
12201 windows_or_buffers_changed
++;
12202 SET_FRAME_GARBAGED (sf
);
12204 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12206 FRAME_TTY (sf
)->previous_frame
= sf
;
12209 /* Set the visible flags for all frames. Do this before checking
12210 for resized or garbaged frames; they want to know if their frames
12211 are visible. See the comment in frame.h for
12212 FRAME_SAMPLE_VISIBILITY. */
12214 Lisp_Object tail
, frame
;
12216 number_of_visible_frames
= 0;
12218 FOR_EACH_FRAME (tail
, frame
)
12220 struct frame
*f
= XFRAME (frame
);
12222 FRAME_SAMPLE_VISIBILITY (f
);
12223 if (FRAME_VISIBLE_P (f
))
12224 ++number_of_visible_frames
;
12225 clear_desired_matrices (f
);
12229 /* Notice any pending interrupt request to change frame size. */
12230 do_pending_window_change (1);
12232 /* do_pending_window_change could change the selected_window due to
12233 frame resizing which makes the selected window too small. */
12234 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12237 reconsider_clip_changes (w
, current_buffer
);
12240 /* Clear frames marked as garbaged. */
12241 if (frame_garbaged
)
12242 clear_garbaged_frames ();
12244 /* Build menubar and tool-bar items. */
12245 if (NILP (Vmemory_full
))
12246 prepare_menu_bars ();
12248 if (windows_or_buffers_changed
)
12249 update_mode_lines
++;
12251 /* Detect case that we need to write or remove a star in the mode line. */
12252 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12254 w
->update_mode_line
= Qt
;
12255 if (buffer_shared
> 1)
12256 update_mode_lines
++;
12259 /* Avoid invocation of point motion hooks by `current_column' below. */
12260 count1
= SPECPDL_INDEX ();
12261 specbind (Qinhibit_point_motion_hooks
, Qt
);
12263 /* If %c is in the mode line, update it if needed. */
12264 if (!NILP (w
->column_number_displayed
)
12265 /* This alternative quickly identifies a common case
12266 where no change is needed. */
12267 && !(PT
== XFASTINT (w
->last_point
)
12268 && XFASTINT (w
->last_modified
) >= MODIFF
12269 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12270 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12271 w
->update_mode_line
= Qt
;
12273 unbind_to (count1
, Qnil
);
12275 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12277 /* The variable buffer_shared is set in redisplay_window and
12278 indicates that we redisplay a buffer in different windows. See
12280 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12281 || cursor_type_changed
);
12283 /* If specs for an arrow have changed, do thorough redisplay
12284 to ensure we remove any arrow that should no longer exist. */
12285 if (overlay_arrows_changed_p ())
12286 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12288 /* Normally the message* functions will have already displayed and
12289 updated the echo area, but the frame may have been trashed, or
12290 the update may have been preempted, so display the echo area
12291 again here. Checking message_cleared_p captures the case that
12292 the echo area should be cleared. */
12293 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12294 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12295 || (message_cleared_p
12296 && minibuf_level
== 0
12297 /* If the mini-window is currently selected, this means the
12298 echo-area doesn't show through. */
12299 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12301 int window_height_changed_p
= echo_area_display (0);
12304 /* If we don't display the current message, don't clear the
12305 message_cleared_p flag, because, if we did, we wouldn't clear
12306 the echo area in the next redisplay which doesn't preserve
12308 if (!display_last_displayed_message_p
)
12309 message_cleared_p
= 0;
12311 if (fonts_changed_p
)
12313 else if (window_height_changed_p
)
12315 consider_all_windows_p
= 1;
12316 ++update_mode_lines
;
12317 ++windows_or_buffers_changed
;
12319 /* If window configuration was changed, frames may have been
12320 marked garbaged. Clear them or we will experience
12321 surprises wrt scrolling. */
12322 if (frame_garbaged
)
12323 clear_garbaged_frames ();
12326 else if (EQ (selected_window
, minibuf_window
)
12327 && (current_buffer
->clip_changed
12328 || XFASTINT (w
->last_modified
) < MODIFF
12329 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12330 && resize_mini_window (w
, 0))
12332 /* Resized active mini-window to fit the size of what it is
12333 showing if its contents might have changed. */
12335 /* FIXME: this causes all frames to be updated, which seems unnecessary
12336 since only the current frame needs to be considered. This function needs
12337 to be rewritten with two variables, consider_all_windows and
12338 consider_all_frames. */
12339 consider_all_windows_p
= 1;
12340 ++windows_or_buffers_changed
;
12341 ++update_mode_lines
;
12343 /* If window configuration was changed, frames may have been
12344 marked garbaged. Clear them or we will experience
12345 surprises wrt scrolling. */
12346 if (frame_garbaged
)
12347 clear_garbaged_frames ();
12351 /* If showing the region, and mark has changed, we must redisplay
12352 the whole window. The assignment to this_line_start_pos prevents
12353 the optimization directly below this if-statement. */
12354 if (((!NILP (Vtransient_mark_mode
)
12355 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12356 != !NILP (w
->region_showing
))
12357 || (!NILP (w
->region_showing
)
12358 && !EQ (w
->region_showing
,
12359 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12360 CHARPOS (this_line_start_pos
) = 0;
12362 /* Optimize the case that only the line containing the cursor in the
12363 selected window has changed. Variables starting with this_ are
12364 set in display_line and record information about the line
12365 containing the cursor. */
12366 tlbufpos
= this_line_start_pos
;
12367 tlendpos
= this_line_end_pos
;
12368 if (!consider_all_windows_p
12369 && CHARPOS (tlbufpos
) > 0
12370 && NILP (w
->update_mode_line
)
12371 && !current_buffer
->clip_changed
12372 && !current_buffer
->prevent_redisplay_optimizations_p
12373 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12374 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12375 /* Make sure recorded data applies to current buffer, etc. */
12376 && this_line_buffer
== current_buffer
12377 && current_buffer
== XBUFFER (w
->buffer
)
12378 && NILP (w
->force_start
)
12379 && NILP (w
->optional_new_start
)
12380 /* Point must be on the line that we have info recorded about. */
12381 && PT
>= CHARPOS (tlbufpos
)
12382 && PT
<= Z
- CHARPOS (tlendpos
)
12383 /* All text outside that line, including its final newline,
12384 must be unchanged. */
12385 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12386 CHARPOS (tlendpos
)))
12388 if (CHARPOS (tlbufpos
) > BEGV
12389 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12390 && (CHARPOS (tlbufpos
) == ZV
12391 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12392 /* Former continuation line has disappeared by becoming empty. */
12394 else if (XFASTINT (w
->last_modified
) < MODIFF
12395 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12396 || MINI_WINDOW_P (w
))
12398 /* We have to handle the case of continuation around a
12399 wide-column character (see the comment in indent.c around
12402 For instance, in the following case:
12404 -------- Insert --------
12405 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12406 J_I_ ==> J_I_ `^^' are cursors.
12410 As we have to redraw the line above, we cannot use this
12414 int line_height_before
= this_line_pixel_height
;
12416 /* Note that start_display will handle the case that the
12417 line starting at tlbufpos is a continuation line. */
12418 start_display (&it
, w
, tlbufpos
);
12420 /* Implementation note: It this still necessary? */
12421 if (it
.current_x
!= this_line_start_x
)
12424 TRACE ((stderr
, "trying display optimization 1\n"));
12425 w
->cursor
.vpos
= -1;
12426 overlay_arrow_seen
= 0;
12427 it
.vpos
= this_line_vpos
;
12428 it
.current_y
= this_line_y
;
12429 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12430 display_line (&it
);
12432 /* If line contains point, is not continued,
12433 and ends at same distance from eob as before, we win. */
12434 if (w
->cursor
.vpos
>= 0
12435 /* Line is not continued, otherwise this_line_start_pos
12436 would have been set to 0 in display_line. */
12437 && CHARPOS (this_line_start_pos
)
12438 /* Line ends as before. */
12439 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12440 /* Line has same height as before. Otherwise other lines
12441 would have to be shifted up or down. */
12442 && this_line_pixel_height
== line_height_before
)
12444 /* If this is not the window's last line, we must adjust
12445 the charstarts of the lines below. */
12446 if (it
.current_y
< it
.last_visible_y
)
12448 struct glyph_row
*row
12449 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12450 EMACS_INT delta
, delta_bytes
;
12452 /* We used to distinguish between two cases here,
12453 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12454 when the line ends in a newline or the end of the
12455 buffer's accessible portion. But both cases did
12456 the same, so they were collapsed. */
12458 - CHARPOS (tlendpos
)
12459 - MATRIX_ROW_START_CHARPOS (row
));
12460 delta_bytes
= (Z_BYTE
12461 - BYTEPOS (tlendpos
)
12462 - MATRIX_ROW_START_BYTEPOS (row
));
12464 increment_matrix_positions (w
->current_matrix
,
12465 this_line_vpos
+ 1,
12466 w
->current_matrix
->nrows
,
12467 delta
, delta_bytes
);
12470 /* If this row displays text now but previously didn't,
12471 or vice versa, w->window_end_vpos may have to be
12473 if ((it
.glyph_row
- 1)->displays_text_p
)
12475 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12476 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12478 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12479 && this_line_vpos
> 0)
12480 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12481 w
->window_end_valid
= Qnil
;
12483 /* Update hint: No need to try to scroll in update_window. */
12484 w
->desired_matrix
->no_scrolling_p
= 1;
12487 *w
->desired_matrix
->method
= 0;
12488 debug_method_add (w
, "optimization 1");
12490 #ifdef HAVE_WINDOW_SYSTEM
12491 update_window_fringes (w
, 0);
12498 else if (/* Cursor position hasn't changed. */
12499 PT
== XFASTINT (w
->last_point
)
12500 /* Make sure the cursor was last displayed
12501 in this window. Otherwise we have to reposition it. */
12502 && 0 <= w
->cursor
.vpos
12503 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12507 do_pending_window_change (1);
12508 /* If selected_window changed, redisplay again. */
12509 if (WINDOWP (selected_window
)
12510 && (w
= XWINDOW (selected_window
)) != sw
)
12513 /* We used to always goto end_of_redisplay here, but this
12514 isn't enough if we have a blinking cursor. */
12515 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12516 goto end_of_redisplay
;
12520 /* If highlighting the region, or if the cursor is in the echo area,
12521 then we can't just move the cursor. */
12522 else if (! (!NILP (Vtransient_mark_mode
)
12523 && !NILP (BVAR (current_buffer
, mark_active
)))
12524 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12525 || highlight_nonselected_windows
)
12526 && NILP (w
->region_showing
)
12527 && NILP (Vshow_trailing_whitespace
)
12528 && !cursor_in_echo_area
)
12531 struct glyph_row
*row
;
12533 /* Skip from tlbufpos to PT and see where it is. Note that
12534 PT may be in invisible text. If so, we will end at the
12535 next visible position. */
12536 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12537 NULL
, DEFAULT_FACE_ID
);
12538 it
.current_x
= this_line_start_x
;
12539 it
.current_y
= this_line_y
;
12540 it
.vpos
= this_line_vpos
;
12542 /* The call to move_it_to stops in front of PT, but
12543 moves over before-strings. */
12544 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12546 if (it
.vpos
== this_line_vpos
12547 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12550 xassert (this_line_vpos
== it
.vpos
);
12551 xassert (this_line_y
== it
.current_y
);
12552 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12554 *w
->desired_matrix
->method
= 0;
12555 debug_method_add (w
, "optimization 3");
12564 /* Text changed drastically or point moved off of line. */
12565 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12568 CHARPOS (this_line_start_pos
) = 0;
12569 consider_all_windows_p
|= buffer_shared
> 1;
12570 ++clear_face_cache_count
;
12571 #ifdef HAVE_WINDOW_SYSTEM
12572 ++clear_image_cache_count
;
12575 /* Build desired matrices, and update the display. If
12576 consider_all_windows_p is non-zero, do it for all windows on all
12577 frames. Otherwise do it for selected_window, only. */
12579 if (consider_all_windows_p
)
12581 Lisp_Object tail
, frame
;
12583 FOR_EACH_FRAME (tail
, frame
)
12584 XFRAME (frame
)->updated_p
= 0;
12586 /* Recompute # windows showing selected buffer. This will be
12587 incremented each time such a window is displayed. */
12590 FOR_EACH_FRAME (tail
, frame
)
12592 struct frame
*f
= XFRAME (frame
);
12594 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12596 if (! EQ (frame
, selected_frame
))
12597 /* Select the frame, for the sake of frame-local
12599 select_frame_for_redisplay (frame
);
12601 /* Mark all the scroll bars to be removed; we'll redeem
12602 the ones we want when we redisplay their windows. */
12603 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12604 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12606 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12607 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12609 /* The X error handler may have deleted that frame. */
12610 if (!FRAME_LIVE_P (f
))
12613 /* Any scroll bars which redisplay_windows should have
12614 nuked should now go away. */
12615 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12616 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12618 /* If fonts changed, display again. */
12619 /* ??? rms: I suspect it is a mistake to jump all the way
12620 back to retry here. It should just retry this frame. */
12621 if (fonts_changed_p
)
12624 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12626 /* See if we have to hscroll. */
12627 if (!f
->already_hscrolled_p
)
12629 f
->already_hscrolled_p
= 1;
12630 if (hscroll_windows (f
->root_window
))
12634 /* Prevent various kinds of signals during display
12635 update. stdio is not robust about handling
12636 signals, which can cause an apparent I/O
12638 if (interrupt_input
)
12639 unrequest_sigio ();
12642 /* Update the display. */
12643 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12644 pending
|= update_frame (f
, 0, 0);
12650 if (!EQ (old_frame
, selected_frame
)
12651 && FRAME_LIVE_P (XFRAME (old_frame
)))
12652 /* We played a bit fast-and-loose above and allowed selected_frame
12653 and selected_window to be temporarily out-of-sync but let's make
12654 sure this stays contained. */
12655 select_frame_for_redisplay (old_frame
);
12656 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12660 /* Do the mark_window_display_accurate after all windows have
12661 been redisplayed because this call resets flags in buffers
12662 which are needed for proper redisplay. */
12663 FOR_EACH_FRAME (tail
, frame
)
12665 struct frame
*f
= XFRAME (frame
);
12668 mark_window_display_accurate (f
->root_window
, 1);
12669 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12670 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12675 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12677 Lisp_Object mini_window
;
12678 struct frame
*mini_frame
;
12680 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12681 /* Use list_of_error, not Qerror, so that
12682 we catch only errors and don't run the debugger. */
12683 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12685 redisplay_window_error
);
12687 /* Compare desired and current matrices, perform output. */
12690 /* If fonts changed, display again. */
12691 if (fonts_changed_p
)
12694 /* Prevent various kinds of signals during display update.
12695 stdio is not robust about handling signals,
12696 which can cause an apparent I/O error. */
12697 if (interrupt_input
)
12698 unrequest_sigio ();
12701 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12703 if (hscroll_windows (selected_window
))
12706 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12707 pending
= update_frame (sf
, 0, 0);
12710 /* We may have called echo_area_display at the top of this
12711 function. If the echo area is on another frame, that may
12712 have put text on a frame other than the selected one, so the
12713 above call to update_frame would not have caught it. Catch
12715 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12716 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12718 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12720 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12721 pending
|= update_frame (mini_frame
, 0, 0);
12722 if (!pending
&& hscroll_windows (mini_window
))
12727 /* If display was paused because of pending input, make sure we do a
12728 thorough update the next time. */
12731 /* Prevent the optimization at the beginning of
12732 redisplay_internal that tries a single-line update of the
12733 line containing the cursor in the selected window. */
12734 CHARPOS (this_line_start_pos
) = 0;
12736 /* Let the overlay arrow be updated the next time. */
12737 update_overlay_arrows (0);
12739 /* If we pause after scrolling, some rows in the current
12740 matrices of some windows are not valid. */
12741 if (!WINDOW_FULL_WIDTH_P (w
)
12742 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12743 update_mode_lines
= 1;
12747 if (!consider_all_windows_p
)
12749 /* This has already been done above if
12750 consider_all_windows_p is set. */
12751 mark_window_display_accurate_1 (w
, 1);
12753 /* Say overlay arrows are up to date. */
12754 update_overlay_arrows (1);
12756 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12757 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12760 update_mode_lines
= 0;
12761 windows_or_buffers_changed
= 0;
12762 cursor_type_changed
= 0;
12765 /* Start SIGIO interrupts coming again. Having them off during the
12766 code above makes it less likely one will discard output, but not
12767 impossible, since there might be stuff in the system buffer here.
12768 But it is much hairier to try to do anything about that. */
12769 if (interrupt_input
)
12773 /* If a frame has become visible which was not before, redisplay
12774 again, so that we display it. Expose events for such a frame
12775 (which it gets when becoming visible) don't call the parts of
12776 redisplay constructing glyphs, so simply exposing a frame won't
12777 display anything in this case. So, we have to display these
12778 frames here explicitly. */
12781 Lisp_Object tail
, frame
;
12784 FOR_EACH_FRAME (tail
, frame
)
12786 int this_is_visible
= 0;
12788 if (XFRAME (frame
)->visible
)
12789 this_is_visible
= 1;
12790 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12791 if (XFRAME (frame
)->visible
)
12792 this_is_visible
= 1;
12794 if (this_is_visible
)
12798 if (new_count
!= number_of_visible_frames
)
12799 windows_or_buffers_changed
++;
12802 /* Change frame size now if a change is pending. */
12803 do_pending_window_change (1);
12805 /* If we just did a pending size change, or have additional
12806 visible frames, or selected_window changed, redisplay again. */
12807 if ((windows_or_buffers_changed
&& !pending
)
12808 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12811 /* Clear the face and image caches.
12813 We used to do this only if consider_all_windows_p. But the cache
12814 needs to be cleared if a timer creates images in the current
12815 buffer (e.g. the test case in Bug#6230). */
12817 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12819 clear_face_cache (0);
12820 clear_face_cache_count
= 0;
12823 #ifdef HAVE_WINDOW_SYSTEM
12824 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12826 clear_image_caches (Qnil
);
12827 clear_image_cache_count
= 0;
12829 #endif /* HAVE_WINDOW_SYSTEM */
12832 unbind_to (count
, Qnil
);
12837 /* Redisplay, but leave alone any recent echo area message unless
12838 another message has been requested in its place.
12840 This is useful in situations where you need to redisplay but no
12841 user action has occurred, making it inappropriate for the message
12842 area to be cleared. See tracking_off and
12843 wait_reading_process_output for examples of these situations.
12845 FROM_WHERE is an integer saying from where this function was
12846 called. This is useful for debugging. */
12849 redisplay_preserve_echo_area (int from_where
)
12851 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12853 if (!NILP (echo_area_buffer
[1]))
12855 /* We have a previously displayed message, but no current
12856 message. Redisplay the previous message. */
12857 display_last_displayed_message_p
= 1;
12858 redisplay_internal ();
12859 display_last_displayed_message_p
= 0;
12862 redisplay_internal ();
12864 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12865 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12866 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12870 /* Function registered with record_unwind_protect in
12871 redisplay_internal. Reset redisplaying_p to the value it had
12872 before redisplay_internal was called, and clear
12873 prevent_freeing_realized_faces_p. It also selects the previously
12874 selected frame, unless it has been deleted (by an X connection
12875 failure during redisplay, for example). */
12878 unwind_redisplay (Lisp_Object val
)
12880 Lisp_Object old_redisplaying_p
, old_frame
;
12882 old_redisplaying_p
= XCAR (val
);
12883 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12884 old_frame
= XCDR (val
);
12885 if (! EQ (old_frame
, selected_frame
)
12886 && FRAME_LIVE_P (XFRAME (old_frame
)))
12887 select_frame_for_redisplay (old_frame
);
12892 /* Mark the display of window W as accurate or inaccurate. If
12893 ACCURATE_P is non-zero mark display of W as accurate. If
12894 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12895 redisplay_internal is called. */
12898 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12900 if (BUFFERP (w
->buffer
))
12902 struct buffer
*b
= XBUFFER (w
->buffer
);
12905 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12906 w
->last_overlay_modified
12907 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12909 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12913 b
->clip_changed
= 0;
12914 b
->prevent_redisplay_optimizations_p
= 0;
12916 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12917 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12918 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12919 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12921 w
->current_matrix
->buffer
= b
;
12922 w
->current_matrix
->begv
= BUF_BEGV (b
);
12923 w
->current_matrix
->zv
= BUF_ZV (b
);
12925 w
->last_cursor
= w
->cursor
;
12926 w
->last_cursor_off_p
= w
->cursor_off_p
;
12928 if (w
== XWINDOW (selected_window
))
12929 w
->last_point
= make_number (BUF_PT (b
));
12931 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12937 w
->window_end_valid
= w
->buffer
;
12938 w
->update_mode_line
= Qnil
;
12943 /* Mark the display of windows in the window tree rooted at WINDOW as
12944 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12945 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12946 be redisplayed the next time redisplay_internal is called. */
12949 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12953 for (; !NILP (window
); window
= w
->next
)
12955 w
= XWINDOW (window
);
12956 mark_window_display_accurate_1 (w
, accurate_p
);
12958 if (!NILP (w
->vchild
))
12959 mark_window_display_accurate (w
->vchild
, accurate_p
);
12960 if (!NILP (w
->hchild
))
12961 mark_window_display_accurate (w
->hchild
, accurate_p
);
12966 update_overlay_arrows (1);
12970 /* Force a thorough redisplay the next time by setting
12971 last_arrow_position and last_arrow_string to t, which is
12972 unequal to any useful value of Voverlay_arrow_... */
12973 update_overlay_arrows (-1);
12978 /* Return value in display table DP (Lisp_Char_Table *) for character
12979 C. Since a display table doesn't have any parent, we don't have to
12980 follow parent. Do not call this function directly but use the
12981 macro DISP_CHAR_VECTOR. */
12984 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12988 if (ASCII_CHAR_P (c
))
12991 if (SUB_CHAR_TABLE_P (val
))
12992 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12998 XSETCHAR_TABLE (table
, dp
);
12999 val
= char_table_ref (table
, c
);
13008 /***********************************************************************
13010 ***********************************************************************/
13012 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13015 redisplay_windows (Lisp_Object window
)
13017 while (!NILP (window
))
13019 struct window
*w
= XWINDOW (window
);
13021 if (!NILP (w
->hchild
))
13022 redisplay_windows (w
->hchild
);
13023 else if (!NILP (w
->vchild
))
13024 redisplay_windows (w
->vchild
);
13025 else if (!NILP (w
->buffer
))
13027 displayed_buffer
= XBUFFER (w
->buffer
);
13028 /* Use list_of_error, not Qerror, so that
13029 we catch only errors and don't run the debugger. */
13030 internal_condition_case_1 (redisplay_window_0
, window
,
13032 redisplay_window_error
);
13040 redisplay_window_error (Lisp_Object ignore
)
13042 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13047 redisplay_window_0 (Lisp_Object window
)
13049 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13050 redisplay_window (window
, 0);
13055 redisplay_window_1 (Lisp_Object window
)
13057 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13058 redisplay_window (window
, 1);
13063 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13064 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13065 which positions recorded in ROW differ from current buffer
13068 Return 0 if cursor is not on this row, 1 otherwise. */
13071 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13072 struct glyph_matrix
*matrix
,
13073 EMACS_INT delta
, EMACS_INT delta_bytes
,
13076 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13077 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13078 struct glyph
*cursor
= NULL
;
13079 /* The last known character position in row. */
13080 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13082 EMACS_INT pt_old
= PT
- delta
;
13083 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13084 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13085 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13086 /* A glyph beyond the edge of TEXT_AREA which we should never
13088 struct glyph
*glyphs_end
= end
;
13089 /* Non-zero means we've found a match for cursor position, but that
13090 glyph has the avoid_cursor_p flag set. */
13091 int match_with_avoid_cursor
= 0;
13092 /* Non-zero means we've seen at least one glyph that came from a
13094 int string_seen
= 0;
13095 /* Largest and smalles buffer positions seen so far during scan of
13097 EMACS_INT bpos_max
= pos_before
;
13098 EMACS_INT bpos_min
= pos_after
;
13099 /* Last buffer position covered by an overlay string with an integer
13100 `cursor' property. */
13101 EMACS_INT bpos_covered
= 0;
13103 /* Skip over glyphs not having an object at the start and the end of
13104 the row. These are special glyphs like truncation marks on
13105 terminal frames. */
13106 if (row
->displays_text_p
)
13108 if (!row
->reversed_p
)
13111 && INTEGERP (glyph
->object
)
13112 && glyph
->charpos
< 0)
13114 x
+= glyph
->pixel_width
;
13118 && INTEGERP ((end
- 1)->object
)
13119 /* CHARPOS is zero for blanks and stretch glyphs
13120 inserted by extend_face_to_end_of_line. */
13121 && (end
- 1)->charpos
<= 0)
13123 glyph_before
= glyph
- 1;
13130 /* If the glyph row is reversed, we need to process it from back
13131 to front, so swap the edge pointers. */
13132 glyphs_end
= end
= glyph
- 1;
13133 glyph
+= row
->used
[TEXT_AREA
] - 1;
13135 while (glyph
> end
+ 1
13136 && INTEGERP (glyph
->object
)
13137 && glyph
->charpos
< 0)
13140 x
-= glyph
->pixel_width
;
13142 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13144 /* By default, in reversed rows we put the cursor on the
13145 rightmost (first in the reading order) glyph. */
13146 for (g
= end
+ 1; g
< glyph
; g
++)
13147 x
+= g
->pixel_width
;
13149 && INTEGERP ((end
+ 1)->object
)
13150 && (end
+ 1)->charpos
<= 0)
13152 glyph_before
= glyph
+ 1;
13156 else if (row
->reversed_p
)
13158 /* In R2L rows that don't display text, put the cursor on the
13159 rightmost glyph. Case in point: an empty last line that is
13160 part of an R2L paragraph. */
13162 /* Avoid placing the cursor on the last glyph of the row, where
13163 on terminal frames we hold the vertical border between
13164 adjacent windows. */
13165 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13166 && !WINDOW_RIGHTMOST_P (w
)
13167 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13169 x
= -1; /* will be computed below, at label compute_x */
13172 /* Step 1: Try to find the glyph whose character position
13173 corresponds to point. If that's not possible, find 2 glyphs
13174 whose character positions are the closest to point, one before
13175 point, the other after it. */
13176 if (!row
->reversed_p
)
13177 while (/* not marched to end of glyph row */
13179 /* glyph was not inserted by redisplay for internal purposes */
13180 && !INTEGERP (glyph
->object
))
13182 if (BUFFERP (glyph
->object
))
13184 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13186 if (glyph
->charpos
> bpos_max
)
13187 bpos_max
= glyph
->charpos
;
13188 if (glyph
->charpos
< bpos_min
)
13189 bpos_min
= glyph
->charpos
;
13190 if (!glyph
->avoid_cursor_p
)
13192 /* If we hit point, we've found the glyph on which to
13193 display the cursor. */
13196 match_with_avoid_cursor
= 0;
13199 /* See if we've found a better approximation to
13200 POS_BEFORE or to POS_AFTER. Note that we want the
13201 first (leftmost) glyph of all those that are the
13202 closest from below, and the last (rightmost) of all
13203 those from above. */
13204 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13206 pos_before
= glyph
->charpos
;
13207 glyph_before
= glyph
;
13209 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13211 pos_after
= glyph
->charpos
;
13212 glyph_after
= glyph
;
13215 else if (dpos
== 0)
13216 match_with_avoid_cursor
= 1;
13218 else if (STRINGP (glyph
->object
))
13220 Lisp_Object chprop
;
13221 EMACS_INT glyph_pos
= glyph
->charpos
;
13223 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13225 if (INTEGERP (chprop
))
13227 bpos_covered
= bpos_max
+ XINT (chprop
);
13228 /* If the `cursor' property covers buffer positions up
13229 to and including point, we should display cursor on
13230 this glyph. Note that overlays and text properties
13231 with string values stop bidi reordering, so every
13232 buffer position to the left of the string is always
13233 smaller than any position to the right of the
13234 string. Therefore, if a `cursor' property on one
13235 of the string's characters has an integer value, we
13236 will break out of the loop below _before_ we get to
13237 the position match above. IOW, integer values of
13238 the `cursor' property override the "exact match for
13239 point" strategy of positioning the cursor. */
13240 /* Implementation note: bpos_max == pt_old when, e.g.,
13241 we are in an empty line, where bpos_max is set to
13242 MATRIX_ROW_START_CHARPOS, see above. */
13243 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13252 x
+= glyph
->pixel_width
;
13255 else if (glyph
> end
) /* row is reversed */
13256 while (!INTEGERP (glyph
->object
))
13258 if (BUFFERP (glyph
->object
))
13260 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13262 if (glyph
->charpos
> bpos_max
)
13263 bpos_max
= glyph
->charpos
;
13264 if (glyph
->charpos
< bpos_min
)
13265 bpos_min
= glyph
->charpos
;
13266 if (!glyph
->avoid_cursor_p
)
13270 match_with_avoid_cursor
= 0;
13273 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13275 pos_before
= glyph
->charpos
;
13276 glyph_before
= glyph
;
13278 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13280 pos_after
= glyph
->charpos
;
13281 glyph_after
= glyph
;
13284 else if (dpos
== 0)
13285 match_with_avoid_cursor
= 1;
13287 else if (STRINGP (glyph
->object
))
13289 Lisp_Object chprop
;
13290 EMACS_INT glyph_pos
= glyph
->charpos
;
13292 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13294 if (INTEGERP (chprop
))
13296 bpos_covered
= bpos_max
+ XINT (chprop
);
13297 /* If the `cursor' property covers buffer positions up
13298 to and including point, we should display cursor on
13300 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13309 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13311 x
--; /* can't use any pixel_width */
13314 x
-= glyph
->pixel_width
;
13317 /* Step 2: If we didn't find an exact match for point, we need to
13318 look for a proper place to put the cursor among glyphs between
13319 GLYPH_BEFORE and GLYPH_AFTER. */
13320 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13321 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13322 && bpos_covered
< pt_old
)
13324 /* An empty line has a single glyph whose OBJECT is zero and
13325 whose CHARPOS is the position of a newline on that line.
13326 Note that on a TTY, there are more glyphs after that, which
13327 were produced by extend_face_to_end_of_line, but their
13328 CHARPOS is zero or negative. */
13330 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13331 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13333 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13335 EMACS_INT ellipsis_pos
;
13337 /* Scan back over the ellipsis glyphs. */
13338 if (!row
->reversed_p
)
13340 ellipsis_pos
= (glyph
- 1)->charpos
;
13341 while (glyph
> row
->glyphs
[TEXT_AREA
]
13342 && (glyph
- 1)->charpos
== ellipsis_pos
)
13343 glyph
--, x
-= glyph
->pixel_width
;
13344 /* That loop always goes one position too far, including
13345 the glyph before the ellipsis. So scan forward over
13347 x
+= glyph
->pixel_width
;
13350 else /* row is reversed */
13352 ellipsis_pos
= (glyph
+ 1)->charpos
;
13353 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13354 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13355 glyph
++, x
+= glyph
->pixel_width
;
13356 x
-= glyph
->pixel_width
;
13360 else if (match_with_avoid_cursor
13361 /* A truncated row may not include PT among its
13362 character positions. Setting the cursor inside the
13363 scroll margin will trigger recalculation of hscroll
13364 in hscroll_window_tree. */
13365 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13366 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13367 /* Zero-width characters produce no glyphs. */
13370 && (row
->reversed_p
13371 ? glyph_after
> glyphs_end
13372 : glyph_after
< glyphs_end
)))
13374 cursor
= glyph_after
;
13377 else if (string_seen
)
13379 int incr
= row
->reversed_p
? -1 : +1;
13381 /* Need to find the glyph that came out of a string which is
13382 present at point. That glyph is somewhere between
13383 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13384 positioned between POS_BEFORE and POS_AFTER in the
13386 struct glyph
*start
, *stop
;
13387 EMACS_INT pos
= pos_before
;
13391 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13392 correspond to POS_BEFORE and POS_AFTER, respectively. We
13393 need START and STOP in the order that corresponds to the
13394 row's direction as given by its reversed_p flag. If the
13395 directionality of characters between POS_BEFORE and
13396 POS_AFTER is the opposite of the row's base direction,
13397 these characters will have been reordered for display,
13398 and we need to reverse START and STOP. */
13399 if (!row
->reversed_p
)
13401 start
= min (glyph_before
, glyph_after
);
13402 stop
= max (glyph_before
, glyph_after
);
13406 start
= max (glyph_before
, glyph_after
);
13407 stop
= min (glyph_before
, glyph_after
);
13409 for (glyph
= start
+ incr
;
13410 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13413 /* Any glyphs that come from the buffer are here because
13414 of bidi reordering. Skip them, and only pay
13415 attention to glyphs that came from some string. */
13416 if (STRINGP (glyph
->object
))
13421 str
= glyph
->object
;
13422 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13423 if (tem
== 0 /* from overlay */
13426 /* If the string from which this glyph came is
13427 found in the buffer at point, then we've
13428 found the glyph we've been looking for. If
13429 it comes from an overlay (tem == 0), and it
13430 has the `cursor' property on one of its
13431 glyphs, record that glyph as a candidate for
13432 displaying the cursor. (As in the
13433 unidirectional version, we will display the
13434 cursor on the last candidate we find.) */
13435 if (tem
== 0 || tem
== pt_old
)
13437 /* The glyphs from this string could have
13438 been reordered. Find the one with the
13439 smallest string position. Or there could
13440 be a character in the string with the
13441 `cursor' property, which means display
13442 cursor on that character's glyph. */
13443 EMACS_INT strpos
= glyph
->charpos
;
13448 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13449 && EQ (glyph
->object
, str
);
13453 EMACS_INT gpos
= glyph
->charpos
;
13455 cprop
= Fget_char_property (make_number (gpos
),
13463 if (tem
&& glyph
->charpos
< strpos
)
13465 strpos
= glyph
->charpos
;
13474 pos
= tem
+ 1; /* don't find previous instances */
13476 /* This string is not what we want; skip all of the
13477 glyphs that came from it. */
13478 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13479 && EQ (glyph
->object
, str
))
13486 /* If we reached the end of the line, and END was from a string,
13487 the cursor is not on this line. */
13489 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13490 && STRINGP (end
->object
)
13491 && row
->continued_p
)
13497 if (cursor
!= NULL
)
13503 /* Need to compute x that corresponds to GLYPH. */
13504 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13506 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13508 x
+= g
->pixel_width
;
13512 /* ROW could be part of a continued line, which, under bidi
13513 reordering, might have other rows whose start and end charpos
13514 occlude point. Only set w->cursor if we found a better
13515 approximation to the cursor position than we have from previously
13516 examined candidate rows belonging to the same continued line. */
13517 if (/* we already have a candidate row */
13518 w
->cursor
.vpos
>= 0
13519 /* that candidate is not the row we are processing */
13520 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13521 /* the row we are processing is part of a continued line */
13522 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13523 /* Make sure cursor.vpos specifies a row whose start and end
13524 charpos occlude point. This is because some callers of this
13525 function leave cursor.vpos at the row where the cursor was
13526 displayed during the last redisplay cycle. */
13527 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13528 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13531 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13533 /* Don't consider glyphs that are outside TEXT_AREA. */
13534 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13536 /* Keep the candidate whose buffer position is the closest to
13538 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13539 w
->cursor
.hpos
>= 0
13540 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13541 && BUFFERP (g1
->object
)
13542 && (g1
->charpos
== pt_old
/* an exact match always wins */
13543 || (BUFFERP (glyph
->object
)
13544 && eabs (g1
->charpos
- pt_old
)
13545 < eabs (glyph
->charpos
- pt_old
))))
13547 /* If this candidate gives an exact match, use that. */
13548 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13549 /* Otherwise, keep the candidate that comes from a row
13550 spanning less buffer positions. This may win when one or
13551 both candidate positions are on glyphs that came from
13552 display strings, for which we cannot compare buffer
13554 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13555 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13556 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13559 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13561 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13562 w
->cursor
.y
= row
->y
+ dy
;
13564 if (w
== XWINDOW (selected_window
))
13566 if (!row
->continued_p
13567 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13570 this_line_buffer
= XBUFFER (w
->buffer
);
13572 CHARPOS (this_line_start_pos
)
13573 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13574 BYTEPOS (this_line_start_pos
)
13575 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13577 CHARPOS (this_line_end_pos
)
13578 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13579 BYTEPOS (this_line_end_pos
)
13580 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13582 this_line_y
= w
->cursor
.y
;
13583 this_line_pixel_height
= row
->height
;
13584 this_line_vpos
= w
->cursor
.vpos
;
13585 this_line_start_x
= row
->x
;
13588 CHARPOS (this_line_start_pos
) = 0;
13595 /* Run window scroll functions, if any, for WINDOW with new window
13596 start STARTP. Sets the window start of WINDOW to that position.
13598 We assume that the window's buffer is really current. */
13600 static INLINE
struct text_pos
13601 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13603 struct window
*w
= XWINDOW (window
);
13604 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13606 if (current_buffer
!= XBUFFER (w
->buffer
))
13609 if (!NILP (Vwindow_scroll_functions
))
13611 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13612 make_number (CHARPOS (startp
)));
13613 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13614 /* In case the hook functions switch buffers. */
13615 if (current_buffer
!= XBUFFER (w
->buffer
))
13616 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13623 /* Make sure the line containing the cursor is fully visible.
13624 A value of 1 means there is nothing to be done.
13625 (Either the line is fully visible, or it cannot be made so,
13626 or we cannot tell.)
13628 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13629 is higher than window.
13631 A value of 0 means the caller should do scrolling
13632 as if point had gone off the screen. */
13635 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13637 struct glyph_matrix
*matrix
;
13638 struct glyph_row
*row
;
13641 if (!make_cursor_line_fully_visible_p
)
13644 /* It's not always possible to find the cursor, e.g, when a window
13645 is full of overlay strings. Don't do anything in that case. */
13646 if (w
->cursor
.vpos
< 0)
13649 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13650 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13652 /* If the cursor row is not partially visible, there's nothing to do. */
13653 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13656 /* If the row the cursor is in is taller than the window's height,
13657 it's not clear what to do, so do nothing. */
13658 window_height
= window_box_height (w
);
13659 if (row
->height
>= window_height
)
13661 if (!force_p
|| MINI_WINDOW_P (w
)
13662 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13669 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13670 non-zero means only WINDOW is redisplayed in redisplay_internal.
13671 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13672 in redisplay_window to bring a partially visible line into view in
13673 the case that only the cursor has moved.
13675 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13676 last screen line's vertical height extends past the end of the screen.
13680 1 if scrolling succeeded
13682 0 if scrolling didn't find point.
13684 -1 if new fonts have been loaded so that we must interrupt
13685 redisplay, adjust glyph matrices, and try again. */
13691 SCROLLING_NEED_LARGER_MATRICES
13694 /* If scroll-conservatively is more than this, never recenter.
13696 If you change this, don't forget to update the doc string of
13697 `scroll-conservatively' and the Emacs manual. */
13698 #define SCROLL_LIMIT 100
13701 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13702 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13703 int temp_scroll_step
, int last_line_misfit
)
13705 struct window
*w
= XWINDOW (window
);
13706 struct frame
*f
= XFRAME (w
->frame
);
13707 struct text_pos pos
, startp
;
13709 int this_scroll_margin
, scroll_max
, rc
, height
;
13710 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13711 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13712 Lisp_Object aggressive
;
13713 /* We will never try scrolling more than this number of lines. */
13714 int scroll_limit
= SCROLL_LIMIT
;
13717 debug_method_add (w
, "try_scrolling");
13720 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13722 /* Compute scroll margin height in pixels. We scroll when point is
13723 within this distance from the top or bottom of the window. */
13724 if (scroll_margin
> 0)
13725 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13726 * FRAME_LINE_HEIGHT (f
);
13728 this_scroll_margin
= 0;
13730 /* Force arg_scroll_conservatively to have a reasonable value, to
13731 avoid scrolling too far away with slow move_it_* functions. Note
13732 that the user can supply scroll-conservatively equal to
13733 `most-positive-fixnum', which can be larger than INT_MAX. */
13734 if (arg_scroll_conservatively
> scroll_limit
)
13736 arg_scroll_conservatively
= scroll_limit
+ 1;
13737 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13739 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13740 /* Compute how much we should try to scroll maximally to bring
13741 point into view. */
13742 scroll_max
= (max (scroll_step
,
13743 max (arg_scroll_conservatively
, temp_scroll_step
))
13744 * FRAME_LINE_HEIGHT (f
));
13745 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13746 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13747 /* We're trying to scroll because of aggressive scrolling but no
13748 scroll_step is set. Choose an arbitrary one. */
13749 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13755 /* Decide whether to scroll down. */
13756 if (PT
> CHARPOS (startp
))
13758 int scroll_margin_y
;
13760 /* Compute the pixel ypos of the scroll margin, then move it to
13761 either that ypos or PT, whichever comes first. */
13762 start_display (&it
, w
, startp
);
13763 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13764 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13765 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13766 (MOVE_TO_POS
| MOVE_TO_Y
));
13768 if (PT
> CHARPOS (it
.current
.pos
))
13770 int y0
= line_bottom_y (&it
);
13771 /* Compute how many pixels below window bottom to stop searching
13772 for PT. This avoids costly search for PT that is far away if
13773 the user limited scrolling by a small number of lines, but
13774 always finds PT if scroll_conservatively is set to a large
13775 number, such as most-positive-fixnum. */
13776 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13777 int y_to_move
= it
.last_visible_y
+ slack
;
13779 /* Compute the distance from the scroll margin to PT or to
13780 the scroll limit, whichever comes first. This should
13781 include the height of the cursor line, to make that line
13783 move_it_to (&it
, PT
, -1, y_to_move
,
13784 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13785 dy
= line_bottom_y (&it
) - y0
;
13787 if (dy
> scroll_max
)
13788 return SCROLLING_FAILED
;
13796 /* Point is in or below the bottom scroll margin, so move the
13797 window start down. If scrolling conservatively, move it just
13798 enough down to make point visible. If scroll_step is set,
13799 move it down by scroll_step. */
13800 if (arg_scroll_conservatively
)
13802 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13803 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13804 else if (scroll_step
|| temp_scroll_step
)
13805 amount_to_scroll
= scroll_max
;
13808 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13809 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13810 if (NUMBERP (aggressive
))
13812 double float_amount
= XFLOATINT (aggressive
) * height
;
13813 amount_to_scroll
= float_amount
;
13814 if (amount_to_scroll
== 0 && float_amount
> 0)
13815 amount_to_scroll
= 1;
13816 /* Don't let point enter the scroll margin near top of
13818 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13819 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13823 if (amount_to_scroll
<= 0)
13824 return SCROLLING_FAILED
;
13826 start_display (&it
, w
, startp
);
13827 if (arg_scroll_conservatively
<= scroll_limit
)
13828 move_it_vertically (&it
, amount_to_scroll
);
13831 /* Extra precision for users who set scroll-conservatively
13832 to a large number: make sure the amount we scroll
13833 the window start is never less than amount_to_scroll,
13834 which was computed as distance from window bottom to
13835 point. This matters when lines at window top and lines
13836 below window bottom have different height. */
13838 void *it1data
= NULL
;
13839 /* We use a temporary it1 because line_bottom_y can modify
13840 its argument, if it moves one line down; see there. */
13843 SAVE_IT (it1
, it
, it1data
);
13844 start_y
= line_bottom_y (&it1
);
13846 RESTORE_IT (&it
, &it
, it1data
);
13847 move_it_by_lines (&it
, 1);
13848 SAVE_IT (it1
, it
, it1data
);
13849 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13852 /* If STARTP is unchanged, move it down another screen line. */
13853 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13854 move_it_by_lines (&it
, 1);
13855 startp
= it
.current
.pos
;
13859 struct text_pos scroll_margin_pos
= startp
;
13861 /* See if point is inside the scroll margin at the top of the
13863 if (this_scroll_margin
)
13865 start_display (&it
, w
, startp
);
13866 move_it_vertically (&it
, this_scroll_margin
);
13867 scroll_margin_pos
= it
.current
.pos
;
13870 if (PT
< CHARPOS (scroll_margin_pos
))
13872 /* Point is in the scroll margin at the top of the window or
13873 above what is displayed in the window. */
13876 /* Compute the vertical distance from PT to the scroll
13877 margin position. Move as far as scroll_max allows, or
13878 one screenful, or 10 screen lines, whichever is largest.
13879 Give up if distance is greater than scroll_max. */
13880 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13881 start_display (&it
, w
, pos
);
13883 y_to_move
= max (it
.last_visible_y
,
13884 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13885 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13887 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13888 dy
= it
.current_y
- y0
;
13889 if (dy
> scroll_max
)
13890 return SCROLLING_FAILED
;
13892 /* Compute new window start. */
13893 start_display (&it
, w
, startp
);
13895 if (arg_scroll_conservatively
)
13896 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13897 max (scroll_step
, temp_scroll_step
));
13898 else if (scroll_step
|| temp_scroll_step
)
13899 amount_to_scroll
= scroll_max
;
13902 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13903 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13904 if (NUMBERP (aggressive
))
13906 double float_amount
= XFLOATINT (aggressive
) * height
;
13907 amount_to_scroll
= float_amount
;
13908 if (amount_to_scroll
== 0 && float_amount
> 0)
13909 amount_to_scroll
= 1;
13910 amount_to_scroll
-=
13911 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13912 /* Don't let point enter the scroll margin near
13913 bottom of the window. */
13914 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13915 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13919 if (amount_to_scroll
<= 0)
13920 return SCROLLING_FAILED
;
13922 move_it_vertically_backward (&it
, amount_to_scroll
);
13923 startp
= it
.current
.pos
;
13927 /* Run window scroll functions. */
13928 startp
= run_window_scroll_functions (window
, startp
);
13930 /* Display the window. Give up if new fonts are loaded, or if point
13932 if (!try_window (window
, startp
, 0))
13933 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13934 else if (w
->cursor
.vpos
< 0)
13936 clear_glyph_matrix (w
->desired_matrix
);
13937 rc
= SCROLLING_FAILED
;
13941 /* Maybe forget recorded base line for line number display. */
13942 if (!just_this_one_p
13943 || current_buffer
->clip_changed
13944 || BEG_UNCHANGED
< CHARPOS (startp
))
13945 w
->base_line_number
= Qnil
;
13947 /* If cursor ends up on a partially visible line,
13948 treat that as being off the bottom of the screen. */
13949 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13950 /* It's possible that the cursor is on the first line of the
13951 buffer, which is partially obscured due to a vscroll
13952 (Bug#7537). In that case, avoid looping forever . */
13953 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13955 clear_glyph_matrix (w
->desired_matrix
);
13956 ++extra_scroll_margin_lines
;
13959 rc
= SCROLLING_SUCCESS
;
13966 /* Compute a suitable window start for window W if display of W starts
13967 on a continuation line. Value is non-zero if a new window start
13970 The new window start will be computed, based on W's width, starting
13971 from the start of the continued line. It is the start of the
13972 screen line with the minimum distance from the old start W->start. */
13975 compute_window_start_on_continuation_line (struct window
*w
)
13977 struct text_pos pos
, start_pos
;
13978 int window_start_changed_p
= 0;
13980 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13982 /* If window start is on a continuation line... Window start may be
13983 < BEGV in case there's invisible text at the start of the
13984 buffer (M-x rmail, for example). */
13985 if (CHARPOS (start_pos
) > BEGV
13986 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13989 struct glyph_row
*row
;
13991 /* Handle the case that the window start is out of range. */
13992 if (CHARPOS (start_pos
) < BEGV
)
13993 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13994 else if (CHARPOS (start_pos
) > ZV
)
13995 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13997 /* Find the start of the continued line. This should be fast
13998 because scan_buffer is fast (newline cache). */
13999 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14000 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14001 row
, DEFAULT_FACE_ID
);
14002 reseat_at_previous_visible_line_start (&it
);
14004 /* If the line start is "too far" away from the window start,
14005 say it takes too much time to compute a new window start. */
14006 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14007 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14009 int min_distance
, distance
;
14011 /* Move forward by display lines to find the new window
14012 start. If window width was enlarged, the new start can
14013 be expected to be > the old start. If window width was
14014 decreased, the new window start will be < the old start.
14015 So, we're looking for the display line start with the
14016 minimum distance from the old window start. */
14017 pos
= it
.current
.pos
;
14018 min_distance
= INFINITY
;
14019 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14020 distance
< min_distance
)
14022 min_distance
= distance
;
14023 pos
= it
.current
.pos
;
14024 move_it_by_lines (&it
, 1);
14027 /* Set the window start there. */
14028 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14029 window_start_changed_p
= 1;
14033 return window_start_changed_p
;
14037 /* Try cursor movement in case text has not changed in window WINDOW,
14038 with window start STARTP. Value is
14040 CURSOR_MOVEMENT_SUCCESS if successful
14042 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14044 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14045 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14046 we want to scroll as if scroll-step were set to 1. See the code.
14048 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14049 which case we have to abort this redisplay, and adjust matrices
14054 CURSOR_MOVEMENT_SUCCESS
,
14055 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14056 CURSOR_MOVEMENT_MUST_SCROLL
,
14057 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14061 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14063 struct window
*w
= XWINDOW (window
);
14064 struct frame
*f
= XFRAME (w
->frame
);
14065 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14068 if (inhibit_try_cursor_movement
)
14072 /* Handle case where text has not changed, only point, and it has
14073 not moved off the frame. */
14074 if (/* Point may be in this window. */
14075 PT
>= CHARPOS (startp
)
14076 /* Selective display hasn't changed. */
14077 && !current_buffer
->clip_changed
14078 /* Function force-mode-line-update is used to force a thorough
14079 redisplay. It sets either windows_or_buffers_changed or
14080 update_mode_lines. So don't take a shortcut here for these
14082 && !update_mode_lines
14083 && !windows_or_buffers_changed
14084 && !cursor_type_changed
14085 /* Can't use this case if highlighting a region. When a
14086 region exists, cursor movement has to do more than just
14088 && !(!NILP (Vtransient_mark_mode
)
14089 && !NILP (BVAR (current_buffer
, mark_active
)))
14090 && NILP (w
->region_showing
)
14091 && NILP (Vshow_trailing_whitespace
)
14092 /* Right after splitting windows, last_point may be nil. */
14093 && INTEGERP (w
->last_point
)
14094 /* This code is not used for mini-buffer for the sake of the case
14095 of redisplaying to replace an echo area message; since in
14096 that case the mini-buffer contents per se are usually
14097 unchanged. This code is of no real use in the mini-buffer
14098 since the handling of this_line_start_pos, etc., in redisplay
14099 handles the same cases. */
14100 && !EQ (window
, minibuf_window
)
14101 /* When splitting windows or for new windows, it happens that
14102 redisplay is called with a nil window_end_vpos or one being
14103 larger than the window. This should really be fixed in
14104 window.c. I don't have this on my list, now, so we do
14105 approximately the same as the old redisplay code. --gerd. */
14106 && INTEGERP (w
->window_end_vpos
)
14107 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14108 && (FRAME_WINDOW_P (f
)
14109 || !overlay_arrow_in_current_buffer_p ()))
14111 int this_scroll_margin
, top_scroll_margin
;
14112 struct glyph_row
*row
= NULL
;
14115 debug_method_add (w
, "cursor movement");
14118 /* Scroll if point within this distance from the top or bottom
14119 of the window. This is a pixel value. */
14120 if (scroll_margin
> 0)
14122 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14123 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14126 this_scroll_margin
= 0;
14128 top_scroll_margin
= this_scroll_margin
;
14129 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14130 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14132 /* Start with the row the cursor was displayed during the last
14133 not paused redisplay. Give up if that row is not valid. */
14134 if (w
->last_cursor
.vpos
< 0
14135 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14136 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14139 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14140 if (row
->mode_line_p
)
14142 if (!row
->enabled_p
)
14143 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14146 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14148 int scroll_p
= 0, must_scroll
= 0;
14149 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14151 if (PT
> XFASTINT (w
->last_point
))
14153 /* Point has moved forward. */
14154 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14155 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14157 xassert (row
->enabled_p
);
14161 /* If the end position of a row equals the start
14162 position of the next row, and PT is at that position,
14163 we would rather display cursor in the next line. */
14164 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14165 && MATRIX_ROW_END_CHARPOS (row
) == PT
14166 && row
< w
->current_matrix
->rows
14167 + w
->current_matrix
->nrows
- 1
14168 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14169 && !cursor_row_p (row
))
14172 /* If within the scroll margin, scroll. Note that
14173 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14174 the next line would be drawn, and that
14175 this_scroll_margin can be zero. */
14176 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14177 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14178 /* Line is completely visible last line in window
14179 and PT is to be set in the next line. */
14180 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14181 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14182 && !row
->ends_at_zv_p
14183 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14186 else if (PT
< XFASTINT (w
->last_point
))
14188 /* Cursor has to be moved backward. Note that PT >=
14189 CHARPOS (startp) because of the outer if-statement. */
14190 while (!row
->mode_line_p
14191 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14192 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14193 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14194 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14195 row
> w
->current_matrix
->rows
14196 && (row
-1)->ends_in_newline_from_string_p
))))
14197 && (row
->y
> top_scroll_margin
14198 || CHARPOS (startp
) == BEGV
))
14200 xassert (row
->enabled_p
);
14204 /* Consider the following case: Window starts at BEGV,
14205 there is invisible, intangible text at BEGV, so that
14206 display starts at some point START > BEGV. It can
14207 happen that we are called with PT somewhere between
14208 BEGV and START. Try to handle that case. */
14209 if (row
< w
->current_matrix
->rows
14210 || row
->mode_line_p
)
14212 row
= w
->current_matrix
->rows
;
14213 if (row
->mode_line_p
)
14217 /* Due to newlines in overlay strings, we may have to
14218 skip forward over overlay strings. */
14219 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14220 && MATRIX_ROW_END_CHARPOS (row
) == PT
14221 && !cursor_row_p (row
))
14224 /* If within the scroll margin, scroll. */
14225 if (row
->y
< top_scroll_margin
14226 && CHARPOS (startp
) != BEGV
)
14231 /* Cursor did not move. So don't scroll even if cursor line
14232 is partially visible, as it was so before. */
14233 rc
= CURSOR_MOVEMENT_SUCCESS
;
14236 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14237 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14239 /* if PT is not in the glyph row, give up. */
14240 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14243 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14244 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14246 /* If rows are bidi-reordered and point moved, back up
14247 until we find a row that does not belong to a
14248 continuation line. This is because we must consider
14249 all rows of a continued line as candidates for the
14250 new cursor positioning, since row start and end
14251 positions change non-linearly with vertical position
14253 /* FIXME: Revisit this when glyph ``spilling'' in
14254 continuation lines' rows is implemented for
14255 bidi-reordered rows. */
14256 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14258 xassert (row
->enabled_p
);
14260 /* If we hit the beginning of the displayed portion
14261 without finding the first row of a continued
14263 if (row
<= w
->current_matrix
->rows
)
14265 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14273 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14274 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14275 && make_cursor_line_fully_visible_p
)
14277 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14278 && !row
->ends_at_zv_p
14279 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14280 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14281 else if (row
->height
> window_box_height (w
))
14283 /* If we end up in a partially visible line, let's
14284 make it fully visible, except when it's taller
14285 than the window, in which case we can't do much
14288 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14292 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14293 if (!cursor_row_fully_visible_p (w
, 0, 1))
14294 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14296 rc
= CURSOR_MOVEMENT_SUCCESS
;
14300 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14301 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14302 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14304 /* With bidi-reordered rows, there could be more than
14305 one candidate row whose start and end positions
14306 occlude point. We need to let set_cursor_from_row
14307 find the best candidate. */
14308 /* FIXME: Revisit this when glyph ``spilling'' in
14309 continuation lines' rows is implemented for
14310 bidi-reordered rows. */
14315 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14316 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14317 && cursor_row_p (row
))
14318 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14320 /* As soon as we've found the first suitable row
14321 whose ends_at_zv_p flag is set, we are done. */
14323 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14325 rc
= CURSOR_MOVEMENT_SUCCESS
;
14330 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14331 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14332 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14333 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14334 /* If we didn't find any candidate rows, or exited the
14335 loop before all the candidates were examined, signal
14336 to the caller that this method failed. */
14337 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14338 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14339 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14341 rc
= CURSOR_MOVEMENT_SUCCESS
;
14347 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14349 rc
= CURSOR_MOVEMENT_SUCCESS
;
14354 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14355 && MATRIX_ROW_START_CHARPOS (row
) == PT
14356 && cursor_row_p (row
));
14364 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14368 set_vertical_scroll_bar (struct window
*w
)
14370 EMACS_INT start
, end
, whole
;
14372 /* Calculate the start and end positions for the current window.
14373 At some point, it would be nice to choose between scrollbars
14374 which reflect the whole buffer size, with special markers
14375 indicating narrowing, and scrollbars which reflect only the
14378 Note that mini-buffers sometimes aren't displaying any text. */
14379 if (!MINI_WINDOW_P (w
)
14380 || (w
== XWINDOW (minibuf_window
)
14381 && NILP (echo_area_buffer
[0])))
14383 struct buffer
*buf
= XBUFFER (w
->buffer
);
14384 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14385 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14386 /* I don't think this is guaranteed to be right. For the
14387 moment, we'll pretend it is. */
14388 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14392 if (whole
< (end
- start
))
14393 whole
= end
- start
;
14396 start
= end
= whole
= 0;
14398 /* Indicate what this scroll bar ought to be displaying now. */
14399 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14400 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14401 (w
, end
- start
, whole
, start
);
14405 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14406 selected_window is redisplayed.
14408 We can return without actually redisplaying the window if
14409 fonts_changed_p is nonzero. In that case, redisplay_internal will
14413 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14415 struct window
*w
= XWINDOW (window
);
14416 struct frame
*f
= XFRAME (w
->frame
);
14417 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14418 struct buffer
*old
= current_buffer
;
14419 struct text_pos lpoint
, opoint
, startp
;
14420 int update_mode_line
;
14423 /* Record it now because it's overwritten. */
14424 int current_matrix_up_to_date_p
= 0;
14425 int used_current_matrix_p
= 0;
14426 /* This is less strict than current_matrix_up_to_date_p.
14427 It indictes that the buffer contents and narrowing are unchanged. */
14428 int buffer_unchanged_p
= 0;
14429 int temp_scroll_step
= 0;
14430 int count
= SPECPDL_INDEX ();
14432 int centering_position
= -1;
14433 int last_line_misfit
= 0;
14434 EMACS_INT beg_unchanged
, end_unchanged
;
14436 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14439 /* W must be a leaf window here. */
14440 xassert (!NILP (w
->buffer
));
14442 *w
->desired_matrix
->method
= 0;
14446 reconsider_clip_changes (w
, buffer
);
14448 /* Has the mode line to be updated? */
14449 update_mode_line
= (!NILP (w
->update_mode_line
)
14450 || update_mode_lines
14451 || buffer
->clip_changed
14452 || buffer
->prevent_redisplay_optimizations_p
);
14454 if (MINI_WINDOW_P (w
))
14456 if (w
== XWINDOW (echo_area_window
)
14457 && !NILP (echo_area_buffer
[0]))
14459 if (update_mode_line
)
14460 /* We may have to update a tty frame's menu bar or a
14461 tool-bar. Example `M-x C-h C-h C-g'. */
14462 goto finish_menu_bars
;
14464 /* We've already displayed the echo area glyphs in this window. */
14465 goto finish_scroll_bars
;
14467 else if ((w
!= XWINDOW (minibuf_window
)
14468 || minibuf_level
== 0)
14469 /* When buffer is nonempty, redisplay window normally. */
14470 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14471 /* Quail displays non-mini buffers in minibuffer window.
14472 In that case, redisplay the window normally. */
14473 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14475 /* W is a mini-buffer window, but it's not active, so clear
14477 int yb
= window_text_bottom_y (w
);
14478 struct glyph_row
*row
;
14481 for (y
= 0, row
= w
->desired_matrix
->rows
;
14483 y
+= row
->height
, ++row
)
14484 blank_row (w
, row
, y
);
14485 goto finish_scroll_bars
;
14488 clear_glyph_matrix (w
->desired_matrix
);
14491 /* Otherwise set up data on this window; select its buffer and point
14493 /* Really select the buffer, for the sake of buffer-local
14495 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14497 current_matrix_up_to_date_p
14498 = (!NILP (w
->window_end_valid
)
14499 && !current_buffer
->clip_changed
14500 && !current_buffer
->prevent_redisplay_optimizations_p
14501 && XFASTINT (w
->last_modified
) >= MODIFF
14502 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14504 /* Run the window-bottom-change-functions
14505 if it is possible that the text on the screen has changed
14506 (either due to modification of the text, or any other reason). */
14507 if (!current_matrix_up_to_date_p
14508 && !NILP (Vwindow_text_change_functions
))
14510 safe_run_hooks (Qwindow_text_change_functions
);
14514 beg_unchanged
= BEG_UNCHANGED
;
14515 end_unchanged
= END_UNCHANGED
;
14517 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14519 specbind (Qinhibit_point_motion_hooks
, Qt
);
14522 = (!NILP (w
->window_end_valid
)
14523 && !current_buffer
->clip_changed
14524 && XFASTINT (w
->last_modified
) >= MODIFF
14525 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14527 /* When windows_or_buffers_changed is non-zero, we can't rely on
14528 the window end being valid, so set it to nil there. */
14529 if (windows_or_buffers_changed
)
14531 /* If window starts on a continuation line, maybe adjust the
14532 window start in case the window's width changed. */
14533 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14534 compute_window_start_on_continuation_line (w
);
14536 w
->window_end_valid
= Qnil
;
14539 /* Some sanity checks. */
14540 CHECK_WINDOW_END (w
);
14541 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14543 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14546 /* If %c is in mode line, update it if needed. */
14547 if (!NILP (w
->column_number_displayed
)
14548 /* This alternative quickly identifies a common case
14549 where no change is needed. */
14550 && !(PT
== XFASTINT (w
->last_point
)
14551 && XFASTINT (w
->last_modified
) >= MODIFF
14552 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14553 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14554 update_mode_line
= 1;
14556 /* Count number of windows showing the selected buffer. An indirect
14557 buffer counts as its base buffer. */
14558 if (!just_this_one_p
)
14560 struct buffer
*current_base
, *window_base
;
14561 current_base
= current_buffer
;
14562 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14563 if (current_base
->base_buffer
)
14564 current_base
= current_base
->base_buffer
;
14565 if (window_base
->base_buffer
)
14566 window_base
= window_base
->base_buffer
;
14567 if (current_base
== window_base
)
14571 /* Point refers normally to the selected window. For any other
14572 window, set up appropriate value. */
14573 if (!EQ (window
, selected_window
))
14575 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14576 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14580 new_pt_byte
= BEGV_BYTE
;
14581 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14583 else if (new_pt
> (ZV
- 1))
14586 new_pt_byte
= ZV_BYTE
;
14587 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14590 /* We don't use SET_PT so that the point-motion hooks don't run. */
14591 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14594 /* If any of the character widths specified in the display table
14595 have changed, invalidate the width run cache. It's true that
14596 this may be a bit late to catch such changes, but the rest of
14597 redisplay goes (non-fatally) haywire when the display table is
14598 changed, so why should we worry about doing any better? */
14599 if (current_buffer
->width_run_cache
)
14601 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14603 if (! disptab_matches_widthtab (disptab
,
14604 XVECTOR (BVAR (current_buffer
, width_table
))))
14606 invalidate_region_cache (current_buffer
,
14607 current_buffer
->width_run_cache
,
14609 recompute_width_table (current_buffer
, disptab
);
14613 /* If window-start is screwed up, choose a new one. */
14614 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14617 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14619 /* If someone specified a new starting point but did not insist,
14620 check whether it can be used. */
14621 if (!NILP (w
->optional_new_start
)
14622 && CHARPOS (startp
) >= BEGV
14623 && CHARPOS (startp
) <= ZV
)
14625 w
->optional_new_start
= Qnil
;
14626 start_display (&it
, w
, startp
);
14627 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14628 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14629 if (IT_CHARPOS (it
) == PT
)
14630 w
->force_start
= Qt
;
14631 /* IT may overshoot PT if text at PT is invisible. */
14632 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14633 w
->force_start
= Qt
;
14638 /* Handle case where place to start displaying has been specified,
14639 unless the specified location is outside the accessible range. */
14640 if (!NILP (w
->force_start
)
14641 || w
->frozen_window_start_p
)
14643 /* We set this later on if we have to adjust point. */
14646 w
->force_start
= Qnil
;
14648 w
->window_end_valid
= Qnil
;
14650 /* Forget any recorded base line for line number display. */
14651 if (!buffer_unchanged_p
)
14652 w
->base_line_number
= Qnil
;
14654 /* Redisplay the mode line. Select the buffer properly for that.
14655 Also, run the hook window-scroll-functions
14656 because we have scrolled. */
14657 /* Note, we do this after clearing force_start because
14658 if there's an error, it is better to forget about force_start
14659 than to get into an infinite loop calling the hook functions
14660 and having them get more errors. */
14661 if (!update_mode_line
14662 || ! NILP (Vwindow_scroll_functions
))
14664 update_mode_line
= 1;
14665 w
->update_mode_line
= Qt
;
14666 startp
= run_window_scroll_functions (window
, startp
);
14669 w
->last_modified
= make_number (0);
14670 w
->last_overlay_modified
= make_number (0);
14671 if (CHARPOS (startp
) < BEGV
)
14672 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14673 else if (CHARPOS (startp
) > ZV
)
14674 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14676 /* Redisplay, then check if cursor has been set during the
14677 redisplay. Give up if new fonts were loaded. */
14678 /* We used to issue a CHECK_MARGINS argument to try_window here,
14679 but this causes scrolling to fail when point begins inside
14680 the scroll margin (bug#148) -- cyd */
14681 if (!try_window (window
, startp
, 0))
14683 w
->force_start
= Qt
;
14684 clear_glyph_matrix (w
->desired_matrix
);
14685 goto need_larger_matrices
;
14688 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14690 /* If point does not appear, try to move point so it does
14691 appear. The desired matrix has been built above, so we
14692 can use it here. */
14693 new_vpos
= window_box_height (w
) / 2;
14696 if (!cursor_row_fully_visible_p (w
, 0, 0))
14698 /* Point does appear, but on a line partly visible at end of window.
14699 Move it back to a fully-visible line. */
14700 new_vpos
= window_box_height (w
);
14703 /* If we need to move point for either of the above reasons,
14704 now actually do it. */
14707 struct glyph_row
*row
;
14709 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14710 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14713 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14714 MATRIX_ROW_START_BYTEPOS (row
));
14716 if (w
!= XWINDOW (selected_window
))
14717 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14718 else if (current_buffer
== old
)
14719 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14721 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14723 /* If we are highlighting the region, then we just changed
14724 the region, so redisplay to show it. */
14725 if (!NILP (Vtransient_mark_mode
)
14726 && !NILP (BVAR (current_buffer
, mark_active
)))
14728 clear_glyph_matrix (w
->desired_matrix
);
14729 if (!try_window (window
, startp
, 0))
14730 goto need_larger_matrices
;
14735 debug_method_add (w
, "forced window start");
14740 /* Handle case where text has not changed, only point, and it has
14741 not moved off the frame, and we are not retrying after hscroll.
14742 (current_matrix_up_to_date_p is nonzero when retrying.) */
14743 if (current_matrix_up_to_date_p
14744 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14745 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14749 case CURSOR_MOVEMENT_SUCCESS
:
14750 used_current_matrix_p
= 1;
14753 case CURSOR_MOVEMENT_MUST_SCROLL
:
14754 goto try_to_scroll
;
14760 /* If current starting point was originally the beginning of a line
14761 but no longer is, find a new starting point. */
14762 else if (!NILP (w
->start_at_line_beg
)
14763 && !(CHARPOS (startp
) <= BEGV
14764 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14767 debug_method_add (w
, "recenter 1");
14772 /* Try scrolling with try_window_id. Value is > 0 if update has
14773 been done, it is -1 if we know that the same window start will
14774 not work. It is 0 if unsuccessful for some other reason. */
14775 else if ((tem
= try_window_id (w
)) != 0)
14778 debug_method_add (w
, "try_window_id %d", tem
);
14781 if (fonts_changed_p
)
14782 goto need_larger_matrices
;
14786 /* Otherwise try_window_id has returned -1 which means that we
14787 don't want the alternative below this comment to execute. */
14789 else if (CHARPOS (startp
) >= BEGV
14790 && CHARPOS (startp
) <= ZV
14791 && PT
>= CHARPOS (startp
)
14792 && (CHARPOS (startp
) < ZV
14793 /* Avoid starting at end of buffer. */
14794 || CHARPOS (startp
) == BEGV
14795 || (XFASTINT (w
->last_modified
) >= MODIFF
14796 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14799 /* If first window line is a continuation line, and window start
14800 is inside the modified region, but the first change is before
14801 current window start, we must select a new window start.
14803 However, if this is the result of a down-mouse event (e.g. by
14804 extending the mouse-drag-overlay), we don't want to select a
14805 new window start, since that would change the position under
14806 the mouse, resulting in an unwanted mouse-movement rather
14807 than a simple mouse-click. */
14808 if (NILP (w
->start_at_line_beg
)
14809 && NILP (do_mouse_tracking
)
14810 && CHARPOS (startp
) > BEGV
14811 && CHARPOS (startp
) > BEG
+ beg_unchanged
14812 && CHARPOS (startp
) <= Z
- end_unchanged
14813 /* Even if w->start_at_line_beg is nil, a new window may
14814 start at a line_beg, since that's how set_buffer_window
14815 sets it. So, we need to check the return value of
14816 compute_window_start_on_continuation_line. (See also
14818 && XMARKER (w
->start
)->buffer
== current_buffer
14819 && compute_window_start_on_continuation_line (w
))
14821 w
->force_start
= Qt
;
14822 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14827 debug_method_add (w
, "same window start");
14830 /* Try to redisplay starting at same place as before.
14831 If point has not moved off frame, accept the results. */
14832 if (!current_matrix_up_to_date_p
14833 /* Don't use try_window_reusing_current_matrix in this case
14834 because a window scroll function can have changed the
14836 || !NILP (Vwindow_scroll_functions
)
14837 || MINI_WINDOW_P (w
)
14838 || !(used_current_matrix_p
14839 = try_window_reusing_current_matrix (w
)))
14841 IF_DEBUG (debug_method_add (w
, "1"));
14842 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14843 /* -1 means we need to scroll.
14844 0 means we need new matrices, but fonts_changed_p
14845 is set in that case, so we will detect it below. */
14846 goto try_to_scroll
;
14849 if (fonts_changed_p
)
14850 goto need_larger_matrices
;
14852 if (w
->cursor
.vpos
>= 0)
14854 if (!just_this_one_p
14855 || current_buffer
->clip_changed
14856 || BEG_UNCHANGED
< CHARPOS (startp
))
14857 /* Forget any recorded base line for line number display. */
14858 w
->base_line_number
= Qnil
;
14860 if (!cursor_row_fully_visible_p (w
, 1, 0))
14862 clear_glyph_matrix (w
->desired_matrix
);
14863 last_line_misfit
= 1;
14865 /* Drop through and scroll. */
14870 clear_glyph_matrix (w
->desired_matrix
);
14875 w
->last_modified
= make_number (0);
14876 w
->last_overlay_modified
= make_number (0);
14878 /* Redisplay the mode line. Select the buffer properly for that. */
14879 if (!update_mode_line
)
14881 update_mode_line
= 1;
14882 w
->update_mode_line
= Qt
;
14885 /* Try to scroll by specified few lines. */
14886 if ((scroll_conservatively
14887 || emacs_scroll_step
14888 || temp_scroll_step
14889 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14890 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14891 && CHARPOS (startp
) >= BEGV
14892 && CHARPOS (startp
) <= ZV
)
14894 /* The function returns -1 if new fonts were loaded, 1 if
14895 successful, 0 if not successful. */
14896 int ss
= try_scrolling (window
, just_this_one_p
,
14897 scroll_conservatively
,
14899 temp_scroll_step
, last_line_misfit
);
14902 case SCROLLING_SUCCESS
:
14905 case SCROLLING_NEED_LARGER_MATRICES
:
14906 goto need_larger_matrices
;
14908 case SCROLLING_FAILED
:
14916 /* Finally, just choose a place to start which positions point
14917 according to user preferences. */
14922 debug_method_add (w
, "recenter");
14925 /* w->vscroll = 0; */
14927 /* Forget any previously recorded base line for line number display. */
14928 if (!buffer_unchanged_p
)
14929 w
->base_line_number
= Qnil
;
14931 /* Determine the window start relative to point. */
14932 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14933 it
.current_y
= it
.last_visible_y
;
14934 if (centering_position
< 0)
14938 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14940 EMACS_INT margin_pos
= CHARPOS (startp
);
14942 Lisp_Object aggressive
;
14944 /* If there is a scroll margin at the top of the window, find
14945 its character position. */
14947 /* Cannot call start_display if startp is not in the
14948 accessible region of the buffer. This can happen when we
14949 have just switched to a different buffer and/or changed
14950 its restriction. In that case, startp is initialized to
14951 the character position 1 (BEG) because we did not yet
14952 have chance to display the buffer even once. */
14953 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14956 void *it1data
= NULL
;
14958 SAVE_IT (it1
, it
, it1data
);
14959 start_display (&it1
, w
, startp
);
14960 move_it_vertically (&it1
, margin
);
14961 margin_pos
= IT_CHARPOS (it1
);
14962 RESTORE_IT (&it
, &it
, it1data
);
14964 scrolling_up
= PT
> margin_pos
;
14967 ? BVAR (current_buffer
, scroll_up_aggressively
)
14968 : BVAR (current_buffer
, scroll_down_aggressively
);
14970 if (!MINI_WINDOW_P (w
)
14971 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14975 /* Setting scroll-conservatively overrides
14976 scroll-*-aggressively. */
14977 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14979 double float_amount
= XFLOATINT (aggressive
);
14981 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14982 if (pt_offset
== 0 && float_amount
> 0)
14987 /* Compute how much to move the window start backward from
14988 point so that point will be displayed where the user
14992 centering_position
= it
.last_visible_y
;
14994 centering_position
-= pt_offset
;
14995 centering_position
-=
14996 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14997 /* Don't let point enter the scroll margin near top of
14999 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15000 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15003 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15006 /* Set the window start half the height of the window backward
15008 centering_position
= window_box_height (w
) / 2;
15010 move_it_vertically_backward (&it
, centering_position
);
15012 xassert (IT_CHARPOS (it
) >= BEGV
);
15014 /* The function move_it_vertically_backward may move over more
15015 than the specified y-distance. If it->w is small, e.g. a
15016 mini-buffer window, we may end up in front of the window's
15017 display area. Start displaying at the start of the line
15018 containing PT in this case. */
15019 if (it
.current_y
<= 0)
15021 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15022 move_it_vertically_backward (&it
, 0);
15026 it
.current_x
= it
.hpos
= 0;
15028 /* Set the window start position here explicitly, to avoid an
15029 infinite loop in case the functions in window-scroll-functions
15031 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15033 /* Run scroll hooks. */
15034 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15036 /* Redisplay the window. */
15037 if (!current_matrix_up_to_date_p
15038 || windows_or_buffers_changed
15039 || cursor_type_changed
15040 /* Don't use try_window_reusing_current_matrix in this case
15041 because it can have changed the buffer. */
15042 || !NILP (Vwindow_scroll_functions
)
15043 || !just_this_one_p
15044 || MINI_WINDOW_P (w
)
15045 || !(used_current_matrix_p
15046 = try_window_reusing_current_matrix (w
)))
15047 try_window (window
, startp
, 0);
15049 /* If new fonts have been loaded (due to fontsets), give up. We
15050 have to start a new redisplay since we need to re-adjust glyph
15052 if (fonts_changed_p
)
15053 goto need_larger_matrices
;
15055 /* If cursor did not appear assume that the middle of the window is
15056 in the first line of the window. Do it again with the next line.
15057 (Imagine a window of height 100, displaying two lines of height
15058 60. Moving back 50 from it->last_visible_y will end in the first
15060 if (w
->cursor
.vpos
< 0)
15062 if (!NILP (w
->window_end_valid
)
15063 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15065 clear_glyph_matrix (w
->desired_matrix
);
15066 move_it_by_lines (&it
, 1);
15067 try_window (window
, it
.current
.pos
, 0);
15069 else if (PT
< IT_CHARPOS (it
))
15071 clear_glyph_matrix (w
->desired_matrix
);
15072 move_it_by_lines (&it
, -1);
15073 try_window (window
, it
.current
.pos
, 0);
15077 /* Not much we can do about it. */
15081 /* Consider the following case: Window starts at BEGV, there is
15082 invisible, intangible text at BEGV, so that display starts at
15083 some point START > BEGV. It can happen that we are called with
15084 PT somewhere between BEGV and START. Try to handle that case. */
15085 if (w
->cursor
.vpos
< 0)
15087 struct glyph_row
*row
= w
->current_matrix
->rows
;
15088 if (row
->mode_line_p
)
15090 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15093 if (!cursor_row_fully_visible_p (w
, 0, 0))
15095 /* If vscroll is enabled, disable it and try again. */
15099 clear_glyph_matrix (w
->desired_matrix
);
15103 /* If centering point failed to make the whole line visible,
15104 put point at the top instead. That has to make the whole line
15105 visible, if it can be done. */
15106 if (centering_position
== 0)
15109 clear_glyph_matrix (w
->desired_matrix
);
15110 centering_position
= 0;
15116 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15117 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15118 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15121 /* Display the mode line, if we must. */
15122 if ((update_mode_line
15123 /* If window not full width, must redo its mode line
15124 if (a) the window to its side is being redone and
15125 (b) we do a frame-based redisplay. This is a consequence
15126 of how inverted lines are drawn in frame-based redisplay. */
15127 || (!just_this_one_p
15128 && !FRAME_WINDOW_P (f
)
15129 && !WINDOW_FULL_WIDTH_P (w
))
15130 /* Line number to display. */
15131 || INTEGERP (w
->base_line_pos
)
15132 /* Column number is displayed and different from the one displayed. */
15133 || (!NILP (w
->column_number_displayed
)
15134 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15135 /* This means that the window has a mode line. */
15136 && (WINDOW_WANTS_MODELINE_P (w
)
15137 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15139 display_mode_lines (w
);
15141 /* If mode line height has changed, arrange for a thorough
15142 immediate redisplay using the correct mode line height. */
15143 if (WINDOW_WANTS_MODELINE_P (w
)
15144 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15146 fonts_changed_p
= 1;
15147 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15148 = DESIRED_MODE_LINE_HEIGHT (w
);
15151 /* If header line height has changed, arrange for a thorough
15152 immediate redisplay using the correct header line height. */
15153 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15154 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15156 fonts_changed_p
= 1;
15157 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15158 = DESIRED_HEADER_LINE_HEIGHT (w
);
15161 if (fonts_changed_p
)
15162 goto need_larger_matrices
;
15165 if (!line_number_displayed
15166 && !BUFFERP (w
->base_line_pos
))
15168 w
->base_line_pos
= Qnil
;
15169 w
->base_line_number
= Qnil
;
15174 /* When we reach a frame's selected window, redo the frame's menu bar. */
15175 if (update_mode_line
15176 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15178 int redisplay_menu_p
= 0;
15180 if (FRAME_WINDOW_P (f
))
15182 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15183 || defined (HAVE_NS) || defined (USE_GTK)
15184 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15186 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15190 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15192 if (redisplay_menu_p
)
15193 display_menu_bar (w
);
15195 #ifdef HAVE_WINDOW_SYSTEM
15196 if (FRAME_WINDOW_P (f
))
15198 #if defined (USE_GTK) || defined (HAVE_NS)
15199 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15200 redisplay_tool_bar (f
);
15202 if (WINDOWP (f
->tool_bar_window
)
15203 && (FRAME_TOOL_BAR_LINES (f
) > 0
15204 || !NILP (Vauto_resize_tool_bars
))
15205 && redisplay_tool_bar (f
))
15206 ignore_mouse_drag_p
= 1;
15212 #ifdef HAVE_WINDOW_SYSTEM
15213 if (FRAME_WINDOW_P (f
)
15214 && update_window_fringes (w
, (just_this_one_p
15215 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15216 || w
->pseudo_window_p
)))
15220 if (draw_window_fringes (w
, 1))
15221 x_draw_vertical_border (w
);
15225 #endif /* HAVE_WINDOW_SYSTEM */
15227 /* We go to this label, with fonts_changed_p nonzero,
15228 if it is necessary to try again using larger glyph matrices.
15229 We have to redeem the scroll bar even in this case,
15230 because the loop in redisplay_internal expects that. */
15231 need_larger_matrices
:
15233 finish_scroll_bars
:
15235 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15237 /* Set the thumb's position and size. */
15238 set_vertical_scroll_bar (w
);
15240 /* Note that we actually used the scroll bar attached to this
15241 window, so it shouldn't be deleted at the end of redisplay. */
15242 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15243 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15246 /* Restore current_buffer and value of point in it. The window
15247 update may have changed the buffer, so first make sure `opoint'
15248 is still valid (Bug#6177). */
15249 if (CHARPOS (opoint
) < BEGV
)
15250 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15251 else if (CHARPOS (opoint
) > ZV
)
15252 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15254 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15256 set_buffer_internal_1 (old
);
15257 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15258 shorter. This can be caused by log truncation in *Messages*. */
15259 if (CHARPOS (lpoint
) <= ZV
)
15260 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15262 unbind_to (count
, Qnil
);
15266 /* Build the complete desired matrix of WINDOW with a window start
15267 buffer position POS.
15269 Value is 1 if successful. It is zero if fonts were loaded during
15270 redisplay which makes re-adjusting glyph matrices necessary, and -1
15271 if point would appear in the scroll margins.
15272 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15273 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15277 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15279 struct window
*w
= XWINDOW (window
);
15281 struct glyph_row
*last_text_row
= NULL
;
15282 struct frame
*f
= XFRAME (w
->frame
);
15284 /* Make POS the new window start. */
15285 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15287 /* Mark cursor position as unknown. No overlay arrow seen. */
15288 w
->cursor
.vpos
= -1;
15289 overlay_arrow_seen
= 0;
15291 /* Initialize iterator and info to start at POS. */
15292 start_display (&it
, w
, pos
);
15294 /* Display all lines of W. */
15295 while (it
.current_y
< it
.last_visible_y
)
15297 if (display_line (&it
))
15298 last_text_row
= it
.glyph_row
- 1;
15299 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15303 /* Don't let the cursor end in the scroll margins. */
15304 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15305 && !MINI_WINDOW_P (w
))
15307 int this_scroll_margin
;
15309 if (scroll_margin
> 0)
15311 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15312 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15315 this_scroll_margin
= 0;
15317 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15318 && w
->cursor
.y
< this_scroll_margin
15319 && CHARPOS (pos
) > BEGV
15320 && IT_CHARPOS (it
) < ZV
)
15321 /* rms: considering make_cursor_line_fully_visible_p here
15322 seems to give wrong results. We don't want to recenter
15323 when the last line is partly visible, we want to allow
15324 that case to be handled in the usual way. */
15325 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15327 w
->cursor
.vpos
= -1;
15328 clear_glyph_matrix (w
->desired_matrix
);
15333 /* If bottom moved off end of frame, change mode line percentage. */
15334 if (XFASTINT (w
->window_end_pos
) <= 0
15335 && Z
!= IT_CHARPOS (it
))
15336 w
->update_mode_line
= Qt
;
15338 /* Set window_end_pos to the offset of the last character displayed
15339 on the window from the end of current_buffer. Set
15340 window_end_vpos to its row number. */
15343 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15344 w
->window_end_bytepos
15345 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15347 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15349 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15350 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15351 ->displays_text_p
);
15355 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15356 w
->window_end_pos
= make_number (Z
- ZV
);
15357 w
->window_end_vpos
= make_number (0);
15360 /* But that is not valid info until redisplay finishes. */
15361 w
->window_end_valid
= Qnil
;
15367 /************************************************************************
15368 Window redisplay reusing current matrix when buffer has not changed
15369 ************************************************************************/
15371 /* Try redisplay of window W showing an unchanged buffer with a
15372 different window start than the last time it was displayed by
15373 reusing its current matrix. Value is non-zero if successful.
15374 W->start is the new window start. */
15377 try_window_reusing_current_matrix (struct window
*w
)
15379 struct frame
*f
= XFRAME (w
->frame
);
15380 struct glyph_row
*bottom_row
;
15383 struct text_pos start
, new_start
;
15384 int nrows_scrolled
, i
;
15385 struct glyph_row
*last_text_row
;
15386 struct glyph_row
*last_reused_text_row
;
15387 struct glyph_row
*start_row
;
15388 int start_vpos
, min_y
, max_y
;
15391 if (inhibit_try_window_reusing
)
15395 if (/* This function doesn't handle terminal frames. */
15396 !FRAME_WINDOW_P (f
)
15397 /* Don't try to reuse the display if windows have been split
15399 || windows_or_buffers_changed
15400 || cursor_type_changed
)
15403 /* Can't do this if region may have changed. */
15404 if ((!NILP (Vtransient_mark_mode
)
15405 && !NILP (BVAR (current_buffer
, mark_active
)))
15406 || !NILP (w
->region_showing
)
15407 || !NILP (Vshow_trailing_whitespace
))
15410 /* If top-line visibility has changed, give up. */
15411 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15412 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15415 /* Give up if old or new display is scrolled vertically. We could
15416 make this function handle this, but right now it doesn't. */
15417 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15418 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15421 /* The variable new_start now holds the new window start. The old
15422 start `start' can be determined from the current matrix. */
15423 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15424 start
= start_row
->minpos
;
15425 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15427 /* Clear the desired matrix for the display below. */
15428 clear_glyph_matrix (w
->desired_matrix
);
15430 if (CHARPOS (new_start
) <= CHARPOS (start
))
15432 /* Don't use this method if the display starts with an ellipsis
15433 displayed for invisible text. It's not easy to handle that case
15434 below, and it's certainly not worth the effort since this is
15435 not a frequent case. */
15436 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15439 IF_DEBUG (debug_method_add (w
, "twu1"));
15441 /* Display up to a row that can be reused. The variable
15442 last_text_row is set to the last row displayed that displays
15443 text. Note that it.vpos == 0 if or if not there is a
15444 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15445 start_display (&it
, w
, new_start
);
15446 w
->cursor
.vpos
= -1;
15447 last_text_row
= last_reused_text_row
= NULL
;
15449 while (it
.current_y
< it
.last_visible_y
15450 && !fonts_changed_p
)
15452 /* If we have reached into the characters in the START row,
15453 that means the line boundaries have changed. So we
15454 can't start copying with the row START. Maybe it will
15455 work to start copying with the following row. */
15456 while (IT_CHARPOS (it
) > CHARPOS (start
))
15458 /* Advance to the next row as the "start". */
15460 start
= start_row
->minpos
;
15461 /* If there are no more rows to try, or just one, give up. */
15462 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15463 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15464 || CHARPOS (start
) == ZV
)
15466 clear_glyph_matrix (w
->desired_matrix
);
15470 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15472 /* If we have reached alignment,
15473 we can copy the rest of the rows. */
15474 if (IT_CHARPOS (it
) == CHARPOS (start
))
15477 if (display_line (&it
))
15478 last_text_row
= it
.glyph_row
- 1;
15481 /* A value of current_y < last_visible_y means that we stopped
15482 at the previous window start, which in turn means that we
15483 have at least one reusable row. */
15484 if (it
.current_y
< it
.last_visible_y
)
15486 struct glyph_row
*row
;
15488 /* IT.vpos always starts from 0; it counts text lines. */
15489 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15491 /* Find PT if not already found in the lines displayed. */
15492 if (w
->cursor
.vpos
< 0)
15494 int dy
= it
.current_y
- start_row
->y
;
15496 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15497 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15499 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15500 dy
, nrows_scrolled
);
15503 clear_glyph_matrix (w
->desired_matrix
);
15508 /* Scroll the display. Do it before the current matrix is
15509 changed. The problem here is that update has not yet
15510 run, i.e. part of the current matrix is not up to date.
15511 scroll_run_hook will clear the cursor, and use the
15512 current matrix to get the height of the row the cursor is
15514 run
.current_y
= start_row
->y
;
15515 run
.desired_y
= it
.current_y
;
15516 run
.height
= it
.last_visible_y
- it
.current_y
;
15518 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15521 FRAME_RIF (f
)->update_window_begin_hook (w
);
15522 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15523 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15524 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15528 /* Shift current matrix down by nrows_scrolled lines. */
15529 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15530 rotate_matrix (w
->current_matrix
,
15532 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15535 /* Disable lines that must be updated. */
15536 for (i
= 0; i
< nrows_scrolled
; ++i
)
15537 (start_row
+ i
)->enabled_p
= 0;
15539 /* Re-compute Y positions. */
15540 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15541 max_y
= it
.last_visible_y
;
15542 for (row
= start_row
+ nrows_scrolled
;
15546 row
->y
= it
.current_y
;
15547 row
->visible_height
= row
->height
;
15549 if (row
->y
< min_y
)
15550 row
->visible_height
-= min_y
- row
->y
;
15551 if (row
->y
+ row
->height
> max_y
)
15552 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15553 row
->redraw_fringe_bitmaps_p
= 1;
15555 it
.current_y
+= row
->height
;
15557 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15558 last_reused_text_row
= row
;
15559 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15563 /* Disable lines in the current matrix which are now
15564 below the window. */
15565 for (++row
; row
< bottom_row
; ++row
)
15566 row
->enabled_p
= row
->mode_line_p
= 0;
15569 /* Update window_end_pos etc.; last_reused_text_row is the last
15570 reused row from the current matrix containing text, if any.
15571 The value of last_text_row is the last displayed line
15572 containing text. */
15573 if (last_reused_text_row
)
15575 w
->window_end_bytepos
15576 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15578 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15580 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15581 w
->current_matrix
));
15583 else if (last_text_row
)
15585 w
->window_end_bytepos
15586 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15588 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15590 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15594 /* This window must be completely empty. */
15595 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15596 w
->window_end_pos
= make_number (Z
- ZV
);
15597 w
->window_end_vpos
= make_number (0);
15599 w
->window_end_valid
= Qnil
;
15601 /* Update hint: don't try scrolling again in update_window. */
15602 w
->desired_matrix
->no_scrolling_p
= 1;
15605 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15609 else if (CHARPOS (new_start
) > CHARPOS (start
))
15611 struct glyph_row
*pt_row
, *row
;
15612 struct glyph_row
*first_reusable_row
;
15613 struct glyph_row
*first_row_to_display
;
15615 int yb
= window_text_bottom_y (w
);
15617 /* Find the row starting at new_start, if there is one. Don't
15618 reuse a partially visible line at the end. */
15619 first_reusable_row
= start_row
;
15620 while (first_reusable_row
->enabled_p
15621 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15622 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15623 < CHARPOS (new_start
)))
15624 ++first_reusable_row
;
15626 /* Give up if there is no row to reuse. */
15627 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15628 || !first_reusable_row
->enabled_p
15629 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15630 != CHARPOS (new_start
)))
15633 /* We can reuse fully visible rows beginning with
15634 first_reusable_row to the end of the window. Set
15635 first_row_to_display to the first row that cannot be reused.
15636 Set pt_row to the row containing point, if there is any. */
15638 for (first_row_to_display
= first_reusable_row
;
15639 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15640 ++first_row_to_display
)
15642 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15643 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15644 pt_row
= first_row_to_display
;
15647 /* Start displaying at the start of first_row_to_display. */
15648 xassert (first_row_to_display
->y
< yb
);
15649 init_to_row_start (&it
, w
, first_row_to_display
);
15651 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15653 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15655 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15656 + WINDOW_HEADER_LINE_HEIGHT (w
));
15658 /* Display lines beginning with first_row_to_display in the
15659 desired matrix. Set last_text_row to the last row displayed
15660 that displays text. */
15661 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15662 if (pt_row
== NULL
)
15663 w
->cursor
.vpos
= -1;
15664 last_text_row
= NULL
;
15665 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15666 if (display_line (&it
))
15667 last_text_row
= it
.glyph_row
- 1;
15669 /* If point is in a reused row, adjust y and vpos of the cursor
15673 w
->cursor
.vpos
-= nrows_scrolled
;
15674 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15677 /* Give up if point isn't in a row displayed or reused. (This
15678 also handles the case where w->cursor.vpos < nrows_scrolled
15679 after the calls to display_line, which can happen with scroll
15680 margins. See bug#1295.) */
15681 if (w
->cursor
.vpos
< 0)
15683 clear_glyph_matrix (w
->desired_matrix
);
15687 /* Scroll the display. */
15688 run
.current_y
= first_reusable_row
->y
;
15689 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15690 run
.height
= it
.last_visible_y
- run
.current_y
;
15691 dy
= run
.current_y
- run
.desired_y
;
15696 FRAME_RIF (f
)->update_window_begin_hook (w
);
15697 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15698 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15699 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15703 /* Adjust Y positions of reused rows. */
15704 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15705 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15706 max_y
= it
.last_visible_y
;
15707 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15710 row
->visible_height
= row
->height
;
15711 if (row
->y
< min_y
)
15712 row
->visible_height
-= min_y
- row
->y
;
15713 if (row
->y
+ row
->height
> max_y
)
15714 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15715 row
->redraw_fringe_bitmaps_p
= 1;
15718 /* Scroll the current matrix. */
15719 xassert (nrows_scrolled
> 0);
15720 rotate_matrix (w
->current_matrix
,
15722 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15725 /* Disable rows not reused. */
15726 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15727 row
->enabled_p
= 0;
15729 /* Point may have moved to a different line, so we cannot assume that
15730 the previous cursor position is valid; locate the correct row. */
15733 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15734 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15738 w
->cursor
.y
= row
->y
;
15740 if (row
< bottom_row
)
15742 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15743 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15745 /* Can't use this optimization with bidi-reordered glyph
15746 rows, unless cursor is already at point. */
15747 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15749 if (!(w
->cursor
.hpos
>= 0
15750 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15751 && BUFFERP (glyph
->object
)
15752 && glyph
->charpos
== PT
))
15757 && (!BUFFERP (glyph
->object
)
15758 || glyph
->charpos
< PT
);
15762 w
->cursor
.x
+= glyph
->pixel_width
;
15767 /* Adjust window end. A null value of last_text_row means that
15768 the window end is in reused rows which in turn means that
15769 only its vpos can have changed. */
15772 w
->window_end_bytepos
15773 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15775 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15777 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15782 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15785 w
->window_end_valid
= Qnil
;
15786 w
->desired_matrix
->no_scrolling_p
= 1;
15789 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15799 /************************************************************************
15800 Window redisplay reusing current matrix when buffer has changed
15801 ************************************************************************/
15803 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15804 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15805 EMACS_INT
*, EMACS_INT
*);
15806 static struct glyph_row
*
15807 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15808 struct glyph_row
*);
15811 /* Return the last row in MATRIX displaying text. If row START is
15812 non-null, start searching with that row. IT gives the dimensions
15813 of the display. Value is null if matrix is empty; otherwise it is
15814 a pointer to the row found. */
15816 static struct glyph_row
*
15817 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15818 struct glyph_row
*start
)
15820 struct glyph_row
*row
, *row_found
;
15822 /* Set row_found to the last row in IT->w's current matrix
15823 displaying text. The loop looks funny but think of partially
15826 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15827 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15829 xassert (row
->enabled_p
);
15831 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15840 /* Return the last row in the current matrix of W that is not affected
15841 by changes at the start of current_buffer that occurred since W's
15842 current matrix was built. Value is null if no such row exists.
15844 BEG_UNCHANGED us the number of characters unchanged at the start of
15845 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15846 first changed character in current_buffer. Characters at positions <
15847 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15848 when the current matrix was built. */
15850 static struct glyph_row
*
15851 find_last_unchanged_at_beg_row (struct window
*w
)
15853 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15854 struct glyph_row
*row
;
15855 struct glyph_row
*row_found
= NULL
;
15856 int yb
= window_text_bottom_y (w
);
15858 /* Find the last row displaying unchanged text. */
15859 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15860 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15861 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15864 if (/* If row ends before first_changed_pos, it is unchanged,
15865 except in some case. */
15866 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15867 /* When row ends in ZV and we write at ZV it is not
15869 && !row
->ends_at_zv_p
15870 /* When first_changed_pos is the end of a continued line,
15871 row is not unchanged because it may be no longer
15873 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15874 && (row
->continued_p
15875 || row
->exact_window_width_line_p
)))
15878 /* Stop if last visible row. */
15879 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15887 /* Find the first glyph row in the current matrix of W that is not
15888 affected by changes at the end of current_buffer since the
15889 time W's current matrix was built.
15891 Return in *DELTA the number of chars by which buffer positions in
15892 unchanged text at the end of current_buffer must be adjusted.
15894 Return in *DELTA_BYTES the corresponding number of bytes.
15896 Value is null if no such row exists, i.e. all rows are affected by
15899 static struct glyph_row
*
15900 find_first_unchanged_at_end_row (struct window
*w
,
15901 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15903 struct glyph_row
*row
;
15904 struct glyph_row
*row_found
= NULL
;
15906 *delta
= *delta_bytes
= 0;
15908 /* Display must not have been paused, otherwise the current matrix
15909 is not up to date. */
15910 eassert (!NILP (w
->window_end_valid
));
15912 /* A value of window_end_pos >= END_UNCHANGED means that the window
15913 end is in the range of changed text. If so, there is no
15914 unchanged row at the end of W's current matrix. */
15915 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15918 /* Set row to the last row in W's current matrix displaying text. */
15919 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15921 /* If matrix is entirely empty, no unchanged row exists. */
15922 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15924 /* The value of row is the last glyph row in the matrix having a
15925 meaningful buffer position in it. The end position of row
15926 corresponds to window_end_pos. This allows us to translate
15927 buffer positions in the current matrix to current buffer
15928 positions for characters not in changed text. */
15930 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15931 EMACS_INT Z_BYTE_old
=
15932 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15933 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15934 struct glyph_row
*first_text_row
15935 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15937 *delta
= Z
- Z_old
;
15938 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15940 /* Set last_unchanged_pos to the buffer position of the last
15941 character in the buffer that has not been changed. Z is the
15942 index + 1 of the last character in current_buffer, i.e. by
15943 subtracting END_UNCHANGED we get the index of the last
15944 unchanged character, and we have to add BEG to get its buffer
15946 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15947 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15949 /* Search backward from ROW for a row displaying a line that
15950 starts at a minimum position >= last_unchanged_pos_old. */
15951 for (; row
> first_text_row
; --row
)
15953 /* This used to abort, but it can happen.
15954 It is ok to just stop the search instead here. KFS. */
15955 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15958 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15963 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15969 /* Make sure that glyph rows in the current matrix of window W
15970 reference the same glyph memory as corresponding rows in the
15971 frame's frame matrix. This function is called after scrolling W's
15972 current matrix on a terminal frame in try_window_id and
15973 try_window_reusing_current_matrix. */
15976 sync_frame_with_window_matrix_rows (struct window
*w
)
15978 struct frame
*f
= XFRAME (w
->frame
);
15979 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15981 /* Preconditions: W must be a leaf window and full-width. Its frame
15982 must have a frame matrix. */
15983 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15984 xassert (WINDOW_FULL_WIDTH_P (w
));
15985 xassert (!FRAME_WINDOW_P (f
));
15987 /* If W is a full-width window, glyph pointers in W's current matrix
15988 have, by definition, to be the same as glyph pointers in the
15989 corresponding frame matrix. Note that frame matrices have no
15990 marginal areas (see build_frame_matrix). */
15991 window_row
= w
->current_matrix
->rows
;
15992 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15993 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15994 while (window_row
< window_row_end
)
15996 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15997 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15999 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16000 frame_row
->glyphs
[TEXT_AREA
] = start
;
16001 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16002 frame_row
->glyphs
[LAST_AREA
] = end
;
16004 /* Disable frame rows whose corresponding window rows have
16005 been disabled in try_window_id. */
16006 if (!window_row
->enabled_p
)
16007 frame_row
->enabled_p
= 0;
16009 ++window_row
, ++frame_row
;
16014 /* Find the glyph row in window W containing CHARPOS. Consider all
16015 rows between START and END (not inclusive). END null means search
16016 all rows to the end of the display area of W. Value is the row
16017 containing CHARPOS or null. */
16020 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16021 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16023 struct glyph_row
*row
= start
;
16024 struct glyph_row
*best_row
= NULL
;
16025 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16028 /* If we happen to start on a header-line, skip that. */
16029 if (row
->mode_line_p
)
16032 if ((end
&& row
>= end
) || !row
->enabled_p
)
16035 last_y
= window_text_bottom_y (w
) - dy
;
16039 /* Give up if we have gone too far. */
16040 if (end
&& row
>= end
)
16042 /* This formerly returned if they were equal.
16043 I think that both quantities are of a "last plus one" type;
16044 if so, when they are equal, the row is within the screen. -- rms. */
16045 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16048 /* If it is in this row, return this row. */
16049 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16050 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16051 /* The end position of a row equals the start
16052 position of the next row. If CHARPOS is there, we
16053 would rather display it in the next line, except
16054 when this line ends in ZV. */
16055 && !row
->ends_at_zv_p
16056 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16057 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16061 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16062 || (!best_row
&& !row
->continued_p
))
16064 /* In bidi-reordered rows, there could be several rows
16065 occluding point, all of them belonging to the same
16066 continued line. We need to find the row which fits
16067 CHARPOS the best. */
16068 for (g
= row
->glyphs
[TEXT_AREA
];
16069 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16072 if (!STRINGP (g
->object
))
16074 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16076 mindif
= eabs (g
->charpos
- charpos
);
16078 /* Exact match always wins. */
16085 else if (best_row
&& !row
->continued_p
)
16092 /* Try to redisplay window W by reusing its existing display. W's
16093 current matrix must be up to date when this function is called,
16094 i.e. window_end_valid must not be nil.
16098 1 if display has been updated
16099 0 if otherwise unsuccessful
16100 -1 if redisplay with same window start is known not to succeed
16102 The following steps are performed:
16104 1. Find the last row in the current matrix of W that is not
16105 affected by changes at the start of current_buffer. If no such row
16108 2. Find the first row in W's current matrix that is not affected by
16109 changes at the end of current_buffer. Maybe there is no such row.
16111 3. Display lines beginning with the row + 1 found in step 1 to the
16112 row found in step 2 or, if step 2 didn't find a row, to the end of
16115 4. If cursor is not known to appear on the window, give up.
16117 5. If display stopped at the row found in step 2, scroll the
16118 display and current matrix as needed.
16120 6. Maybe display some lines at the end of W, if we must. This can
16121 happen under various circumstances, like a partially visible line
16122 becoming fully visible, or because newly displayed lines are displayed
16123 in smaller font sizes.
16125 7. Update W's window end information. */
16128 try_window_id (struct window
*w
)
16130 struct frame
*f
= XFRAME (w
->frame
);
16131 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16132 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16133 struct glyph_row
*last_unchanged_at_beg_row
;
16134 struct glyph_row
*first_unchanged_at_end_row
;
16135 struct glyph_row
*row
;
16136 struct glyph_row
*bottom_row
;
16139 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16141 struct text_pos start_pos
;
16143 int first_unchanged_at_end_vpos
= 0;
16144 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16145 struct text_pos start
;
16146 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16149 if (inhibit_try_window_id
)
16153 /* This is handy for debugging. */
16155 #define GIVE_UP(X) \
16157 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16161 #define GIVE_UP(X) return 0
16164 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16166 /* Don't use this for mini-windows because these can show
16167 messages and mini-buffers, and we don't handle that here. */
16168 if (MINI_WINDOW_P (w
))
16171 /* This flag is used to prevent redisplay optimizations. */
16172 if (windows_or_buffers_changed
|| cursor_type_changed
)
16175 /* Verify that narrowing has not changed.
16176 Also verify that we were not told to prevent redisplay optimizations.
16177 It would be nice to further
16178 reduce the number of cases where this prevents try_window_id. */
16179 if (current_buffer
->clip_changed
16180 || current_buffer
->prevent_redisplay_optimizations_p
)
16183 /* Window must either use window-based redisplay or be full width. */
16184 if (!FRAME_WINDOW_P (f
)
16185 && (!FRAME_LINE_INS_DEL_OK (f
)
16186 || !WINDOW_FULL_WIDTH_P (w
)))
16189 /* Give up if point is known NOT to appear in W. */
16190 if (PT
< CHARPOS (start
))
16193 /* Another way to prevent redisplay optimizations. */
16194 if (XFASTINT (w
->last_modified
) == 0)
16197 /* Verify that window is not hscrolled. */
16198 if (XFASTINT (w
->hscroll
) != 0)
16201 /* Verify that display wasn't paused. */
16202 if (NILP (w
->window_end_valid
))
16205 /* Can't use this if highlighting a region because a cursor movement
16206 will do more than just set the cursor. */
16207 if (!NILP (Vtransient_mark_mode
)
16208 && !NILP (BVAR (current_buffer
, mark_active
)))
16211 /* Likewise if highlighting trailing whitespace. */
16212 if (!NILP (Vshow_trailing_whitespace
))
16215 /* Likewise if showing a region. */
16216 if (!NILP (w
->region_showing
))
16219 /* Can't use this if overlay arrow position and/or string have
16221 if (overlay_arrows_changed_p ())
16224 /* When word-wrap is on, adding a space to the first word of a
16225 wrapped line can change the wrap position, altering the line
16226 above it. It might be worthwhile to handle this more
16227 intelligently, but for now just redisplay from scratch. */
16228 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16231 /* Under bidi reordering, adding or deleting a character in the
16232 beginning of a paragraph, before the first strong directional
16233 character, can change the base direction of the paragraph (unless
16234 the buffer specifies a fixed paragraph direction), which will
16235 require to redisplay the whole paragraph. It might be worthwhile
16236 to find the paragraph limits and widen the range of redisplayed
16237 lines to that, but for now just give up this optimization and
16238 redisplay from scratch. */
16239 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16240 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16243 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16244 only if buffer has really changed. The reason is that the gap is
16245 initially at Z for freshly visited files. The code below would
16246 set end_unchanged to 0 in that case. */
16247 if (MODIFF
> SAVE_MODIFF
16248 /* This seems to happen sometimes after saving a buffer. */
16249 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16251 if (GPT
- BEG
< BEG_UNCHANGED
)
16252 BEG_UNCHANGED
= GPT
- BEG
;
16253 if (Z
- GPT
< END_UNCHANGED
)
16254 END_UNCHANGED
= Z
- GPT
;
16257 /* The position of the first and last character that has been changed. */
16258 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16259 last_changed_charpos
= Z
- END_UNCHANGED
;
16261 /* If window starts after a line end, and the last change is in
16262 front of that newline, then changes don't affect the display.
16263 This case happens with stealth-fontification. Note that although
16264 the display is unchanged, glyph positions in the matrix have to
16265 be adjusted, of course. */
16266 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16267 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16268 && ((last_changed_charpos
< CHARPOS (start
)
16269 && CHARPOS (start
) == BEGV
)
16270 || (last_changed_charpos
< CHARPOS (start
) - 1
16271 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16273 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16274 struct glyph_row
*r0
;
16276 /* Compute how many chars/bytes have been added to or removed
16277 from the buffer. */
16278 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16279 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16280 Z_delta
= Z
- Z_old
;
16281 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16283 /* Give up if PT is not in the window. Note that it already has
16284 been checked at the start of try_window_id that PT is not in
16285 front of the window start. */
16286 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16289 /* If window start is unchanged, we can reuse the whole matrix
16290 as is, after adjusting glyph positions. No need to compute
16291 the window end again, since its offset from Z hasn't changed. */
16292 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16293 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16294 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16295 /* PT must not be in a partially visible line. */
16296 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16297 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16299 /* Adjust positions in the glyph matrix. */
16300 if (Z_delta
|| Z_delta_bytes
)
16302 struct glyph_row
*r1
16303 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16304 increment_matrix_positions (w
->current_matrix
,
16305 MATRIX_ROW_VPOS (r0
, current_matrix
),
16306 MATRIX_ROW_VPOS (r1
, current_matrix
),
16307 Z_delta
, Z_delta_bytes
);
16310 /* Set the cursor. */
16311 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16313 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16320 /* Handle the case that changes are all below what is displayed in
16321 the window, and that PT is in the window. This shortcut cannot
16322 be taken if ZV is visible in the window, and text has been added
16323 there that is visible in the window. */
16324 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16325 /* ZV is not visible in the window, or there are no
16326 changes at ZV, actually. */
16327 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16328 || first_changed_charpos
== last_changed_charpos
))
16330 struct glyph_row
*r0
;
16332 /* Give up if PT is not in the window. Note that it already has
16333 been checked at the start of try_window_id that PT is not in
16334 front of the window start. */
16335 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16338 /* If window start is unchanged, we can reuse the whole matrix
16339 as is, without changing glyph positions since no text has
16340 been added/removed in front of the window end. */
16341 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16342 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16343 /* PT must not be in a partially visible line. */
16344 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16345 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16347 /* We have to compute the window end anew since text
16348 could have been added/removed after it. */
16350 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16351 w
->window_end_bytepos
16352 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16354 /* Set the cursor. */
16355 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16357 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16364 /* Give up if window start is in the changed area.
16366 The condition used to read
16368 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16370 but why that was tested escapes me at the moment. */
16371 if (CHARPOS (start
) >= first_changed_charpos
16372 && CHARPOS (start
) <= last_changed_charpos
)
16375 /* Check that window start agrees with the start of the first glyph
16376 row in its current matrix. Check this after we know the window
16377 start is not in changed text, otherwise positions would not be
16379 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16380 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16383 /* Give up if the window ends in strings. Overlay strings
16384 at the end are difficult to handle, so don't try. */
16385 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16386 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16389 /* Compute the position at which we have to start displaying new
16390 lines. Some of the lines at the top of the window might be
16391 reusable because they are not displaying changed text. Find the
16392 last row in W's current matrix not affected by changes at the
16393 start of current_buffer. Value is null if changes start in the
16394 first line of window. */
16395 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16396 if (last_unchanged_at_beg_row
)
16398 /* Avoid starting to display in the moddle of a character, a TAB
16399 for instance. This is easier than to set up the iterator
16400 exactly, and it's not a frequent case, so the additional
16401 effort wouldn't really pay off. */
16402 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16403 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16404 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16405 --last_unchanged_at_beg_row
;
16407 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16410 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16412 start_pos
= it
.current
.pos
;
16414 /* Start displaying new lines in the desired matrix at the same
16415 vpos we would use in the current matrix, i.e. below
16416 last_unchanged_at_beg_row. */
16417 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16419 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16420 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16422 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16426 /* There are no reusable lines at the start of the window.
16427 Start displaying in the first text line. */
16428 start_display (&it
, w
, start
);
16429 it
.vpos
= it
.first_vpos
;
16430 start_pos
= it
.current
.pos
;
16433 /* Find the first row that is not affected by changes at the end of
16434 the buffer. Value will be null if there is no unchanged row, in
16435 which case we must redisplay to the end of the window. delta
16436 will be set to the value by which buffer positions beginning with
16437 first_unchanged_at_end_row have to be adjusted due to text
16439 first_unchanged_at_end_row
16440 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16441 IF_DEBUG (debug_delta
= delta
);
16442 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16444 /* Set stop_pos to the buffer position up to which we will have to
16445 display new lines. If first_unchanged_at_end_row != NULL, this
16446 is the buffer position of the start of the line displayed in that
16447 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16448 that we don't stop at a buffer position. */
16450 if (first_unchanged_at_end_row
)
16452 xassert (last_unchanged_at_beg_row
== NULL
16453 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16455 /* If this is a continuation line, move forward to the next one
16456 that isn't. Changes in lines above affect this line.
16457 Caution: this may move first_unchanged_at_end_row to a row
16458 not displaying text. */
16459 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16460 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16461 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16462 < it
.last_visible_y
))
16463 ++first_unchanged_at_end_row
;
16465 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16466 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16467 >= it
.last_visible_y
))
16468 first_unchanged_at_end_row
= NULL
;
16471 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16473 first_unchanged_at_end_vpos
16474 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16475 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16478 else if (last_unchanged_at_beg_row
== NULL
)
16484 /* Either there is no unchanged row at the end, or the one we have
16485 now displays text. This is a necessary condition for the window
16486 end pos calculation at the end of this function. */
16487 xassert (first_unchanged_at_end_row
== NULL
16488 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16490 debug_last_unchanged_at_beg_vpos
16491 = (last_unchanged_at_beg_row
16492 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16494 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16496 #endif /* GLYPH_DEBUG != 0 */
16499 /* Display new lines. Set last_text_row to the last new line
16500 displayed which has text on it, i.e. might end up as being the
16501 line where the window_end_vpos is. */
16502 w
->cursor
.vpos
= -1;
16503 last_text_row
= NULL
;
16504 overlay_arrow_seen
= 0;
16505 while (it
.current_y
< it
.last_visible_y
16506 && !fonts_changed_p
16507 && (first_unchanged_at_end_row
== NULL
16508 || IT_CHARPOS (it
) < stop_pos
))
16510 if (display_line (&it
))
16511 last_text_row
= it
.glyph_row
- 1;
16514 if (fonts_changed_p
)
16518 /* Compute differences in buffer positions, y-positions etc. for
16519 lines reused at the bottom of the window. Compute what we can
16521 if (first_unchanged_at_end_row
16522 /* No lines reused because we displayed everything up to the
16523 bottom of the window. */
16524 && it
.current_y
< it
.last_visible_y
)
16527 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16529 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16530 run
.current_y
= first_unchanged_at_end_row
->y
;
16531 run
.desired_y
= run
.current_y
+ dy
;
16532 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16536 delta
= delta_bytes
= dvpos
= dy
16537 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16538 first_unchanged_at_end_row
= NULL
;
16540 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16543 /* Find the cursor if not already found. We have to decide whether
16544 PT will appear on this window (it sometimes doesn't, but this is
16545 not a very frequent case.) This decision has to be made before
16546 the current matrix is altered. A value of cursor.vpos < 0 means
16547 that PT is either in one of the lines beginning at
16548 first_unchanged_at_end_row or below the window. Don't care for
16549 lines that might be displayed later at the window end; as
16550 mentioned, this is not a frequent case. */
16551 if (w
->cursor
.vpos
< 0)
16553 /* Cursor in unchanged rows at the top? */
16554 if (PT
< CHARPOS (start_pos
)
16555 && last_unchanged_at_beg_row
)
16557 row
= row_containing_pos (w
, PT
,
16558 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16559 last_unchanged_at_beg_row
+ 1, 0);
16561 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16564 /* Start from first_unchanged_at_end_row looking for PT. */
16565 else if (first_unchanged_at_end_row
)
16567 row
= row_containing_pos (w
, PT
- delta
,
16568 first_unchanged_at_end_row
, NULL
, 0);
16570 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16571 delta_bytes
, dy
, dvpos
);
16574 /* Give up if cursor was not found. */
16575 if (w
->cursor
.vpos
< 0)
16577 clear_glyph_matrix (w
->desired_matrix
);
16582 /* Don't let the cursor end in the scroll margins. */
16584 int this_scroll_margin
, cursor_height
;
16586 this_scroll_margin
= max (0, scroll_margin
);
16587 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16588 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16589 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16591 if ((w
->cursor
.y
< this_scroll_margin
16592 && CHARPOS (start
) > BEGV
)
16593 /* Old redisplay didn't take scroll margin into account at the bottom,
16594 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16595 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16596 ? cursor_height
+ this_scroll_margin
16597 : 1)) > it
.last_visible_y
)
16599 w
->cursor
.vpos
= -1;
16600 clear_glyph_matrix (w
->desired_matrix
);
16605 /* Scroll the display. Do it before changing the current matrix so
16606 that xterm.c doesn't get confused about where the cursor glyph is
16608 if (dy
&& run
.height
)
16612 if (FRAME_WINDOW_P (f
))
16614 FRAME_RIF (f
)->update_window_begin_hook (w
);
16615 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16616 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16617 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16621 /* Terminal frame. In this case, dvpos gives the number of
16622 lines to scroll by; dvpos < 0 means scroll up. */
16624 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16625 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16626 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16627 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16628 + window_internal_height (w
));
16630 #if defined (HAVE_GPM) || defined (MSDOS)
16631 x_clear_window_mouse_face (w
);
16633 /* Perform the operation on the screen. */
16636 /* Scroll last_unchanged_at_beg_row to the end of the
16637 window down dvpos lines. */
16638 set_terminal_window (f
, end
);
16640 /* On dumb terminals delete dvpos lines at the end
16641 before inserting dvpos empty lines. */
16642 if (!FRAME_SCROLL_REGION_OK (f
))
16643 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16645 /* Insert dvpos empty lines in front of
16646 last_unchanged_at_beg_row. */
16647 ins_del_lines (f
, from
, dvpos
);
16649 else if (dvpos
< 0)
16651 /* Scroll up last_unchanged_at_beg_vpos to the end of
16652 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16653 set_terminal_window (f
, end
);
16655 /* Delete dvpos lines in front of
16656 last_unchanged_at_beg_vpos. ins_del_lines will set
16657 the cursor to the given vpos and emit |dvpos| delete
16659 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16661 /* On a dumb terminal insert dvpos empty lines at the
16663 if (!FRAME_SCROLL_REGION_OK (f
))
16664 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16667 set_terminal_window (f
, 0);
16673 /* Shift reused rows of the current matrix to the right position.
16674 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16676 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16677 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16680 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16681 bottom_vpos
, dvpos
);
16682 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16685 else if (dvpos
> 0)
16687 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16688 bottom_vpos
, dvpos
);
16689 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16690 first_unchanged_at_end_vpos
+ dvpos
, 0);
16693 /* For frame-based redisplay, make sure that current frame and window
16694 matrix are in sync with respect to glyph memory. */
16695 if (!FRAME_WINDOW_P (f
))
16696 sync_frame_with_window_matrix_rows (w
);
16698 /* Adjust buffer positions in reused rows. */
16699 if (delta
|| delta_bytes
)
16700 increment_matrix_positions (current_matrix
,
16701 first_unchanged_at_end_vpos
+ dvpos
,
16702 bottom_vpos
, delta
, delta_bytes
);
16704 /* Adjust Y positions. */
16706 shift_glyph_matrix (w
, current_matrix
,
16707 first_unchanged_at_end_vpos
+ dvpos
,
16710 if (first_unchanged_at_end_row
)
16712 first_unchanged_at_end_row
+= dvpos
;
16713 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16714 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16715 first_unchanged_at_end_row
= NULL
;
16718 /* If scrolling up, there may be some lines to display at the end of
16720 last_text_row_at_end
= NULL
;
16723 /* Scrolling up can leave for example a partially visible line
16724 at the end of the window to be redisplayed. */
16725 /* Set last_row to the glyph row in the current matrix where the
16726 window end line is found. It has been moved up or down in
16727 the matrix by dvpos. */
16728 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16729 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16731 /* If last_row is the window end line, it should display text. */
16732 xassert (last_row
->displays_text_p
);
16734 /* If window end line was partially visible before, begin
16735 displaying at that line. Otherwise begin displaying with the
16736 line following it. */
16737 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16739 init_to_row_start (&it
, w
, last_row
);
16740 it
.vpos
= last_vpos
;
16741 it
.current_y
= last_row
->y
;
16745 init_to_row_end (&it
, w
, last_row
);
16746 it
.vpos
= 1 + last_vpos
;
16747 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16751 /* We may start in a continuation line. If so, we have to
16752 get the right continuation_lines_width and current_x. */
16753 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16754 it
.hpos
= it
.current_x
= 0;
16756 /* Display the rest of the lines at the window end. */
16757 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16758 while (it
.current_y
< it
.last_visible_y
16759 && !fonts_changed_p
)
16761 /* Is it always sure that the display agrees with lines in
16762 the current matrix? I don't think so, so we mark rows
16763 displayed invalid in the current matrix by setting their
16764 enabled_p flag to zero. */
16765 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16766 if (display_line (&it
))
16767 last_text_row_at_end
= it
.glyph_row
- 1;
16771 /* Update window_end_pos and window_end_vpos. */
16772 if (first_unchanged_at_end_row
16773 && !last_text_row_at_end
)
16775 /* Window end line if one of the preserved rows from the current
16776 matrix. Set row to the last row displaying text in current
16777 matrix starting at first_unchanged_at_end_row, after
16779 xassert (first_unchanged_at_end_row
->displays_text_p
);
16780 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16781 first_unchanged_at_end_row
);
16782 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16784 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16785 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16787 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16788 xassert (w
->window_end_bytepos
>= 0);
16789 IF_DEBUG (debug_method_add (w
, "A"));
16791 else if (last_text_row_at_end
)
16794 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16795 w
->window_end_bytepos
16796 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16798 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16799 xassert (w
->window_end_bytepos
>= 0);
16800 IF_DEBUG (debug_method_add (w
, "B"));
16802 else if (last_text_row
)
16804 /* We have displayed either to the end of the window or at the
16805 end of the window, i.e. the last row with text is to be found
16806 in the desired matrix. */
16808 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16809 w
->window_end_bytepos
16810 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16812 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16813 xassert (w
->window_end_bytepos
>= 0);
16815 else if (first_unchanged_at_end_row
== NULL
16816 && last_text_row
== NULL
16817 && last_text_row_at_end
== NULL
)
16819 /* Displayed to end of window, but no line containing text was
16820 displayed. Lines were deleted at the end of the window. */
16821 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16822 int vpos
= XFASTINT (w
->window_end_vpos
);
16823 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16824 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16827 row
== NULL
&& vpos
>= first_vpos
;
16828 --vpos
, --current_row
, --desired_row
)
16830 if (desired_row
->enabled_p
)
16832 if (desired_row
->displays_text_p
)
16835 else if (current_row
->displays_text_p
)
16839 xassert (row
!= NULL
);
16840 w
->window_end_vpos
= make_number (vpos
+ 1);
16841 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16842 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16843 xassert (w
->window_end_bytepos
>= 0);
16844 IF_DEBUG (debug_method_add (w
, "C"));
16849 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16850 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16852 /* Record that display has not been completed. */
16853 w
->window_end_valid
= Qnil
;
16854 w
->desired_matrix
->no_scrolling_p
= 1;
16862 /***********************************************************************
16863 More debugging support
16864 ***********************************************************************/
16868 void dump_glyph_row (struct glyph_row
*, int, int);
16869 void dump_glyph_matrix (struct glyph_matrix
*, int);
16870 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16873 /* Dump the contents of glyph matrix MATRIX on stderr.
16875 GLYPHS 0 means don't show glyph contents.
16876 GLYPHS 1 means show glyphs in short form
16877 GLYPHS > 1 means show glyphs in long form. */
16880 dump_glyph_matrix (matrix
, glyphs
)
16881 struct glyph_matrix
*matrix
;
16885 for (i
= 0; i
< matrix
->nrows
; ++i
)
16886 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16890 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16891 the glyph row and area where the glyph comes from. */
16894 dump_glyph (row
, glyph
, area
)
16895 struct glyph_row
*row
;
16896 struct glyph
*glyph
;
16899 if (glyph
->type
== CHAR_GLYPH
)
16902 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16903 glyph
- row
->glyphs
[TEXT_AREA
],
16906 (BUFFERP (glyph
->object
)
16908 : (STRINGP (glyph
->object
)
16911 glyph
->pixel_width
,
16913 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16917 glyph
->left_box_line_p
,
16918 glyph
->right_box_line_p
);
16920 else if (glyph
->type
== STRETCH_GLYPH
)
16923 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16924 glyph
- row
->glyphs
[TEXT_AREA
],
16927 (BUFFERP (glyph
->object
)
16929 : (STRINGP (glyph
->object
)
16932 glyph
->pixel_width
,
16936 glyph
->left_box_line_p
,
16937 glyph
->right_box_line_p
);
16939 else if (glyph
->type
== IMAGE_GLYPH
)
16942 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16943 glyph
- row
->glyphs
[TEXT_AREA
],
16946 (BUFFERP (glyph
->object
)
16948 : (STRINGP (glyph
->object
)
16951 glyph
->pixel_width
,
16955 glyph
->left_box_line_p
,
16956 glyph
->right_box_line_p
);
16958 else if (glyph
->type
== COMPOSITE_GLYPH
)
16961 " %5d %4c %6d %c %3d 0x%05x",
16962 glyph
- row
->glyphs
[TEXT_AREA
],
16965 (BUFFERP (glyph
->object
)
16967 : (STRINGP (glyph
->object
)
16970 glyph
->pixel_width
,
16972 if (glyph
->u
.cmp
.automatic
)
16975 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16976 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16978 glyph
->left_box_line_p
,
16979 glyph
->right_box_line_p
);
16984 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16985 GLYPHS 0 means don't show glyph contents.
16986 GLYPHS 1 means show glyphs in short form
16987 GLYPHS > 1 means show glyphs in long form. */
16990 dump_glyph_row (row
, vpos
, glyphs
)
16991 struct glyph_row
*row
;
16996 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16997 fprintf (stderr
, "======================================================================\n");
16999 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
17000 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17002 MATRIX_ROW_START_CHARPOS (row
),
17003 MATRIX_ROW_END_CHARPOS (row
),
17004 row
->used
[TEXT_AREA
],
17005 row
->contains_overlapping_glyphs_p
,
17007 row
->truncated_on_left_p
,
17008 row
->truncated_on_right_p
,
17010 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17011 row
->displays_text_p
,
17014 row
->ends_in_middle_of_char_p
,
17015 row
->starts_in_middle_of_char_p
,
17021 row
->visible_height
,
17024 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17025 row
->end
.overlay_string_index
,
17026 row
->continuation_lines_width
);
17027 fprintf (stderr
, "%9d %5d\n",
17028 CHARPOS (row
->start
.string_pos
),
17029 CHARPOS (row
->end
.string_pos
));
17030 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17031 row
->end
.dpvec_index
);
17038 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17040 struct glyph
*glyph
= row
->glyphs
[area
];
17041 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17043 /* Glyph for a line end in text. */
17044 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17047 if (glyph
< glyph_end
)
17048 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17050 for (; glyph
< glyph_end
; ++glyph
)
17051 dump_glyph (row
, glyph
, area
);
17054 else if (glyphs
== 1)
17058 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17060 char *s
= (char *) alloca (row
->used
[area
] + 1);
17063 for (i
= 0; i
< row
->used
[area
]; ++i
)
17065 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17066 if (glyph
->type
== CHAR_GLYPH
17067 && glyph
->u
.ch
< 0x80
17068 && glyph
->u
.ch
>= ' ')
17069 s
[i
] = glyph
->u
.ch
;
17075 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17081 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17082 Sdump_glyph_matrix
, 0, 1, "p",
17083 doc
: /* Dump the current matrix of the selected window to stderr.
17084 Shows contents of glyph row structures. With non-nil
17085 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17086 glyphs in short form, otherwise show glyphs in long form. */)
17087 (Lisp_Object glyphs
)
17089 struct window
*w
= XWINDOW (selected_window
);
17090 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17092 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
17093 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17094 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17095 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17096 fprintf (stderr
, "=============================================\n");
17097 dump_glyph_matrix (w
->current_matrix
,
17098 NILP (glyphs
) ? 0 : XINT (glyphs
));
17103 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17104 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17107 struct frame
*f
= XFRAME (selected_frame
);
17108 dump_glyph_matrix (f
->current_matrix
, 1);
17113 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17114 doc
: /* Dump glyph row ROW to stderr.
17115 GLYPH 0 means don't dump glyphs.
17116 GLYPH 1 means dump glyphs in short form.
17117 GLYPH > 1 or omitted means dump glyphs in long form. */)
17118 (Lisp_Object row
, Lisp_Object glyphs
)
17120 struct glyph_matrix
*matrix
;
17123 CHECK_NUMBER (row
);
17124 matrix
= XWINDOW (selected_window
)->current_matrix
;
17126 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17127 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17129 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17134 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17135 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17136 GLYPH 0 means don't dump glyphs.
17137 GLYPH 1 means dump glyphs in short form.
17138 GLYPH > 1 or omitted means dump glyphs in long form. */)
17139 (Lisp_Object row
, Lisp_Object glyphs
)
17141 struct frame
*sf
= SELECTED_FRAME ();
17142 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17145 CHECK_NUMBER (row
);
17147 if (vpos
>= 0 && vpos
< m
->nrows
)
17148 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17149 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17154 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17155 doc
: /* Toggle tracing of redisplay.
17156 With ARG, turn tracing on if and only if ARG is positive. */)
17160 trace_redisplay_p
= !trace_redisplay_p
;
17163 arg
= Fprefix_numeric_value (arg
);
17164 trace_redisplay_p
= XINT (arg
) > 0;
17171 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17172 doc
: /* Like `format', but print result to stderr.
17173 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17174 (size_t nargs
, Lisp_Object
*args
)
17176 Lisp_Object s
= Fformat (nargs
, args
);
17177 fprintf (stderr
, "%s", SDATA (s
));
17181 #endif /* GLYPH_DEBUG */
17185 /***********************************************************************
17186 Building Desired Matrix Rows
17187 ***********************************************************************/
17189 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17190 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17192 static struct glyph_row
*
17193 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17195 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17196 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17197 struct buffer
*old
= current_buffer
;
17198 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17199 int arrow_len
= SCHARS (overlay_arrow_string
);
17200 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17201 const unsigned char *p
;
17204 int n_glyphs_before
;
17206 set_buffer_temp (buffer
);
17207 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17208 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17209 SET_TEXT_POS (it
.position
, 0, 0);
17211 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17213 while (p
< arrow_end
)
17215 Lisp_Object face
, ilisp
;
17217 /* Get the next character. */
17219 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17222 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17223 if (! ASCII_CHAR_P (it
.c
))
17224 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17228 /* Get its face. */
17229 ilisp
= make_number (p
- arrow_string
);
17230 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17231 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17233 /* Compute its width, get its glyphs. */
17234 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17235 SET_TEXT_POS (it
.position
, -1, -1);
17236 PRODUCE_GLYPHS (&it
);
17238 /* If this character doesn't fit any more in the line, we have
17239 to remove some glyphs. */
17240 if (it
.current_x
> it
.last_visible_x
)
17242 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17247 set_buffer_temp (old
);
17248 return it
.glyph_row
;
17252 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17253 glyphs are only inserted for terminal frames since we can't really
17254 win with truncation glyphs when partially visible glyphs are
17255 involved. Which glyphs to insert is determined by
17256 produce_special_glyphs. */
17259 insert_left_trunc_glyphs (struct it
*it
)
17261 struct it truncate_it
;
17262 struct glyph
*from
, *end
, *to
, *toend
;
17264 xassert (!FRAME_WINDOW_P (it
->f
));
17266 /* Get the truncation glyphs. */
17268 truncate_it
.current_x
= 0;
17269 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17270 truncate_it
.glyph_row
= &scratch_glyph_row
;
17271 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17272 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17273 truncate_it
.object
= make_number (0);
17274 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17276 /* Overwrite glyphs from IT with truncation glyphs. */
17277 if (!it
->glyph_row
->reversed_p
)
17279 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17280 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17281 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17282 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17287 /* There may be padding glyphs left over. Overwrite them too. */
17288 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17290 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17296 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17300 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17301 that back to front. */
17302 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17303 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17304 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17305 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17307 while (from
>= end
&& to
>= toend
)
17309 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17312 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17313 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17314 while (from
>= end
&& to
>= toend
)
17319 /* Need to free some room before prepending additional
17321 int move_by
= from
- end
+ 1;
17322 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17323 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17325 for ( ; g
>= g0
; g
--)
17327 while (from
>= end
)
17329 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17335 /* Compute the pixel height and width of IT->glyph_row.
17337 Most of the time, ascent and height of a display line will be equal
17338 to the max_ascent and max_height values of the display iterator
17339 structure. This is not the case if
17341 1. We hit ZV without displaying anything. In this case, max_ascent
17342 and max_height will be zero.
17344 2. We have some glyphs that don't contribute to the line height.
17345 (The glyph row flag contributes_to_line_height_p is for future
17346 pixmap extensions).
17348 The first case is easily covered by using default values because in
17349 these cases, the line height does not really matter, except that it
17350 must not be zero. */
17353 compute_line_metrics (struct it
*it
)
17355 struct glyph_row
*row
= it
->glyph_row
;
17357 if (FRAME_WINDOW_P (it
->f
))
17359 int i
, min_y
, max_y
;
17361 /* The line may consist of one space only, that was added to
17362 place the cursor on it. If so, the row's height hasn't been
17364 if (row
->height
== 0)
17366 if (it
->max_ascent
+ it
->max_descent
== 0)
17367 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17368 row
->ascent
= it
->max_ascent
;
17369 row
->height
= it
->max_ascent
+ it
->max_descent
;
17370 row
->phys_ascent
= it
->max_phys_ascent
;
17371 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17372 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17375 /* Compute the width of this line. */
17376 row
->pixel_width
= row
->x
;
17377 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17378 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17380 xassert (row
->pixel_width
>= 0);
17381 xassert (row
->ascent
>= 0 && row
->height
> 0);
17383 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17384 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17386 /* If first line's physical ascent is larger than its logical
17387 ascent, use the physical ascent, and make the row taller.
17388 This makes accented characters fully visible. */
17389 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17390 && row
->phys_ascent
> row
->ascent
)
17392 row
->height
+= row
->phys_ascent
- row
->ascent
;
17393 row
->ascent
= row
->phys_ascent
;
17396 /* Compute how much of the line is visible. */
17397 row
->visible_height
= row
->height
;
17399 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17400 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17402 if (row
->y
< min_y
)
17403 row
->visible_height
-= min_y
- row
->y
;
17404 if (row
->y
+ row
->height
> max_y
)
17405 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17409 row
->pixel_width
= row
->used
[TEXT_AREA
];
17410 if (row
->continued_p
)
17411 row
->pixel_width
-= it
->continuation_pixel_width
;
17412 else if (row
->truncated_on_right_p
)
17413 row
->pixel_width
-= it
->truncation_pixel_width
;
17414 row
->ascent
= row
->phys_ascent
= 0;
17415 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17416 row
->extra_line_spacing
= 0;
17419 /* Compute a hash code for this row. */
17423 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17424 for (i
= 0; i
< row
->used
[area
]; ++i
)
17425 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17426 + row
->glyphs
[area
][i
].u
.val
17427 + row
->glyphs
[area
][i
].face_id
17428 + row
->glyphs
[area
][i
].padding_p
17429 + (row
->glyphs
[area
][i
].type
<< 2));
17432 it
->max_ascent
= it
->max_descent
= 0;
17433 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17437 /* Append one space to the glyph row of iterator IT if doing a
17438 window-based redisplay. The space has the same face as
17439 IT->face_id. Value is non-zero if a space was added.
17441 This function is called to make sure that there is always one glyph
17442 at the end of a glyph row that the cursor can be set on under
17443 window-systems. (If there weren't such a glyph we would not know
17444 how wide and tall a box cursor should be displayed).
17446 At the same time this space let's a nicely handle clearing to the
17447 end of the line if the row ends in italic text. */
17450 append_space_for_newline (struct it
*it
, int default_face_p
)
17452 if (FRAME_WINDOW_P (it
->f
))
17454 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17456 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17457 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17459 /* Save some values that must not be changed.
17460 Must save IT->c and IT->len because otherwise
17461 ITERATOR_AT_END_P wouldn't work anymore after
17462 append_space_for_newline has been called. */
17463 enum display_element_type saved_what
= it
->what
;
17464 int saved_c
= it
->c
, saved_len
= it
->len
;
17465 int saved_char_to_display
= it
->char_to_display
;
17466 int saved_x
= it
->current_x
;
17467 int saved_face_id
= it
->face_id
;
17468 struct text_pos saved_pos
;
17469 Lisp_Object saved_object
;
17472 saved_object
= it
->object
;
17473 saved_pos
= it
->position
;
17475 it
->what
= IT_CHARACTER
;
17476 memset (&it
->position
, 0, sizeof it
->position
);
17477 it
->object
= make_number (0);
17478 it
->c
= it
->char_to_display
= ' ';
17481 if (default_face_p
)
17482 it
->face_id
= DEFAULT_FACE_ID
;
17483 else if (it
->face_before_selective_p
)
17484 it
->face_id
= it
->saved_face_id
;
17485 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17486 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17488 PRODUCE_GLYPHS (it
);
17490 it
->override_ascent
= -1;
17491 it
->constrain_row_ascent_descent_p
= 0;
17492 it
->current_x
= saved_x
;
17493 it
->object
= saved_object
;
17494 it
->position
= saved_pos
;
17495 it
->what
= saved_what
;
17496 it
->face_id
= saved_face_id
;
17497 it
->len
= saved_len
;
17499 it
->char_to_display
= saved_char_to_display
;
17508 /* Extend the face of the last glyph in the text area of IT->glyph_row
17509 to the end of the display line. Called from display_line. If the
17510 glyph row is empty, add a space glyph to it so that we know the
17511 face to draw. Set the glyph row flag fill_line_p. If the glyph
17512 row is R2L, prepend a stretch glyph to cover the empty space to the
17513 left of the leftmost glyph. */
17516 extend_face_to_end_of_line (struct it
*it
)
17519 struct frame
*f
= it
->f
;
17521 /* If line is already filled, do nothing. Non window-system frames
17522 get a grace of one more ``pixel'' because their characters are
17523 1-``pixel'' wide, so they hit the equality too early. This grace
17524 is needed only for R2L rows that are not continued, to produce
17525 one extra blank where we could display the cursor. */
17526 if (it
->current_x
>= it
->last_visible_x
17527 + (!FRAME_WINDOW_P (f
)
17528 && it
->glyph_row
->reversed_p
17529 && !it
->glyph_row
->continued_p
))
17532 /* Face extension extends the background and box of IT->face_id
17533 to the end of the line. If the background equals the background
17534 of the frame, we don't have to do anything. */
17535 if (it
->face_before_selective_p
)
17536 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17538 face
= FACE_FROM_ID (f
, it
->face_id
);
17540 if (FRAME_WINDOW_P (f
)
17541 && it
->glyph_row
->displays_text_p
17542 && face
->box
== FACE_NO_BOX
17543 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17545 && !it
->glyph_row
->reversed_p
)
17548 /* Set the glyph row flag indicating that the face of the last glyph
17549 in the text area has to be drawn to the end of the text area. */
17550 it
->glyph_row
->fill_line_p
= 1;
17552 /* If current character of IT is not ASCII, make sure we have the
17553 ASCII face. This will be automatically undone the next time
17554 get_next_display_element returns a multibyte character. Note
17555 that the character will always be single byte in unibyte
17557 if (!ASCII_CHAR_P (it
->c
))
17559 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17562 if (FRAME_WINDOW_P (f
))
17564 /* If the row is empty, add a space with the current face of IT,
17565 so that we know which face to draw. */
17566 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17568 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17569 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17570 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17572 #ifdef HAVE_WINDOW_SYSTEM
17573 if (it
->glyph_row
->reversed_p
)
17575 /* Prepend a stretch glyph to the row, such that the
17576 rightmost glyph will be drawn flushed all the way to the
17577 right margin of the window. The stretch glyph that will
17578 occupy the empty space, if any, to the left of the
17580 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17581 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17582 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17584 int row_width
, stretch_ascent
, stretch_width
;
17585 struct text_pos saved_pos
;
17586 int saved_face_id
, saved_avoid_cursor
;
17588 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17589 row_width
+= g
->pixel_width
;
17590 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17591 if (stretch_width
> 0)
17594 (((it
->ascent
+ it
->descent
)
17595 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17596 saved_pos
= it
->position
;
17597 memset (&it
->position
, 0, sizeof it
->position
);
17598 saved_avoid_cursor
= it
->avoid_cursor_p
;
17599 it
->avoid_cursor_p
= 1;
17600 saved_face_id
= it
->face_id
;
17601 /* The last row's stretch glyph should get the default
17602 face, to avoid painting the rest of the window with
17603 the region face, if the region ends at ZV. */
17604 if (it
->glyph_row
->ends_at_zv_p
)
17605 it
->face_id
= DEFAULT_FACE_ID
;
17607 it
->face_id
= face
->id
;
17608 append_stretch_glyph (it
, make_number (0), stretch_width
,
17609 it
->ascent
+ it
->descent
, stretch_ascent
);
17610 it
->position
= saved_pos
;
17611 it
->avoid_cursor_p
= saved_avoid_cursor
;
17612 it
->face_id
= saved_face_id
;
17615 #endif /* HAVE_WINDOW_SYSTEM */
17619 /* Save some values that must not be changed. */
17620 int saved_x
= it
->current_x
;
17621 struct text_pos saved_pos
;
17622 Lisp_Object saved_object
;
17623 enum display_element_type saved_what
= it
->what
;
17624 int saved_face_id
= it
->face_id
;
17626 saved_object
= it
->object
;
17627 saved_pos
= it
->position
;
17629 it
->what
= IT_CHARACTER
;
17630 memset (&it
->position
, 0, sizeof it
->position
);
17631 it
->object
= make_number (0);
17632 it
->c
= it
->char_to_display
= ' ';
17634 /* The last row's blank glyphs should get the default face, to
17635 avoid painting the rest of the window with the region face,
17636 if the region ends at ZV. */
17637 if (it
->glyph_row
->ends_at_zv_p
)
17638 it
->face_id
= DEFAULT_FACE_ID
;
17640 it
->face_id
= face
->id
;
17642 PRODUCE_GLYPHS (it
);
17644 while (it
->current_x
<= it
->last_visible_x
)
17645 PRODUCE_GLYPHS (it
);
17647 /* Don't count these blanks really. It would let us insert a left
17648 truncation glyph below and make us set the cursor on them, maybe. */
17649 it
->current_x
= saved_x
;
17650 it
->object
= saved_object
;
17651 it
->position
= saved_pos
;
17652 it
->what
= saved_what
;
17653 it
->face_id
= saved_face_id
;
17658 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17659 trailing whitespace. */
17662 trailing_whitespace_p (EMACS_INT charpos
)
17664 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17667 while (bytepos
< ZV_BYTE
17668 && (c
= FETCH_CHAR (bytepos
),
17669 c
== ' ' || c
== '\t'))
17672 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17674 if (bytepos
!= PT_BYTE
)
17681 /* Highlight trailing whitespace, if any, in ROW. */
17684 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17686 int used
= row
->used
[TEXT_AREA
];
17690 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17691 struct glyph
*glyph
= start
+ used
- 1;
17693 if (row
->reversed_p
)
17695 /* Right-to-left rows need to be processed in the opposite
17696 direction, so swap the edge pointers. */
17698 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17701 /* Skip over glyphs inserted to display the cursor at the
17702 end of a line, for extending the face of the last glyph
17703 to the end of the line on terminals, and for truncation
17704 and continuation glyphs. */
17705 if (!row
->reversed_p
)
17707 while (glyph
>= start
17708 && glyph
->type
== CHAR_GLYPH
17709 && INTEGERP (glyph
->object
))
17714 while (glyph
<= start
17715 && glyph
->type
== CHAR_GLYPH
17716 && INTEGERP (glyph
->object
))
17720 /* If last glyph is a space or stretch, and it's trailing
17721 whitespace, set the face of all trailing whitespace glyphs in
17722 IT->glyph_row to `trailing-whitespace'. */
17723 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17724 && BUFFERP (glyph
->object
)
17725 && (glyph
->type
== STRETCH_GLYPH
17726 || (glyph
->type
== CHAR_GLYPH
17727 && glyph
->u
.ch
== ' '))
17728 && trailing_whitespace_p (glyph
->charpos
))
17730 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17734 if (!row
->reversed_p
)
17736 while (glyph
>= start
17737 && BUFFERP (glyph
->object
)
17738 && (glyph
->type
== STRETCH_GLYPH
17739 || (glyph
->type
== CHAR_GLYPH
17740 && glyph
->u
.ch
== ' ')))
17741 (glyph
--)->face_id
= face_id
;
17745 while (glyph
<= start
17746 && BUFFERP (glyph
->object
)
17747 && (glyph
->type
== STRETCH_GLYPH
17748 || (glyph
->type
== CHAR_GLYPH
17749 && glyph
->u
.ch
== ' ')))
17750 (glyph
++)->face_id
= face_id
;
17757 /* Value is non-zero if glyph row ROW should be
17758 used to hold the cursor. */
17761 cursor_row_p (struct glyph_row
*row
)
17765 if (PT
== CHARPOS (row
->end
.pos
))
17767 /* Suppose the row ends on a string.
17768 Unless the row is continued, that means it ends on a newline
17769 in the string. If it's anything other than a display string
17770 (e.g. a before-string from an overlay), we don't want the
17771 cursor there. (This heuristic seems to give the optimal
17772 behavior for the various types of multi-line strings.) */
17773 if (CHARPOS (row
->end
.string_pos
) >= 0)
17775 if (row
->continued_p
)
17779 /* Check for `display' property. */
17780 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17781 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17782 struct glyph
*glyph
;
17785 for (glyph
= end
; glyph
>= beg
; --glyph
)
17786 if (STRINGP (glyph
->object
))
17789 = Fget_char_property (make_number (PT
),
17793 && display_prop_string_p (prop
, glyph
->object
));
17798 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17800 /* If the row ends in middle of a real character,
17801 and the line is continued, we want the cursor here.
17802 That's because CHARPOS (ROW->end.pos) would equal
17803 PT if PT is before the character. */
17804 if (!row
->ends_in_ellipsis_p
)
17805 result
= row
->continued_p
;
17807 /* If the row ends in an ellipsis, then
17808 CHARPOS (ROW->end.pos) will equal point after the
17809 invisible text. We want that position to be displayed
17810 after the ellipsis. */
17813 /* If the row ends at ZV, display the cursor at the end of that
17814 row instead of at the start of the row below. */
17815 else if (row
->ends_at_zv_p
)
17826 /* Push the display property PROP so that it will be rendered at the
17827 current position in IT. Return 1 if PROP was successfully pushed,
17831 push_display_prop (struct it
*it
, Lisp_Object prop
)
17833 xassert (it
->method
== GET_FROM_BUFFER
);
17835 push_it (it
, NULL
);
17837 if (STRINGP (prop
))
17839 if (SCHARS (prop
) == 0)
17846 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17847 it
->current
.overlay_string_index
= -1;
17848 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17849 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17850 it
->method
= GET_FROM_STRING
;
17851 it
->stop_charpos
= 0;
17853 it
->base_level_stop
= 0;
17854 it
->string_from_display_prop_p
= 1;
17855 it
->from_disp_prop_p
= 1;
17857 /* Force paragraph direction to be that of the parent
17859 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
17860 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
17862 it
->paragraph_embedding
= L2R
;
17864 /* Set up the bidi iterator for this display string. */
17867 it
->bidi_it
.string
.lstring
= it
->string
;
17868 it
->bidi_it
.string
.s
= NULL
;
17869 it
->bidi_it
.string
.schars
= it
->end_charpos
;
17870 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
17871 it
->bidi_it
.string
.from_disp_str
= 1;
17872 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
17873 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
17876 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17878 it
->method
= GET_FROM_STRETCH
;
17881 #ifdef HAVE_WINDOW_SYSTEM
17882 else if (IMAGEP (prop
))
17884 it
->what
= IT_IMAGE
;
17885 it
->image_id
= lookup_image (it
->f
, prop
);
17886 it
->method
= GET_FROM_IMAGE
;
17888 #endif /* HAVE_WINDOW_SYSTEM */
17891 pop_it (it
); /* bogus display property, give up */
17898 /* Return the character-property PROP at the current position in IT. */
17901 get_it_property (struct it
*it
, Lisp_Object prop
)
17903 Lisp_Object position
;
17905 if (STRINGP (it
->object
))
17906 position
= make_number (IT_STRING_CHARPOS (*it
));
17907 else if (BUFFERP (it
->object
))
17908 position
= make_number (IT_CHARPOS (*it
));
17912 return Fget_char_property (position
, prop
, it
->object
);
17915 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17918 handle_line_prefix (struct it
*it
)
17920 Lisp_Object prefix
;
17922 if (it
->continuation_lines_width
> 0)
17924 prefix
= get_it_property (it
, Qwrap_prefix
);
17926 prefix
= Vwrap_prefix
;
17930 prefix
= get_it_property (it
, Qline_prefix
);
17932 prefix
= Vline_prefix
;
17934 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17936 /* If the prefix is wider than the window, and we try to wrap
17937 it, it would acquire its own wrap prefix, and so on till the
17938 iterator stack overflows. So, don't wrap the prefix. */
17939 it
->line_wrap
= TRUNCATE
;
17940 it
->avoid_cursor_p
= 1;
17946 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17947 only for R2L lines from display_line and display_string, when they
17948 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
17949 the line/string needs to be continued on the next glyph row. */
17951 unproduce_glyphs (struct it
*it
, int n
)
17953 struct glyph
*glyph
, *end
;
17955 xassert (it
->glyph_row
);
17956 xassert (it
->glyph_row
->reversed_p
);
17957 xassert (it
->area
== TEXT_AREA
);
17958 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17960 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17961 n
= it
->glyph_row
->used
[TEXT_AREA
];
17962 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17963 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17964 for ( ; glyph
< end
; glyph
++)
17965 glyph
[-n
] = *glyph
;
17968 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17969 and ROW->maxpos. */
17971 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17972 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17973 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17975 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17976 lines' rows is implemented for bidi-reordered rows. */
17978 /* ROW->minpos is the value of min_pos, the minimal buffer position
17979 we have in ROW, or ROW->start.pos if that is smaller. */
17980 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
17981 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17983 /* We didn't find buffer positions smaller than ROW->start, or
17984 didn't find _any_ valid buffer positions in any of the glyphs,
17985 so we must trust the iterator's computed positions. */
17986 row
->minpos
= row
->start
.pos
;
17989 max_pos
= CHARPOS (it
->current
.pos
);
17990 max_bpos
= BYTEPOS (it
->current
.pos
);
17993 /* Here are the various use-cases for ending the row, and the
17994 corresponding values for ROW->maxpos:
17996 Line ends in a newline from buffer eol_pos + 1
17997 Line is continued from buffer max_pos + 1
17998 Line is truncated on right it->current.pos
17999 Line ends in a newline from string max_pos
18000 Line is continued from string max_pos
18001 Line is continued from display vector max_pos
18002 Line is entirely from a string min_pos == max_pos
18003 Line is entirely from a display vector min_pos == max_pos
18004 Line that ends at ZV ZV
18006 If you discover other use-cases, please add them here as
18008 if (row
->ends_at_zv_p
)
18009 row
->maxpos
= it
->current
.pos
;
18010 else if (row
->used
[TEXT_AREA
])
18012 if (row
->ends_in_newline_from_string_p
)
18013 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18014 else if (CHARPOS (it
->eol_pos
) > 0)
18015 SET_TEXT_POS (row
->maxpos
,
18016 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18017 else if (row
->continued_p
)
18019 /* If max_pos is different from IT's current position, it
18020 means IT->method does not belong to the display element
18021 at max_pos. However, it also means that the display
18022 element at max_pos was displayed in its entirety on this
18023 line, which is equivalent to saying that the next line
18024 starts at the next buffer position. */
18025 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18026 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18029 INC_BOTH (max_pos
, max_bpos
);
18030 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18033 else if (row
->truncated_on_right_p
)
18034 /* display_line already called reseat_at_next_visible_line_start,
18035 which puts the iterator at the beginning of the next line, in
18036 the logical order. */
18037 row
->maxpos
= it
->current
.pos
;
18038 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18039 /* A line that is entirely from a string/image/stretch... */
18040 row
->maxpos
= row
->minpos
;
18045 row
->maxpos
= it
->current
.pos
;
18048 /* Construct the glyph row IT->glyph_row in the desired matrix of
18049 IT->w from text at the current position of IT. See dispextern.h
18050 for an overview of struct it. Value is non-zero if
18051 IT->glyph_row displays text, as opposed to a line displaying ZV
18055 display_line (struct it
*it
)
18057 struct glyph_row
*row
= it
->glyph_row
;
18058 Lisp_Object overlay_arrow_string
;
18060 void *wrap_data
= NULL
;
18061 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18062 int wrap_row_used
= -1;
18063 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18064 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18065 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18066 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18067 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18069 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18070 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18072 /* We always start displaying at hpos zero even if hscrolled. */
18073 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18075 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18076 >= it
->w
->desired_matrix
->nrows
)
18078 it
->w
->nrows_scale_factor
++;
18079 fonts_changed_p
= 1;
18083 /* Is IT->w showing the region? */
18084 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18086 /* Clear the result glyph row and enable it. */
18087 prepare_desired_row (row
);
18089 row
->y
= it
->current_y
;
18090 row
->start
= it
->start
;
18091 row
->continuation_lines_width
= it
->continuation_lines_width
;
18092 row
->displays_text_p
= 1;
18093 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18094 it
->starts_in_middle_of_char_p
= 0;
18096 /* Arrange the overlays nicely for our purposes. Usually, we call
18097 display_line on only one line at a time, in which case this
18098 can't really hurt too much, or we call it on lines which appear
18099 one after another in the buffer, in which case all calls to
18100 recenter_overlay_lists but the first will be pretty cheap. */
18101 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18103 /* Move over display elements that are not visible because we are
18104 hscrolled. This may stop at an x-position < IT->first_visible_x
18105 if the first glyph is partially visible or if we hit a line end. */
18106 if (it
->current_x
< it
->first_visible_x
)
18108 this_line_min_pos
= row
->start
.pos
;
18109 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18110 MOVE_TO_POS
| MOVE_TO_X
);
18111 /* Record the smallest positions seen while we moved over
18112 display elements that are not visible. This is needed by
18113 redisplay_internal for optimizing the case where the cursor
18114 stays inside the same line. The rest of this function only
18115 considers positions that are actually displayed, so
18116 RECORD_MAX_MIN_POS will not otherwise record positions that
18117 are hscrolled to the left of the left edge of the window. */
18118 min_pos
= CHARPOS (this_line_min_pos
);
18119 min_bpos
= BYTEPOS (this_line_min_pos
);
18123 /* We only do this when not calling `move_it_in_display_line_to'
18124 above, because move_it_in_display_line_to calls
18125 handle_line_prefix itself. */
18126 handle_line_prefix (it
);
18129 /* Get the initial row height. This is either the height of the
18130 text hscrolled, if there is any, or zero. */
18131 row
->ascent
= it
->max_ascent
;
18132 row
->height
= it
->max_ascent
+ it
->max_descent
;
18133 row
->phys_ascent
= it
->max_phys_ascent
;
18134 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18135 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18137 /* Utility macro to record max and min buffer positions seen until now. */
18138 #define RECORD_MAX_MIN_POS(IT) \
18141 if (IT_CHARPOS (*(IT)) < min_pos) \
18143 min_pos = IT_CHARPOS (*(IT)); \
18144 min_bpos = IT_BYTEPOS (*(IT)); \
18146 if (IT_CHARPOS (*(IT)) > max_pos) \
18148 max_pos = IT_CHARPOS (*(IT)); \
18149 max_bpos = IT_BYTEPOS (*(IT)); \
18154 /* Loop generating characters. The loop is left with IT on the next
18155 character to display. */
18158 int n_glyphs_before
, hpos_before
, x_before
;
18160 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18162 /* Retrieve the next thing to display. Value is zero if end of
18164 if (!get_next_display_element (it
))
18166 /* Maybe add a space at the end of this line that is used to
18167 display the cursor there under X. Set the charpos of the
18168 first glyph of blank lines not corresponding to any text
18170 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18171 row
->exact_window_width_line_p
= 1;
18172 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18173 || row
->used
[TEXT_AREA
] == 0)
18175 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18176 row
->displays_text_p
= 0;
18178 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18179 && (!MINI_WINDOW_P (it
->w
)
18180 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18181 row
->indicate_empty_line_p
= 1;
18184 it
->continuation_lines_width
= 0;
18185 row
->ends_at_zv_p
= 1;
18186 /* A row that displays right-to-left text must always have
18187 its last face extended all the way to the end of line,
18188 even if this row ends in ZV, because we still write to
18189 the screen left to right. */
18190 if (row
->reversed_p
)
18191 extend_face_to_end_of_line (it
);
18195 /* Now, get the metrics of what we want to display. This also
18196 generates glyphs in `row' (which is IT->glyph_row). */
18197 n_glyphs_before
= row
->used
[TEXT_AREA
];
18200 /* Remember the line height so far in case the next element doesn't
18201 fit on the line. */
18202 if (it
->line_wrap
!= TRUNCATE
)
18204 ascent
= it
->max_ascent
;
18205 descent
= it
->max_descent
;
18206 phys_ascent
= it
->max_phys_ascent
;
18207 phys_descent
= it
->max_phys_descent
;
18209 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18211 if (IT_DISPLAYING_WHITESPACE (it
))
18215 SAVE_IT (wrap_it
, *it
, wrap_data
);
18217 wrap_row_used
= row
->used
[TEXT_AREA
];
18218 wrap_row_ascent
= row
->ascent
;
18219 wrap_row_height
= row
->height
;
18220 wrap_row_phys_ascent
= row
->phys_ascent
;
18221 wrap_row_phys_height
= row
->phys_height
;
18222 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18223 wrap_row_min_pos
= min_pos
;
18224 wrap_row_min_bpos
= min_bpos
;
18225 wrap_row_max_pos
= max_pos
;
18226 wrap_row_max_bpos
= max_bpos
;
18232 PRODUCE_GLYPHS (it
);
18234 /* If this display element was in marginal areas, continue with
18236 if (it
->area
!= TEXT_AREA
)
18238 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18239 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18240 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18241 row
->phys_height
= max (row
->phys_height
,
18242 it
->max_phys_ascent
+ it
->max_phys_descent
);
18243 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18244 it
->max_extra_line_spacing
);
18245 set_iterator_to_next (it
, 1);
18249 /* Does the display element fit on the line? If we truncate
18250 lines, we should draw past the right edge of the window. If
18251 we don't truncate, we want to stop so that we can display the
18252 continuation glyph before the right margin. If lines are
18253 continued, there are two possible strategies for characters
18254 resulting in more than 1 glyph (e.g. tabs): Display as many
18255 glyphs as possible in this line and leave the rest for the
18256 continuation line, or display the whole element in the next
18257 line. Original redisplay did the former, so we do it also. */
18258 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18259 hpos_before
= it
->hpos
;
18262 if (/* Not a newline. */
18264 /* Glyphs produced fit entirely in the line. */
18265 && it
->current_x
< it
->last_visible_x
)
18267 it
->hpos
+= nglyphs
;
18268 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18269 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18270 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18271 row
->phys_height
= max (row
->phys_height
,
18272 it
->max_phys_ascent
+ it
->max_phys_descent
);
18273 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18274 it
->max_extra_line_spacing
);
18275 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18276 row
->x
= x
- it
->first_visible_x
;
18277 /* Record the maximum and minimum buffer positions seen so
18278 far in glyphs that will be displayed by this row. */
18280 RECORD_MAX_MIN_POS (it
);
18285 struct glyph
*glyph
;
18287 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18289 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18290 new_x
= x
+ glyph
->pixel_width
;
18292 if (/* Lines are continued. */
18293 it
->line_wrap
!= TRUNCATE
18294 && (/* Glyph doesn't fit on the line. */
18295 new_x
> it
->last_visible_x
18296 /* Or it fits exactly on a window system frame. */
18297 || (new_x
== it
->last_visible_x
18298 && FRAME_WINDOW_P (it
->f
))))
18300 /* End of a continued line. */
18303 || (new_x
== it
->last_visible_x
18304 && FRAME_WINDOW_P (it
->f
)))
18306 /* Current glyph is the only one on the line or
18307 fits exactly on the line. We must continue
18308 the line because we can't draw the cursor
18309 after the glyph. */
18310 row
->continued_p
= 1;
18311 it
->current_x
= new_x
;
18312 it
->continuation_lines_width
+= new_x
;
18314 /* Record the maximum and minimum buffer
18315 positions seen so far in glyphs that will be
18316 displayed by this row. */
18318 RECORD_MAX_MIN_POS (it
);
18319 if (i
== nglyphs
- 1)
18321 /* If line-wrap is on, check if a previous
18322 wrap point was found. */
18323 if (wrap_row_used
> 0
18324 /* Even if there is a previous wrap
18325 point, continue the line here as
18326 usual, if (i) the previous character
18327 was a space or tab AND (ii) the
18328 current character is not. */
18330 || IT_DISPLAYING_WHITESPACE (it
)))
18333 set_iterator_to_next (it
, 1);
18334 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18336 if (!get_next_display_element (it
))
18338 row
->exact_window_width_line_p
= 1;
18339 it
->continuation_lines_width
= 0;
18340 row
->continued_p
= 0;
18341 row
->ends_at_zv_p
= 1;
18343 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18345 row
->continued_p
= 0;
18346 row
->exact_window_width_line_p
= 1;
18351 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18352 && !FRAME_WINDOW_P (it
->f
))
18354 /* A padding glyph that doesn't fit on this line.
18355 This means the whole character doesn't fit
18357 if (row
->reversed_p
)
18358 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18359 - n_glyphs_before
);
18360 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18362 /* Fill the rest of the row with continuation
18363 glyphs like in 20.x. */
18364 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18365 < row
->glyphs
[1 + TEXT_AREA
])
18366 produce_special_glyphs (it
, IT_CONTINUATION
);
18368 row
->continued_p
= 1;
18369 it
->current_x
= x_before
;
18370 it
->continuation_lines_width
+= x_before
;
18372 /* Restore the height to what it was before the
18373 element not fitting on the line. */
18374 it
->max_ascent
= ascent
;
18375 it
->max_descent
= descent
;
18376 it
->max_phys_ascent
= phys_ascent
;
18377 it
->max_phys_descent
= phys_descent
;
18379 else if (wrap_row_used
> 0)
18382 if (row
->reversed_p
)
18383 unproduce_glyphs (it
,
18384 row
->used
[TEXT_AREA
] - wrap_row_used
);
18385 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18386 it
->continuation_lines_width
+= wrap_x
;
18387 row
->used
[TEXT_AREA
] = wrap_row_used
;
18388 row
->ascent
= wrap_row_ascent
;
18389 row
->height
= wrap_row_height
;
18390 row
->phys_ascent
= wrap_row_phys_ascent
;
18391 row
->phys_height
= wrap_row_phys_height
;
18392 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18393 min_pos
= wrap_row_min_pos
;
18394 min_bpos
= wrap_row_min_bpos
;
18395 max_pos
= wrap_row_max_pos
;
18396 max_bpos
= wrap_row_max_bpos
;
18397 row
->continued_p
= 1;
18398 row
->ends_at_zv_p
= 0;
18399 row
->exact_window_width_line_p
= 0;
18400 it
->continuation_lines_width
+= x
;
18402 /* Make sure that a non-default face is extended
18403 up to the right margin of the window. */
18404 extend_face_to_end_of_line (it
);
18406 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18408 /* A TAB that extends past the right edge of the
18409 window. This produces a single glyph on
18410 window system frames. We leave the glyph in
18411 this row and let it fill the row, but don't
18412 consume the TAB. */
18413 it
->continuation_lines_width
+= it
->last_visible_x
;
18414 row
->ends_in_middle_of_char_p
= 1;
18415 row
->continued_p
= 1;
18416 glyph
->pixel_width
= it
->last_visible_x
- x
;
18417 it
->starts_in_middle_of_char_p
= 1;
18421 /* Something other than a TAB that draws past
18422 the right edge of the window. Restore
18423 positions to values before the element. */
18424 if (row
->reversed_p
)
18425 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18426 - (n_glyphs_before
+ i
));
18427 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18429 /* Display continuation glyphs. */
18430 if (!FRAME_WINDOW_P (it
->f
))
18431 produce_special_glyphs (it
, IT_CONTINUATION
);
18432 row
->continued_p
= 1;
18434 it
->current_x
= x_before
;
18435 it
->continuation_lines_width
+= x
;
18436 extend_face_to_end_of_line (it
);
18438 if (nglyphs
> 1 && i
> 0)
18440 row
->ends_in_middle_of_char_p
= 1;
18441 it
->starts_in_middle_of_char_p
= 1;
18444 /* Restore the height to what it was before the
18445 element not fitting on the line. */
18446 it
->max_ascent
= ascent
;
18447 it
->max_descent
= descent
;
18448 it
->max_phys_ascent
= phys_ascent
;
18449 it
->max_phys_descent
= phys_descent
;
18454 else if (new_x
> it
->first_visible_x
)
18456 /* Increment number of glyphs actually displayed. */
18459 /* Record the maximum and minimum buffer positions
18460 seen so far in glyphs that will be displayed by
18463 RECORD_MAX_MIN_POS (it
);
18465 if (x
< it
->first_visible_x
)
18466 /* Glyph is partially visible, i.e. row starts at
18467 negative X position. */
18468 row
->x
= x
- it
->first_visible_x
;
18472 /* Glyph is completely off the left margin of the
18473 window. This should not happen because of the
18474 move_it_in_display_line at the start of this
18475 function, unless the text display area of the
18476 window is empty. */
18477 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18481 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18482 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18483 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18484 row
->phys_height
= max (row
->phys_height
,
18485 it
->max_phys_ascent
+ it
->max_phys_descent
);
18486 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18487 it
->max_extra_line_spacing
);
18489 /* End of this display line if row is continued. */
18490 if (row
->continued_p
|| row
->ends_at_zv_p
)
18495 /* Is this a line end? If yes, we're also done, after making
18496 sure that a non-default face is extended up to the right
18497 margin of the window. */
18498 if (ITERATOR_AT_END_OF_LINE_P (it
))
18500 int used_before
= row
->used
[TEXT_AREA
];
18502 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18504 /* Add a space at the end of the line that is used to
18505 display the cursor there. */
18506 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18507 append_space_for_newline (it
, 0);
18509 /* Extend the face to the end of the line. */
18510 extend_face_to_end_of_line (it
);
18512 /* Make sure we have the position. */
18513 if (used_before
== 0)
18514 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18516 /* Record the position of the newline, for use in
18518 it
->eol_pos
= it
->current
.pos
;
18520 /* Consume the line end. This skips over invisible lines. */
18521 set_iterator_to_next (it
, 1);
18522 it
->continuation_lines_width
= 0;
18526 /* Proceed with next display element. Note that this skips
18527 over lines invisible because of selective display. */
18528 set_iterator_to_next (it
, 1);
18530 /* If we truncate lines, we are done when the last displayed
18531 glyphs reach past the right margin of the window. */
18532 if (it
->line_wrap
== TRUNCATE
18533 && (FRAME_WINDOW_P (it
->f
)
18534 ? (it
->current_x
>= it
->last_visible_x
)
18535 : (it
->current_x
> it
->last_visible_x
)))
18537 /* Maybe add truncation glyphs. */
18538 if (!FRAME_WINDOW_P (it
->f
))
18542 if (!row
->reversed_p
)
18544 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18545 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18550 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18551 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18553 /* Remove any padding glyphs at the front of ROW, to
18554 make room for the truncation glyphs we will be
18555 adding below. The loop below always inserts at
18556 least one truncation glyph, so also remove the
18557 last glyph added to ROW. */
18558 unproduce_glyphs (it
, i
+ 1);
18559 /* Adjust i for the loop below. */
18560 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18563 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18565 row
->used
[TEXT_AREA
] = i
;
18566 produce_special_glyphs (it
, IT_TRUNCATION
);
18569 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18571 /* Don't truncate if we can overflow newline into fringe. */
18572 if (!get_next_display_element (it
))
18574 it
->continuation_lines_width
= 0;
18575 row
->ends_at_zv_p
= 1;
18576 row
->exact_window_width_line_p
= 1;
18579 if (ITERATOR_AT_END_OF_LINE_P (it
))
18581 row
->exact_window_width_line_p
= 1;
18582 goto at_end_of_line
;
18586 row
->truncated_on_right_p
= 1;
18587 it
->continuation_lines_width
= 0;
18588 reseat_at_next_visible_line_start (it
, 0);
18589 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18590 it
->hpos
= hpos_before
;
18591 it
->current_x
= x_before
;
18596 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18597 at the left window margin. */
18598 if (it
->first_visible_x
18599 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18601 if (!FRAME_WINDOW_P (it
->f
))
18602 insert_left_trunc_glyphs (it
);
18603 row
->truncated_on_left_p
= 1;
18606 /* Remember the position at which this line ends.
18608 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18609 cannot be before the call to find_row_edges below, since that is
18610 where these positions are determined. */
18611 row
->end
= it
->current
;
18614 row
->minpos
= row
->start
.pos
;
18615 row
->maxpos
= row
->end
.pos
;
18619 /* ROW->minpos and ROW->maxpos must be the smallest and
18620 `1 + the largest' buffer positions in ROW. But if ROW was
18621 bidi-reordered, these two positions can be anywhere in the
18622 row, so we must determine them now. */
18623 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18626 /* If the start of this line is the overlay arrow-position, then
18627 mark this glyph row as the one containing the overlay arrow.
18628 This is clearly a mess with variable size fonts. It would be
18629 better to let it be displayed like cursors under X. */
18630 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18631 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18632 !NILP (overlay_arrow_string
)))
18634 /* Overlay arrow in window redisplay is a fringe bitmap. */
18635 if (STRINGP (overlay_arrow_string
))
18637 struct glyph_row
*arrow_row
18638 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18639 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18640 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18641 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18642 struct glyph
*p2
, *end
;
18644 /* Copy the arrow glyphs. */
18645 while (glyph
< arrow_end
)
18648 /* Throw away padding glyphs. */
18650 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18651 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18657 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18662 xassert (INTEGERP (overlay_arrow_string
));
18663 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18665 overlay_arrow_seen
= 1;
18668 /* Compute pixel dimensions of this line. */
18669 compute_line_metrics (it
);
18671 /* Record whether this row ends inside an ellipsis. */
18672 row
->ends_in_ellipsis_p
18673 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18674 && it
->ellipsis_p
);
18676 /* Save fringe bitmaps in this row. */
18677 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18678 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18679 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18680 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18682 it
->left_user_fringe_bitmap
= 0;
18683 it
->left_user_fringe_face_id
= 0;
18684 it
->right_user_fringe_bitmap
= 0;
18685 it
->right_user_fringe_face_id
= 0;
18687 /* Maybe set the cursor. */
18688 cvpos
= it
->w
->cursor
.vpos
;
18690 /* In bidi-reordered rows, keep checking for proper cursor
18691 position even if one has been found already, because buffer
18692 positions in such rows change non-linearly with ROW->VPOS,
18693 when a line is continued. One exception: when we are at ZV,
18694 display cursor on the first suitable glyph row, since all
18695 the empty rows after that also have their position set to ZV. */
18696 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18697 lines' rows is implemented for bidi-reordered rows. */
18699 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18700 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18701 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18702 && cursor_row_p (row
))
18703 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18705 /* Highlight trailing whitespace. */
18706 if (!NILP (Vshow_trailing_whitespace
))
18707 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18709 /* Prepare for the next line. This line starts horizontally at (X
18710 HPOS) = (0 0). Vertical positions are incremented. As a
18711 convenience for the caller, IT->glyph_row is set to the next
18713 it
->current_x
= it
->hpos
= 0;
18714 it
->current_y
+= row
->height
;
18715 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18718 /* The next row should by default use the same value of the
18719 reversed_p flag as this one. set_iterator_to_next decides when
18720 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18721 the flag accordingly. */
18722 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18723 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18724 it
->start
= row
->end
;
18725 return row
->displays_text_p
;
18727 #undef RECORD_MAX_MIN_POS
18730 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18731 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18732 doc
: /* Return paragraph direction at point in BUFFER.
18733 Value is either `left-to-right' or `right-to-left'.
18734 If BUFFER is omitted or nil, it defaults to the current buffer.
18736 Paragraph direction determines how the text in the paragraph is displayed.
18737 In left-to-right paragraphs, text begins at the left margin of the window
18738 and the reading direction is generally left to right. In right-to-left
18739 paragraphs, text begins at the right margin and is read from right to left.
18741 See also `bidi-paragraph-direction'. */)
18742 (Lisp_Object buffer
)
18744 struct buffer
*buf
= current_buffer
;
18745 struct buffer
*old
= buf
;
18747 if (! NILP (buffer
))
18749 CHECK_BUFFER (buffer
);
18750 buf
= XBUFFER (buffer
);
18753 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18754 return Qleft_to_right
;
18755 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18756 return BVAR (buf
, bidi_paragraph_direction
);
18759 /* Determine the direction from buffer text. We could try to
18760 use current_matrix if it is up to date, but this seems fast
18761 enough as it is. */
18762 struct bidi_it itb
;
18763 EMACS_INT pos
= BUF_PT (buf
);
18764 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18767 set_buffer_temp (buf
);
18768 /* bidi_paragraph_init finds the base direction of the paragraph
18769 by searching forward from paragraph start. We need the base
18770 direction of the current or _previous_ paragraph, so we need
18771 to make sure we are within that paragraph. To that end, find
18772 the previous non-empty line. */
18773 if (pos
>= ZV
&& pos
> BEGV
)
18776 bytepos
= CHAR_TO_BYTE (pos
);
18778 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18779 || c
== ' ' || c
== '\t' || c
== '\f')
18781 if (bytepos
<= BEGV_BYTE
)
18786 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18789 itb
.bytepos
= bytepos
;
18791 itb
.string
.s
= NULL
;
18792 itb
.string
.lstring
= Qnil
;
18793 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18795 itb
.separator_limit
= -1;
18796 itb
.paragraph_dir
= NEUTRAL_DIR
;
18798 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18799 set_buffer_temp (old
);
18800 switch (itb
.paragraph_dir
)
18803 return Qleft_to_right
;
18806 return Qright_to_left
;
18816 /***********************************************************************
18818 ***********************************************************************/
18820 /* Redisplay the menu bar in the frame for window W.
18822 The menu bar of X frames that don't have X toolkit support is
18823 displayed in a special window W->frame->menu_bar_window.
18825 The menu bar of terminal frames is treated specially as far as
18826 glyph matrices are concerned. Menu bar lines are not part of
18827 windows, so the update is done directly on the frame matrix rows
18828 for the menu bar. */
18831 display_menu_bar (struct window
*w
)
18833 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18838 /* Don't do all this for graphical frames. */
18840 if (FRAME_W32_P (f
))
18843 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18849 if (FRAME_NS_P (f
))
18851 #endif /* HAVE_NS */
18853 #ifdef USE_X_TOOLKIT
18854 xassert (!FRAME_WINDOW_P (f
));
18855 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18856 it
.first_visible_x
= 0;
18857 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18858 #else /* not USE_X_TOOLKIT */
18859 if (FRAME_WINDOW_P (f
))
18861 /* Menu bar lines are displayed in the desired matrix of the
18862 dummy window menu_bar_window. */
18863 struct window
*menu_w
;
18864 xassert (WINDOWP (f
->menu_bar_window
));
18865 menu_w
= XWINDOW (f
->menu_bar_window
);
18866 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18868 it
.first_visible_x
= 0;
18869 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18873 /* This is a TTY frame, i.e. character hpos/vpos are used as
18875 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18877 it
.first_visible_x
= 0;
18878 it
.last_visible_x
= FRAME_COLS (f
);
18880 #endif /* not USE_X_TOOLKIT */
18882 /* FIXME: This should be controlled by a user option. See the
18883 comments in redisplay_tool_bar and display_mode_line about
18885 it
.paragraph_embedding
= L2R
;
18887 if (! mode_line_inverse_video
)
18888 /* Force the menu-bar to be displayed in the default face. */
18889 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18891 /* Clear all rows of the menu bar. */
18892 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18894 struct glyph_row
*row
= it
.glyph_row
+ i
;
18895 clear_glyph_row (row
);
18896 row
->enabled_p
= 1;
18897 row
->full_width_p
= 1;
18900 /* Display all items of the menu bar. */
18901 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18902 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18904 Lisp_Object string
;
18906 /* Stop at nil string. */
18907 string
= AREF (items
, i
+ 1);
18911 /* Remember where item was displayed. */
18912 ASET (items
, i
+ 3, make_number (it
.hpos
));
18914 /* Display the item, pad with one space. */
18915 if (it
.current_x
< it
.last_visible_x
)
18916 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18917 SCHARS (string
) + 1, 0, 0, -1);
18920 /* Fill out the line with spaces. */
18921 if (it
.current_x
< it
.last_visible_x
)
18922 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18924 /* Compute the total height of the lines. */
18925 compute_line_metrics (&it
);
18930 /***********************************************************************
18932 ***********************************************************************/
18934 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18935 FORCE is non-zero, redisplay mode lines unconditionally.
18936 Otherwise, redisplay only mode lines that are garbaged. Value is
18937 the number of windows whose mode lines were redisplayed. */
18940 redisplay_mode_lines (Lisp_Object window
, int force
)
18944 while (!NILP (window
))
18946 struct window
*w
= XWINDOW (window
);
18948 if (WINDOWP (w
->hchild
))
18949 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18950 else if (WINDOWP (w
->vchild
))
18951 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18953 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18954 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18956 struct text_pos lpoint
;
18957 struct buffer
*old
= current_buffer
;
18959 /* Set the window's buffer for the mode line display. */
18960 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18961 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18963 /* Point refers normally to the selected window. For any
18964 other window, set up appropriate value. */
18965 if (!EQ (window
, selected_window
))
18967 struct text_pos pt
;
18969 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18970 if (CHARPOS (pt
) < BEGV
)
18971 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18972 else if (CHARPOS (pt
) > (ZV
- 1))
18973 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18975 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18978 /* Display mode lines. */
18979 clear_glyph_matrix (w
->desired_matrix
);
18980 if (display_mode_lines (w
))
18983 w
->must_be_updated_p
= 1;
18986 /* Restore old settings. */
18987 set_buffer_internal_1 (old
);
18988 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18998 /* Display the mode and/or header line of window W. Value is the
18999 sum number of mode lines and header lines displayed. */
19002 display_mode_lines (struct window
*w
)
19004 Lisp_Object old_selected_window
, old_selected_frame
;
19007 old_selected_frame
= selected_frame
;
19008 selected_frame
= w
->frame
;
19009 old_selected_window
= selected_window
;
19010 XSETWINDOW (selected_window
, w
);
19012 /* These will be set while the mode line specs are processed. */
19013 line_number_displayed
= 0;
19014 w
->column_number_displayed
= Qnil
;
19016 if (WINDOW_WANTS_MODELINE_P (w
))
19018 struct window
*sel_w
= XWINDOW (old_selected_window
);
19020 /* Select mode line face based on the real selected window. */
19021 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19022 BVAR (current_buffer
, mode_line_format
));
19026 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19028 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19029 BVAR (current_buffer
, header_line_format
));
19033 selected_frame
= old_selected_frame
;
19034 selected_window
= old_selected_window
;
19039 /* Display mode or header line of window W. FACE_ID specifies which
19040 line to display; it is either MODE_LINE_FACE_ID or
19041 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19042 display. Value is the pixel height of the mode/header line
19046 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19050 int count
= SPECPDL_INDEX ();
19052 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19053 /* Don't extend on a previously drawn mode-line.
19054 This may happen if called from pos_visible_p. */
19055 it
.glyph_row
->enabled_p
= 0;
19056 prepare_desired_row (it
.glyph_row
);
19058 it
.glyph_row
->mode_line_p
= 1;
19060 if (! mode_line_inverse_video
)
19061 /* Force the mode-line to be displayed in the default face. */
19062 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19064 /* FIXME: This should be controlled by a user option. But
19065 supporting such an option is not trivial, since the mode line is
19066 made up of many separate strings. */
19067 it
.paragraph_embedding
= L2R
;
19069 record_unwind_protect (unwind_format_mode_line
,
19070 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19072 mode_line_target
= MODE_LINE_DISPLAY
;
19074 /* Temporarily make frame's keyboard the current kboard so that
19075 kboard-local variables in the mode_line_format will get the right
19077 push_kboard (FRAME_KBOARD (it
.f
));
19078 record_unwind_save_match_data ();
19079 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19082 unbind_to (count
, Qnil
);
19084 /* Fill up with spaces. */
19085 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19087 compute_line_metrics (&it
);
19088 it
.glyph_row
->full_width_p
= 1;
19089 it
.glyph_row
->continued_p
= 0;
19090 it
.glyph_row
->truncated_on_left_p
= 0;
19091 it
.glyph_row
->truncated_on_right_p
= 0;
19093 /* Make a 3D mode-line have a shadow at its right end. */
19094 face
= FACE_FROM_ID (it
.f
, face_id
);
19095 extend_face_to_end_of_line (&it
);
19096 if (face
->box
!= FACE_NO_BOX
)
19098 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19099 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19100 last
->right_box_line_p
= 1;
19103 return it
.glyph_row
->height
;
19106 /* Move element ELT in LIST to the front of LIST.
19107 Return the updated list. */
19110 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19112 register Lisp_Object tail
, prev
;
19113 register Lisp_Object tem
;
19117 while (CONSP (tail
))
19123 /* Splice out the link TAIL. */
19125 list
= XCDR (tail
);
19127 Fsetcdr (prev
, XCDR (tail
));
19129 /* Now make it the first. */
19130 Fsetcdr (tail
, list
);
19135 tail
= XCDR (tail
);
19139 /* Not found--return unchanged LIST. */
19143 /* Contribute ELT to the mode line for window IT->w. How it
19144 translates into text depends on its data type.
19146 IT describes the display environment in which we display, as usual.
19148 DEPTH is the depth in recursion. It is used to prevent
19149 infinite recursion here.
19151 FIELD_WIDTH is the number of characters the display of ELT should
19152 occupy in the mode line, and PRECISION is the maximum number of
19153 characters to display from ELT's representation. See
19154 display_string for details.
19156 Returns the hpos of the end of the text generated by ELT.
19158 PROPS is a property list to add to any string we encounter.
19160 If RISKY is nonzero, remove (disregard) any properties in any string
19161 we encounter, and ignore :eval and :propertize.
19163 The global variable `mode_line_target' determines whether the
19164 output is passed to `store_mode_line_noprop',
19165 `store_mode_line_string', or `display_string'. */
19168 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19169 Lisp_Object elt
, Lisp_Object props
, int risky
)
19171 int n
= 0, field
, prec
;
19176 elt
= build_string ("*too-deep*");
19180 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19184 /* A string: output it and check for %-constructs within it. */
19186 EMACS_INT offset
= 0;
19188 if (SCHARS (elt
) > 0
19189 && (!NILP (props
) || risky
))
19191 Lisp_Object oprops
, aelt
;
19192 oprops
= Ftext_properties_at (make_number (0), elt
);
19194 /* If the starting string's properties are not what
19195 we want, translate the string. Also, if the string
19196 is risky, do that anyway. */
19198 if (NILP (Fequal (props
, oprops
)) || risky
)
19200 /* If the starting string has properties,
19201 merge the specified ones onto the existing ones. */
19202 if (! NILP (oprops
) && !risky
)
19206 oprops
= Fcopy_sequence (oprops
);
19208 while (CONSP (tem
))
19210 oprops
= Fplist_put (oprops
, XCAR (tem
),
19211 XCAR (XCDR (tem
)));
19212 tem
= XCDR (XCDR (tem
));
19217 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19218 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19220 /* AELT is what we want. Move it to the front
19221 without consing. */
19223 mode_line_proptrans_alist
19224 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19230 /* If AELT has the wrong props, it is useless.
19231 so get rid of it. */
19233 mode_line_proptrans_alist
19234 = Fdelq (aelt
, mode_line_proptrans_alist
);
19236 elt
= Fcopy_sequence (elt
);
19237 Fset_text_properties (make_number (0), Flength (elt
),
19239 /* Add this item to mode_line_proptrans_alist. */
19240 mode_line_proptrans_alist
19241 = Fcons (Fcons (elt
, props
),
19242 mode_line_proptrans_alist
);
19243 /* Truncate mode_line_proptrans_alist
19244 to at most 50 elements. */
19245 tem
= Fnthcdr (make_number (50),
19246 mode_line_proptrans_alist
);
19248 XSETCDR (tem
, Qnil
);
19257 prec
= precision
- n
;
19258 switch (mode_line_target
)
19260 case MODE_LINE_NOPROP
:
19261 case MODE_LINE_TITLE
:
19262 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19264 case MODE_LINE_STRING
:
19265 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19267 case MODE_LINE_DISPLAY
:
19268 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19269 0, prec
, 0, STRING_MULTIBYTE (elt
));
19276 /* Handle the non-literal case. */
19278 while ((precision
<= 0 || n
< precision
)
19279 && SREF (elt
, offset
) != 0
19280 && (mode_line_target
!= MODE_LINE_DISPLAY
19281 || it
->current_x
< it
->last_visible_x
))
19283 EMACS_INT last_offset
= offset
;
19285 /* Advance to end of string or next format specifier. */
19286 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19289 if (offset
- 1 != last_offset
)
19291 EMACS_INT nchars
, nbytes
;
19293 /* Output to end of string or up to '%'. Field width
19294 is length of string. Don't output more than
19295 PRECISION allows us. */
19298 prec
= c_string_width (SDATA (elt
) + last_offset
,
19299 offset
- last_offset
, precision
- n
,
19302 switch (mode_line_target
)
19304 case MODE_LINE_NOPROP
:
19305 case MODE_LINE_TITLE
:
19306 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19308 case MODE_LINE_STRING
:
19310 EMACS_INT bytepos
= last_offset
;
19311 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19312 EMACS_INT endpos
= (precision
<= 0
19313 ? string_byte_to_char (elt
, offset
)
19314 : charpos
+ nchars
);
19316 n
+= store_mode_line_string (NULL
,
19317 Fsubstring (elt
, make_number (charpos
),
19318 make_number (endpos
)),
19322 case MODE_LINE_DISPLAY
:
19324 EMACS_INT bytepos
= last_offset
;
19325 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19327 if (precision
<= 0)
19328 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19329 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19331 STRING_MULTIBYTE (elt
));
19336 else /* c == '%' */
19338 EMACS_INT percent_position
= offset
;
19340 /* Get the specified minimum width. Zero means
19343 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19344 field
= field
* 10 + c
- '0';
19346 /* Don't pad beyond the total padding allowed. */
19347 if (field_width
- n
> 0 && field
> field_width
- n
)
19348 field
= field_width
- n
;
19350 /* Note that either PRECISION <= 0 or N < PRECISION. */
19351 prec
= precision
- n
;
19354 n
+= display_mode_element (it
, depth
, field
, prec
,
19355 Vglobal_mode_string
, props
,
19360 EMACS_INT bytepos
, charpos
;
19362 Lisp_Object string
;
19364 bytepos
= percent_position
;
19365 charpos
= (STRING_MULTIBYTE (elt
)
19366 ? string_byte_to_char (elt
, bytepos
)
19368 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19369 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19371 switch (mode_line_target
)
19373 case MODE_LINE_NOPROP
:
19374 case MODE_LINE_TITLE
:
19375 n
+= store_mode_line_noprop (spec
, field
, prec
);
19377 case MODE_LINE_STRING
:
19379 int len
= strlen (spec
);
19380 Lisp_Object tem
= make_string (spec
, len
);
19381 props
= Ftext_properties_at (make_number (charpos
), elt
);
19382 /* Should only keep face property in props */
19383 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19386 case MODE_LINE_DISPLAY
:
19388 int nglyphs_before
, nwritten
;
19390 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19391 nwritten
= display_string (spec
, string
, elt
,
19396 /* Assign to the glyphs written above the
19397 string where the `%x' came from, position
19401 struct glyph
*glyph
19402 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19406 for (i
= 0; i
< nwritten
; ++i
)
19408 glyph
[i
].object
= elt
;
19409 glyph
[i
].charpos
= charpos
;
19426 /* A symbol: process the value of the symbol recursively
19427 as if it appeared here directly. Avoid error if symbol void.
19428 Special case: if value of symbol is a string, output the string
19431 register Lisp_Object tem
;
19433 /* If the variable is not marked as risky to set
19434 then its contents are risky to use. */
19435 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19438 tem
= Fboundp (elt
);
19441 tem
= Fsymbol_value (elt
);
19442 /* If value is a string, output that string literally:
19443 don't check for % within it. */
19447 if (!EQ (tem
, elt
))
19449 /* Give up right away for nil or t. */
19459 register Lisp_Object car
, tem
;
19461 /* A cons cell: five distinct cases.
19462 If first element is :eval or :propertize, do something special.
19463 If first element is a string or a cons, process all the elements
19464 and effectively concatenate them.
19465 If first element is a negative number, truncate displaying cdr to
19466 at most that many characters. If positive, pad (with spaces)
19467 to at least that many characters.
19468 If first element is a symbol, process the cadr or caddr recursively
19469 according to whether the symbol's value is non-nil or nil. */
19471 if (EQ (car
, QCeval
))
19473 /* An element of the form (:eval FORM) means evaluate FORM
19474 and use the result as mode line elements. */
19479 if (CONSP (XCDR (elt
)))
19482 spec
= safe_eval (XCAR (XCDR (elt
)));
19483 n
+= display_mode_element (it
, depth
, field_width
- n
,
19484 precision
- n
, spec
, props
,
19488 else if (EQ (car
, QCpropertize
))
19490 /* An element of the form (:propertize ELT PROPS...)
19491 means display ELT but applying properties PROPS. */
19496 if (CONSP (XCDR (elt
)))
19497 n
+= display_mode_element (it
, depth
, field_width
- n
,
19498 precision
- n
, XCAR (XCDR (elt
)),
19499 XCDR (XCDR (elt
)), risky
);
19501 else if (SYMBOLP (car
))
19503 tem
= Fboundp (car
);
19507 /* elt is now the cdr, and we know it is a cons cell.
19508 Use its car if CAR has a non-nil value. */
19511 tem
= Fsymbol_value (car
);
19518 /* Symbol's value is nil (or symbol is unbound)
19519 Get the cddr of the original list
19520 and if possible find the caddr and use that. */
19524 else if (!CONSP (elt
))
19529 else if (INTEGERP (car
))
19531 register int lim
= XINT (car
);
19535 /* Negative int means reduce maximum width. */
19536 if (precision
<= 0)
19539 precision
= min (precision
, -lim
);
19543 /* Padding specified. Don't let it be more than
19544 current maximum. */
19546 lim
= min (precision
, lim
);
19548 /* If that's more padding than already wanted, queue it.
19549 But don't reduce padding already specified even if
19550 that is beyond the current truncation point. */
19551 field_width
= max (lim
, field_width
);
19555 else if (STRINGP (car
) || CONSP (car
))
19557 Lisp_Object halftail
= elt
;
19561 && (precision
<= 0 || n
< precision
))
19563 n
+= display_mode_element (it
, depth
,
19564 /* Do padding only after the last
19565 element in the list. */
19566 (! CONSP (XCDR (elt
))
19569 precision
- n
, XCAR (elt
),
19573 if ((len
& 1) == 0)
19574 halftail
= XCDR (halftail
);
19575 /* Check for cycle. */
19576 if (EQ (halftail
, elt
))
19585 elt
= build_string ("*invalid*");
19589 /* Pad to FIELD_WIDTH. */
19590 if (field_width
> 0 && n
< field_width
)
19592 switch (mode_line_target
)
19594 case MODE_LINE_NOPROP
:
19595 case MODE_LINE_TITLE
:
19596 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19598 case MODE_LINE_STRING
:
19599 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19601 case MODE_LINE_DISPLAY
:
19602 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19611 /* Store a mode-line string element in mode_line_string_list.
19613 If STRING is non-null, display that C string. Otherwise, the Lisp
19614 string LISP_STRING is displayed.
19616 FIELD_WIDTH is the minimum number of output glyphs to produce.
19617 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19618 with spaces. FIELD_WIDTH <= 0 means don't pad.
19620 PRECISION is the maximum number of characters to output from
19621 STRING. PRECISION <= 0 means don't truncate the string.
19623 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19624 properties to the string.
19626 PROPS are the properties to add to the string.
19627 The mode_line_string_face face property is always added to the string.
19631 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19632 int field_width
, int precision
, Lisp_Object props
)
19637 if (string
!= NULL
)
19639 len
= strlen (string
);
19640 if (precision
> 0 && len
> precision
)
19642 lisp_string
= make_string (string
, len
);
19644 props
= mode_line_string_face_prop
;
19645 else if (!NILP (mode_line_string_face
))
19647 Lisp_Object face
= Fplist_get (props
, Qface
);
19648 props
= Fcopy_sequence (props
);
19650 face
= mode_line_string_face
;
19652 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19653 props
= Fplist_put (props
, Qface
, face
);
19655 Fadd_text_properties (make_number (0), make_number (len
),
19656 props
, lisp_string
);
19660 len
= XFASTINT (Flength (lisp_string
));
19661 if (precision
> 0 && len
> precision
)
19664 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19667 if (!NILP (mode_line_string_face
))
19671 props
= Ftext_properties_at (make_number (0), lisp_string
);
19672 face
= Fplist_get (props
, Qface
);
19674 face
= mode_line_string_face
;
19676 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19677 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19679 lisp_string
= Fcopy_sequence (lisp_string
);
19682 Fadd_text_properties (make_number (0), make_number (len
),
19683 props
, lisp_string
);
19688 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19692 if (field_width
> len
)
19694 field_width
-= len
;
19695 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19697 Fadd_text_properties (make_number (0), make_number (field_width
),
19698 props
, lisp_string
);
19699 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19707 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19709 doc
: /* Format a string out of a mode line format specification.
19710 First arg FORMAT specifies the mode line format (see `mode-line-format'
19711 for details) to use.
19713 By default, the format is evaluated for the currently selected window.
19715 Optional second arg FACE specifies the face property to put on all
19716 characters for which no face is specified. The value nil means the
19717 default face. The value t means whatever face the window's mode line
19718 currently uses (either `mode-line' or `mode-line-inactive',
19719 depending on whether the window is the selected window or not).
19720 An integer value means the value string has no text
19723 Optional third and fourth args WINDOW and BUFFER specify the window
19724 and buffer to use as the context for the formatting (defaults
19725 are the selected window and the WINDOW's buffer). */)
19726 (Lisp_Object format
, Lisp_Object face
,
19727 Lisp_Object window
, Lisp_Object buffer
)
19732 struct buffer
*old_buffer
= NULL
;
19734 int no_props
= INTEGERP (face
);
19735 int count
= SPECPDL_INDEX ();
19737 int string_start
= 0;
19740 window
= selected_window
;
19741 CHECK_WINDOW (window
);
19742 w
= XWINDOW (window
);
19745 buffer
= w
->buffer
;
19746 CHECK_BUFFER (buffer
);
19748 /* Make formatting the modeline a non-op when noninteractive, otherwise
19749 there will be problems later caused by a partially initialized frame. */
19750 if (NILP (format
) || noninteractive
)
19751 return empty_unibyte_string
;
19756 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19757 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19758 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19759 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19760 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19761 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19762 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19765 if (XBUFFER (buffer
) != current_buffer
)
19766 old_buffer
= current_buffer
;
19768 /* Save things including mode_line_proptrans_alist,
19769 and set that to nil so that we don't alter the outer value. */
19770 record_unwind_protect (unwind_format_mode_line
,
19771 format_mode_line_unwind_data
19772 (old_buffer
, selected_window
, 1));
19773 mode_line_proptrans_alist
= Qnil
;
19775 Fselect_window (window
, Qt
);
19777 set_buffer_internal_1 (XBUFFER (buffer
));
19779 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19783 mode_line_target
= MODE_LINE_NOPROP
;
19784 mode_line_string_face_prop
= Qnil
;
19785 mode_line_string_list
= Qnil
;
19786 string_start
= MODE_LINE_NOPROP_LEN (0);
19790 mode_line_target
= MODE_LINE_STRING
;
19791 mode_line_string_list
= Qnil
;
19792 mode_line_string_face
= face
;
19793 mode_line_string_face_prop
19794 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19797 push_kboard (FRAME_KBOARD (it
.f
));
19798 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19803 len
= MODE_LINE_NOPROP_LEN (string_start
);
19804 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19808 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19809 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19810 empty_unibyte_string
);
19813 unbind_to (count
, Qnil
);
19817 /* Write a null-terminated, right justified decimal representation of
19818 the positive integer D to BUF using a minimal field width WIDTH. */
19821 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19823 register char *p
= buf
;
19831 *p
++ = d
% 10 + '0';
19836 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19847 /* Write a null-terminated, right justified decimal and "human
19848 readable" representation of the nonnegative integer D to BUF using
19849 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19851 static const char power_letter
[] =
19865 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19867 /* We aim to represent the nonnegative integer D as
19868 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19869 EMACS_INT quotient
= d
;
19871 /* -1 means: do not use TENTHS. */
19875 /* Length of QUOTIENT.TENTHS as a string. */
19881 if (1000 <= quotient
)
19883 /* Scale to the appropriate EXPONENT. */
19886 remainder
= quotient
% 1000;
19890 while (1000 <= quotient
);
19892 /* Round to nearest and decide whether to use TENTHS or not. */
19895 tenths
= remainder
/ 100;
19896 if (50 <= remainder
% 100)
19903 if (quotient
== 10)
19911 if (500 <= remainder
)
19913 if (quotient
< 999)
19924 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19925 if (tenths
== -1 && quotient
<= 99)
19932 p
= psuffix
= buf
+ max (width
, length
);
19934 /* Print EXPONENT. */
19935 *psuffix
++ = power_letter
[exponent
];
19938 /* Print TENTHS. */
19941 *--p
= '0' + tenths
;
19945 /* Print QUOTIENT. */
19948 int digit
= quotient
% 10;
19949 *--p
= '0' + digit
;
19951 while ((quotient
/= 10) != 0);
19953 /* Print leading spaces. */
19958 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19959 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19960 type of CODING_SYSTEM. Return updated pointer into BUF. */
19962 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19965 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19968 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19969 const unsigned char *eol_str
;
19971 /* The EOL conversion we are using. */
19972 Lisp_Object eoltype
;
19974 val
= CODING_SYSTEM_SPEC (coding_system
);
19977 if (!VECTORP (val
)) /* Not yet decided. */
19982 eoltype
= eol_mnemonic_undecided
;
19983 /* Don't mention EOL conversion if it isn't decided. */
19988 Lisp_Object eolvalue
;
19990 attrs
= AREF (val
, 0);
19991 eolvalue
= AREF (val
, 2);
19994 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19998 /* The EOL conversion that is normal on this system. */
20000 if (NILP (eolvalue
)) /* Not yet decided. */
20001 eoltype
= eol_mnemonic_undecided
;
20002 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20003 eoltype
= eol_mnemonic_undecided
;
20004 else /* eolvalue is Qunix, Qdos, or Qmac. */
20005 eoltype
= (EQ (eolvalue
, Qunix
)
20006 ? eol_mnemonic_unix
20007 : (EQ (eolvalue
, Qdos
) == 1
20008 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20014 /* Mention the EOL conversion if it is not the usual one. */
20015 if (STRINGP (eoltype
))
20017 eol_str
= SDATA (eoltype
);
20018 eol_str_len
= SBYTES (eoltype
);
20020 else if (CHARACTERP (eoltype
))
20022 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20023 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
20028 eol_str
= invalid_eol_type
;
20029 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20031 memcpy (buf
, eol_str
, eol_str_len
);
20032 buf
+= eol_str_len
;
20038 /* Return a string for the output of a mode line %-spec for window W,
20039 generated by character C. FIELD_WIDTH > 0 means pad the string
20040 returned with spaces to that value. Return a Lisp string in
20041 *STRING if the resulting string is taken from that Lisp string.
20043 Note we operate on the current buffer for most purposes,
20044 the exception being w->base_line_pos. */
20046 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20048 static const char *
20049 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20050 Lisp_Object
*string
)
20053 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20054 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20055 struct buffer
*b
= current_buffer
;
20063 if (!NILP (BVAR (b
, read_only
)))
20065 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20070 /* This differs from %* only for a modified read-only buffer. */
20071 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20073 if (!NILP (BVAR (b
, read_only
)))
20078 /* This differs from %* in ignoring read-only-ness. */
20079 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20091 if (command_loop_level
> 5)
20093 p
= decode_mode_spec_buf
;
20094 for (i
= 0; i
< command_loop_level
; i
++)
20097 return decode_mode_spec_buf
;
20105 if (command_loop_level
> 5)
20107 p
= decode_mode_spec_buf
;
20108 for (i
= 0; i
< command_loop_level
; i
++)
20111 return decode_mode_spec_buf
;
20118 /* Let lots_of_dashes be a string of infinite length. */
20119 if (mode_line_target
== MODE_LINE_NOPROP
||
20120 mode_line_target
== MODE_LINE_STRING
)
20122 if (field_width
<= 0
20123 || field_width
> sizeof (lots_of_dashes
))
20125 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20126 decode_mode_spec_buf
[i
] = '-';
20127 decode_mode_spec_buf
[i
] = '\0';
20128 return decode_mode_spec_buf
;
20131 return lots_of_dashes
;
20135 obj
= BVAR (b
, name
);
20139 /* %c and %l are ignored in `frame-title-format'.
20140 (In redisplay_internal, the frame title is drawn _before_ the
20141 windows are updated, so the stuff which depends on actual
20142 window contents (such as %l) may fail to render properly, or
20143 even crash emacs.) */
20144 if (mode_line_target
== MODE_LINE_TITLE
)
20148 EMACS_INT col
= current_column ();
20149 w
->column_number_displayed
= make_number (col
);
20150 pint2str (decode_mode_spec_buf
, field_width
, col
);
20151 return decode_mode_spec_buf
;
20155 #ifndef SYSTEM_MALLOC
20157 if (NILP (Vmemory_full
))
20160 return "!MEM FULL! ";
20167 /* %F displays the frame name. */
20168 if (!NILP (f
->title
))
20169 return SSDATA (f
->title
);
20170 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20171 return SSDATA (f
->name
);
20175 obj
= BVAR (b
, filename
);
20180 EMACS_INT size
= ZV
- BEGV
;
20181 pint2str (decode_mode_spec_buf
, field_width
, size
);
20182 return decode_mode_spec_buf
;
20187 EMACS_INT size
= ZV
- BEGV
;
20188 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20189 return decode_mode_spec_buf
;
20194 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20195 EMACS_INT topline
, nlines
, height
;
20198 /* %c and %l are ignored in `frame-title-format'. */
20199 if (mode_line_target
== MODE_LINE_TITLE
)
20202 startpos
= XMARKER (w
->start
)->charpos
;
20203 startpos_byte
= marker_byte_position (w
->start
);
20204 height
= WINDOW_TOTAL_LINES (w
);
20206 /* If we decided that this buffer isn't suitable for line numbers,
20207 don't forget that too fast. */
20208 if (EQ (w
->base_line_pos
, w
->buffer
))
20210 /* But do forget it, if the window shows a different buffer now. */
20211 else if (BUFFERP (w
->base_line_pos
))
20212 w
->base_line_pos
= Qnil
;
20214 /* If the buffer is very big, don't waste time. */
20215 if (INTEGERP (Vline_number_display_limit
)
20216 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20218 w
->base_line_pos
= Qnil
;
20219 w
->base_line_number
= Qnil
;
20223 if (INTEGERP (w
->base_line_number
)
20224 && INTEGERP (w
->base_line_pos
)
20225 && XFASTINT (w
->base_line_pos
) <= startpos
)
20227 line
= XFASTINT (w
->base_line_number
);
20228 linepos
= XFASTINT (w
->base_line_pos
);
20229 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20234 linepos
= BUF_BEGV (b
);
20235 linepos_byte
= BUF_BEGV_BYTE (b
);
20238 /* Count lines from base line to window start position. */
20239 nlines
= display_count_lines (linepos_byte
,
20243 topline
= nlines
+ line
;
20245 /* Determine a new base line, if the old one is too close
20246 or too far away, or if we did not have one.
20247 "Too close" means it's plausible a scroll-down would
20248 go back past it. */
20249 if (startpos
== BUF_BEGV (b
))
20251 w
->base_line_number
= make_number (topline
);
20252 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20254 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20255 || linepos
== BUF_BEGV (b
))
20257 EMACS_INT limit
= BUF_BEGV (b
);
20258 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20259 EMACS_INT position
;
20260 EMACS_INT distance
=
20261 (height
* 2 + 30) * line_number_display_limit_width
;
20263 if (startpos
- distance
> limit
)
20265 limit
= startpos
- distance
;
20266 limit_byte
= CHAR_TO_BYTE (limit
);
20269 nlines
= display_count_lines (startpos_byte
,
20271 - (height
* 2 + 30),
20273 /* If we couldn't find the lines we wanted within
20274 line_number_display_limit_width chars per line,
20275 give up on line numbers for this window. */
20276 if (position
== limit_byte
&& limit
== startpos
- distance
)
20278 w
->base_line_pos
= w
->buffer
;
20279 w
->base_line_number
= Qnil
;
20283 w
->base_line_number
= make_number (topline
- nlines
);
20284 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20287 /* Now count lines from the start pos to point. */
20288 nlines
= display_count_lines (startpos_byte
,
20289 PT_BYTE
, PT
, &junk
);
20291 /* Record that we did display the line number. */
20292 line_number_displayed
= 1;
20294 /* Make the string to show. */
20295 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20296 return decode_mode_spec_buf
;
20299 char* p
= decode_mode_spec_buf
;
20300 int pad
= field_width
- 2;
20306 return decode_mode_spec_buf
;
20312 obj
= BVAR (b
, mode_name
);
20316 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20322 EMACS_INT pos
= marker_position (w
->start
);
20323 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20325 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20327 if (pos
<= BUF_BEGV (b
))
20332 else if (pos
<= BUF_BEGV (b
))
20336 if (total
> 1000000)
20337 /* Do it differently for a large value, to avoid overflow. */
20338 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20340 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20341 /* We can't normally display a 3-digit number,
20342 so get us a 2-digit number that is close. */
20345 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20346 return decode_mode_spec_buf
;
20350 /* Display percentage of size above the bottom of the screen. */
20353 EMACS_INT toppos
= marker_position (w
->start
);
20354 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20355 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20357 if (botpos
>= BUF_ZV (b
))
20359 if (toppos
<= BUF_BEGV (b
))
20366 if (total
> 1000000)
20367 /* Do it differently for a large value, to avoid overflow. */
20368 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20370 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20371 /* We can't normally display a 3-digit number,
20372 so get us a 2-digit number that is close. */
20375 if (toppos
<= BUF_BEGV (b
))
20376 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20378 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20379 return decode_mode_spec_buf
;
20384 /* status of process */
20385 obj
= Fget_buffer_process (Fcurrent_buffer ());
20387 return "no process";
20389 obj
= Fsymbol_name (Fprocess_status (obj
));
20395 int count
= inhibit_garbage_collection ();
20396 Lisp_Object val
= call1 (intern ("file-remote-p"),
20397 BVAR (current_buffer
, directory
));
20398 unbind_to (count
, Qnil
);
20406 case 't': /* indicate TEXT or BINARY */
20410 /* coding-system (not including end-of-line format) */
20412 /* coding-system (including end-of-line type) */
20414 int eol_flag
= (c
== 'Z');
20415 char *p
= decode_mode_spec_buf
;
20417 if (! FRAME_WINDOW_P (f
))
20419 /* No need to mention EOL here--the terminal never needs
20420 to do EOL conversion. */
20421 p
= decode_mode_spec_coding (CODING_ID_NAME
20422 (FRAME_KEYBOARD_CODING (f
)->id
),
20424 p
= decode_mode_spec_coding (CODING_ID_NAME
20425 (FRAME_TERMINAL_CODING (f
)->id
),
20428 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20431 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20432 #ifdef subprocesses
20433 obj
= Fget_buffer_process (Fcurrent_buffer ());
20434 if (PROCESSP (obj
))
20436 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20438 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20441 #endif /* subprocesses */
20444 return decode_mode_spec_buf
;
20451 return SSDATA (obj
);
20458 /* Count up to COUNT lines starting from START_BYTE.
20459 But don't go beyond LIMIT_BYTE.
20460 Return the number of lines thus found (always nonnegative).
20462 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20465 display_count_lines (EMACS_INT start_byte
,
20466 EMACS_INT limit_byte
, EMACS_INT count
,
20467 EMACS_INT
*byte_pos_ptr
)
20469 register unsigned char *cursor
;
20470 unsigned char *base
;
20472 register EMACS_INT ceiling
;
20473 register unsigned char *ceiling_addr
;
20474 EMACS_INT orig_count
= count
;
20476 /* If we are not in selective display mode,
20477 check only for newlines. */
20478 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20479 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20483 while (start_byte
< limit_byte
)
20485 ceiling
= BUFFER_CEILING_OF (start_byte
);
20486 ceiling
= min (limit_byte
- 1, ceiling
);
20487 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20488 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20491 if (selective_display
)
20492 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20495 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20498 if (cursor
!= ceiling_addr
)
20502 start_byte
+= cursor
- base
+ 1;
20503 *byte_pos_ptr
= start_byte
;
20507 if (++cursor
== ceiling_addr
)
20513 start_byte
+= cursor
- base
;
20518 while (start_byte
> limit_byte
)
20520 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20521 ceiling
= max (limit_byte
, ceiling
);
20522 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20523 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20526 if (selective_display
)
20527 while (--cursor
!= ceiling_addr
20528 && *cursor
!= '\n' && *cursor
!= 015)
20531 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20534 if (cursor
!= ceiling_addr
)
20538 start_byte
+= cursor
- base
+ 1;
20539 *byte_pos_ptr
= start_byte
;
20540 /* When scanning backwards, we should
20541 not count the newline posterior to which we stop. */
20542 return - orig_count
- 1;
20548 /* Here we add 1 to compensate for the last decrement
20549 of CURSOR, which took it past the valid range. */
20550 start_byte
+= cursor
- base
+ 1;
20554 *byte_pos_ptr
= limit_byte
;
20557 return - orig_count
+ count
;
20558 return orig_count
- count
;
20564 /***********************************************************************
20566 ***********************************************************************/
20568 /* Display a NUL-terminated string, starting with index START.
20570 If STRING is non-null, display that C string. Otherwise, the Lisp
20571 string LISP_STRING is displayed. There's a case that STRING is
20572 non-null and LISP_STRING is not nil. It means STRING is a string
20573 data of LISP_STRING. In that case, we display LISP_STRING while
20574 ignoring its text properties.
20576 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20577 FACE_STRING. Display STRING or LISP_STRING with the face at
20578 FACE_STRING_POS in FACE_STRING:
20580 Display the string in the environment given by IT, but use the
20581 standard display table, temporarily.
20583 FIELD_WIDTH is the minimum number of output glyphs to produce.
20584 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20585 with spaces. If STRING has more characters, more than FIELD_WIDTH
20586 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20588 PRECISION is the maximum number of characters to output from
20589 STRING. PRECISION < 0 means don't truncate the string.
20591 This is roughly equivalent to printf format specifiers:
20593 FIELD_WIDTH PRECISION PRINTF
20594 ----------------------------------------
20600 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20601 display them, and < 0 means obey the current buffer's value of
20602 enable_multibyte_characters.
20604 Value is the number of columns displayed. */
20607 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20608 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20609 int field_width
, int precision
, int max_x
, int multibyte
)
20611 int hpos_at_start
= it
->hpos
;
20612 int saved_face_id
= it
->face_id
;
20613 struct glyph_row
*row
= it
->glyph_row
;
20614 EMACS_INT it_charpos
;
20616 /* Initialize the iterator IT for iteration over STRING beginning
20617 with index START. */
20618 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20619 precision
, field_width
, multibyte
);
20620 if (string
&& STRINGP (lisp_string
))
20621 /* LISP_STRING is the one returned by decode_mode_spec. We should
20622 ignore its text properties. */
20623 it
->stop_charpos
= it
->end_charpos
;
20625 /* If displaying STRING, set up the face of the iterator from
20626 FACE_STRING, if that's given. */
20627 if (STRINGP (face_string
))
20633 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20634 0, it
->region_beg_charpos
,
20635 it
->region_end_charpos
,
20636 &endptr
, it
->base_face_id
, 0);
20637 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20638 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20641 /* Set max_x to the maximum allowed X position. Don't let it go
20642 beyond the right edge of the window. */
20644 max_x
= it
->last_visible_x
;
20646 max_x
= min (max_x
, it
->last_visible_x
);
20648 /* Skip over display elements that are not visible. because IT->w is
20650 if (it
->current_x
< it
->first_visible_x
)
20651 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20652 MOVE_TO_POS
| MOVE_TO_X
);
20654 row
->ascent
= it
->max_ascent
;
20655 row
->height
= it
->max_ascent
+ it
->max_descent
;
20656 row
->phys_ascent
= it
->max_phys_ascent
;
20657 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20658 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20660 if (STRINGP (it
->string
))
20661 it_charpos
= IT_STRING_CHARPOS (*it
);
20663 it_charpos
= IT_CHARPOS (*it
);
20665 /* This condition is for the case that we are called with current_x
20666 past last_visible_x. */
20667 while (it
->current_x
< max_x
)
20669 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20671 /* Get the next display element. */
20672 if (!get_next_display_element (it
))
20675 /* Produce glyphs. */
20676 x_before
= it
->current_x
;
20677 n_glyphs_before
= row
->used
[TEXT_AREA
];
20678 PRODUCE_GLYPHS (it
);
20680 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20683 while (i
< nglyphs
)
20685 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20687 if (it
->line_wrap
!= TRUNCATE
20688 && x
+ glyph
->pixel_width
> max_x
)
20690 /* End of continued line or max_x reached. */
20691 if (CHAR_GLYPH_PADDING_P (*glyph
))
20693 /* A wide character is unbreakable. */
20694 if (row
->reversed_p
)
20695 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20696 - n_glyphs_before
);
20697 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20698 it
->current_x
= x_before
;
20702 if (row
->reversed_p
)
20703 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20704 - (n_glyphs_before
+ i
));
20705 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20710 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20712 /* Glyph is at least partially visible. */
20714 if (x
< it
->first_visible_x
)
20715 row
->x
= x
- it
->first_visible_x
;
20719 /* Glyph is off the left margin of the display area.
20720 Should not happen. */
20724 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20725 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20726 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20727 row
->phys_height
= max (row
->phys_height
,
20728 it
->max_phys_ascent
+ it
->max_phys_descent
);
20729 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20730 it
->max_extra_line_spacing
);
20731 x
+= glyph
->pixel_width
;
20735 /* Stop if max_x reached. */
20739 /* Stop at line ends. */
20740 if (ITERATOR_AT_END_OF_LINE_P (it
))
20742 it
->continuation_lines_width
= 0;
20746 set_iterator_to_next (it
, 1);
20747 if (STRINGP (it
->string
))
20748 it_charpos
= IT_STRING_CHARPOS (*it
);
20750 it_charpos
= IT_CHARPOS (*it
);
20752 /* Stop if truncating at the right edge. */
20753 if (it
->line_wrap
== TRUNCATE
20754 && it
->current_x
>= it
->last_visible_x
)
20756 /* Add truncation mark, but don't do it if the line is
20757 truncated at a padding space. */
20758 if (it_charpos
< it
->string_nchars
)
20760 if (!FRAME_WINDOW_P (it
->f
))
20764 if (it
->current_x
> it
->last_visible_x
)
20766 if (!row
->reversed_p
)
20768 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20769 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20774 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20775 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20777 unproduce_glyphs (it
, ii
+ 1);
20778 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20780 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20782 row
->used
[TEXT_AREA
] = ii
;
20783 produce_special_glyphs (it
, IT_TRUNCATION
);
20786 produce_special_glyphs (it
, IT_TRUNCATION
);
20788 row
->truncated_on_right_p
= 1;
20794 /* Maybe insert a truncation at the left. */
20795 if (it
->first_visible_x
20798 if (!FRAME_WINDOW_P (it
->f
))
20799 insert_left_trunc_glyphs (it
);
20800 row
->truncated_on_left_p
= 1;
20803 it
->face_id
= saved_face_id
;
20805 /* Value is number of columns displayed. */
20806 return it
->hpos
- hpos_at_start
;
20811 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20812 appears as an element of LIST or as the car of an element of LIST.
20813 If PROPVAL is a list, compare each element against LIST in that
20814 way, and return 1/2 if any element of PROPVAL is found in LIST.
20815 Otherwise return 0. This function cannot quit.
20816 The return value is 2 if the text is invisible but with an ellipsis
20817 and 1 if it's invisible and without an ellipsis. */
20820 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20822 register Lisp_Object tail
, proptail
;
20824 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20826 register Lisp_Object tem
;
20828 if (EQ (propval
, tem
))
20830 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20831 return NILP (XCDR (tem
)) ? 1 : 2;
20834 if (CONSP (propval
))
20836 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20838 Lisp_Object propelt
;
20839 propelt
= XCAR (proptail
);
20840 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20842 register Lisp_Object tem
;
20844 if (EQ (propelt
, tem
))
20846 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20847 return NILP (XCDR (tem
)) ? 1 : 2;
20855 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20856 doc
: /* Non-nil if the property makes the text invisible.
20857 POS-OR-PROP can be a marker or number, in which case it is taken to be
20858 a position in the current buffer and the value of the `invisible' property
20859 is checked; or it can be some other value, which is then presumed to be the
20860 value of the `invisible' property of the text of interest.
20861 The non-nil value returned can be t for truly invisible text or something
20862 else if the text is replaced by an ellipsis. */)
20863 (Lisp_Object pos_or_prop
)
20866 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20867 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20869 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20870 return (invis
== 0 ? Qnil
20872 : make_number (invis
));
20875 /* Calculate a width or height in pixels from a specification using
20876 the following elements:
20879 NUM - a (fractional) multiple of the default font width/height
20880 (NUM) - specifies exactly NUM pixels
20881 UNIT - a fixed number of pixels, see below.
20882 ELEMENT - size of a display element in pixels, see below.
20883 (NUM . SPEC) - equals NUM * SPEC
20884 (+ SPEC SPEC ...) - add pixel values
20885 (- SPEC SPEC ...) - subtract pixel values
20886 (- SPEC) - negate pixel value
20889 INT or FLOAT - a number constant
20890 SYMBOL - use symbol's (buffer local) variable binding.
20893 in - pixels per inch *)
20894 mm - pixels per 1/1000 meter *)
20895 cm - pixels per 1/100 meter *)
20896 width - width of current font in pixels.
20897 height - height of current font in pixels.
20899 *) using the ratio(s) defined in display-pixels-per-inch.
20903 left-fringe - left fringe width in pixels
20904 right-fringe - right fringe width in pixels
20906 left-margin - left margin width in pixels
20907 right-margin - right margin width in pixels
20909 scroll-bar - scroll-bar area width in pixels
20913 Pixels corresponding to 5 inches:
20916 Total width of non-text areas on left side of window (if scroll-bar is on left):
20917 '(space :width (+ left-fringe left-margin scroll-bar))
20919 Align to first text column (in header line):
20920 '(space :align-to 0)
20922 Align to middle of text area minus half the width of variable `my-image'
20923 containing a loaded image:
20924 '(space :align-to (0.5 . (- text my-image)))
20926 Width of left margin minus width of 1 character in the default font:
20927 '(space :width (- left-margin 1))
20929 Width of left margin minus width of 2 characters in the current font:
20930 '(space :width (- left-margin (2 . width)))
20932 Center 1 character over left-margin (in header line):
20933 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20935 Different ways to express width of left fringe plus left margin minus one pixel:
20936 '(space :width (- (+ left-fringe left-margin) (1)))
20937 '(space :width (+ left-fringe left-margin (- (1))))
20938 '(space :width (+ left-fringe left-margin (-1)))
20942 #define NUMVAL(X) \
20943 ((INTEGERP (X) || FLOATP (X)) \
20948 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20949 struct font
*font
, int width_p
, int *align_to
)
20953 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20954 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20957 return OK_PIXELS (0);
20959 xassert (FRAME_LIVE_P (it
->f
));
20961 if (SYMBOLP (prop
))
20963 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20965 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20967 if (unit
[0] == 'i' && unit
[1] == 'n')
20969 else if (unit
[0] == 'm' && unit
[1] == 'm')
20971 else if (unit
[0] == 'c' && unit
[1] == 'm')
20978 #ifdef HAVE_WINDOW_SYSTEM
20979 if (FRAME_WINDOW_P (it
->f
)
20981 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20982 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20984 return OK_PIXELS (ppi
/ pixels
);
20987 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20988 || (CONSP (Vdisplay_pixels_per_inch
)
20990 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20991 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20993 return OK_PIXELS (ppi
/ pixels
);
20999 #ifdef HAVE_WINDOW_SYSTEM
21000 if (EQ (prop
, Qheight
))
21001 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21002 if (EQ (prop
, Qwidth
))
21003 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21005 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21006 return OK_PIXELS (1);
21009 if (EQ (prop
, Qtext
))
21010 return OK_PIXELS (width_p
21011 ? window_box_width (it
->w
, TEXT_AREA
)
21012 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21014 if (align_to
&& *align_to
< 0)
21017 if (EQ (prop
, Qleft
))
21018 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21019 if (EQ (prop
, Qright
))
21020 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21021 if (EQ (prop
, Qcenter
))
21022 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21023 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21024 if (EQ (prop
, Qleft_fringe
))
21025 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21026 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21027 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21028 if (EQ (prop
, Qright_fringe
))
21029 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21030 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21031 : window_box_right_offset (it
->w
, TEXT_AREA
));
21032 if (EQ (prop
, Qleft_margin
))
21033 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21034 if (EQ (prop
, Qright_margin
))
21035 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21036 if (EQ (prop
, Qscroll_bar
))
21037 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21039 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21040 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21041 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21046 if (EQ (prop
, Qleft_fringe
))
21047 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21048 if (EQ (prop
, Qright_fringe
))
21049 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21050 if (EQ (prop
, Qleft_margin
))
21051 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21052 if (EQ (prop
, Qright_margin
))
21053 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21054 if (EQ (prop
, Qscroll_bar
))
21055 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21058 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21061 if (INTEGERP (prop
) || FLOATP (prop
))
21063 int base_unit
= (width_p
21064 ? FRAME_COLUMN_WIDTH (it
->f
)
21065 : FRAME_LINE_HEIGHT (it
->f
));
21066 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21071 Lisp_Object car
= XCAR (prop
);
21072 Lisp_Object cdr
= XCDR (prop
);
21076 #ifdef HAVE_WINDOW_SYSTEM
21077 if (FRAME_WINDOW_P (it
->f
)
21078 && valid_image_p (prop
))
21080 int id
= lookup_image (it
->f
, prop
);
21081 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21083 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21086 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21092 while (CONSP (cdr
))
21094 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21095 font
, width_p
, align_to
))
21098 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21103 if (EQ (car
, Qminus
))
21105 return OK_PIXELS (pixels
);
21108 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21111 if (INTEGERP (car
) || FLOATP (car
))
21114 pixels
= XFLOATINT (car
);
21116 return OK_PIXELS (pixels
);
21117 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21118 font
, width_p
, align_to
))
21119 return OK_PIXELS (pixels
* fact
);
21130 /***********************************************************************
21132 ***********************************************************************/
21134 #ifdef HAVE_WINDOW_SYSTEM
21139 dump_glyph_string (s
)
21140 struct glyph_string
*s
;
21142 fprintf (stderr
, "glyph string\n");
21143 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21144 s
->x
, s
->y
, s
->width
, s
->height
);
21145 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21146 fprintf (stderr
, " hl = %d\n", s
->hl
);
21147 fprintf (stderr
, " left overhang = %d, right = %d\n",
21148 s
->left_overhang
, s
->right_overhang
);
21149 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21150 fprintf (stderr
, " extends to end of line = %d\n",
21151 s
->extends_to_end_of_line_p
);
21152 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21153 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21156 #endif /* GLYPH_DEBUG */
21158 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21159 of XChar2b structures for S; it can't be allocated in
21160 init_glyph_string because it must be allocated via `alloca'. W
21161 is the window on which S is drawn. ROW and AREA are the glyph row
21162 and area within the row from which S is constructed. START is the
21163 index of the first glyph structure covered by S. HL is a
21164 face-override for drawing S. */
21167 #define OPTIONAL_HDC(hdc) HDC hdc,
21168 #define DECLARE_HDC(hdc) HDC hdc;
21169 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21170 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21173 #ifndef OPTIONAL_HDC
21174 #define OPTIONAL_HDC(hdc)
21175 #define DECLARE_HDC(hdc)
21176 #define ALLOCATE_HDC(hdc, f)
21177 #define RELEASE_HDC(hdc, f)
21181 init_glyph_string (struct glyph_string
*s
,
21183 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21184 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21186 memset (s
, 0, sizeof *s
);
21188 s
->f
= XFRAME (w
->frame
);
21192 s
->display
= FRAME_X_DISPLAY (s
->f
);
21193 s
->window
= FRAME_X_WINDOW (s
->f
);
21194 s
->char2b
= char2b
;
21198 s
->first_glyph
= row
->glyphs
[area
] + start
;
21199 s
->height
= row
->height
;
21200 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21201 s
->ybase
= s
->y
+ row
->ascent
;
21205 /* Append the list of glyph strings with head H and tail T to the list
21206 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21209 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21210 struct glyph_string
*h
, struct glyph_string
*t
)
21224 /* Prepend the list of glyph strings with head H and tail T to the
21225 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21229 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21230 struct glyph_string
*h
, struct glyph_string
*t
)
21244 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21245 Set *HEAD and *TAIL to the resulting list. */
21248 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21249 struct glyph_string
*s
)
21251 s
->next
= s
->prev
= NULL
;
21252 append_glyph_string_lists (head
, tail
, s
, s
);
21256 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21257 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21258 make sure that X resources for the face returned are allocated.
21259 Value is a pointer to a realized face that is ready for display if
21260 DISPLAY_P is non-zero. */
21262 static INLINE
struct face
*
21263 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21264 XChar2b
*char2b
, int display_p
)
21266 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21270 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21272 if (code
!= FONT_INVALID_CODE
)
21273 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21275 STORE_XCHAR2B (char2b
, 0, 0);
21278 /* Make sure X resources of the face are allocated. */
21279 #ifdef HAVE_X_WINDOWS
21283 xassert (face
!= NULL
);
21284 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21291 /* Get face and two-byte form of character glyph GLYPH on frame F.
21292 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21293 a pointer to a realized face that is ready for display. */
21295 static INLINE
struct face
*
21296 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21297 XChar2b
*char2b
, int *two_byte_p
)
21301 xassert (glyph
->type
== CHAR_GLYPH
);
21302 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21311 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21312 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21314 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21316 if (code
!= FONT_INVALID_CODE
)
21317 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21319 STORE_XCHAR2B (char2b
, 0, 0);
21322 /* Make sure X resources of the face are allocated. */
21323 xassert (face
!= NULL
);
21324 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21329 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21330 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21333 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21337 if (CHAR_BYTE8_P (c
))
21338 code
= CHAR_TO_BYTE8 (c
);
21340 code
= font
->driver
->encode_char (font
, c
);
21342 if (code
== FONT_INVALID_CODE
)
21344 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21349 /* Fill glyph string S with composition components specified by S->cmp.
21351 BASE_FACE is the base face of the composition.
21352 S->cmp_from is the index of the first component for S.
21354 OVERLAPS non-zero means S should draw the foreground only, and use
21355 its physical height for clipping. See also draw_glyphs.
21357 Value is the index of a component not in S. */
21360 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21364 /* For all glyphs of this composition, starting at the offset
21365 S->cmp_from, until we reach the end of the definition or encounter a
21366 glyph that requires the different face, add it to S. */
21371 s
->for_overlaps
= overlaps
;
21374 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21376 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21380 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21383 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21390 s
->font
= s
->face
->font
;
21392 else if (s
->face
!= face
)
21400 /* All glyph strings for the same composition has the same width,
21401 i.e. the width set for the first component of the composition. */
21402 s
->width
= s
->first_glyph
->pixel_width
;
21404 /* If the specified font could not be loaded, use the frame's
21405 default font, but record the fact that we couldn't load it in
21406 the glyph string so that we can draw rectangles for the
21407 characters of the glyph string. */
21408 if (s
->font
== NULL
)
21410 s
->font_not_found_p
= 1;
21411 s
->font
= FRAME_FONT (s
->f
);
21414 /* Adjust base line for subscript/superscript text. */
21415 s
->ybase
+= s
->first_glyph
->voffset
;
21417 /* This glyph string must always be drawn with 16-bit functions. */
21424 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21425 int start
, int end
, int overlaps
)
21427 struct glyph
*glyph
, *last
;
21428 Lisp_Object lgstring
;
21431 s
->for_overlaps
= overlaps
;
21432 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21433 last
= s
->row
->glyphs
[s
->area
] + end
;
21434 s
->cmp_id
= glyph
->u
.cmp
.id
;
21435 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21436 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21437 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21438 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21439 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21441 while (glyph
< last
21442 && glyph
->u
.cmp
.automatic
21443 && glyph
->u
.cmp
.id
== s
->cmp_id
21444 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21445 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21447 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21449 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21450 unsigned code
= LGLYPH_CODE (lglyph
);
21452 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21454 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21455 return glyph
- s
->row
->glyphs
[s
->area
];
21459 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21460 See the comment of fill_glyph_string for arguments.
21461 Value is the index of the first glyph not in S. */
21465 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21466 int start
, int end
, int overlaps
)
21468 struct glyph
*glyph
, *last
;
21471 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21472 s
->for_overlaps
= overlaps
;
21473 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21474 last
= s
->row
->glyphs
[s
->area
] + end
;
21475 voffset
= glyph
->voffset
;
21476 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21477 s
->font
= s
->face
->font
;
21479 s
->width
= glyph
->pixel_width
;
21481 while (glyph
< last
21482 && glyph
->type
== GLYPHLESS_GLYPH
21483 && glyph
->voffset
== voffset
21484 && glyph
->face_id
== face_id
)
21487 s
->width
+= glyph
->pixel_width
;
21490 s
->ybase
+= voffset
;
21491 return glyph
- s
->row
->glyphs
[s
->area
];
21495 /* Fill glyph string S from a sequence of character glyphs.
21497 FACE_ID is the face id of the string. START is the index of the
21498 first glyph to consider, END is the index of the last + 1.
21499 OVERLAPS non-zero means S should draw the foreground only, and use
21500 its physical height for clipping. See also draw_glyphs.
21502 Value is the index of the first glyph not in S. */
21505 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21506 int start
, int end
, int overlaps
)
21508 struct glyph
*glyph
, *last
;
21510 int glyph_not_available_p
;
21512 xassert (s
->f
== XFRAME (s
->w
->frame
));
21513 xassert (s
->nchars
== 0);
21514 xassert (start
>= 0 && end
> start
);
21516 s
->for_overlaps
= overlaps
;
21517 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21518 last
= s
->row
->glyphs
[s
->area
] + end
;
21519 voffset
= glyph
->voffset
;
21520 s
->padding_p
= glyph
->padding_p
;
21521 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21523 while (glyph
< last
21524 && glyph
->type
== CHAR_GLYPH
21525 && glyph
->voffset
== voffset
21526 /* Same face id implies same font, nowadays. */
21527 && glyph
->face_id
== face_id
21528 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21532 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21533 s
->char2b
+ s
->nchars
,
21535 s
->two_byte_p
= two_byte_p
;
21537 xassert (s
->nchars
<= end
- start
);
21538 s
->width
+= glyph
->pixel_width
;
21539 if (glyph
++->padding_p
!= s
->padding_p
)
21543 s
->font
= s
->face
->font
;
21545 /* If the specified font could not be loaded, use the frame's font,
21546 but record the fact that we couldn't load it in
21547 S->font_not_found_p so that we can draw rectangles for the
21548 characters of the glyph string. */
21549 if (s
->font
== NULL
|| glyph_not_available_p
)
21551 s
->font_not_found_p
= 1;
21552 s
->font
= FRAME_FONT (s
->f
);
21555 /* Adjust base line for subscript/superscript text. */
21556 s
->ybase
+= voffset
;
21558 xassert (s
->face
&& s
->face
->gc
);
21559 return glyph
- s
->row
->glyphs
[s
->area
];
21563 /* Fill glyph string S from image glyph S->first_glyph. */
21566 fill_image_glyph_string (struct glyph_string
*s
)
21568 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21569 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21571 s
->slice
= s
->first_glyph
->slice
.img
;
21572 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21573 s
->font
= s
->face
->font
;
21574 s
->width
= s
->first_glyph
->pixel_width
;
21576 /* Adjust base line for subscript/superscript text. */
21577 s
->ybase
+= s
->first_glyph
->voffset
;
21581 /* Fill glyph string S from a sequence of stretch glyphs.
21583 START is the index of the first glyph to consider,
21584 END is the index of the last + 1.
21586 Value is the index of the first glyph not in S. */
21589 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21591 struct glyph
*glyph
, *last
;
21592 int voffset
, face_id
;
21594 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21596 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21597 last
= s
->row
->glyphs
[s
->area
] + end
;
21598 face_id
= glyph
->face_id
;
21599 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21600 s
->font
= s
->face
->font
;
21601 s
->width
= glyph
->pixel_width
;
21603 voffset
= glyph
->voffset
;
21607 && glyph
->type
== STRETCH_GLYPH
21608 && glyph
->voffset
== voffset
21609 && glyph
->face_id
== face_id
);
21611 s
->width
+= glyph
->pixel_width
;
21613 /* Adjust base line for subscript/superscript text. */
21614 s
->ybase
+= voffset
;
21616 /* The case that face->gc == 0 is handled when drawing the glyph
21617 string by calling PREPARE_FACE_FOR_DISPLAY. */
21619 return glyph
- s
->row
->glyphs
[s
->area
];
21622 static struct font_metrics
*
21623 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21625 static struct font_metrics metrics
;
21626 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21628 if (! font
|| code
== FONT_INVALID_CODE
)
21630 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21635 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21636 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21637 assumed to be zero. */
21640 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21642 *left
= *right
= 0;
21644 if (glyph
->type
== CHAR_GLYPH
)
21648 struct font_metrics
*pcm
;
21650 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21651 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21653 if (pcm
->rbearing
> pcm
->width
)
21654 *right
= pcm
->rbearing
- pcm
->width
;
21655 if (pcm
->lbearing
< 0)
21656 *left
= -pcm
->lbearing
;
21659 else if (glyph
->type
== COMPOSITE_GLYPH
)
21661 if (! glyph
->u
.cmp
.automatic
)
21663 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21665 if (cmp
->rbearing
> cmp
->pixel_width
)
21666 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21667 if (cmp
->lbearing
< 0)
21668 *left
= - cmp
->lbearing
;
21672 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21673 struct font_metrics metrics
;
21675 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21676 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21677 if (metrics
.rbearing
> metrics
.width
)
21678 *right
= metrics
.rbearing
- metrics
.width
;
21679 if (metrics
.lbearing
< 0)
21680 *left
= - metrics
.lbearing
;
21686 /* Return the index of the first glyph preceding glyph string S that
21687 is overwritten by S because of S's left overhang. Value is -1
21688 if no glyphs are overwritten. */
21691 left_overwritten (struct glyph_string
*s
)
21695 if (s
->left_overhang
)
21698 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21699 int first
= s
->first_glyph
- glyphs
;
21701 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21702 x
-= glyphs
[i
].pixel_width
;
21713 /* Return the index of the first glyph preceding glyph string S that
21714 is overwriting S because of its right overhang. Value is -1 if no
21715 glyph in front of S overwrites S. */
21718 left_overwriting (struct glyph_string
*s
)
21721 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21722 int first
= s
->first_glyph
- glyphs
;
21726 for (i
= first
- 1; i
>= 0; --i
)
21729 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21732 x
-= glyphs
[i
].pixel_width
;
21739 /* Return the index of the last glyph following glyph string S that is
21740 overwritten by S because of S's right overhang. Value is -1 if
21741 no such glyph is found. */
21744 right_overwritten (struct glyph_string
*s
)
21748 if (s
->right_overhang
)
21751 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21752 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21753 int end
= s
->row
->used
[s
->area
];
21755 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21756 x
+= glyphs
[i
].pixel_width
;
21765 /* Return the index of the last glyph following glyph string S that
21766 overwrites S because of its left overhang. Value is negative
21767 if no such glyph is found. */
21770 right_overwriting (struct glyph_string
*s
)
21773 int end
= s
->row
->used
[s
->area
];
21774 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21775 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21779 for (i
= first
; i
< end
; ++i
)
21782 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21785 x
+= glyphs
[i
].pixel_width
;
21792 /* Set background width of glyph string S. START is the index of the
21793 first glyph following S. LAST_X is the right-most x-position + 1
21794 in the drawing area. */
21797 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21799 /* If the face of this glyph string has to be drawn to the end of
21800 the drawing area, set S->extends_to_end_of_line_p. */
21802 if (start
== s
->row
->used
[s
->area
]
21803 && s
->area
== TEXT_AREA
21804 && ((s
->row
->fill_line_p
21805 && (s
->hl
== DRAW_NORMAL_TEXT
21806 || s
->hl
== DRAW_IMAGE_RAISED
21807 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21808 || s
->hl
== DRAW_MOUSE_FACE
))
21809 s
->extends_to_end_of_line_p
= 1;
21811 /* If S extends its face to the end of the line, set its
21812 background_width to the distance to the right edge of the drawing
21814 if (s
->extends_to_end_of_line_p
)
21815 s
->background_width
= last_x
- s
->x
+ 1;
21817 s
->background_width
= s
->width
;
21821 /* Compute overhangs and x-positions for glyph string S and its
21822 predecessors, or successors. X is the starting x-position for S.
21823 BACKWARD_P non-zero means process predecessors. */
21826 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21832 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21833 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21843 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21844 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21854 /* The following macros are only called from draw_glyphs below.
21855 They reference the following parameters of that function directly:
21856 `w', `row', `area', and `overlap_p'
21857 as well as the following local variables:
21858 `s', `f', and `hdc' (in W32) */
21861 /* On W32, silently add local `hdc' variable to argument list of
21862 init_glyph_string. */
21863 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21864 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21866 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21867 init_glyph_string (s, char2b, w, row, area, start, hl)
21870 /* Add a glyph string for a stretch glyph to the list of strings
21871 between HEAD and TAIL. START is the index of the stretch glyph in
21872 row area AREA of glyph row ROW. END is the index of the last glyph
21873 in that glyph row area. X is the current output position assigned
21874 to the new glyph string constructed. HL overrides that face of the
21875 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21876 is the right-most x-position of the drawing area. */
21878 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21879 and below -- keep them on one line. */
21880 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21883 s = (struct glyph_string *) alloca (sizeof *s); \
21884 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21885 START = fill_stretch_glyph_string (s, START, END); \
21886 append_glyph_string (&HEAD, &TAIL, s); \
21892 /* Add a glyph string for an image glyph to the list of strings
21893 between HEAD and TAIL. START is the index of the image glyph in
21894 row area AREA of glyph row ROW. END is the index of the last glyph
21895 in that glyph row area. X is the current output position assigned
21896 to the new glyph string constructed. HL overrides that face of the
21897 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21898 is the right-most x-position of the drawing area. */
21900 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21903 s = (struct glyph_string *) alloca (sizeof *s); \
21904 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21905 fill_image_glyph_string (s); \
21906 append_glyph_string (&HEAD, &TAIL, s); \
21913 /* Add a glyph string for a sequence of character glyphs to the list
21914 of strings between HEAD and TAIL. START is the index of the first
21915 glyph in row area AREA of glyph row ROW that is part of the new
21916 glyph string. END is the index of the last glyph in that glyph row
21917 area. X is the current output position assigned to the new glyph
21918 string constructed. HL overrides that face of the glyph; e.g. it
21919 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21920 right-most x-position of the drawing area. */
21922 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21928 face_id = (row)->glyphs[area][START].face_id; \
21930 s = (struct glyph_string *) alloca (sizeof *s); \
21931 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21932 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21933 append_glyph_string (&HEAD, &TAIL, s); \
21935 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21940 /* Add a glyph string for a composite sequence to the list of strings
21941 between HEAD and TAIL. START is the index of the first glyph in
21942 row area AREA of glyph row ROW that is part of the new glyph
21943 string. END is the index of the last glyph in that glyph row area.
21944 X is the current output position assigned to the new glyph string
21945 constructed. HL overrides that face of the glyph; e.g. it is
21946 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21947 x-position of the drawing area. */
21949 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21951 int face_id = (row)->glyphs[area][START].face_id; \
21952 struct face *base_face = FACE_FROM_ID (f, face_id); \
21953 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21954 struct composition *cmp = composition_table[cmp_id]; \
21956 struct glyph_string *first_s IF_LINT (= NULL); \
21959 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21961 /* Make glyph_strings for each glyph sequence that is drawable by \
21962 the same face, and append them to HEAD/TAIL. */ \
21963 for (n = 0; n < cmp->glyph_len;) \
21965 s = (struct glyph_string *) alloca (sizeof *s); \
21966 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21967 append_glyph_string (&(HEAD), &(TAIL), s); \
21973 n = fill_composite_glyph_string (s, base_face, overlaps); \
21981 /* Add a glyph string for a glyph-string sequence to the list of strings
21982 between HEAD and TAIL. */
21984 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21988 Lisp_Object gstring; \
21990 face_id = (row)->glyphs[area][START].face_id; \
21991 gstring = (composition_gstring_from_id \
21992 ((row)->glyphs[area][START].u.cmp.id)); \
21993 s = (struct glyph_string *) alloca (sizeof *s); \
21994 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21995 * LGSTRING_GLYPH_LEN (gstring)); \
21996 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21997 append_glyph_string (&(HEAD), &(TAIL), s); \
21999 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22003 /* Add a glyph string for a sequence of glyphless character's glyphs
22004 to the list of strings between HEAD and TAIL. The meanings of
22005 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22007 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22012 face_id = (row)->glyphs[area][START].face_id; \
22014 s = (struct glyph_string *) alloca (sizeof *s); \
22015 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22016 append_glyph_string (&HEAD, &TAIL, s); \
22018 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22024 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22025 of AREA of glyph row ROW on window W between indices START and END.
22026 HL overrides the face for drawing glyph strings, e.g. it is
22027 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22028 x-positions of the drawing area.
22030 This is an ugly monster macro construct because we must use alloca
22031 to allocate glyph strings (because draw_glyphs can be called
22032 asynchronously). */
22034 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22037 HEAD = TAIL = NULL; \
22038 while (START < END) \
22040 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22041 switch (first_glyph->type) \
22044 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22048 case COMPOSITE_GLYPH: \
22049 if (first_glyph->u.cmp.automatic) \
22050 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22053 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22057 case STRETCH_GLYPH: \
22058 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22062 case IMAGE_GLYPH: \
22063 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22067 case GLYPHLESS_GLYPH: \
22068 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22078 set_glyph_string_background_width (s, START, LAST_X); \
22085 /* Draw glyphs between START and END in AREA of ROW on window W,
22086 starting at x-position X. X is relative to AREA in W. HL is a
22087 face-override with the following meaning:
22089 DRAW_NORMAL_TEXT draw normally
22090 DRAW_CURSOR draw in cursor face
22091 DRAW_MOUSE_FACE draw in mouse face.
22092 DRAW_INVERSE_VIDEO draw in mode line face
22093 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22094 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22096 If OVERLAPS is non-zero, draw only the foreground of characters and
22097 clip to the physical height of ROW. Non-zero value also defines
22098 the overlapping part to be drawn:
22100 OVERLAPS_PRED overlap with preceding rows
22101 OVERLAPS_SUCC overlap with succeeding rows
22102 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22103 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22105 Value is the x-position reached, relative to AREA of W. */
22108 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22109 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22110 enum draw_glyphs_face hl
, int overlaps
)
22112 struct glyph_string
*head
, *tail
;
22113 struct glyph_string
*s
;
22114 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22115 int i
, j
, x_reached
, last_x
, area_left
= 0;
22116 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22119 ALLOCATE_HDC (hdc
, f
);
22121 /* Let's rather be paranoid than getting a SEGV. */
22122 end
= min (end
, row
->used
[area
]);
22123 start
= max (0, start
);
22124 start
= min (end
, start
);
22126 /* Translate X to frame coordinates. Set last_x to the right
22127 end of the drawing area. */
22128 if (row
->full_width_p
)
22130 /* X is relative to the left edge of W, without scroll bars
22132 area_left
= WINDOW_LEFT_EDGE_X (w
);
22133 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22137 area_left
= window_box_left (w
, area
);
22138 last_x
= area_left
+ window_box_width (w
, area
);
22142 /* Build a doubly-linked list of glyph_string structures between
22143 head and tail from what we have to draw. Note that the macro
22144 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22145 the reason we use a separate variable `i'. */
22147 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22149 x_reached
= tail
->x
+ tail
->background_width
;
22153 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22154 the row, redraw some glyphs in front or following the glyph
22155 strings built above. */
22156 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22158 struct glyph_string
*h
, *t
;
22159 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22160 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22161 int check_mouse_face
= 0;
22164 /* If mouse highlighting is on, we may need to draw adjacent
22165 glyphs using mouse-face highlighting. */
22166 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22168 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22170 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22171 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22173 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22175 check_mouse_face
= 1;
22176 mouse_beg_col
= (row
== mouse_beg_row
)
22177 ? hlinfo
->mouse_face_beg_col
: 0;
22178 mouse_end_col
= (row
== mouse_end_row
)
22179 ? hlinfo
->mouse_face_end_col
22180 : row
->used
[TEXT_AREA
];
22184 /* Compute overhangs for all glyph strings. */
22185 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22186 for (s
= head
; s
; s
= s
->next
)
22187 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22189 /* Prepend glyph strings for glyphs in front of the first glyph
22190 string that are overwritten because of the first glyph
22191 string's left overhang. The background of all strings
22192 prepended must be drawn because the first glyph string
22194 i
= left_overwritten (head
);
22197 enum draw_glyphs_face overlap_hl
;
22199 /* If this row contains mouse highlighting, attempt to draw
22200 the overlapped glyphs with the correct highlight. This
22201 code fails if the overlap encompasses more than one glyph
22202 and mouse-highlight spans only some of these glyphs.
22203 However, making it work perfectly involves a lot more
22204 code, and I don't know if the pathological case occurs in
22205 practice, so we'll stick to this for now. --- cyd */
22206 if (check_mouse_face
22207 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22208 overlap_hl
= DRAW_MOUSE_FACE
;
22210 overlap_hl
= DRAW_NORMAL_TEXT
;
22213 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22214 overlap_hl
, dummy_x
, last_x
);
22216 compute_overhangs_and_x (t
, head
->x
, 1);
22217 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22221 /* Prepend glyph strings for glyphs in front of the first glyph
22222 string that overwrite that glyph string because of their
22223 right overhang. For these strings, only the foreground must
22224 be drawn, because it draws over the glyph string at `head'.
22225 The background must not be drawn because this would overwrite
22226 right overhangs of preceding glyphs for which no glyph
22228 i
= left_overwriting (head
);
22231 enum draw_glyphs_face overlap_hl
;
22233 if (check_mouse_face
22234 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22235 overlap_hl
= DRAW_MOUSE_FACE
;
22237 overlap_hl
= DRAW_NORMAL_TEXT
;
22240 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22241 overlap_hl
, dummy_x
, last_x
);
22242 for (s
= h
; s
; s
= s
->next
)
22243 s
->background_filled_p
= 1;
22244 compute_overhangs_and_x (t
, head
->x
, 1);
22245 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22248 /* Append glyphs strings for glyphs following the last glyph
22249 string tail that are overwritten by tail. The background of
22250 these strings has to be drawn because tail's foreground draws
22252 i
= right_overwritten (tail
);
22255 enum draw_glyphs_face overlap_hl
;
22257 if (check_mouse_face
22258 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22259 overlap_hl
= DRAW_MOUSE_FACE
;
22261 overlap_hl
= DRAW_NORMAL_TEXT
;
22263 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22264 overlap_hl
, x
, last_x
);
22265 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22266 we don't have `end = i;' here. */
22267 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22268 append_glyph_string_lists (&head
, &tail
, h
, t
);
22272 /* Append glyph strings for glyphs following the last glyph
22273 string tail that overwrite tail. The foreground of such
22274 glyphs has to be drawn because it writes into the background
22275 of tail. The background must not be drawn because it could
22276 paint over the foreground of following glyphs. */
22277 i
= right_overwriting (tail
);
22280 enum draw_glyphs_face overlap_hl
;
22281 if (check_mouse_face
22282 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22283 overlap_hl
= DRAW_MOUSE_FACE
;
22285 overlap_hl
= DRAW_NORMAL_TEXT
;
22288 i
++; /* We must include the Ith glyph. */
22289 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22290 overlap_hl
, x
, last_x
);
22291 for (s
= h
; s
; s
= s
->next
)
22292 s
->background_filled_p
= 1;
22293 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22294 append_glyph_string_lists (&head
, &tail
, h
, t
);
22296 if (clip_head
|| clip_tail
)
22297 for (s
= head
; s
; s
= s
->next
)
22299 s
->clip_head
= clip_head
;
22300 s
->clip_tail
= clip_tail
;
22304 /* Draw all strings. */
22305 for (s
= head
; s
; s
= s
->next
)
22306 FRAME_RIF (f
)->draw_glyph_string (s
);
22309 /* When focus a sole frame and move horizontally, this sets on_p to 0
22310 causing a failure to erase prev cursor position. */
22311 if (area
== TEXT_AREA
22312 && !row
->full_width_p
22313 /* When drawing overlapping rows, only the glyph strings'
22314 foreground is drawn, which doesn't erase a cursor
22318 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22319 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22320 : (tail
? tail
->x
+ tail
->background_width
: x
));
22324 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22325 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22329 /* Value is the x-position up to which drawn, relative to AREA of W.
22330 This doesn't include parts drawn because of overhangs. */
22331 if (row
->full_width_p
)
22332 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22334 x_reached
-= area_left
;
22336 RELEASE_HDC (hdc
, f
);
22341 /* Expand row matrix if too narrow. Don't expand if area
22344 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22346 if (!fonts_changed_p \
22347 && (it->glyph_row->glyphs[area] \
22348 < it->glyph_row->glyphs[area + 1])) \
22350 it->w->ncols_scale_factor++; \
22351 fonts_changed_p = 1; \
22355 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22356 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22359 append_glyph (struct it
*it
)
22361 struct glyph
*glyph
;
22362 enum glyph_row_area area
= it
->area
;
22364 xassert (it
->glyph_row
);
22365 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22367 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22368 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22370 /* If the glyph row is reversed, we need to prepend the glyph
22371 rather than append it. */
22372 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22376 /* Make room for the additional glyph. */
22377 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22379 glyph
= it
->glyph_row
->glyphs
[area
];
22381 glyph
->charpos
= CHARPOS (it
->position
);
22382 glyph
->object
= it
->object
;
22383 if (it
->pixel_width
> 0)
22385 glyph
->pixel_width
= it
->pixel_width
;
22386 glyph
->padding_p
= 0;
22390 /* Assure at least 1-pixel width. Otherwise, cursor can't
22391 be displayed correctly. */
22392 glyph
->pixel_width
= 1;
22393 glyph
->padding_p
= 1;
22395 glyph
->ascent
= it
->ascent
;
22396 glyph
->descent
= it
->descent
;
22397 glyph
->voffset
= it
->voffset
;
22398 glyph
->type
= CHAR_GLYPH
;
22399 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22400 glyph
->multibyte_p
= it
->multibyte_p
;
22401 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22402 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22403 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22404 || it
->phys_descent
> it
->descent
);
22405 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22406 glyph
->face_id
= it
->face_id
;
22407 glyph
->u
.ch
= it
->char_to_display
;
22408 glyph
->slice
.img
= null_glyph_slice
;
22409 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22412 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22413 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22415 glyph
->bidi_type
= it
->bidi_it
.type
;
22419 glyph
->resolved_level
= 0;
22420 glyph
->bidi_type
= UNKNOWN_BT
;
22422 ++it
->glyph_row
->used
[area
];
22425 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22428 /* Store one glyph for the composition IT->cmp_it.id in
22429 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22433 append_composite_glyph (struct it
*it
)
22435 struct glyph
*glyph
;
22436 enum glyph_row_area area
= it
->area
;
22438 xassert (it
->glyph_row
);
22440 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22441 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22443 /* If the glyph row is reversed, we need to prepend the glyph
22444 rather than append it. */
22445 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22449 /* Make room for the new glyph. */
22450 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22452 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22454 glyph
->charpos
= it
->cmp_it
.charpos
;
22455 glyph
->object
= it
->object
;
22456 glyph
->pixel_width
= it
->pixel_width
;
22457 glyph
->ascent
= it
->ascent
;
22458 glyph
->descent
= it
->descent
;
22459 glyph
->voffset
= it
->voffset
;
22460 glyph
->type
= COMPOSITE_GLYPH
;
22461 if (it
->cmp_it
.ch
< 0)
22463 glyph
->u
.cmp
.automatic
= 0;
22464 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22465 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22469 glyph
->u
.cmp
.automatic
= 1;
22470 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22471 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22472 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22474 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22475 glyph
->multibyte_p
= it
->multibyte_p
;
22476 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22477 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22478 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22479 || it
->phys_descent
> it
->descent
);
22480 glyph
->padding_p
= 0;
22481 glyph
->glyph_not_available_p
= 0;
22482 glyph
->face_id
= it
->face_id
;
22483 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22486 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22487 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22489 glyph
->bidi_type
= it
->bidi_it
.type
;
22491 ++it
->glyph_row
->used
[area
];
22494 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22498 /* Change IT->ascent and IT->height according to the setting of
22502 take_vertical_position_into_account (struct it
*it
)
22506 if (it
->voffset
< 0)
22507 /* Increase the ascent so that we can display the text higher
22509 it
->ascent
-= it
->voffset
;
22511 /* Increase the descent so that we can display the text lower
22513 it
->descent
+= it
->voffset
;
22518 /* Produce glyphs/get display metrics for the image IT is loaded with.
22519 See the description of struct display_iterator in dispextern.h for
22520 an overview of struct display_iterator. */
22523 produce_image_glyph (struct it
*it
)
22527 int glyph_ascent
, crop
;
22528 struct glyph_slice slice
;
22530 xassert (it
->what
== IT_IMAGE
);
22532 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22534 /* Make sure X resources of the face is loaded. */
22535 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22537 if (it
->image_id
< 0)
22539 /* Fringe bitmap. */
22540 it
->ascent
= it
->phys_ascent
= 0;
22541 it
->descent
= it
->phys_descent
= 0;
22542 it
->pixel_width
= 0;
22547 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22549 /* Make sure X resources of the image is loaded. */
22550 prepare_image_for_display (it
->f
, img
);
22552 slice
.x
= slice
.y
= 0;
22553 slice
.width
= img
->width
;
22554 slice
.height
= img
->height
;
22556 if (INTEGERP (it
->slice
.x
))
22557 slice
.x
= XINT (it
->slice
.x
);
22558 else if (FLOATP (it
->slice
.x
))
22559 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22561 if (INTEGERP (it
->slice
.y
))
22562 slice
.y
= XINT (it
->slice
.y
);
22563 else if (FLOATP (it
->slice
.y
))
22564 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22566 if (INTEGERP (it
->slice
.width
))
22567 slice
.width
= XINT (it
->slice
.width
);
22568 else if (FLOATP (it
->slice
.width
))
22569 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22571 if (INTEGERP (it
->slice
.height
))
22572 slice
.height
= XINT (it
->slice
.height
);
22573 else if (FLOATP (it
->slice
.height
))
22574 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22576 if (slice
.x
>= img
->width
)
22577 slice
.x
= img
->width
;
22578 if (slice
.y
>= img
->height
)
22579 slice
.y
= img
->height
;
22580 if (slice
.x
+ slice
.width
>= img
->width
)
22581 slice
.width
= img
->width
- slice
.x
;
22582 if (slice
.y
+ slice
.height
> img
->height
)
22583 slice
.height
= img
->height
- slice
.y
;
22585 if (slice
.width
== 0 || slice
.height
== 0)
22588 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22590 it
->descent
= slice
.height
- glyph_ascent
;
22592 it
->descent
+= img
->vmargin
;
22593 if (slice
.y
+ slice
.height
== img
->height
)
22594 it
->descent
+= img
->vmargin
;
22595 it
->phys_descent
= it
->descent
;
22597 it
->pixel_width
= slice
.width
;
22599 it
->pixel_width
+= img
->hmargin
;
22600 if (slice
.x
+ slice
.width
== img
->width
)
22601 it
->pixel_width
+= img
->hmargin
;
22603 /* It's quite possible for images to have an ascent greater than
22604 their height, so don't get confused in that case. */
22605 if (it
->descent
< 0)
22610 if (face
->box
!= FACE_NO_BOX
)
22612 if (face
->box_line_width
> 0)
22615 it
->ascent
+= face
->box_line_width
;
22616 if (slice
.y
+ slice
.height
== img
->height
)
22617 it
->descent
+= face
->box_line_width
;
22620 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22621 it
->pixel_width
+= eabs (face
->box_line_width
);
22622 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22623 it
->pixel_width
+= eabs (face
->box_line_width
);
22626 take_vertical_position_into_account (it
);
22628 /* Automatically crop wide image glyphs at right edge so we can
22629 draw the cursor on same display row. */
22630 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22631 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22633 it
->pixel_width
-= crop
;
22634 slice
.width
-= crop
;
22639 struct glyph
*glyph
;
22640 enum glyph_row_area area
= it
->area
;
22642 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22643 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22645 glyph
->charpos
= CHARPOS (it
->position
);
22646 glyph
->object
= it
->object
;
22647 glyph
->pixel_width
= it
->pixel_width
;
22648 glyph
->ascent
= glyph_ascent
;
22649 glyph
->descent
= it
->descent
;
22650 glyph
->voffset
= it
->voffset
;
22651 glyph
->type
= IMAGE_GLYPH
;
22652 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22653 glyph
->multibyte_p
= it
->multibyte_p
;
22654 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22655 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22656 glyph
->overlaps_vertically_p
= 0;
22657 glyph
->padding_p
= 0;
22658 glyph
->glyph_not_available_p
= 0;
22659 glyph
->face_id
= it
->face_id
;
22660 glyph
->u
.img_id
= img
->id
;
22661 glyph
->slice
.img
= slice
;
22662 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22665 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22666 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22668 glyph
->bidi_type
= it
->bidi_it
.type
;
22670 ++it
->glyph_row
->used
[area
];
22673 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22678 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22679 of the glyph, WIDTH and HEIGHT are the width and height of the
22680 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22683 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22684 int width
, int height
, int ascent
)
22686 struct glyph
*glyph
;
22687 enum glyph_row_area area
= it
->area
;
22689 xassert (ascent
>= 0 && ascent
<= height
);
22691 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22692 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22694 /* If the glyph row is reversed, we need to prepend the glyph
22695 rather than append it. */
22696 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22700 /* Make room for the additional glyph. */
22701 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22703 glyph
= it
->glyph_row
->glyphs
[area
];
22705 glyph
->charpos
= CHARPOS (it
->position
);
22706 glyph
->object
= object
;
22707 glyph
->pixel_width
= width
;
22708 glyph
->ascent
= ascent
;
22709 glyph
->descent
= height
- ascent
;
22710 glyph
->voffset
= it
->voffset
;
22711 glyph
->type
= STRETCH_GLYPH
;
22712 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22713 glyph
->multibyte_p
= it
->multibyte_p
;
22714 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22715 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22716 glyph
->overlaps_vertically_p
= 0;
22717 glyph
->padding_p
= 0;
22718 glyph
->glyph_not_available_p
= 0;
22719 glyph
->face_id
= it
->face_id
;
22720 glyph
->u
.stretch
.ascent
= ascent
;
22721 glyph
->u
.stretch
.height
= height
;
22722 glyph
->slice
.img
= null_glyph_slice
;
22723 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22726 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22727 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22729 glyph
->bidi_type
= it
->bidi_it
.type
;
22733 glyph
->resolved_level
= 0;
22734 glyph
->bidi_type
= UNKNOWN_BT
;
22736 ++it
->glyph_row
->used
[area
];
22739 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22743 /* Produce a stretch glyph for iterator IT. IT->object is the value
22744 of the glyph property displayed. The value must be a list
22745 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22748 1. `:width WIDTH' specifies that the space should be WIDTH *
22749 canonical char width wide. WIDTH may be an integer or floating
22752 2. `:relative-width FACTOR' specifies that the width of the stretch
22753 should be computed from the width of the first character having the
22754 `glyph' property, and should be FACTOR times that width.
22756 3. `:align-to HPOS' specifies that the space should be wide enough
22757 to reach HPOS, a value in canonical character units.
22759 Exactly one of the above pairs must be present.
22761 4. `:height HEIGHT' specifies that the height of the stretch produced
22762 should be HEIGHT, measured in canonical character units.
22764 5. `:relative-height FACTOR' specifies that the height of the
22765 stretch should be FACTOR times the height of the characters having
22766 the glyph property.
22768 Either none or exactly one of 4 or 5 must be present.
22770 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22771 of the stretch should be used for the ascent of the stretch.
22772 ASCENT must be in the range 0 <= ASCENT <= 100. */
22775 produce_stretch_glyph (struct it
*it
)
22777 /* (space :width WIDTH :height HEIGHT ...) */
22778 Lisp_Object prop
, plist
;
22779 int width
= 0, height
= 0, align_to
= -1;
22780 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22783 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22784 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22786 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22788 /* List should start with `space'. */
22789 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22790 plist
= XCDR (it
->object
);
22792 /* Compute the width of the stretch. */
22793 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22794 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22796 /* Absolute width `:width WIDTH' specified and valid. */
22797 zero_width_ok_p
= 1;
22800 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22803 /* Relative width `:relative-width FACTOR' specified and valid.
22804 Compute the width of the characters having the `glyph'
22807 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22810 if (it
->multibyte_p
)
22811 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22814 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22815 if (! ASCII_CHAR_P (it2
.c
))
22816 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22819 it2
.glyph_row
= NULL
;
22820 it2
.what
= IT_CHARACTER
;
22821 x_produce_glyphs (&it2
);
22822 width
= NUMVAL (prop
) * it2
.pixel_width
;
22824 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22825 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22827 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22828 align_to
= (align_to
< 0
22830 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22831 else if (align_to
< 0)
22832 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22833 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22834 zero_width_ok_p
= 1;
22837 /* Nothing specified -> width defaults to canonical char width. */
22838 width
= FRAME_COLUMN_WIDTH (it
->f
);
22840 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22843 /* Compute height. */
22844 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22845 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22848 zero_height_ok_p
= 1;
22850 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22852 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22854 height
= FONT_HEIGHT (font
);
22856 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22859 /* Compute percentage of height used for ascent. If
22860 `:ascent ASCENT' is present and valid, use that. Otherwise,
22861 derive the ascent from the font in use. */
22862 if (prop
= Fplist_get (plist
, QCascent
),
22863 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22864 ascent
= height
* NUMVAL (prop
) / 100.0;
22865 else if (!NILP (prop
)
22866 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22867 ascent
= min (max (0, (int)tem
), height
);
22869 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22871 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22872 && it
->current_x
+ width
> it
->last_visible_x
)
22873 width
= it
->last_visible_x
- it
->current_x
- 1;
22875 if (width
> 0 && height
> 0 && it
->glyph_row
)
22877 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22878 if (!STRINGP (object
))
22879 object
= it
->w
->buffer
;
22880 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22883 it
->pixel_width
= width
;
22884 it
->ascent
= it
->phys_ascent
= ascent
;
22885 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22886 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22888 take_vertical_position_into_account (it
);
22891 /* Calculate line-height and line-spacing properties.
22892 An integer value specifies explicit pixel value.
22893 A float value specifies relative value to current face height.
22894 A cons (float . face-name) specifies relative value to
22895 height of specified face font.
22897 Returns height in pixels, or nil. */
22901 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22902 int boff
, int override
)
22904 Lisp_Object face_name
= Qnil
;
22905 int ascent
, descent
, height
;
22907 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22912 face_name
= XCAR (val
);
22914 if (!NUMBERP (val
))
22915 val
= make_number (1);
22916 if (NILP (face_name
))
22918 height
= it
->ascent
+ it
->descent
;
22923 if (NILP (face_name
))
22925 font
= FRAME_FONT (it
->f
);
22926 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22928 else if (EQ (face_name
, Qt
))
22937 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22939 return make_number (-1);
22941 face
= FACE_FROM_ID (it
->f
, face_id
);
22944 return make_number (-1);
22945 boff
= font
->baseline_offset
;
22946 if (font
->vertical_centering
)
22947 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22950 ascent
= FONT_BASE (font
) + boff
;
22951 descent
= FONT_DESCENT (font
) - boff
;
22955 it
->override_ascent
= ascent
;
22956 it
->override_descent
= descent
;
22957 it
->override_boff
= boff
;
22960 height
= ascent
+ descent
;
22964 height
= (int)(XFLOAT_DATA (val
) * height
);
22965 else if (INTEGERP (val
))
22966 height
*= XINT (val
);
22968 return make_number (height
);
22972 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22973 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22974 and only if this is for a character for which no font was found.
22976 If the display method (it->glyphless_method) is
22977 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22978 length of the acronym or the hexadecimal string, UPPER_XOFF and
22979 UPPER_YOFF are pixel offsets for the upper part of the string,
22980 LOWER_XOFF and LOWER_YOFF are for the lower part.
22982 For the other display methods, LEN through LOWER_YOFF are zero. */
22985 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22986 short upper_xoff
, short upper_yoff
,
22987 short lower_xoff
, short lower_yoff
)
22989 struct glyph
*glyph
;
22990 enum glyph_row_area area
= it
->area
;
22992 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22993 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22995 /* If the glyph row is reversed, we need to prepend the glyph
22996 rather than append it. */
22997 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23001 /* Make room for the additional glyph. */
23002 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23004 glyph
= it
->glyph_row
->glyphs
[area
];
23006 glyph
->charpos
= CHARPOS (it
->position
);
23007 glyph
->object
= it
->object
;
23008 glyph
->pixel_width
= it
->pixel_width
;
23009 glyph
->ascent
= it
->ascent
;
23010 glyph
->descent
= it
->descent
;
23011 glyph
->voffset
= it
->voffset
;
23012 glyph
->type
= GLYPHLESS_GLYPH
;
23013 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23014 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23015 glyph
->u
.glyphless
.len
= len
;
23016 glyph
->u
.glyphless
.ch
= it
->c
;
23017 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23018 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23019 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23020 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23021 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23022 glyph
->multibyte_p
= it
->multibyte_p
;
23023 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23024 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23025 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23026 || it
->phys_descent
> it
->descent
);
23027 glyph
->padding_p
= 0;
23028 glyph
->glyph_not_available_p
= 0;
23029 glyph
->face_id
= face_id
;
23030 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23033 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23034 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23036 glyph
->bidi_type
= it
->bidi_it
.type
;
23038 ++it
->glyph_row
->used
[area
];
23041 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23045 /* Produce a glyph for a glyphless character for iterator IT.
23046 IT->glyphless_method specifies which method to use for displaying
23047 the character. See the description of enum
23048 glyphless_display_method in dispextern.h for the detail.
23050 FOR_NO_FONT is nonzero if and only if this is for a character for
23051 which no font was found. ACRONYM, if non-nil, is an acronym string
23052 for the character. */
23055 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23060 int base_width
, base_height
, width
, height
;
23061 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23064 /* Get the metrics of the base font. We always refer to the current
23066 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23067 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23068 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23069 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23070 base_height
= it
->ascent
+ it
->descent
;
23071 base_width
= font
->average_width
;
23073 /* Get a face ID for the glyph by utilizing a cache (the same way as
23074 doen for `escape-glyph' in get_next_display_element). */
23075 if (it
->f
== last_glyphless_glyph_frame
23076 && it
->face_id
== last_glyphless_glyph_face_id
)
23078 face_id
= last_glyphless_glyph_merged_face_id
;
23082 /* Merge the `glyphless-char' face into the current face. */
23083 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23084 last_glyphless_glyph_frame
= it
->f
;
23085 last_glyphless_glyph_face_id
= it
->face_id
;
23086 last_glyphless_glyph_merged_face_id
= face_id
;
23089 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23091 it
->pixel_width
= THIN_SPACE_WIDTH
;
23093 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23095 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23097 width
= CHAR_WIDTH (it
->c
);
23100 else if (width
> 4)
23102 it
->pixel_width
= base_width
* width
;
23104 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23110 unsigned int code
[6];
23112 int ascent
, descent
;
23113 struct font_metrics metrics_upper
, metrics_lower
;
23115 face
= FACE_FROM_ID (it
->f
, face_id
);
23116 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23117 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23119 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23121 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23122 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23123 if (CONSP (acronym
))
23124 acronym
= XCAR (acronym
);
23125 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23129 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23130 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23133 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23134 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23135 upper_len
= (len
+ 1) / 2;
23136 font
->driver
->text_extents (font
, code
, upper_len
,
23138 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23143 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23144 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23145 upper_xoff
= upper_yoff
= 2; /* the typical case */
23146 if (base_width
>= width
)
23148 /* Align the upper to the left, the lower to the right. */
23149 it
->pixel_width
= base_width
;
23150 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23154 /* Center the shorter one. */
23155 it
->pixel_width
= width
;
23156 if (metrics_upper
.width
>= metrics_lower
.width
)
23157 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23160 /* FIXME: This code doesn't look right. It formerly was
23161 missing the "lower_xoff = 0;", which couldn't have
23162 been right since it left lower_xoff uninitialized. */
23164 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23168 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23169 top, bottom, and between upper and lower strings. */
23170 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23171 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23172 /* Center vertically.
23173 H:base_height, D:base_descent
23174 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23176 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23177 descent = D - H/2 + h/2;
23178 lower_yoff = descent - 2 - ld;
23179 upper_yoff = lower_yoff - la - 1 - ud; */
23180 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23181 descent
= it
->descent
- (base_height
- height
) / 2;
23182 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23183 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23184 - metrics_upper
.descent
);
23185 /* Don't make the height shorter than the base height. */
23186 if (height
> base_height
)
23188 it
->ascent
= ascent
;
23189 it
->descent
= descent
;
23193 it
->phys_ascent
= it
->ascent
;
23194 it
->phys_descent
= it
->descent
;
23196 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23197 upper_xoff
, upper_yoff
,
23198 lower_xoff
, lower_yoff
);
23200 take_vertical_position_into_account (it
);
23205 Produce glyphs/get display metrics for the display element IT is
23206 loaded with. See the description of struct it in dispextern.h
23207 for an overview of struct it. */
23210 x_produce_glyphs (struct it
*it
)
23212 int extra_line_spacing
= it
->extra_line_spacing
;
23214 it
->glyph_not_available_p
= 0;
23216 if (it
->what
== IT_CHARACTER
)
23219 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23220 struct font
*font
= face
->font
;
23221 struct font_metrics
*pcm
= NULL
;
23222 int boff
; /* baseline offset */
23226 /* When no suitable font is found, display this character by
23227 the method specified in the first extra slot of
23228 Vglyphless_char_display. */
23229 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23231 xassert (it
->what
== IT_GLYPHLESS
);
23232 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23236 boff
= font
->baseline_offset
;
23237 if (font
->vertical_centering
)
23238 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23240 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23246 if (it
->override_ascent
>= 0)
23248 it
->ascent
= it
->override_ascent
;
23249 it
->descent
= it
->override_descent
;
23250 boff
= it
->override_boff
;
23254 it
->ascent
= FONT_BASE (font
) + boff
;
23255 it
->descent
= FONT_DESCENT (font
) - boff
;
23258 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23260 pcm
= get_per_char_metric (font
, &char2b
);
23261 if (pcm
->width
== 0
23262 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23268 it
->phys_ascent
= pcm
->ascent
+ boff
;
23269 it
->phys_descent
= pcm
->descent
- boff
;
23270 it
->pixel_width
= pcm
->width
;
23274 it
->glyph_not_available_p
= 1;
23275 it
->phys_ascent
= it
->ascent
;
23276 it
->phys_descent
= it
->descent
;
23277 it
->pixel_width
= font
->space_width
;
23280 if (it
->constrain_row_ascent_descent_p
)
23282 if (it
->descent
> it
->max_descent
)
23284 it
->ascent
+= it
->descent
- it
->max_descent
;
23285 it
->descent
= it
->max_descent
;
23287 if (it
->ascent
> it
->max_ascent
)
23289 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23290 it
->ascent
= it
->max_ascent
;
23292 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23293 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23294 extra_line_spacing
= 0;
23297 /* If this is a space inside a region of text with
23298 `space-width' property, change its width. */
23299 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23301 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23303 /* If face has a box, add the box thickness to the character
23304 height. If character has a box line to the left and/or
23305 right, add the box line width to the character's width. */
23306 if (face
->box
!= FACE_NO_BOX
)
23308 int thick
= face
->box_line_width
;
23312 it
->ascent
+= thick
;
23313 it
->descent
+= thick
;
23318 if (it
->start_of_box_run_p
)
23319 it
->pixel_width
+= thick
;
23320 if (it
->end_of_box_run_p
)
23321 it
->pixel_width
+= thick
;
23324 /* If face has an overline, add the height of the overline
23325 (1 pixel) and a 1 pixel margin to the character height. */
23326 if (face
->overline_p
)
23327 it
->ascent
+= overline_margin
;
23329 if (it
->constrain_row_ascent_descent_p
)
23331 if (it
->ascent
> it
->max_ascent
)
23332 it
->ascent
= it
->max_ascent
;
23333 if (it
->descent
> it
->max_descent
)
23334 it
->descent
= it
->max_descent
;
23337 take_vertical_position_into_account (it
);
23339 /* If we have to actually produce glyphs, do it. */
23344 /* Translate a space with a `space-width' property
23345 into a stretch glyph. */
23346 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23347 / FONT_HEIGHT (font
));
23348 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23349 it
->ascent
+ it
->descent
, ascent
);
23354 /* If characters with lbearing or rbearing are displayed
23355 in this line, record that fact in a flag of the
23356 glyph row. This is used to optimize X output code. */
23357 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23358 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23360 if (! stretched_p
&& it
->pixel_width
== 0)
23361 /* We assure that all visible glyphs have at least 1-pixel
23363 it
->pixel_width
= 1;
23365 else if (it
->char_to_display
== '\n')
23367 /* A newline has no width, but we need the height of the
23368 line. But if previous part of the line sets a height,
23369 don't increase that height */
23371 Lisp_Object height
;
23372 Lisp_Object total_height
= Qnil
;
23374 it
->override_ascent
= -1;
23375 it
->pixel_width
= 0;
23378 height
= get_it_property (it
, Qline_height
);
23379 /* Split (line-height total-height) list */
23381 && CONSP (XCDR (height
))
23382 && NILP (XCDR (XCDR (height
))))
23384 total_height
= XCAR (XCDR (height
));
23385 height
= XCAR (height
);
23387 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23389 if (it
->override_ascent
>= 0)
23391 it
->ascent
= it
->override_ascent
;
23392 it
->descent
= it
->override_descent
;
23393 boff
= it
->override_boff
;
23397 it
->ascent
= FONT_BASE (font
) + boff
;
23398 it
->descent
= FONT_DESCENT (font
) - boff
;
23401 if (EQ (height
, Qt
))
23403 if (it
->descent
> it
->max_descent
)
23405 it
->ascent
+= it
->descent
- it
->max_descent
;
23406 it
->descent
= it
->max_descent
;
23408 if (it
->ascent
> it
->max_ascent
)
23410 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23411 it
->ascent
= it
->max_ascent
;
23413 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23414 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23415 it
->constrain_row_ascent_descent_p
= 1;
23416 extra_line_spacing
= 0;
23420 Lisp_Object spacing
;
23422 it
->phys_ascent
= it
->ascent
;
23423 it
->phys_descent
= it
->descent
;
23425 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23426 && face
->box
!= FACE_NO_BOX
23427 && face
->box_line_width
> 0)
23429 it
->ascent
+= face
->box_line_width
;
23430 it
->descent
+= face
->box_line_width
;
23433 && XINT (height
) > it
->ascent
+ it
->descent
)
23434 it
->ascent
= XINT (height
) - it
->descent
;
23436 if (!NILP (total_height
))
23437 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23440 spacing
= get_it_property (it
, Qline_spacing
);
23441 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23443 if (INTEGERP (spacing
))
23445 extra_line_spacing
= XINT (spacing
);
23446 if (!NILP (total_height
))
23447 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23451 else /* i.e. (it->char_to_display == '\t') */
23453 if (font
->space_width
> 0)
23455 int tab_width
= it
->tab_width
* font
->space_width
;
23456 int x
= it
->current_x
+ it
->continuation_lines_width
;
23457 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23459 /* If the distance from the current position to the next tab
23460 stop is less than a space character width, use the
23461 tab stop after that. */
23462 if (next_tab_x
- x
< font
->space_width
)
23463 next_tab_x
+= tab_width
;
23465 it
->pixel_width
= next_tab_x
- x
;
23467 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23468 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23472 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23473 it
->ascent
+ it
->descent
, it
->ascent
);
23478 it
->pixel_width
= 0;
23483 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23485 /* A static composition.
23487 Note: A composition is represented as one glyph in the
23488 glyph matrix. There are no padding glyphs.
23490 Important note: pixel_width, ascent, and descent are the
23491 values of what is drawn by draw_glyphs (i.e. the values of
23492 the overall glyphs composed). */
23493 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23494 int boff
; /* baseline offset */
23495 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23496 int glyph_len
= cmp
->glyph_len
;
23497 struct font
*font
= face
->font
;
23501 /* If we have not yet calculated pixel size data of glyphs of
23502 the composition for the current face font, calculate them
23503 now. Theoretically, we have to check all fonts for the
23504 glyphs, but that requires much time and memory space. So,
23505 here we check only the font of the first glyph. This may
23506 lead to incorrect display, but it's very rare, and C-l
23507 (recenter-top-bottom) can correct the display anyway. */
23508 if (! cmp
->font
|| cmp
->font
!= font
)
23510 /* Ascent and descent of the font of the first character
23511 of this composition (adjusted by baseline offset).
23512 Ascent and descent of overall glyphs should not be less
23513 than these, respectively. */
23514 int font_ascent
, font_descent
, font_height
;
23515 /* Bounding box of the overall glyphs. */
23516 int leftmost
, rightmost
, lowest
, highest
;
23517 int lbearing
, rbearing
;
23518 int i
, width
, ascent
, descent
;
23519 int left_padded
= 0, right_padded
= 0;
23520 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23522 struct font_metrics
*pcm
;
23523 int font_not_found_p
;
23526 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23527 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23529 if (glyph_len
< cmp
->glyph_len
)
23531 for (i
= 0; i
< glyph_len
; i
++)
23533 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23535 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23540 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23541 : IT_CHARPOS (*it
));
23542 /* If no suitable font is found, use the default font. */
23543 font_not_found_p
= font
== NULL
;
23544 if (font_not_found_p
)
23546 face
= face
->ascii_face
;
23549 boff
= font
->baseline_offset
;
23550 if (font
->vertical_centering
)
23551 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23552 font_ascent
= FONT_BASE (font
) + boff
;
23553 font_descent
= FONT_DESCENT (font
) - boff
;
23554 font_height
= FONT_HEIGHT (font
);
23556 cmp
->font
= (void *) font
;
23559 if (! font_not_found_p
)
23561 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23563 pcm
= get_per_char_metric (font
, &char2b
);
23566 /* Initialize the bounding box. */
23569 width
= pcm
->width
;
23570 ascent
= pcm
->ascent
;
23571 descent
= pcm
->descent
;
23572 lbearing
= pcm
->lbearing
;
23573 rbearing
= pcm
->rbearing
;
23577 width
= font
->space_width
;
23578 ascent
= FONT_BASE (font
);
23579 descent
= FONT_DESCENT (font
);
23586 lowest
= - descent
+ boff
;
23587 highest
= ascent
+ boff
;
23589 if (! font_not_found_p
23590 && font
->default_ascent
23591 && CHAR_TABLE_P (Vuse_default_ascent
)
23592 && !NILP (Faref (Vuse_default_ascent
,
23593 make_number (it
->char_to_display
))))
23594 highest
= font
->default_ascent
+ boff
;
23596 /* Draw the first glyph at the normal position. It may be
23597 shifted to right later if some other glyphs are drawn
23599 cmp
->offsets
[i
* 2] = 0;
23600 cmp
->offsets
[i
* 2 + 1] = boff
;
23601 cmp
->lbearing
= lbearing
;
23602 cmp
->rbearing
= rbearing
;
23604 /* Set cmp->offsets for the remaining glyphs. */
23605 for (i
++; i
< glyph_len
; i
++)
23607 int left
, right
, btm
, top
;
23608 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23610 struct face
*this_face
;
23614 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23615 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23616 font
= this_face
->font
;
23622 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23624 pcm
= get_per_char_metric (font
, &char2b
);
23627 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23630 width
= pcm
->width
;
23631 ascent
= pcm
->ascent
;
23632 descent
= pcm
->descent
;
23633 lbearing
= pcm
->lbearing
;
23634 rbearing
= pcm
->rbearing
;
23635 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23637 /* Relative composition with or without
23638 alternate chars. */
23639 left
= (leftmost
+ rightmost
- width
) / 2;
23640 btm
= - descent
+ boff
;
23641 if (font
->relative_compose
23642 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23643 || NILP (Faref (Vignore_relative_composition
,
23644 make_number (ch
)))))
23647 if (- descent
>= font
->relative_compose
)
23648 /* One extra pixel between two glyphs. */
23650 else if (ascent
<= 0)
23651 /* One extra pixel between two glyphs. */
23652 btm
= lowest
- 1 - ascent
- descent
;
23657 /* A composition rule is specified by an integer
23658 value that encodes global and new reference
23659 points (GREF and NREF). GREF and NREF are
23660 specified by numbers as below:
23662 0---1---2 -- ascent
23666 9--10--11 -- center
23668 ---3---4---5--- baseline
23670 6---7---8 -- descent
23672 int rule
= COMPOSITION_RULE (cmp
, i
);
23673 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23675 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23676 grefx
= gref
% 3, nrefx
= nref
% 3;
23677 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23679 xoff
= font_height
* (xoff
- 128) / 256;
23681 yoff
= font_height
* (yoff
- 128) / 256;
23684 + grefx
* (rightmost
- leftmost
) / 2
23685 - nrefx
* width
/ 2
23688 btm
= ((grefy
== 0 ? highest
23690 : grefy
== 2 ? lowest
23691 : (highest
+ lowest
) / 2)
23692 - (nrefy
== 0 ? ascent
+ descent
23693 : nrefy
== 1 ? descent
- boff
23695 : (ascent
+ descent
) / 2)
23699 cmp
->offsets
[i
* 2] = left
;
23700 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23702 /* Update the bounding box of the overall glyphs. */
23705 right
= left
+ width
;
23706 if (left
< leftmost
)
23708 if (right
> rightmost
)
23711 top
= btm
+ descent
+ ascent
;
23717 if (cmp
->lbearing
> left
+ lbearing
)
23718 cmp
->lbearing
= left
+ lbearing
;
23719 if (cmp
->rbearing
< left
+ rbearing
)
23720 cmp
->rbearing
= left
+ rbearing
;
23724 /* If there are glyphs whose x-offsets are negative,
23725 shift all glyphs to the right and make all x-offsets
23729 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23730 cmp
->offsets
[i
* 2] -= leftmost
;
23731 rightmost
-= leftmost
;
23732 cmp
->lbearing
-= leftmost
;
23733 cmp
->rbearing
-= leftmost
;
23736 if (left_padded
&& cmp
->lbearing
< 0)
23738 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23739 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23740 rightmost
-= cmp
->lbearing
;
23741 cmp
->rbearing
-= cmp
->lbearing
;
23744 if (right_padded
&& rightmost
< cmp
->rbearing
)
23746 rightmost
= cmp
->rbearing
;
23749 cmp
->pixel_width
= rightmost
;
23750 cmp
->ascent
= highest
;
23751 cmp
->descent
= - lowest
;
23752 if (cmp
->ascent
< font_ascent
)
23753 cmp
->ascent
= font_ascent
;
23754 if (cmp
->descent
< font_descent
)
23755 cmp
->descent
= font_descent
;
23759 && (cmp
->lbearing
< 0
23760 || cmp
->rbearing
> cmp
->pixel_width
))
23761 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23763 it
->pixel_width
= cmp
->pixel_width
;
23764 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23765 it
->descent
= it
->phys_descent
= cmp
->descent
;
23766 if (face
->box
!= FACE_NO_BOX
)
23768 int thick
= face
->box_line_width
;
23772 it
->ascent
+= thick
;
23773 it
->descent
+= thick
;
23778 if (it
->start_of_box_run_p
)
23779 it
->pixel_width
+= thick
;
23780 if (it
->end_of_box_run_p
)
23781 it
->pixel_width
+= thick
;
23784 /* If face has an overline, add the height of the overline
23785 (1 pixel) and a 1 pixel margin to the character height. */
23786 if (face
->overline_p
)
23787 it
->ascent
+= overline_margin
;
23789 take_vertical_position_into_account (it
);
23790 if (it
->ascent
< 0)
23792 if (it
->descent
< 0)
23796 append_composite_glyph (it
);
23798 else if (it
->what
== IT_COMPOSITION
)
23800 /* A dynamic (automatic) composition. */
23801 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23802 Lisp_Object gstring
;
23803 struct font_metrics metrics
;
23805 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23807 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23810 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23811 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23812 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23813 it
->descent
= it
->phys_descent
= metrics
.descent
;
23814 if (face
->box
!= FACE_NO_BOX
)
23816 int thick
= face
->box_line_width
;
23820 it
->ascent
+= thick
;
23821 it
->descent
+= thick
;
23826 if (it
->start_of_box_run_p
)
23827 it
->pixel_width
+= thick
;
23828 if (it
->end_of_box_run_p
)
23829 it
->pixel_width
+= thick
;
23831 /* If face has an overline, add the height of the overline
23832 (1 pixel) and a 1 pixel margin to the character height. */
23833 if (face
->overline_p
)
23834 it
->ascent
+= overline_margin
;
23835 take_vertical_position_into_account (it
);
23836 if (it
->ascent
< 0)
23838 if (it
->descent
< 0)
23842 append_composite_glyph (it
);
23844 else if (it
->what
== IT_GLYPHLESS
)
23845 produce_glyphless_glyph (it
, 0, Qnil
);
23846 else if (it
->what
== IT_IMAGE
)
23847 produce_image_glyph (it
);
23848 else if (it
->what
== IT_STRETCH
)
23849 produce_stretch_glyph (it
);
23852 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23853 because this isn't true for images with `:ascent 100'. */
23854 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23855 if (it
->area
== TEXT_AREA
)
23856 it
->current_x
+= it
->pixel_width
;
23858 if (extra_line_spacing
> 0)
23860 it
->descent
+= extra_line_spacing
;
23861 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23862 it
->max_extra_line_spacing
= extra_line_spacing
;
23865 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23866 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23867 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23868 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23872 Output LEN glyphs starting at START at the nominal cursor position.
23873 Advance the nominal cursor over the text. The global variable
23874 updated_window contains the window being updated, updated_row is
23875 the glyph row being updated, and updated_area is the area of that
23876 row being updated. */
23879 x_write_glyphs (struct glyph
*start
, int len
)
23883 xassert (updated_window
&& updated_row
);
23886 /* Write glyphs. */
23888 hpos
= start
- updated_row
->glyphs
[updated_area
];
23889 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23890 updated_row
, updated_area
,
23892 DRAW_NORMAL_TEXT
, 0);
23894 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23895 if (updated_area
== TEXT_AREA
23896 && updated_window
->phys_cursor_on_p
23897 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23898 && updated_window
->phys_cursor
.hpos
>= hpos
23899 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23900 updated_window
->phys_cursor_on_p
= 0;
23904 /* Advance the output cursor. */
23905 output_cursor
.hpos
+= len
;
23906 output_cursor
.x
= x
;
23911 Insert LEN glyphs from START at the nominal cursor position. */
23914 x_insert_glyphs (struct glyph
*start
, int len
)
23918 int line_height
, shift_by_width
, shifted_region_width
;
23919 struct glyph_row
*row
;
23920 struct glyph
*glyph
;
23921 int frame_x
, frame_y
;
23924 xassert (updated_window
&& updated_row
);
23926 w
= updated_window
;
23927 f
= XFRAME (WINDOW_FRAME (w
));
23929 /* Get the height of the line we are in. */
23931 line_height
= row
->height
;
23933 /* Get the width of the glyphs to insert. */
23934 shift_by_width
= 0;
23935 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23936 shift_by_width
+= glyph
->pixel_width
;
23938 /* Get the width of the region to shift right. */
23939 shifted_region_width
= (window_box_width (w
, updated_area
)
23944 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23945 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23947 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23948 line_height
, shift_by_width
);
23950 /* Write the glyphs. */
23951 hpos
= start
- row
->glyphs
[updated_area
];
23952 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23954 DRAW_NORMAL_TEXT
, 0);
23956 /* Advance the output cursor. */
23957 output_cursor
.hpos
+= len
;
23958 output_cursor
.x
+= shift_by_width
;
23964 Erase the current text line from the nominal cursor position
23965 (inclusive) to pixel column TO_X (exclusive). The idea is that
23966 everything from TO_X onward is already erased.
23968 TO_X is a pixel position relative to updated_area of
23969 updated_window. TO_X == -1 means clear to the end of this area. */
23972 x_clear_end_of_line (int to_x
)
23975 struct window
*w
= updated_window
;
23976 int max_x
, min_y
, max_y
;
23977 int from_x
, from_y
, to_y
;
23979 xassert (updated_window
&& updated_row
);
23980 f
= XFRAME (w
->frame
);
23982 if (updated_row
->full_width_p
)
23983 max_x
= WINDOW_TOTAL_WIDTH (w
);
23985 max_x
= window_box_width (w
, updated_area
);
23986 max_y
= window_text_bottom_y (w
);
23988 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23989 of window. For TO_X > 0, truncate to end of drawing area. */
23995 to_x
= min (to_x
, max_x
);
23997 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23999 /* Notice if the cursor will be cleared by this operation. */
24000 if (!updated_row
->full_width_p
)
24001 notice_overwritten_cursor (w
, updated_area
,
24002 output_cursor
.x
, -1,
24004 MATRIX_ROW_BOTTOM_Y (updated_row
));
24006 from_x
= output_cursor
.x
;
24008 /* Translate to frame coordinates. */
24009 if (updated_row
->full_width_p
)
24011 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24012 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24016 int area_left
= window_box_left (w
, updated_area
);
24017 from_x
+= area_left
;
24021 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24022 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24023 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24025 /* Prevent inadvertently clearing to end of the X window. */
24026 if (to_x
> from_x
&& to_y
> from_y
)
24029 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24030 to_x
- from_x
, to_y
- from_y
);
24035 #endif /* HAVE_WINDOW_SYSTEM */
24039 /***********************************************************************
24041 ***********************************************************************/
24043 /* Value is the internal representation of the specified cursor type
24044 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24045 of the bar cursor. */
24047 static enum text_cursor_kinds
24048 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24050 enum text_cursor_kinds type
;
24055 if (EQ (arg
, Qbox
))
24056 return FILLED_BOX_CURSOR
;
24058 if (EQ (arg
, Qhollow
))
24059 return HOLLOW_BOX_CURSOR
;
24061 if (EQ (arg
, Qbar
))
24068 && EQ (XCAR (arg
), Qbar
)
24069 && INTEGERP (XCDR (arg
))
24070 && XINT (XCDR (arg
)) >= 0)
24072 *width
= XINT (XCDR (arg
));
24076 if (EQ (arg
, Qhbar
))
24079 return HBAR_CURSOR
;
24083 && EQ (XCAR (arg
), Qhbar
)
24084 && INTEGERP (XCDR (arg
))
24085 && XINT (XCDR (arg
)) >= 0)
24087 *width
= XINT (XCDR (arg
));
24088 return HBAR_CURSOR
;
24091 /* Treat anything unknown as "hollow box cursor".
24092 It was bad to signal an error; people have trouble fixing
24093 .Xdefaults with Emacs, when it has something bad in it. */
24094 type
= HOLLOW_BOX_CURSOR
;
24099 /* Set the default cursor types for specified frame. */
24101 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24106 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24107 FRAME_CURSOR_WIDTH (f
) = width
;
24109 /* By default, set up the blink-off state depending on the on-state. */
24111 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24114 FRAME_BLINK_OFF_CURSOR (f
)
24115 = get_specified_cursor_type (XCDR (tem
), &width
);
24116 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24119 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24123 #ifdef HAVE_WINDOW_SYSTEM
24125 /* Return the cursor we want to be displayed in window W. Return
24126 width of bar/hbar cursor through WIDTH arg. Return with
24127 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24128 (i.e. if the `system caret' should track this cursor).
24130 In a mini-buffer window, we want the cursor only to appear if we
24131 are reading input from this window. For the selected window, we
24132 want the cursor type given by the frame parameter or buffer local
24133 setting of cursor-type. If explicitly marked off, draw no cursor.
24134 In all other cases, we want a hollow box cursor. */
24136 static enum text_cursor_kinds
24137 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24138 int *active_cursor
)
24140 struct frame
*f
= XFRAME (w
->frame
);
24141 struct buffer
*b
= XBUFFER (w
->buffer
);
24142 int cursor_type
= DEFAULT_CURSOR
;
24143 Lisp_Object alt_cursor
;
24144 int non_selected
= 0;
24146 *active_cursor
= 1;
24149 if (cursor_in_echo_area
24150 && FRAME_HAS_MINIBUF_P (f
)
24151 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24153 if (w
== XWINDOW (echo_area_window
))
24155 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24157 *width
= FRAME_CURSOR_WIDTH (f
);
24158 return FRAME_DESIRED_CURSOR (f
);
24161 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24164 *active_cursor
= 0;
24168 /* Detect a nonselected window or nonselected frame. */
24169 else if (w
!= XWINDOW (f
->selected_window
)
24170 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24172 *active_cursor
= 0;
24174 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24180 /* Never display a cursor in a window in which cursor-type is nil. */
24181 if (NILP (BVAR (b
, cursor_type
)))
24184 /* Get the normal cursor type for this window. */
24185 if (EQ (BVAR (b
, cursor_type
), Qt
))
24187 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24188 *width
= FRAME_CURSOR_WIDTH (f
);
24191 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24193 /* Use cursor-in-non-selected-windows instead
24194 for non-selected window or frame. */
24197 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24198 if (!EQ (Qt
, alt_cursor
))
24199 return get_specified_cursor_type (alt_cursor
, width
);
24200 /* t means modify the normal cursor type. */
24201 if (cursor_type
== FILLED_BOX_CURSOR
)
24202 cursor_type
= HOLLOW_BOX_CURSOR
;
24203 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24205 return cursor_type
;
24208 /* Use normal cursor if not blinked off. */
24209 if (!w
->cursor_off_p
)
24211 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24213 if (cursor_type
== FILLED_BOX_CURSOR
)
24215 /* Using a block cursor on large images can be very annoying.
24216 So use a hollow cursor for "large" images.
24217 If image is not transparent (no mask), also use hollow cursor. */
24218 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24219 if (img
!= NULL
&& IMAGEP (img
->spec
))
24221 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24222 where N = size of default frame font size.
24223 This should cover most of the "tiny" icons people may use. */
24225 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24226 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24227 cursor_type
= HOLLOW_BOX_CURSOR
;
24230 else if (cursor_type
!= NO_CURSOR
)
24232 /* Display current only supports BOX and HOLLOW cursors for images.
24233 So for now, unconditionally use a HOLLOW cursor when cursor is
24234 not a solid box cursor. */
24235 cursor_type
= HOLLOW_BOX_CURSOR
;
24238 return cursor_type
;
24241 /* Cursor is blinked off, so determine how to "toggle" it. */
24243 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24244 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24245 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24247 /* Then see if frame has specified a specific blink off cursor type. */
24248 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24250 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24251 return FRAME_BLINK_OFF_CURSOR (f
);
24255 /* Some people liked having a permanently visible blinking cursor,
24256 while others had very strong opinions against it. So it was
24257 decided to remove it. KFS 2003-09-03 */
24259 /* Finally perform built-in cursor blinking:
24260 filled box <-> hollow box
24261 wide [h]bar <-> narrow [h]bar
24262 narrow [h]bar <-> no cursor
24263 other type <-> no cursor */
24265 if (cursor_type
== FILLED_BOX_CURSOR
)
24266 return HOLLOW_BOX_CURSOR
;
24268 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24271 return cursor_type
;
24279 /* Notice when the text cursor of window W has been completely
24280 overwritten by a drawing operation that outputs glyphs in AREA
24281 starting at X0 and ending at X1 in the line starting at Y0 and
24282 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24283 the rest of the line after X0 has been written. Y coordinates
24284 are window-relative. */
24287 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24288 int x0
, int x1
, int y0
, int y1
)
24290 int cx0
, cx1
, cy0
, cy1
;
24291 struct glyph_row
*row
;
24293 if (!w
->phys_cursor_on_p
)
24295 if (area
!= TEXT_AREA
)
24298 if (w
->phys_cursor
.vpos
< 0
24299 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24300 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24301 !(row
->enabled_p
&& row
->displays_text_p
)))
24304 if (row
->cursor_in_fringe_p
)
24306 row
->cursor_in_fringe_p
= 0;
24307 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24308 w
->phys_cursor_on_p
= 0;
24312 cx0
= w
->phys_cursor
.x
;
24313 cx1
= cx0
+ w
->phys_cursor_width
;
24314 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24317 /* The cursor image will be completely removed from the
24318 screen if the output area intersects the cursor area in
24319 y-direction. When we draw in [y0 y1[, and some part of
24320 the cursor is at y < y0, that part must have been drawn
24321 before. When scrolling, the cursor is erased before
24322 actually scrolling, so we don't come here. When not
24323 scrolling, the rows above the old cursor row must have
24324 changed, and in this case these rows must have written
24325 over the cursor image.
24327 Likewise if part of the cursor is below y1, with the
24328 exception of the cursor being in the first blank row at
24329 the buffer and window end because update_text_area
24330 doesn't draw that row. (Except when it does, but
24331 that's handled in update_text_area.) */
24333 cy0
= w
->phys_cursor
.y
;
24334 cy1
= cy0
+ w
->phys_cursor_height
;
24335 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24338 w
->phys_cursor_on_p
= 0;
24341 #endif /* HAVE_WINDOW_SYSTEM */
24344 /************************************************************************
24346 ************************************************************************/
24348 #ifdef HAVE_WINDOW_SYSTEM
24351 Fix the display of area AREA of overlapping row ROW in window W
24352 with respect to the overlapping part OVERLAPS. */
24355 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24356 enum glyph_row_area area
, int overlaps
)
24363 for (i
= 0; i
< row
->used
[area
];)
24365 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24367 int start
= i
, start_x
= x
;
24371 x
+= row
->glyphs
[area
][i
].pixel_width
;
24374 while (i
< row
->used
[area
]
24375 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24377 draw_glyphs (w
, start_x
, row
, area
,
24379 DRAW_NORMAL_TEXT
, overlaps
);
24383 x
+= row
->glyphs
[area
][i
].pixel_width
;
24393 Draw the cursor glyph of window W in glyph row ROW. See the
24394 comment of draw_glyphs for the meaning of HL. */
24397 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24398 enum draw_glyphs_face hl
)
24400 /* If cursor hpos is out of bounds, don't draw garbage. This can
24401 happen in mini-buffer windows when switching between echo area
24402 glyphs and mini-buffer. */
24403 if ((row
->reversed_p
24404 ? (w
->phys_cursor
.hpos
>= 0)
24405 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24407 int on_p
= w
->phys_cursor_on_p
;
24409 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24410 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24412 w
->phys_cursor_on_p
= on_p
;
24414 if (hl
== DRAW_CURSOR
)
24415 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24416 /* When we erase the cursor, and ROW is overlapped by other
24417 rows, make sure that these overlapping parts of other rows
24419 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24421 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24423 if (row
> w
->current_matrix
->rows
24424 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24425 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24426 OVERLAPS_ERASED_CURSOR
);
24428 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24429 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24430 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24431 OVERLAPS_ERASED_CURSOR
);
24438 Erase the image of a cursor of window W from the screen. */
24441 erase_phys_cursor (struct window
*w
)
24443 struct frame
*f
= XFRAME (w
->frame
);
24444 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24445 int hpos
= w
->phys_cursor
.hpos
;
24446 int vpos
= w
->phys_cursor
.vpos
;
24447 int mouse_face_here_p
= 0;
24448 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24449 struct glyph_row
*cursor_row
;
24450 struct glyph
*cursor_glyph
;
24451 enum draw_glyphs_face hl
;
24453 /* No cursor displayed or row invalidated => nothing to do on the
24455 if (w
->phys_cursor_type
== NO_CURSOR
)
24456 goto mark_cursor_off
;
24458 /* VPOS >= active_glyphs->nrows means that window has been resized.
24459 Don't bother to erase the cursor. */
24460 if (vpos
>= active_glyphs
->nrows
)
24461 goto mark_cursor_off
;
24463 /* If row containing cursor is marked invalid, there is nothing we
24465 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24466 if (!cursor_row
->enabled_p
)
24467 goto mark_cursor_off
;
24469 /* If line spacing is > 0, old cursor may only be partially visible in
24470 window after split-window. So adjust visible height. */
24471 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24472 window_text_bottom_y (w
) - cursor_row
->y
);
24474 /* If row is completely invisible, don't attempt to delete a cursor which
24475 isn't there. This can happen if cursor is at top of a window, and
24476 we switch to a buffer with a header line in that window. */
24477 if (cursor_row
->visible_height
<= 0)
24478 goto mark_cursor_off
;
24480 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24481 if (cursor_row
->cursor_in_fringe_p
)
24483 cursor_row
->cursor_in_fringe_p
= 0;
24484 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24485 goto mark_cursor_off
;
24488 /* This can happen when the new row is shorter than the old one.
24489 In this case, either draw_glyphs or clear_end_of_line
24490 should have cleared the cursor. Note that we wouldn't be
24491 able to erase the cursor in this case because we don't have a
24492 cursor glyph at hand. */
24493 if ((cursor_row
->reversed_p
24494 ? (w
->phys_cursor
.hpos
< 0)
24495 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24496 goto mark_cursor_off
;
24498 /* If the cursor is in the mouse face area, redisplay that when
24499 we clear the cursor. */
24500 if (! NILP (hlinfo
->mouse_face_window
)
24501 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24502 /* Don't redraw the cursor's spot in mouse face if it is at the
24503 end of a line (on a newline). The cursor appears there, but
24504 mouse highlighting does not. */
24505 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24506 mouse_face_here_p
= 1;
24508 /* Maybe clear the display under the cursor. */
24509 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24512 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24515 cursor_glyph
= get_phys_cursor_glyph (w
);
24516 if (cursor_glyph
== NULL
)
24517 goto mark_cursor_off
;
24519 width
= cursor_glyph
->pixel_width
;
24520 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24521 x
= w
->phys_cursor
.x
;
24523 width
-= left_x
- x
;
24524 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24525 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24526 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24529 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24532 /* Erase the cursor by redrawing the character underneath it. */
24533 if (mouse_face_here_p
)
24534 hl
= DRAW_MOUSE_FACE
;
24536 hl
= DRAW_NORMAL_TEXT
;
24537 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24540 w
->phys_cursor_on_p
= 0;
24541 w
->phys_cursor_type
= NO_CURSOR
;
24546 Display or clear cursor of window W. If ON is zero, clear the
24547 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24548 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24551 display_and_set_cursor (struct window
*w
, int on
,
24552 int hpos
, int vpos
, int x
, int y
)
24554 struct frame
*f
= XFRAME (w
->frame
);
24555 int new_cursor_type
;
24556 int new_cursor_width
;
24558 struct glyph_row
*glyph_row
;
24559 struct glyph
*glyph
;
24561 /* This is pointless on invisible frames, and dangerous on garbaged
24562 windows and frames; in the latter case, the frame or window may
24563 be in the midst of changing its size, and x and y may be off the
24565 if (! FRAME_VISIBLE_P (f
)
24566 || FRAME_GARBAGED_P (f
)
24567 || vpos
>= w
->current_matrix
->nrows
24568 || hpos
>= w
->current_matrix
->matrix_w
)
24571 /* If cursor is off and we want it off, return quickly. */
24572 if (!on
&& !w
->phys_cursor_on_p
)
24575 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24576 /* If cursor row is not enabled, we don't really know where to
24577 display the cursor. */
24578 if (!glyph_row
->enabled_p
)
24580 w
->phys_cursor_on_p
= 0;
24585 if (!glyph_row
->exact_window_width_line_p
24586 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24587 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24589 xassert (interrupt_input_blocked
);
24591 /* Set new_cursor_type to the cursor we want to be displayed. */
24592 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24593 &new_cursor_width
, &active_cursor
);
24595 /* If cursor is currently being shown and we don't want it to be or
24596 it is in the wrong place, or the cursor type is not what we want,
24598 if (w
->phys_cursor_on_p
24600 || w
->phys_cursor
.x
!= x
24601 || w
->phys_cursor
.y
!= y
24602 || new_cursor_type
!= w
->phys_cursor_type
24603 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24604 && new_cursor_width
!= w
->phys_cursor_width
)))
24605 erase_phys_cursor (w
);
24607 /* Don't check phys_cursor_on_p here because that flag is only set
24608 to zero in some cases where we know that the cursor has been
24609 completely erased, to avoid the extra work of erasing the cursor
24610 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24611 still not be visible, or it has only been partly erased. */
24614 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24615 w
->phys_cursor_height
= glyph_row
->height
;
24617 /* Set phys_cursor_.* before x_draw_.* is called because some
24618 of them may need the information. */
24619 w
->phys_cursor
.x
= x
;
24620 w
->phys_cursor
.y
= glyph_row
->y
;
24621 w
->phys_cursor
.hpos
= hpos
;
24622 w
->phys_cursor
.vpos
= vpos
;
24625 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24626 new_cursor_type
, new_cursor_width
,
24627 on
, active_cursor
);
24631 /* Switch the display of W's cursor on or off, according to the value
24635 update_window_cursor (struct window
*w
, int on
)
24637 /* Don't update cursor in windows whose frame is in the process
24638 of being deleted. */
24639 if (w
->current_matrix
)
24642 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24643 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24649 /* Call update_window_cursor with parameter ON_P on all leaf windows
24650 in the window tree rooted at W. */
24653 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24657 if (!NILP (w
->hchild
))
24658 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24659 else if (!NILP (w
->vchild
))
24660 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24662 update_window_cursor (w
, on_p
);
24664 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24670 Display the cursor on window W, or clear it, according to ON_P.
24671 Don't change the cursor's position. */
24674 x_update_cursor (struct frame
*f
, int on_p
)
24676 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24681 Clear the cursor of window W to background color, and mark the
24682 cursor as not shown. This is used when the text where the cursor
24683 is about to be rewritten. */
24686 x_clear_cursor (struct window
*w
)
24688 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24689 update_window_cursor (w
, 0);
24692 #endif /* HAVE_WINDOW_SYSTEM */
24694 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24697 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24698 int start_hpos
, int end_hpos
,
24699 enum draw_glyphs_face draw
)
24701 #ifdef HAVE_WINDOW_SYSTEM
24702 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24704 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24708 #if defined (HAVE_GPM) || defined (MSDOS)
24709 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24713 /* Display the active region described by mouse_face_* according to DRAW. */
24716 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24718 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24719 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24721 if (/* If window is in the process of being destroyed, don't bother
24723 w
->current_matrix
!= NULL
24724 /* Don't update mouse highlight if hidden */
24725 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24726 /* Recognize when we are called to operate on rows that don't exist
24727 anymore. This can happen when a window is split. */
24728 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24730 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24731 struct glyph_row
*row
, *first
, *last
;
24733 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24734 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24736 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24738 int start_hpos
, end_hpos
, start_x
;
24740 /* For all but the first row, the highlight starts at column 0. */
24743 /* R2L rows have BEG and END in reversed order, but the
24744 screen drawing geometry is always left to right. So
24745 we need to mirror the beginning and end of the
24746 highlighted area in R2L rows. */
24747 if (!row
->reversed_p
)
24749 start_hpos
= hlinfo
->mouse_face_beg_col
;
24750 start_x
= hlinfo
->mouse_face_beg_x
;
24752 else if (row
== last
)
24754 start_hpos
= hlinfo
->mouse_face_end_col
;
24755 start_x
= hlinfo
->mouse_face_end_x
;
24763 else if (row
->reversed_p
&& row
== last
)
24765 start_hpos
= hlinfo
->mouse_face_end_col
;
24766 start_x
= hlinfo
->mouse_face_end_x
;
24776 if (!row
->reversed_p
)
24777 end_hpos
= hlinfo
->mouse_face_end_col
;
24778 else if (row
== first
)
24779 end_hpos
= hlinfo
->mouse_face_beg_col
;
24782 end_hpos
= row
->used
[TEXT_AREA
];
24783 if (draw
== DRAW_NORMAL_TEXT
)
24784 row
->fill_line_p
= 1; /* Clear to end of line */
24787 else if (row
->reversed_p
&& row
== first
)
24788 end_hpos
= hlinfo
->mouse_face_beg_col
;
24791 end_hpos
= row
->used
[TEXT_AREA
];
24792 if (draw
== DRAW_NORMAL_TEXT
)
24793 row
->fill_line_p
= 1; /* Clear to end of line */
24796 if (end_hpos
> start_hpos
)
24798 draw_row_with_mouse_face (w
, start_x
, row
,
24799 start_hpos
, end_hpos
, draw
);
24802 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24806 #ifdef HAVE_WINDOW_SYSTEM
24807 /* When we've written over the cursor, arrange for it to
24808 be displayed again. */
24809 if (FRAME_WINDOW_P (f
)
24810 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24813 display_and_set_cursor (w
, 1,
24814 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24815 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24818 #endif /* HAVE_WINDOW_SYSTEM */
24821 #ifdef HAVE_WINDOW_SYSTEM
24822 /* Change the mouse cursor. */
24823 if (FRAME_WINDOW_P (f
))
24825 if (draw
== DRAW_NORMAL_TEXT
24826 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24827 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24828 else if (draw
== DRAW_MOUSE_FACE
)
24829 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24831 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24833 #endif /* HAVE_WINDOW_SYSTEM */
24837 Clear out the mouse-highlighted active region.
24838 Redraw it un-highlighted first. Value is non-zero if mouse
24839 face was actually drawn unhighlighted. */
24842 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24846 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24848 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24852 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24853 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24854 hlinfo
->mouse_face_window
= Qnil
;
24855 hlinfo
->mouse_face_overlay
= Qnil
;
24859 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24860 within the mouse face on that window. */
24862 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24864 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24866 /* Quickly resolve the easy cases. */
24867 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24868 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24870 if (vpos
< hlinfo
->mouse_face_beg_row
24871 || vpos
> hlinfo
->mouse_face_end_row
)
24873 if (vpos
> hlinfo
->mouse_face_beg_row
24874 && vpos
< hlinfo
->mouse_face_end_row
)
24877 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24879 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24881 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24884 else if ((vpos
== hlinfo
->mouse_face_beg_row
24885 && hpos
>= hlinfo
->mouse_face_beg_col
)
24886 || (vpos
== hlinfo
->mouse_face_end_row
24887 && hpos
< hlinfo
->mouse_face_end_col
))
24892 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24894 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24897 else if ((vpos
== hlinfo
->mouse_face_beg_row
24898 && hpos
<= hlinfo
->mouse_face_beg_col
)
24899 || (vpos
== hlinfo
->mouse_face_end_row
24900 && hpos
> hlinfo
->mouse_face_end_col
))
24908 Non-zero if physical cursor of window W is within mouse face. */
24911 cursor_in_mouse_face_p (struct window
*w
)
24913 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24918 /* Find the glyph rows START_ROW and END_ROW of window W that display
24919 characters between buffer positions START_CHARPOS and END_CHARPOS
24920 (excluding END_CHARPOS). This is similar to row_containing_pos,
24921 but is more accurate when bidi reordering makes buffer positions
24922 change non-linearly with glyph rows. */
24924 rows_from_pos_range (struct window
*w
,
24925 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24926 struct glyph_row
**start
, struct glyph_row
**end
)
24928 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24929 int last_y
= window_text_bottom_y (w
);
24930 struct glyph_row
*row
;
24935 while (!first
->enabled_p
24936 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24939 /* Find the START row. */
24941 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24944 /* A row can potentially be the START row if the range of the
24945 characters it displays intersects the range
24946 [START_CHARPOS..END_CHARPOS). */
24947 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24948 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24949 /* See the commentary in row_containing_pos, for the
24950 explanation of the complicated way to check whether
24951 some position is beyond the end of the characters
24952 displayed by a row. */
24953 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24954 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24955 && !row
->ends_at_zv_p
24956 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24957 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24958 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24959 && !row
->ends_at_zv_p
24960 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24962 /* Found a candidate row. Now make sure at least one of the
24963 glyphs it displays has a charpos from the range
24964 [START_CHARPOS..END_CHARPOS).
24966 This is not obvious because bidi reordering could make
24967 buffer positions of a row be 1,2,3,102,101,100, and if we
24968 want to highlight characters in [50..60), we don't want
24969 this row, even though [50..60) does intersect [1..103),
24970 the range of character positions given by the row's start
24971 and end positions. */
24972 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24973 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24977 if (BUFFERP (g
->object
)
24978 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24987 /* Find the END row. */
24989 /* If the last row is partially visible, start looking for END
24990 from that row, instead of starting from FIRST. */
24991 && !(row
->enabled_p
24992 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24994 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24996 struct glyph_row
*next
= row
+ 1;
24998 if (!next
->enabled_p
24999 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25000 /* The first row >= START whose range of displayed characters
25001 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25002 is the row END + 1. */
25003 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25004 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25005 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25006 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25007 && !next
->ends_at_zv_p
25008 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25009 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25010 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25011 && !next
->ends_at_zv_p
25012 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25019 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25020 but none of the characters it displays are in the range, it is
25022 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25023 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25027 if (BUFFERP (g
->object
)
25028 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25041 /* This function sets the mouse_face_* elements of HLINFO, assuming
25042 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25043 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25044 for the overlay or run of text properties specifying the mouse
25045 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25046 before-string and after-string that must also be highlighted.
25047 COVER_STRING, if non-nil, is a display string that may cover some
25048 or all of the highlighted text. */
25051 mouse_face_from_buffer_pos (Lisp_Object window
,
25052 Mouse_HLInfo
*hlinfo
,
25053 EMACS_INT mouse_charpos
,
25054 EMACS_INT start_charpos
,
25055 EMACS_INT end_charpos
,
25056 Lisp_Object before_string
,
25057 Lisp_Object after_string
,
25058 Lisp_Object cover_string
)
25060 struct window
*w
= XWINDOW (window
);
25061 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25062 struct glyph_row
*r1
, *r2
;
25063 struct glyph
*glyph
, *end
;
25064 EMACS_INT ignore
, pos
;
25067 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25068 xassert (NILP (before_string
) || STRINGP (before_string
));
25069 xassert (NILP (after_string
) || STRINGP (after_string
));
25071 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25072 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25074 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25075 /* If the before-string or display-string contains newlines,
25076 rows_from_pos_range skips to its last row. Move back. */
25077 if (!NILP (before_string
) || !NILP (cover_string
))
25079 struct glyph_row
*prev
;
25080 while ((prev
= r1
- 1, prev
>= first
)
25081 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25082 && prev
->used
[TEXT_AREA
] > 0)
25084 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25085 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25086 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25088 || !(EQ (glyph
->object
, before_string
)
25089 || EQ (glyph
->object
, cover_string
)))
25096 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25097 hlinfo
->mouse_face_past_end
= 1;
25099 else if (!NILP (after_string
))
25101 /* If the after-string has newlines, advance to its last row. */
25102 struct glyph_row
*next
;
25103 struct glyph_row
*last
25104 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25106 for (next
= r2
+ 1;
25108 && next
->used
[TEXT_AREA
] > 0
25109 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25113 /* The rest of the display engine assumes that mouse_face_beg_row is
25114 either above below mouse_face_end_row or identical to it. But
25115 with bidi-reordered continued lines, the row for START_CHARPOS
25116 could be below the row for END_CHARPOS. If so, swap the rows and
25117 store them in correct order. */
25120 struct glyph_row
*tem
= r2
;
25126 hlinfo
->mouse_face_beg_y
= r1
->y
;
25127 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25128 hlinfo
->mouse_face_end_y
= r2
->y
;
25129 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25131 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25132 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25133 could be anywhere in the row and in any order. The strategy
25134 below is to find the leftmost and the rightmost glyph that
25135 belongs to either of these 3 strings, or whose position is
25136 between START_CHARPOS and END_CHARPOS, and highlight all the
25137 glyphs between those two. This may cover more than just the text
25138 between START_CHARPOS and END_CHARPOS if the range of characters
25139 strides the bidi level boundary, e.g. if the beginning is in R2L
25140 text while the end is in L2R text or vice versa. */
25141 if (!r1
->reversed_p
)
25143 /* This row is in a left to right paragraph. Scan it left to
25145 glyph
= r1
->glyphs
[TEXT_AREA
];
25146 end
= glyph
+ r1
->used
[TEXT_AREA
];
25149 /* Skip truncation glyphs at the start of the glyph row. */
25150 if (r1
->displays_text_p
)
25152 && INTEGERP (glyph
->object
)
25153 && glyph
->charpos
< 0;
25155 x
+= glyph
->pixel_width
;
25157 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25158 or COVER_STRING, and the first glyph from buffer whose
25159 position is between START_CHARPOS and END_CHARPOS. */
25161 && !INTEGERP (glyph
->object
)
25162 && !EQ (glyph
->object
, cover_string
)
25163 && !(BUFFERP (glyph
->object
)
25164 && (glyph
->charpos
>= start_charpos
25165 && glyph
->charpos
< end_charpos
));
25168 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25169 are present at buffer positions between START_CHARPOS and
25170 END_CHARPOS, or if they come from an overlay. */
25171 if (EQ (glyph
->object
, before_string
))
25173 pos
= string_buffer_position (before_string
,
25175 /* If pos == 0, it means before_string came from an
25176 overlay, not from a buffer position. */
25177 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25180 else if (EQ (glyph
->object
, after_string
))
25182 pos
= string_buffer_position (after_string
, end_charpos
);
25183 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25186 x
+= glyph
->pixel_width
;
25188 hlinfo
->mouse_face_beg_x
= x
;
25189 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25193 /* This row is in a right to left paragraph. Scan it right to
25197 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25198 glyph
= end
+ r1
->used
[TEXT_AREA
];
25200 /* Skip truncation glyphs at the start of the glyph row. */
25201 if (r1
->displays_text_p
)
25203 && INTEGERP (glyph
->object
)
25204 && glyph
->charpos
< 0;
25208 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25209 or COVER_STRING, and the first glyph from buffer whose
25210 position is between START_CHARPOS and END_CHARPOS. */
25212 && !INTEGERP (glyph
->object
)
25213 && !EQ (glyph
->object
, cover_string
)
25214 && !(BUFFERP (glyph
->object
)
25215 && (glyph
->charpos
>= start_charpos
25216 && glyph
->charpos
< end_charpos
));
25219 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25220 are present at buffer positions between START_CHARPOS and
25221 END_CHARPOS, or if they come from an overlay. */
25222 if (EQ (glyph
->object
, before_string
))
25224 pos
= string_buffer_position (before_string
, start_charpos
);
25225 /* If pos == 0, it means before_string came from an
25226 overlay, not from a buffer position. */
25227 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25230 else if (EQ (glyph
->object
, after_string
))
25232 pos
= string_buffer_position (after_string
, end_charpos
);
25233 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25238 glyph
++; /* first glyph to the right of the highlighted area */
25239 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25240 x
+= g
->pixel_width
;
25241 hlinfo
->mouse_face_beg_x
= x
;
25242 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25245 /* If the highlight ends in a different row, compute GLYPH and END
25246 for the end row. Otherwise, reuse the values computed above for
25247 the row where the highlight begins. */
25250 if (!r2
->reversed_p
)
25252 glyph
= r2
->glyphs
[TEXT_AREA
];
25253 end
= glyph
+ r2
->used
[TEXT_AREA
];
25258 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25259 glyph
= end
+ r2
->used
[TEXT_AREA
];
25263 if (!r2
->reversed_p
)
25265 /* Skip truncation and continuation glyphs near the end of the
25266 row, and also blanks and stretch glyphs inserted by
25267 extend_face_to_end_of_line. */
25269 && INTEGERP ((end
- 1)->object
)
25270 && (end
- 1)->charpos
<= 0)
25272 /* Scan the rest of the glyph row from the end, looking for the
25273 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25274 COVER_STRING, or whose position is between START_CHARPOS
25278 && !INTEGERP (end
->object
)
25279 && !EQ (end
->object
, cover_string
)
25280 && !(BUFFERP (end
->object
)
25281 && (end
->charpos
>= start_charpos
25282 && end
->charpos
< end_charpos
));
25285 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25286 are present at buffer positions between START_CHARPOS and
25287 END_CHARPOS, or if they come from an overlay. */
25288 if (EQ (end
->object
, before_string
))
25290 pos
= string_buffer_position (before_string
, start_charpos
);
25291 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25294 else if (EQ (end
->object
, after_string
))
25296 pos
= string_buffer_position (after_string
, end_charpos
);
25297 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25301 /* Find the X coordinate of the last glyph to be highlighted. */
25302 for (; glyph
<= end
; ++glyph
)
25303 x
+= glyph
->pixel_width
;
25305 hlinfo
->mouse_face_end_x
= x
;
25306 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25310 /* Skip truncation and continuation glyphs near the end of the
25311 row, and also blanks and stretch glyphs inserted by
25312 extend_face_to_end_of_line. */
25316 && INTEGERP (end
->object
)
25317 && end
->charpos
<= 0)
25319 x
+= end
->pixel_width
;
25322 /* Scan the rest of the glyph row from the end, looking for the
25323 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25324 COVER_STRING, or whose position is between START_CHARPOS
25328 && !INTEGERP (end
->object
)
25329 && !EQ (end
->object
, cover_string
)
25330 && !(BUFFERP (end
->object
)
25331 && (end
->charpos
>= start_charpos
25332 && end
->charpos
< end_charpos
));
25335 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25336 are present at buffer positions between START_CHARPOS and
25337 END_CHARPOS, or if they come from an overlay. */
25338 if (EQ (end
->object
, before_string
))
25340 pos
= string_buffer_position (before_string
, start_charpos
);
25341 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25344 else if (EQ (end
->object
, after_string
))
25346 pos
= string_buffer_position (after_string
, end_charpos
);
25347 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25350 x
+= end
->pixel_width
;
25352 hlinfo
->mouse_face_end_x
= x
;
25353 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25356 hlinfo
->mouse_face_window
= window
;
25357 hlinfo
->mouse_face_face_id
25358 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25360 !hlinfo
->mouse_face_hidden
, -1);
25361 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25364 /* The following function is not used anymore (replaced with
25365 mouse_face_from_string_pos), but I leave it here for the time
25366 being, in case someone would. */
25368 #if 0 /* not used */
25370 /* Find the position of the glyph for position POS in OBJECT in
25371 window W's current matrix, and return in *X, *Y the pixel
25372 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25374 RIGHT_P non-zero means return the position of the right edge of the
25375 glyph, RIGHT_P zero means return the left edge position.
25377 If no glyph for POS exists in the matrix, return the position of
25378 the glyph with the next smaller position that is in the matrix, if
25379 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25380 exists in the matrix, return the position of the glyph with the
25381 next larger position in OBJECT.
25383 Value is non-zero if a glyph was found. */
25386 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25387 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25389 int yb
= window_text_bottom_y (w
);
25390 struct glyph_row
*r
;
25391 struct glyph
*best_glyph
= NULL
;
25392 struct glyph_row
*best_row
= NULL
;
25395 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25396 r
->enabled_p
&& r
->y
< yb
;
25399 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25400 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25403 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25404 if (EQ (g
->object
, object
))
25406 if (g
->charpos
== pos
)
25413 else if (best_glyph
== NULL
25414 || ((eabs (g
->charpos
- pos
)
25415 < eabs (best_glyph
->charpos
- pos
))
25418 : g
->charpos
> pos
)))
25432 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25436 *x
+= best_glyph
->pixel_width
;
25441 *vpos
= best_row
- w
->current_matrix
->rows
;
25444 return best_glyph
!= NULL
;
25446 #endif /* not used */
25448 /* Find the positions of the first and the last glyphs in window W's
25449 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25450 (assumed to be a string), and return in HLINFO's mouse_face_*
25451 members the pixel and column/row coordinates of those glyphs. */
25454 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25455 Lisp_Object object
,
25456 EMACS_INT startpos
, EMACS_INT endpos
)
25458 int yb
= window_text_bottom_y (w
);
25459 struct glyph_row
*r
;
25460 struct glyph
*g
, *e
;
25464 /* Find the glyph row with at least one position in the range
25465 [STARTPOS..ENDPOS], and the first glyph in that row whose
25466 position belongs to that range. */
25467 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25468 r
->enabled_p
&& r
->y
< yb
;
25471 if (!r
->reversed_p
)
25473 g
= r
->glyphs
[TEXT_AREA
];
25474 e
= g
+ r
->used
[TEXT_AREA
];
25475 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25476 if (EQ (g
->object
, object
)
25477 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25479 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25480 hlinfo
->mouse_face_beg_y
= r
->y
;
25481 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25482 hlinfo
->mouse_face_beg_x
= gx
;
25491 e
= r
->glyphs
[TEXT_AREA
];
25492 g
= e
+ r
->used
[TEXT_AREA
];
25493 for ( ; g
> e
; --g
)
25494 if (EQ ((g
-1)->object
, object
)
25495 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25497 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25498 hlinfo
->mouse_face_beg_y
= r
->y
;
25499 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25500 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25501 gx
+= g1
->pixel_width
;
25502 hlinfo
->mouse_face_beg_x
= gx
;
25514 /* Starting with the next row, look for the first row which does NOT
25515 include any glyphs whose positions are in the range. */
25516 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25518 g
= r
->glyphs
[TEXT_AREA
];
25519 e
= g
+ r
->used
[TEXT_AREA
];
25521 for ( ; g
< e
; ++g
)
25522 if (EQ (g
->object
, object
)
25523 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25532 /* The highlighted region ends on the previous row. */
25535 /* Set the end row and its vertical pixel coordinate. */
25536 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25537 hlinfo
->mouse_face_end_y
= r
->y
;
25539 /* Compute and set the end column and the end column's horizontal
25540 pixel coordinate. */
25541 if (!r
->reversed_p
)
25543 g
= r
->glyphs
[TEXT_AREA
];
25544 e
= g
+ r
->used
[TEXT_AREA
];
25545 for ( ; e
> g
; --e
)
25546 if (EQ ((e
-1)->object
, object
)
25547 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25549 hlinfo
->mouse_face_end_col
= e
- g
;
25551 for (gx
= r
->x
; g
< e
; ++g
)
25552 gx
+= g
->pixel_width
;
25553 hlinfo
->mouse_face_end_x
= gx
;
25557 e
= r
->glyphs
[TEXT_AREA
];
25558 g
= e
+ r
->used
[TEXT_AREA
];
25559 for (gx
= r
->x
; e
< g
; ++e
)
25561 if (EQ (e
->object
, object
)
25562 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25564 gx
+= e
->pixel_width
;
25566 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25567 hlinfo
->mouse_face_end_x
= gx
;
25571 #ifdef HAVE_WINDOW_SYSTEM
25573 /* See if position X, Y is within a hot-spot of an image. */
25576 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25578 if (!CONSP (hot_spot
))
25581 if (EQ (XCAR (hot_spot
), Qrect
))
25583 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25584 Lisp_Object rect
= XCDR (hot_spot
);
25588 if (!CONSP (XCAR (rect
)))
25590 if (!CONSP (XCDR (rect
)))
25592 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25594 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25596 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25598 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25602 else if (EQ (XCAR (hot_spot
), Qcircle
))
25604 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25605 Lisp_Object circ
= XCDR (hot_spot
);
25606 Lisp_Object lr
, lx0
, ly0
;
25608 && CONSP (XCAR (circ
))
25609 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25610 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25611 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25613 double r
= XFLOATINT (lr
);
25614 double dx
= XINT (lx0
) - x
;
25615 double dy
= XINT (ly0
) - y
;
25616 return (dx
* dx
+ dy
* dy
<= r
* r
);
25619 else if (EQ (XCAR (hot_spot
), Qpoly
))
25621 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25622 if (VECTORP (XCDR (hot_spot
)))
25624 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25625 Lisp_Object
*poly
= v
->contents
;
25626 int n
= v
->header
.size
;
25629 Lisp_Object lx
, ly
;
25632 /* Need an even number of coordinates, and at least 3 edges. */
25633 if (n
< 6 || n
& 1)
25636 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25637 If count is odd, we are inside polygon. Pixels on edges
25638 may or may not be included depending on actual geometry of the
25640 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25641 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25643 x0
= XINT (lx
), y0
= XINT (ly
);
25644 for (i
= 0; i
< n
; i
+= 2)
25646 int x1
= x0
, y1
= y0
;
25647 if ((lx
= poly
[i
], !INTEGERP (lx
))
25648 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25650 x0
= XINT (lx
), y0
= XINT (ly
);
25652 /* Does this segment cross the X line? */
25660 if (y
> y0
&& y
> y1
)
25662 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25672 find_hot_spot (Lisp_Object map
, int x
, int y
)
25674 while (CONSP (map
))
25676 if (CONSP (XCAR (map
))
25677 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25685 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25687 doc
: /* Lookup in image map MAP coordinates X and Y.
25688 An image map is an alist where each element has the format (AREA ID PLIST).
25689 An AREA is specified as either a rectangle, a circle, or a polygon:
25690 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25691 pixel coordinates of the upper left and bottom right corners.
25692 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25693 and the radius of the circle; r may be a float or integer.
25694 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25695 vector describes one corner in the polygon.
25696 Returns the alist element for the first matching AREA in MAP. */)
25697 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25705 return find_hot_spot (map
, XINT (x
), XINT (y
));
25709 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25711 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25713 /* Do not change cursor shape while dragging mouse. */
25714 if (!NILP (do_mouse_tracking
))
25717 if (!NILP (pointer
))
25719 if (EQ (pointer
, Qarrow
))
25720 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25721 else if (EQ (pointer
, Qhand
))
25722 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25723 else if (EQ (pointer
, Qtext
))
25724 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25725 else if (EQ (pointer
, intern ("hdrag")))
25726 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25727 #ifdef HAVE_X_WINDOWS
25728 else if (EQ (pointer
, intern ("vdrag")))
25729 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25731 else if (EQ (pointer
, intern ("hourglass")))
25732 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25733 else if (EQ (pointer
, Qmodeline
))
25734 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25736 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25739 if (cursor
!= No_Cursor
)
25740 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25743 #endif /* HAVE_WINDOW_SYSTEM */
25745 /* Take proper action when mouse has moved to the mode or header line
25746 or marginal area AREA of window W, x-position X and y-position Y.
25747 X is relative to the start of the text display area of W, so the
25748 width of bitmap areas and scroll bars must be subtracted to get a
25749 position relative to the start of the mode line. */
25752 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25753 enum window_part area
)
25755 struct window
*w
= XWINDOW (window
);
25756 struct frame
*f
= XFRAME (w
->frame
);
25757 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25758 #ifdef HAVE_WINDOW_SYSTEM
25759 Display_Info
*dpyinfo
;
25761 Cursor cursor
= No_Cursor
;
25762 Lisp_Object pointer
= Qnil
;
25763 int dx
, dy
, width
, height
;
25765 Lisp_Object string
, object
= Qnil
;
25766 Lisp_Object pos
, help
;
25768 Lisp_Object mouse_face
;
25769 int original_x_pixel
= x
;
25770 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25771 struct glyph_row
*row
;
25773 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25778 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25779 returns them in row/column units! */
25780 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25781 &object
, &dx
, &dy
, &width
, &height
);
25783 row
= (area
== ON_MODE_LINE
25784 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25785 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25787 /* Find the glyph under the mouse pointer. */
25788 if (row
->mode_line_p
&& row
->enabled_p
)
25790 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25791 end
= glyph
+ row
->used
[TEXT_AREA
];
25793 for (x0
= original_x_pixel
;
25794 glyph
< end
&& x0
>= glyph
->pixel_width
;
25796 x0
-= glyph
->pixel_width
;
25804 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25805 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25806 returns them in row/column units! */
25807 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25808 &object
, &dx
, &dy
, &width
, &height
);
25813 #ifdef HAVE_WINDOW_SYSTEM
25814 if (IMAGEP (object
))
25816 Lisp_Object image_map
, hotspot
;
25817 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25819 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25821 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25825 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25826 If so, we could look for mouse-enter, mouse-leave
25827 properties in PLIST (and do something...). */
25828 hotspot
= XCDR (hotspot
);
25829 if (CONSP (hotspot
)
25830 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25832 pointer
= Fplist_get (plist
, Qpointer
);
25833 if (NILP (pointer
))
25835 help
= Fplist_get (plist
, Qhelp_echo
);
25838 help_echo_string
= help
;
25839 /* Is this correct? ++kfs */
25840 XSETWINDOW (help_echo_window
, w
);
25841 help_echo_object
= w
->buffer
;
25842 help_echo_pos
= charpos
;
25846 if (NILP (pointer
))
25847 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25849 #endif /* HAVE_WINDOW_SYSTEM */
25851 if (STRINGP (string
))
25853 pos
= make_number (charpos
);
25854 /* If we're on a string with `help-echo' text property, arrange
25855 for the help to be displayed. This is done by setting the
25856 global variable help_echo_string to the help string. */
25859 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25862 help_echo_string
= help
;
25863 XSETWINDOW (help_echo_window
, w
);
25864 help_echo_object
= string
;
25865 help_echo_pos
= charpos
;
25869 #ifdef HAVE_WINDOW_SYSTEM
25870 if (FRAME_WINDOW_P (f
))
25872 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25873 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25874 if (NILP (pointer
))
25875 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25877 /* Change the mouse pointer according to what is under X/Y. */
25879 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25882 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25883 if (!KEYMAPP (map
))
25884 map
= Fget_text_property (pos
, Qkeymap
, string
);
25885 if (!KEYMAPP (map
))
25886 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25891 /* Change the mouse face according to what is under X/Y. */
25892 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25893 if (!NILP (mouse_face
)
25894 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25899 struct glyph
* tmp_glyph
;
25903 int total_pixel_width
;
25904 EMACS_INT begpos
, endpos
, ignore
;
25908 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25909 Qmouse_face
, string
, Qnil
);
25915 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25917 endpos
= SCHARS (string
);
25921 /* Calculate the glyph position GPOS of GLYPH in the
25922 displayed string, relative to the beginning of the
25923 highlighted part of the string.
25925 Note: GPOS is different from CHARPOS. CHARPOS is the
25926 position of GLYPH in the internal string object. A mode
25927 line string format has structures which are converted to
25928 a flattened string by the Emacs Lisp interpreter. The
25929 internal string is an element of those structures. The
25930 displayed string is the flattened string. */
25931 tmp_glyph
= row_start_glyph
;
25932 while (tmp_glyph
< glyph
25933 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25934 && begpos
<= tmp_glyph
->charpos
25935 && tmp_glyph
->charpos
< endpos
)))
25937 gpos
= glyph
- tmp_glyph
;
25939 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25940 the highlighted part of the displayed string to which
25941 GLYPH belongs. Note: GSEQ_LENGTH is different from
25942 SCHARS (STRING), because the latter returns the length of
25943 the internal string. */
25944 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25946 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25947 && begpos
<= tmp_glyph
->charpos
25948 && tmp_glyph
->charpos
< endpos
));
25951 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25953 /* Calculate the total pixel width of all the glyphs between
25954 the beginning of the highlighted area and GLYPH. */
25955 total_pixel_width
= 0;
25956 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25957 total_pixel_width
+= tmp_glyph
->pixel_width
;
25959 /* Pre calculation of re-rendering position. Note: X is in
25960 column units here, after the call to mode_line_string or
25961 marginal_area_string. */
25963 vpos
= (area
== ON_MODE_LINE
25964 ? (w
->current_matrix
)->nrows
- 1
25967 /* If GLYPH's position is included in the region that is
25968 already drawn in mouse face, we have nothing to do. */
25969 if ( EQ (window
, hlinfo
->mouse_face_window
)
25970 && (!row
->reversed_p
25971 ? (hlinfo
->mouse_face_beg_col
<= hpos
25972 && hpos
< hlinfo
->mouse_face_end_col
)
25973 /* In R2L rows we swap BEG and END, see below. */
25974 : (hlinfo
->mouse_face_end_col
<= hpos
25975 && hpos
< hlinfo
->mouse_face_beg_col
))
25976 && hlinfo
->mouse_face_beg_row
== vpos
)
25979 if (clear_mouse_face (hlinfo
))
25980 cursor
= No_Cursor
;
25982 if (!row
->reversed_p
)
25984 hlinfo
->mouse_face_beg_col
= hpos
;
25985 hlinfo
->mouse_face_beg_x
= original_x_pixel
25986 - (total_pixel_width
+ dx
);
25987 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25988 hlinfo
->mouse_face_end_x
= 0;
25992 /* In R2L rows, show_mouse_face expects BEG and END
25993 coordinates to be swapped. */
25994 hlinfo
->mouse_face_end_col
= hpos
;
25995 hlinfo
->mouse_face_end_x
= original_x_pixel
25996 - (total_pixel_width
+ dx
);
25997 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25998 hlinfo
->mouse_face_beg_x
= 0;
26001 hlinfo
->mouse_face_beg_row
= vpos
;
26002 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26003 hlinfo
->mouse_face_beg_y
= 0;
26004 hlinfo
->mouse_face_end_y
= 0;
26005 hlinfo
->mouse_face_past_end
= 0;
26006 hlinfo
->mouse_face_window
= window
;
26008 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26014 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26016 if (NILP (pointer
))
26019 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26020 clear_mouse_face (hlinfo
);
26022 #ifdef HAVE_WINDOW_SYSTEM
26023 if (FRAME_WINDOW_P (f
))
26024 define_frame_cursor1 (f
, cursor
, pointer
);
26030 Take proper action when the mouse has moved to position X, Y on
26031 frame F as regards highlighting characters that have mouse-face
26032 properties. Also de-highlighting chars where the mouse was before.
26033 X and Y can be negative or out of range. */
26036 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26038 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26039 enum window_part part
;
26040 Lisp_Object window
;
26042 Cursor cursor
= No_Cursor
;
26043 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26046 /* When a menu is active, don't highlight because this looks odd. */
26047 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26048 if (popup_activated ())
26052 if (NILP (Vmouse_highlight
)
26053 || !f
->glyphs_initialized_p
26054 || f
->pointer_invisible
)
26057 hlinfo
->mouse_face_mouse_x
= x
;
26058 hlinfo
->mouse_face_mouse_y
= y
;
26059 hlinfo
->mouse_face_mouse_frame
= f
;
26061 if (hlinfo
->mouse_face_defer
)
26064 if (gc_in_progress
)
26066 hlinfo
->mouse_face_deferred_gc
= 1;
26070 /* Which window is that in? */
26071 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26073 /* If we were displaying active text in another window, clear that.
26074 Also clear if we move out of text area in same window. */
26075 if (! EQ (window
, hlinfo
->mouse_face_window
)
26076 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26077 && !NILP (hlinfo
->mouse_face_window
)))
26078 clear_mouse_face (hlinfo
);
26080 /* Not on a window -> return. */
26081 if (!WINDOWP (window
))
26084 /* Reset help_echo_string. It will get recomputed below. */
26085 help_echo_string
= Qnil
;
26087 /* Convert to window-relative pixel coordinates. */
26088 w
= XWINDOW (window
);
26089 frame_to_window_pixel_xy (w
, &x
, &y
);
26091 #ifdef HAVE_WINDOW_SYSTEM
26092 /* Handle tool-bar window differently since it doesn't display a
26094 if (EQ (window
, f
->tool_bar_window
))
26096 note_tool_bar_highlight (f
, x
, y
);
26101 /* Mouse is on the mode, header line or margin? */
26102 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26103 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26105 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26109 #ifdef HAVE_WINDOW_SYSTEM
26110 if (part
== ON_VERTICAL_BORDER
)
26112 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26113 help_echo_string
= build_string ("drag-mouse-1: resize");
26115 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26116 || part
== ON_SCROLL_BAR
)
26117 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26119 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26122 /* Are we in a window whose display is up to date?
26123 And verify the buffer's text has not changed. */
26124 b
= XBUFFER (w
->buffer
);
26125 if (part
== ON_TEXT
26126 && EQ (w
->window_end_valid
, w
->buffer
)
26127 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26128 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26130 int hpos
, vpos
, i
, dx
, dy
, area
;
26132 struct glyph
*glyph
;
26133 Lisp_Object object
;
26134 Lisp_Object mouse_face
= Qnil
, position
;
26135 Lisp_Object
*overlay_vec
= NULL
;
26137 struct buffer
*obuf
;
26138 EMACS_INT obegv
, ozv
;
26141 /* Find the glyph under X/Y. */
26142 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26144 #ifdef HAVE_WINDOW_SYSTEM
26145 /* Look for :pointer property on image. */
26146 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26148 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26149 if (img
!= NULL
&& IMAGEP (img
->spec
))
26151 Lisp_Object image_map
, hotspot
;
26152 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26154 && (hotspot
= find_hot_spot (image_map
,
26155 glyph
->slice
.img
.x
+ dx
,
26156 glyph
->slice
.img
.y
+ dy
),
26158 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26162 /* Could check XCAR (hotspot) to see if we enter/leave
26164 If so, we could look for mouse-enter, mouse-leave
26165 properties in PLIST (and do something...). */
26166 hotspot
= XCDR (hotspot
);
26167 if (CONSP (hotspot
)
26168 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26170 pointer
= Fplist_get (plist
, Qpointer
);
26171 if (NILP (pointer
))
26173 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26174 if (!NILP (help_echo_string
))
26176 help_echo_window
= window
;
26177 help_echo_object
= glyph
->object
;
26178 help_echo_pos
= glyph
->charpos
;
26182 if (NILP (pointer
))
26183 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26186 #endif /* HAVE_WINDOW_SYSTEM */
26188 /* Clear mouse face if X/Y not over text. */
26190 || area
!= TEXT_AREA
26191 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26192 /* Glyph's OBJECT is an integer for glyphs inserted by the
26193 display engine for its internal purposes, like truncation
26194 and continuation glyphs and blanks beyond the end of
26195 line's text on text terminals. If we are over such a
26196 glyph, we are not over any text. */
26197 || INTEGERP (glyph
->object
)
26198 /* R2L rows have a stretch glyph at their front, which
26199 stands for no text, whereas L2R rows have no glyphs at
26200 all beyond the end of text. Treat such stretch glyphs
26201 like we do with NULL glyphs in L2R rows. */
26202 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26203 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26204 && glyph
->type
== STRETCH_GLYPH
26205 && glyph
->avoid_cursor_p
))
26207 if (clear_mouse_face (hlinfo
))
26208 cursor
= No_Cursor
;
26209 #ifdef HAVE_WINDOW_SYSTEM
26210 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26212 if (area
!= TEXT_AREA
)
26213 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26215 pointer
= Vvoid_text_area_pointer
;
26221 pos
= glyph
->charpos
;
26222 object
= glyph
->object
;
26223 if (!STRINGP (object
) && !BUFFERP (object
))
26226 /* If we get an out-of-range value, return now; avoid an error. */
26227 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26230 /* Make the window's buffer temporarily current for
26231 overlays_at and compute_char_face. */
26232 obuf
= current_buffer
;
26233 current_buffer
= b
;
26239 /* Is this char mouse-active or does it have help-echo? */
26240 position
= make_number (pos
);
26242 if (BUFFERP (object
))
26244 /* Put all the overlays we want in a vector in overlay_vec. */
26245 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26246 /* Sort overlays into increasing priority order. */
26247 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26252 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26255 cursor
= No_Cursor
;
26257 /* Check mouse-face highlighting. */
26259 /* If there exists an overlay with mouse-face overlapping
26260 the one we are currently highlighting, we have to
26261 check if we enter the overlapping overlay, and then
26262 highlight only that. */
26263 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26264 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26266 /* Find the highest priority overlay with a mouse-face. */
26267 Lisp_Object overlay
= Qnil
;
26268 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26270 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26271 if (!NILP (mouse_face
))
26272 overlay
= overlay_vec
[i
];
26275 /* If we're highlighting the same overlay as before, there's
26276 no need to do that again. */
26277 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26278 goto check_help_echo
;
26279 hlinfo
->mouse_face_overlay
= overlay
;
26281 /* Clear the display of the old active region, if any. */
26282 if (clear_mouse_face (hlinfo
))
26283 cursor
= No_Cursor
;
26285 /* If no overlay applies, get a text property. */
26286 if (NILP (overlay
))
26287 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26289 /* Next, compute the bounds of the mouse highlighting and
26291 if (!NILP (mouse_face
) && STRINGP (object
))
26293 /* The mouse-highlighting comes from a display string
26294 with a mouse-face. */
26298 s
= Fprevious_single_property_change
26299 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26300 e
= Fnext_single_property_change
26301 (position
, Qmouse_face
, object
, Qnil
);
26303 s
= make_number (0);
26305 e
= make_number (SCHARS (object
) - 1);
26306 mouse_face_from_string_pos (w
, hlinfo
, object
,
26307 XINT (s
), XINT (e
));
26308 hlinfo
->mouse_face_past_end
= 0;
26309 hlinfo
->mouse_face_window
= window
;
26310 hlinfo
->mouse_face_face_id
26311 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26312 glyph
->face_id
, 1);
26313 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26314 cursor
= No_Cursor
;
26318 /* The mouse-highlighting, if any, comes from an overlay
26319 or text property in the buffer. */
26320 Lisp_Object buffer
IF_LINT (= Qnil
);
26321 Lisp_Object cover_string
IF_LINT (= Qnil
);
26323 if (STRINGP (object
))
26325 /* If we are on a display string with no mouse-face,
26326 check if the text under it has one. */
26327 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26328 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26329 pos
= string_buffer_position (object
, start
);
26332 mouse_face
= get_char_property_and_overlay
26333 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26334 buffer
= w
->buffer
;
26335 cover_string
= object
;
26341 cover_string
= Qnil
;
26344 if (!NILP (mouse_face
))
26346 Lisp_Object before
, after
;
26347 Lisp_Object before_string
, after_string
;
26348 /* To correctly find the limits of mouse highlight
26349 in a bidi-reordered buffer, we must not use the
26350 optimization of limiting the search in
26351 previous-single-property-change and
26352 next-single-property-change, because
26353 rows_from_pos_range needs the real start and end
26354 positions to DTRT in this case. That's because
26355 the first row visible in a window does not
26356 necessarily display the character whose position
26357 is the smallest. */
26359 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26360 ? Fmarker_position (w
->start
)
26363 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26364 ? make_number (BUF_Z (XBUFFER (buffer
))
26365 - XFASTINT (w
->window_end_pos
))
26368 if (NILP (overlay
))
26370 /* Handle the text property case. */
26371 before
= Fprevious_single_property_change
26372 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26373 after
= Fnext_single_property_change
26374 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26375 before_string
= after_string
= Qnil
;
26379 /* Handle the overlay case. */
26380 before
= Foverlay_start (overlay
);
26381 after
= Foverlay_end (overlay
);
26382 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26383 after_string
= Foverlay_get (overlay
, Qafter_string
);
26385 if (!STRINGP (before_string
)) before_string
= Qnil
;
26386 if (!STRINGP (after_string
)) after_string
= Qnil
;
26389 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26392 before_string
, after_string
,
26394 cursor
= No_Cursor
;
26401 /* Look for a `help-echo' property. */
26402 if (NILP (help_echo_string
)) {
26403 Lisp_Object help
, overlay
;
26405 /* Check overlays first. */
26406 help
= overlay
= Qnil
;
26407 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26409 overlay
= overlay_vec
[i
];
26410 help
= Foverlay_get (overlay
, Qhelp_echo
);
26415 help_echo_string
= help
;
26416 help_echo_window
= window
;
26417 help_echo_object
= overlay
;
26418 help_echo_pos
= pos
;
26422 Lisp_Object obj
= glyph
->object
;
26423 EMACS_INT charpos
= glyph
->charpos
;
26425 /* Try text properties. */
26428 && charpos
< SCHARS (obj
))
26430 help
= Fget_text_property (make_number (charpos
),
26434 /* If the string itself doesn't specify a help-echo,
26435 see if the buffer text ``under'' it does. */
26436 struct glyph_row
*r
26437 = MATRIX_ROW (w
->current_matrix
, vpos
);
26438 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26439 EMACS_INT p
= string_buffer_position (obj
, start
);
26442 help
= Fget_char_property (make_number (p
),
26443 Qhelp_echo
, w
->buffer
);
26452 else if (BUFFERP (obj
)
26455 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26460 help_echo_string
= help
;
26461 help_echo_window
= window
;
26462 help_echo_object
= obj
;
26463 help_echo_pos
= charpos
;
26468 #ifdef HAVE_WINDOW_SYSTEM
26469 /* Look for a `pointer' property. */
26470 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26472 /* Check overlays first. */
26473 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26474 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26476 if (NILP (pointer
))
26478 Lisp_Object obj
= glyph
->object
;
26479 EMACS_INT charpos
= glyph
->charpos
;
26481 /* Try text properties. */
26484 && charpos
< SCHARS (obj
))
26486 pointer
= Fget_text_property (make_number (charpos
),
26488 if (NILP (pointer
))
26490 /* If the string itself doesn't specify a pointer,
26491 see if the buffer text ``under'' it does. */
26492 struct glyph_row
*r
26493 = MATRIX_ROW (w
->current_matrix
, vpos
);
26494 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26495 EMACS_INT p
= string_buffer_position (obj
, start
);
26497 pointer
= Fget_char_property (make_number (p
),
26498 Qpointer
, w
->buffer
);
26501 else if (BUFFERP (obj
)
26504 pointer
= Fget_text_property (make_number (charpos
),
26508 #endif /* HAVE_WINDOW_SYSTEM */
26512 current_buffer
= obuf
;
26517 #ifdef HAVE_WINDOW_SYSTEM
26518 if (FRAME_WINDOW_P (f
))
26519 define_frame_cursor1 (f
, cursor
, pointer
);
26521 /* This is here to prevent a compiler error, about "label at end of
26522 compound statement". */
26529 Clear any mouse-face on window W. This function is part of the
26530 redisplay interface, and is called from try_window_id and similar
26531 functions to ensure the mouse-highlight is off. */
26534 x_clear_window_mouse_face (struct window
*w
)
26536 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26537 Lisp_Object window
;
26540 XSETWINDOW (window
, w
);
26541 if (EQ (window
, hlinfo
->mouse_face_window
))
26542 clear_mouse_face (hlinfo
);
26548 Just discard the mouse face information for frame F, if any.
26549 This is used when the size of F is changed. */
26552 cancel_mouse_face (struct frame
*f
)
26554 Lisp_Object window
;
26555 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26557 window
= hlinfo
->mouse_face_window
;
26558 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26560 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26561 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26562 hlinfo
->mouse_face_window
= Qnil
;
26568 /***********************************************************************
26570 ***********************************************************************/
26572 #ifdef HAVE_WINDOW_SYSTEM
26574 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26575 which intersects rectangle R. R is in window-relative coordinates. */
26578 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26579 enum glyph_row_area area
)
26581 struct glyph
*first
= row
->glyphs
[area
];
26582 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26583 struct glyph
*last
;
26584 int first_x
, start_x
, x
;
26586 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26587 /* If row extends face to end of line write the whole line. */
26588 draw_glyphs (w
, 0, row
, area
,
26589 0, row
->used
[area
],
26590 DRAW_NORMAL_TEXT
, 0);
26593 /* Set START_X to the window-relative start position for drawing glyphs of
26594 AREA. The first glyph of the text area can be partially visible.
26595 The first glyphs of other areas cannot. */
26596 start_x
= window_box_left_offset (w
, area
);
26598 if (area
== TEXT_AREA
)
26601 /* Find the first glyph that must be redrawn. */
26603 && x
+ first
->pixel_width
< r
->x
)
26605 x
+= first
->pixel_width
;
26609 /* Find the last one. */
26613 && x
< r
->x
+ r
->width
)
26615 x
+= last
->pixel_width
;
26621 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26622 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26623 DRAW_NORMAL_TEXT
, 0);
26628 /* Redraw the parts of the glyph row ROW on window W intersecting
26629 rectangle R. R is in window-relative coordinates. Value is
26630 non-zero if mouse-face was overwritten. */
26633 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26635 xassert (row
->enabled_p
);
26637 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26638 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26639 0, row
->used
[TEXT_AREA
],
26640 DRAW_NORMAL_TEXT
, 0);
26643 if (row
->used
[LEFT_MARGIN_AREA
])
26644 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26645 if (row
->used
[TEXT_AREA
])
26646 expose_area (w
, row
, r
, TEXT_AREA
);
26647 if (row
->used
[RIGHT_MARGIN_AREA
])
26648 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26649 draw_row_fringe_bitmaps (w
, row
);
26652 return row
->mouse_face_p
;
26656 /* Redraw those parts of glyphs rows during expose event handling that
26657 overlap other rows. Redrawing of an exposed line writes over parts
26658 of lines overlapping that exposed line; this function fixes that.
26660 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26661 row in W's current matrix that is exposed and overlaps other rows.
26662 LAST_OVERLAPPING_ROW is the last such row. */
26665 expose_overlaps (struct window
*w
,
26666 struct glyph_row
*first_overlapping_row
,
26667 struct glyph_row
*last_overlapping_row
,
26670 struct glyph_row
*row
;
26672 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26673 if (row
->overlapping_p
)
26675 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26678 if (row
->used
[LEFT_MARGIN_AREA
])
26679 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26681 if (row
->used
[TEXT_AREA
])
26682 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26684 if (row
->used
[RIGHT_MARGIN_AREA
])
26685 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26691 /* Return non-zero if W's cursor intersects rectangle R. */
26694 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26696 XRectangle cr
, result
;
26697 struct glyph
*cursor_glyph
;
26698 struct glyph_row
*row
;
26700 if (w
->phys_cursor
.vpos
>= 0
26701 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26702 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26704 && row
->cursor_in_fringe_p
)
26706 /* Cursor is in the fringe. */
26707 cr
.x
= window_box_right_offset (w
,
26708 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26709 ? RIGHT_MARGIN_AREA
26712 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26713 cr
.height
= row
->height
;
26714 return x_intersect_rectangles (&cr
, r
, &result
);
26717 cursor_glyph
= get_phys_cursor_glyph (w
);
26720 /* r is relative to W's box, but w->phys_cursor.x is relative
26721 to left edge of W's TEXT area. Adjust it. */
26722 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26723 cr
.y
= w
->phys_cursor
.y
;
26724 cr
.width
= cursor_glyph
->pixel_width
;
26725 cr
.height
= w
->phys_cursor_height
;
26726 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26727 I assume the effect is the same -- and this is portable. */
26728 return x_intersect_rectangles (&cr
, r
, &result
);
26730 /* If we don't understand the format, pretend we're not in the hot-spot. */
26736 Draw a vertical window border to the right of window W if W doesn't
26737 have vertical scroll bars. */
26740 x_draw_vertical_border (struct window
*w
)
26742 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26744 /* We could do better, if we knew what type of scroll-bar the adjacent
26745 windows (on either side) have... But we don't :-(
26746 However, I think this works ok. ++KFS 2003-04-25 */
26748 /* Redraw borders between horizontally adjacent windows. Don't
26749 do it for frames with vertical scroll bars because either the
26750 right scroll bar of a window, or the left scroll bar of its
26751 neighbor will suffice as a border. */
26752 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26755 if (!WINDOW_RIGHTMOST_P (w
)
26756 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26758 int x0
, x1
, y0
, y1
;
26760 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26763 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26766 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26768 else if (!WINDOW_LEFTMOST_P (w
)
26769 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26771 int x0
, x1
, y0
, y1
;
26773 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26776 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26779 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26784 /* Redraw the part of window W intersection rectangle FR. Pixel
26785 coordinates in FR are frame-relative. Call this function with
26786 input blocked. Value is non-zero if the exposure overwrites
26790 expose_window (struct window
*w
, XRectangle
*fr
)
26792 struct frame
*f
= XFRAME (w
->frame
);
26794 int mouse_face_overwritten_p
= 0;
26796 /* If window is not yet fully initialized, do nothing. This can
26797 happen when toolkit scroll bars are used and a window is split.
26798 Reconfiguring the scroll bar will generate an expose for a newly
26800 if (w
->current_matrix
== NULL
)
26803 /* When we're currently updating the window, display and current
26804 matrix usually don't agree. Arrange for a thorough display
26806 if (w
== updated_window
)
26808 SET_FRAME_GARBAGED (f
);
26812 /* Frame-relative pixel rectangle of W. */
26813 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26814 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26815 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26816 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26818 if (x_intersect_rectangles (fr
, &wr
, &r
))
26820 int yb
= window_text_bottom_y (w
);
26821 struct glyph_row
*row
;
26822 int cursor_cleared_p
;
26823 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26825 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26826 r
.x
, r
.y
, r
.width
, r
.height
));
26828 /* Convert to window coordinates. */
26829 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26830 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26832 /* Turn off the cursor. */
26833 if (!w
->pseudo_window_p
26834 && phys_cursor_in_rect_p (w
, &r
))
26836 x_clear_cursor (w
);
26837 cursor_cleared_p
= 1;
26840 cursor_cleared_p
= 0;
26842 /* Update lines intersecting rectangle R. */
26843 first_overlapping_row
= last_overlapping_row
= NULL
;
26844 for (row
= w
->current_matrix
->rows
;
26849 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26851 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26852 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26853 || (r
.y
>= y0
&& r
.y
< y1
)
26854 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26856 /* A header line may be overlapping, but there is no need
26857 to fix overlapping areas for them. KFS 2005-02-12 */
26858 if (row
->overlapping_p
&& !row
->mode_line_p
)
26860 if (first_overlapping_row
== NULL
)
26861 first_overlapping_row
= row
;
26862 last_overlapping_row
= row
;
26866 if (expose_line (w
, row
, &r
))
26867 mouse_face_overwritten_p
= 1;
26870 else if (row
->overlapping_p
)
26872 /* We must redraw a row overlapping the exposed area. */
26874 ? y0
+ row
->phys_height
> r
.y
26875 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26877 if (first_overlapping_row
== NULL
)
26878 first_overlapping_row
= row
;
26879 last_overlapping_row
= row
;
26887 /* Display the mode line if there is one. */
26888 if (WINDOW_WANTS_MODELINE_P (w
)
26889 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26891 && row
->y
< r
.y
+ r
.height
)
26893 if (expose_line (w
, row
, &r
))
26894 mouse_face_overwritten_p
= 1;
26897 if (!w
->pseudo_window_p
)
26899 /* Fix the display of overlapping rows. */
26900 if (first_overlapping_row
)
26901 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26904 /* Draw border between windows. */
26905 x_draw_vertical_border (w
);
26907 /* Turn the cursor on again. */
26908 if (cursor_cleared_p
)
26909 update_window_cursor (w
, 1);
26913 return mouse_face_overwritten_p
;
26918 /* Redraw (parts) of all windows in the window tree rooted at W that
26919 intersect R. R contains frame pixel coordinates. Value is
26920 non-zero if the exposure overwrites mouse-face. */
26923 expose_window_tree (struct window
*w
, XRectangle
*r
)
26925 struct frame
*f
= XFRAME (w
->frame
);
26926 int mouse_face_overwritten_p
= 0;
26928 while (w
&& !FRAME_GARBAGED_P (f
))
26930 if (!NILP (w
->hchild
))
26931 mouse_face_overwritten_p
26932 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26933 else if (!NILP (w
->vchild
))
26934 mouse_face_overwritten_p
26935 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26937 mouse_face_overwritten_p
|= expose_window (w
, r
);
26939 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26942 return mouse_face_overwritten_p
;
26947 Redisplay an exposed area of frame F. X and Y are the upper-left
26948 corner of the exposed rectangle. W and H are width and height of
26949 the exposed area. All are pixel values. W or H zero means redraw
26950 the entire frame. */
26953 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26956 int mouse_face_overwritten_p
= 0;
26958 TRACE ((stderr
, "expose_frame "));
26960 /* No need to redraw if frame will be redrawn soon. */
26961 if (FRAME_GARBAGED_P (f
))
26963 TRACE ((stderr
, " garbaged\n"));
26967 /* If basic faces haven't been realized yet, there is no point in
26968 trying to redraw anything. This can happen when we get an expose
26969 event while Emacs is starting, e.g. by moving another window. */
26970 if (FRAME_FACE_CACHE (f
) == NULL
26971 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26973 TRACE ((stderr
, " no faces\n"));
26977 if (w
== 0 || h
== 0)
26980 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26981 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26991 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26992 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26994 if (WINDOWP (f
->tool_bar_window
))
26995 mouse_face_overwritten_p
26996 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26998 #ifdef HAVE_X_WINDOWS
27000 #ifndef USE_X_TOOLKIT
27001 if (WINDOWP (f
->menu_bar_window
))
27002 mouse_face_overwritten_p
27003 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27004 #endif /* not USE_X_TOOLKIT */
27008 /* Some window managers support a focus-follows-mouse style with
27009 delayed raising of frames. Imagine a partially obscured frame,
27010 and moving the mouse into partially obscured mouse-face on that
27011 frame. The visible part of the mouse-face will be highlighted,
27012 then the WM raises the obscured frame. With at least one WM, KDE
27013 2.1, Emacs is not getting any event for the raising of the frame
27014 (even tried with SubstructureRedirectMask), only Expose events.
27015 These expose events will draw text normally, i.e. not
27016 highlighted. Which means we must redo the highlight here.
27017 Subsume it under ``we love X''. --gerd 2001-08-15 */
27018 /* Included in Windows version because Windows most likely does not
27019 do the right thing if any third party tool offers
27020 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27021 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27023 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27024 if (f
== hlinfo
->mouse_face_mouse_frame
)
27026 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27027 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27028 clear_mouse_face (hlinfo
);
27029 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27036 Determine the intersection of two rectangles R1 and R2. Return
27037 the intersection in *RESULT. Value is non-zero if RESULT is not
27041 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27043 XRectangle
*left
, *right
;
27044 XRectangle
*upper
, *lower
;
27045 int intersection_p
= 0;
27047 /* Rearrange so that R1 is the left-most rectangle. */
27049 left
= r1
, right
= r2
;
27051 left
= r2
, right
= r1
;
27053 /* X0 of the intersection is right.x0, if this is inside R1,
27054 otherwise there is no intersection. */
27055 if (right
->x
<= left
->x
+ left
->width
)
27057 result
->x
= right
->x
;
27059 /* The right end of the intersection is the minimum of the
27060 the right ends of left and right. */
27061 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27064 /* Same game for Y. */
27066 upper
= r1
, lower
= r2
;
27068 upper
= r2
, lower
= r1
;
27070 /* The upper end of the intersection is lower.y0, if this is inside
27071 of upper. Otherwise, there is no intersection. */
27072 if (lower
->y
<= upper
->y
+ upper
->height
)
27074 result
->y
= lower
->y
;
27076 /* The lower end of the intersection is the minimum of the lower
27077 ends of upper and lower. */
27078 result
->height
= (min (lower
->y
+ lower
->height
,
27079 upper
->y
+ upper
->height
)
27081 intersection_p
= 1;
27085 return intersection_p
;
27088 #endif /* HAVE_WINDOW_SYSTEM */
27091 /***********************************************************************
27093 ***********************************************************************/
27096 syms_of_xdisp (void)
27098 Vwith_echo_area_save_vector
= Qnil
;
27099 staticpro (&Vwith_echo_area_save_vector
);
27101 Vmessage_stack
= Qnil
;
27102 staticpro (&Vmessage_stack
);
27104 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
27105 staticpro (&Qinhibit_redisplay
);
27107 message_dolog_marker1
= Fmake_marker ();
27108 staticpro (&message_dolog_marker1
);
27109 message_dolog_marker2
= Fmake_marker ();
27110 staticpro (&message_dolog_marker2
);
27111 message_dolog_marker3
= Fmake_marker ();
27112 staticpro (&message_dolog_marker3
);
27115 defsubr (&Sdump_frame_glyph_matrix
);
27116 defsubr (&Sdump_glyph_matrix
);
27117 defsubr (&Sdump_glyph_row
);
27118 defsubr (&Sdump_tool_bar_row
);
27119 defsubr (&Strace_redisplay
);
27120 defsubr (&Strace_to_stderr
);
27122 #ifdef HAVE_WINDOW_SYSTEM
27123 defsubr (&Stool_bar_lines_needed
);
27124 defsubr (&Slookup_image_map
);
27126 defsubr (&Sformat_mode_line
);
27127 defsubr (&Sinvisible_p
);
27128 defsubr (&Scurrent_bidi_paragraph_direction
);
27130 staticpro (&Qmenu_bar_update_hook
);
27131 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
27133 staticpro (&Qoverriding_terminal_local_map
);
27134 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
27136 staticpro (&Qoverriding_local_map
);
27137 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
27139 staticpro (&Qwindow_scroll_functions
);
27140 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
27142 staticpro (&Qwindow_text_change_functions
);
27143 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
27145 staticpro (&Qredisplay_end_trigger_functions
);
27146 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
27148 staticpro (&Qinhibit_point_motion_hooks
);
27149 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
27151 Qeval
= intern_c_string ("eval");
27152 staticpro (&Qeval
);
27154 QCdata
= intern_c_string (":data");
27155 staticpro (&QCdata
);
27156 Qdisplay
= intern_c_string ("display");
27157 staticpro (&Qdisplay
);
27158 Qspace_width
= intern_c_string ("space-width");
27159 staticpro (&Qspace_width
);
27160 Qraise
= intern_c_string ("raise");
27161 staticpro (&Qraise
);
27162 Qslice
= intern_c_string ("slice");
27163 staticpro (&Qslice
);
27164 Qspace
= intern_c_string ("space");
27165 staticpro (&Qspace
);
27166 Qmargin
= intern_c_string ("margin");
27167 staticpro (&Qmargin
);
27168 Qpointer
= intern_c_string ("pointer");
27169 staticpro (&Qpointer
);
27170 Qleft_margin
= intern_c_string ("left-margin");
27171 staticpro (&Qleft_margin
);
27172 Qright_margin
= intern_c_string ("right-margin");
27173 staticpro (&Qright_margin
);
27174 Qcenter
= intern_c_string ("center");
27175 staticpro (&Qcenter
);
27176 Qline_height
= intern_c_string ("line-height");
27177 staticpro (&Qline_height
);
27178 QCalign_to
= intern_c_string (":align-to");
27179 staticpro (&QCalign_to
);
27180 QCrelative_width
= intern_c_string (":relative-width");
27181 staticpro (&QCrelative_width
);
27182 QCrelative_height
= intern_c_string (":relative-height");
27183 staticpro (&QCrelative_height
);
27184 QCeval
= intern_c_string (":eval");
27185 staticpro (&QCeval
);
27186 QCpropertize
= intern_c_string (":propertize");
27187 staticpro (&QCpropertize
);
27188 QCfile
= intern_c_string (":file");
27189 staticpro (&QCfile
);
27190 Qfontified
= intern_c_string ("fontified");
27191 staticpro (&Qfontified
);
27192 Qfontification_functions
= intern_c_string ("fontification-functions");
27193 staticpro (&Qfontification_functions
);
27194 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
27195 staticpro (&Qtrailing_whitespace
);
27196 Qescape_glyph
= intern_c_string ("escape-glyph");
27197 staticpro (&Qescape_glyph
);
27198 Qnobreak_space
= intern_c_string ("nobreak-space");
27199 staticpro (&Qnobreak_space
);
27200 Qimage
= intern_c_string ("image");
27201 staticpro (&Qimage
);
27202 Qtext
= intern_c_string ("text");
27203 staticpro (&Qtext
);
27204 Qboth
= intern_c_string ("both");
27205 staticpro (&Qboth
);
27206 Qboth_horiz
= intern_c_string ("both-horiz");
27207 staticpro (&Qboth_horiz
);
27208 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
27209 staticpro (&Qtext_image_horiz
);
27210 QCmap
= intern_c_string (":map");
27211 staticpro (&QCmap
);
27212 QCpointer
= intern_c_string (":pointer");
27213 staticpro (&QCpointer
);
27214 Qrect
= intern_c_string ("rect");
27215 staticpro (&Qrect
);
27216 Qcircle
= intern_c_string ("circle");
27217 staticpro (&Qcircle
);
27218 Qpoly
= intern_c_string ("poly");
27219 staticpro (&Qpoly
);
27220 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
27221 staticpro (&Qmessage_truncate_lines
);
27222 Qgrow_only
= intern_c_string ("grow-only");
27223 staticpro (&Qgrow_only
);
27224 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
27225 staticpro (&Qinhibit_menubar_update
);
27226 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
27227 staticpro (&Qinhibit_eval_during_redisplay
);
27228 Qposition
= intern_c_string ("position");
27229 staticpro (&Qposition
);
27230 Qbuffer_position
= intern_c_string ("buffer-position");
27231 staticpro (&Qbuffer_position
);
27232 Qobject
= intern_c_string ("object");
27233 staticpro (&Qobject
);
27234 Qbar
= intern_c_string ("bar");
27236 Qhbar
= intern_c_string ("hbar");
27237 staticpro (&Qhbar
);
27238 Qbox
= intern_c_string ("box");
27240 Qhollow
= intern_c_string ("hollow");
27241 staticpro (&Qhollow
);
27242 Qhand
= intern_c_string ("hand");
27243 staticpro (&Qhand
);
27244 Qarrow
= intern_c_string ("arrow");
27245 staticpro (&Qarrow
);
27246 Qtext
= intern_c_string ("text");
27247 staticpro (&Qtext
);
27248 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
27249 staticpro (&Qinhibit_free_realized_faces
);
27251 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27252 Fcons (intern_c_string ("void-variable"), Qnil
)),
27254 staticpro (&list_of_error
);
27256 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
27257 staticpro (&Qlast_arrow_position
);
27258 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
27259 staticpro (&Qlast_arrow_string
);
27261 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
27262 staticpro (&Qoverlay_arrow_string
);
27263 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
27264 staticpro (&Qoverlay_arrow_bitmap
);
27266 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27267 staticpro (&echo_buffer
[0]);
27268 staticpro (&echo_buffer
[1]);
27270 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27271 staticpro (&echo_area_buffer
[0]);
27272 staticpro (&echo_area_buffer
[1]);
27274 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27275 staticpro (&Vmessages_buffer_name
);
27277 mode_line_proptrans_alist
= Qnil
;
27278 staticpro (&mode_line_proptrans_alist
);
27279 mode_line_string_list
= Qnil
;
27280 staticpro (&mode_line_string_list
);
27281 mode_line_string_face
= Qnil
;
27282 staticpro (&mode_line_string_face
);
27283 mode_line_string_face_prop
= Qnil
;
27284 staticpro (&mode_line_string_face_prop
);
27285 Vmode_line_unwind_vector
= Qnil
;
27286 staticpro (&Vmode_line_unwind_vector
);
27288 help_echo_string
= Qnil
;
27289 staticpro (&help_echo_string
);
27290 help_echo_object
= Qnil
;
27291 staticpro (&help_echo_object
);
27292 help_echo_window
= Qnil
;
27293 staticpro (&help_echo_window
);
27294 previous_help_echo_string
= Qnil
;
27295 staticpro (&previous_help_echo_string
);
27296 help_echo_pos
= -1;
27298 Qright_to_left
= intern_c_string ("right-to-left");
27299 staticpro (&Qright_to_left
);
27300 Qleft_to_right
= intern_c_string ("left-to-right");
27301 staticpro (&Qleft_to_right
);
27303 #ifdef HAVE_WINDOW_SYSTEM
27304 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27305 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27306 For example, if a block cursor is over a tab, it will be drawn as
27307 wide as that tab on the display. */);
27308 x_stretch_cursor_p
= 0;
27311 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27312 doc
: /* *Non-nil means highlight trailing whitespace.
27313 The face used for trailing whitespace is `trailing-whitespace'. */);
27314 Vshow_trailing_whitespace
= Qnil
;
27316 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27317 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27318 A value of t means highlight the character itself (for nobreak space,
27319 use face `nobreak-space').
27320 A value of nil means no highlighting.
27321 Other values mean display the escape glyph followed by an ordinary
27322 space or ordinary hyphen. */);
27323 Vnobreak_char_display
= Qt
;
27325 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27326 doc
: /* *The pointer shape to show in void text areas.
27327 A value of nil means to show the text pointer. Other options are `arrow',
27328 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27329 Vvoid_text_area_pointer
= Qarrow
;
27331 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27332 doc
: /* Non-nil means don't actually do any redisplay.
27333 This is used for internal purposes. */);
27334 Vinhibit_redisplay
= Qnil
;
27336 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27337 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27338 Vglobal_mode_string
= Qnil
;
27340 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27341 doc
: /* Marker for where to display an arrow on top of the buffer text.
27342 This must be the beginning of a line in order to work.
27343 See also `overlay-arrow-string'. */);
27344 Voverlay_arrow_position
= Qnil
;
27346 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27347 doc
: /* String to display as an arrow in non-window frames.
27348 See also `overlay-arrow-position'. */);
27349 Voverlay_arrow_string
= make_pure_c_string ("=>");
27351 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27352 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27353 The symbols on this list are examined during redisplay to determine
27354 where to display overlay arrows. */);
27355 Voverlay_arrow_variable_list
27356 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27358 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27359 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27360 If that fails to bring point back on frame, point is centered instead.
27361 If this is zero, point is always centered after it moves off frame.
27362 If you want scrolling to always be a line at a time, you should set
27363 `scroll-conservatively' to a large value rather than set this to 1. */);
27365 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27366 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27367 If point moves off-screen, redisplay will scroll by up to
27368 `scroll-conservatively' lines in order to bring point just barely
27369 onto the screen again. If that cannot be done, then redisplay
27370 recenters point as usual.
27372 If the value is greater than 100, redisplay will never recenter point,
27373 but will always scroll just enough text to bring point into view, even
27374 if you move far away.
27376 A value of zero means always recenter point if it moves off screen. */);
27377 scroll_conservatively
= 0;
27379 DEFVAR_INT ("scroll-margin", scroll_margin
,
27380 doc
: /* *Number of lines of margin at the top and bottom of a window.
27381 Recenter the window whenever point gets within this many lines
27382 of the top or bottom of the window. */);
27385 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27386 doc
: /* Pixels per inch value for non-window system displays.
27387 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27388 Vdisplay_pixels_per_inch
= make_float (72.0);
27391 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27394 DEFVAR_LISP ("truncate-partial-width-windows",
27395 Vtruncate_partial_width_windows
,
27396 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27397 For an integer value, truncate lines in each window narrower than the
27398 full frame width, provided the window width is less than that integer;
27399 otherwise, respect the value of `truncate-lines'.
27401 For any other non-nil value, truncate lines in all windows that do
27402 not span the full frame width.
27404 A value of nil means to respect the value of `truncate-lines'.
27406 If `word-wrap' is enabled, you might want to reduce this. */);
27407 Vtruncate_partial_width_windows
= make_number (50);
27409 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27410 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27411 Any other value means to use the appropriate face, `mode-line',
27412 `header-line', or `menu' respectively. */);
27413 mode_line_inverse_video
= 1;
27415 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27416 doc
: /* *Maximum buffer size for which line number should be displayed.
27417 If the buffer is bigger than this, the line number does not appear
27418 in the mode line. A value of nil means no limit. */);
27419 Vline_number_display_limit
= Qnil
;
27421 DEFVAR_INT ("line-number-display-limit-width",
27422 line_number_display_limit_width
,
27423 doc
: /* *Maximum line width (in characters) for line number display.
27424 If the average length of the lines near point is bigger than this, then the
27425 line number may be omitted from the mode line. */);
27426 line_number_display_limit_width
= 200;
27428 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27429 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27430 highlight_nonselected_windows
= 0;
27432 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27433 doc
: /* Non-nil if more than one frame is visible on this display.
27434 Minibuffer-only frames don't count, but iconified frames do.
27435 This variable is not guaranteed to be accurate except while processing
27436 `frame-title-format' and `icon-title-format'. */);
27438 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27439 doc
: /* Template for displaying the title bar of visible frames.
27440 \(Assuming the window manager supports this feature.)
27442 This variable has the same structure as `mode-line-format', except that
27443 the %c and %l constructs are ignored. It is used only on frames for
27444 which no explicit name has been set \(see `modify-frame-parameters'). */);
27446 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27447 doc
: /* Template for displaying the title bar of an iconified frame.
27448 \(Assuming the window manager supports this feature.)
27449 This variable has the same structure as `mode-line-format' (which see),
27450 and is used only on frames for which no explicit name has been set
27451 \(see `modify-frame-parameters'). */);
27453 = Vframe_title_format
27454 = pure_cons (intern_c_string ("multiple-frames"),
27455 pure_cons (make_pure_c_string ("%b"),
27456 pure_cons (pure_cons (empty_unibyte_string
,
27457 pure_cons (intern_c_string ("invocation-name"),
27458 pure_cons (make_pure_c_string ("@"),
27459 pure_cons (intern_c_string ("system-name"),
27463 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27464 doc
: /* Maximum number of lines to keep in the message log buffer.
27465 If nil, disable message logging. If t, log messages but don't truncate
27466 the buffer when it becomes large. */);
27467 Vmessage_log_max
= make_number (100);
27469 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27470 doc
: /* Functions called before redisplay, if window sizes have changed.
27471 The value should be a list of functions that take one argument.
27472 Just before redisplay, for each frame, if any of its windows have changed
27473 size since the last redisplay, or have been split or deleted,
27474 all the functions in the list are called, with the frame as argument. */);
27475 Vwindow_size_change_functions
= Qnil
;
27477 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27478 doc
: /* List of functions to call before redisplaying a window with scrolling.
27479 Each function is called with two arguments, the window and its new
27480 display-start position. Note that these functions are also called by
27481 `set-window-buffer'. Also note that the value of `window-end' is not
27482 valid when these functions are called. */);
27483 Vwindow_scroll_functions
= Qnil
;
27485 DEFVAR_LISP ("window-text-change-functions",
27486 Vwindow_text_change_functions
,
27487 doc
: /* Functions to call in redisplay when text in the window might change. */);
27488 Vwindow_text_change_functions
= Qnil
;
27490 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27491 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27492 Each function is called with two arguments, the window and the end trigger value.
27493 See `set-window-redisplay-end-trigger'. */);
27494 Vredisplay_end_trigger_functions
= Qnil
;
27496 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27497 doc
: /* *Non-nil means autoselect window with mouse pointer.
27498 If nil, do not autoselect windows.
27499 A positive number means delay autoselection by that many seconds: a
27500 window is autoselected only after the mouse has remained in that
27501 window for the duration of the delay.
27502 A negative number has a similar effect, but causes windows to be
27503 autoselected only after the mouse has stopped moving. \(Because of
27504 the way Emacs compares mouse events, you will occasionally wait twice
27505 that time before the window gets selected.\)
27506 Any other value means to autoselect window instantaneously when the
27507 mouse pointer enters it.
27509 Autoselection selects the minibuffer only if it is active, and never
27510 unselects the minibuffer if it is active.
27512 When customizing this variable make sure that the actual value of
27513 `focus-follows-mouse' matches the behavior of your window manager. */);
27514 Vmouse_autoselect_window
= Qnil
;
27516 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27517 doc
: /* *Non-nil means automatically resize tool-bars.
27518 This dynamically changes the tool-bar's height to the minimum height
27519 that is needed to make all tool-bar items visible.
27520 If value is `grow-only', the tool-bar's height is only increased
27521 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27522 Vauto_resize_tool_bars
= Qt
;
27524 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27525 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27526 auto_raise_tool_bar_buttons_p
= 1;
27528 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27529 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27530 make_cursor_line_fully_visible_p
= 1;
27532 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27533 doc
: /* *Border below tool-bar in pixels.
27534 If an integer, use it as the height of the border.
27535 If it is one of `internal-border-width' or `border-width', use the
27536 value of the corresponding frame parameter.
27537 Otherwise, no border is added below the tool-bar. */);
27538 Vtool_bar_border
= Qinternal_border_width
;
27540 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27541 doc
: /* *Margin around tool-bar buttons in pixels.
27542 If an integer, use that for both horizontal and vertical margins.
27543 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27544 HORZ specifying the horizontal margin, and VERT specifying the
27545 vertical margin. */);
27546 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27548 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27549 doc
: /* *Relief thickness of tool-bar buttons. */);
27550 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27552 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27553 doc
: /* Tool bar style to use.
27555 image - show images only
27556 text - show text only
27557 both - show both, text below image
27558 both-horiz - show text to the right of the image
27559 text-image-horiz - show text to the left of the image
27560 any other - use system default or image if no system default. */);
27561 Vtool_bar_style
= Qnil
;
27563 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27564 doc
: /* *Maximum number of characters a label can have to be shown.
27565 The tool bar style must also show labels for this to have any effect, see
27566 `tool-bar-style'. */);
27567 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27569 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27570 doc
: /* List of functions to call to fontify regions of text.
27571 Each function is called with one argument POS. Functions must
27572 fontify a region starting at POS in the current buffer, and give
27573 fontified regions the property `fontified'. */);
27574 Vfontification_functions
= Qnil
;
27575 Fmake_variable_buffer_local (Qfontification_functions
);
27577 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27578 unibyte_display_via_language_environment
,
27579 doc
: /* *Non-nil means display unibyte text according to language environment.
27580 Specifically, this means that raw bytes in the range 160-255 decimal
27581 are displayed by converting them to the equivalent multibyte characters
27582 according to the current language environment. As a result, they are
27583 displayed according to the current fontset.
27585 Note that this variable affects only how these bytes are displayed,
27586 but does not change the fact they are interpreted as raw bytes. */);
27587 unibyte_display_via_language_environment
= 0;
27589 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27590 doc
: /* *Maximum height for resizing mini-windows.
27591 If a float, it specifies a fraction of the mini-window frame's height.
27592 If an integer, it specifies a number of lines. */);
27593 Vmax_mini_window_height
= make_float (0.25);
27595 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27596 doc
: /* *How to resize mini-windows.
27597 A value of nil means don't automatically resize mini-windows.
27598 A value of t means resize them to fit the text displayed in them.
27599 A value of `grow-only', the default, means let mini-windows grow
27600 only, until their display becomes empty, at which point the windows
27601 go back to their normal size. */);
27602 Vresize_mini_windows
= Qgrow_only
;
27604 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27605 doc
: /* Alist specifying how to blink the cursor off.
27606 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27607 `cursor-type' frame-parameter or variable equals ON-STATE,
27608 comparing using `equal', Emacs uses OFF-STATE to specify
27609 how to blink it off. ON-STATE and OFF-STATE are values for
27610 the `cursor-type' frame parameter.
27612 If a frame's ON-STATE has no entry in this list,
27613 the frame's other specifications determine how to blink the cursor off. */);
27614 Vblink_cursor_alist
= Qnil
;
27616 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27617 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27618 If non-nil, windows are automatically scrolled horizontally to make
27619 point visible. */);
27620 automatic_hscrolling_p
= 1;
27621 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
27622 staticpro (&Qauto_hscroll_mode
);
27624 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27625 doc
: /* *How many columns away from the window edge point is allowed to get
27626 before automatic hscrolling will horizontally scroll the window. */);
27627 hscroll_margin
= 5;
27629 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27630 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27631 When point is less than `hscroll-margin' columns from the window
27632 edge, automatic hscrolling will scroll the window by the amount of columns
27633 determined by this variable. If its value is a positive integer, scroll that
27634 many columns. If it's a positive floating-point number, it specifies the
27635 fraction of the window's width to scroll. If it's nil or zero, point will be
27636 centered horizontally after the scroll. Any other value, including negative
27637 numbers, are treated as if the value were zero.
27639 Automatic hscrolling always moves point outside the scroll margin, so if
27640 point was more than scroll step columns inside the margin, the window will
27641 scroll more than the value given by the scroll step.
27643 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27644 and `scroll-right' overrides this variable's effect. */);
27645 Vhscroll_step
= make_number (0);
27647 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27648 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27649 Bind this around calls to `message' to let it take effect. */);
27650 message_truncate_lines
= 0;
27652 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27653 doc
: /* Normal hook run to update the menu bar definitions.
27654 Redisplay runs this hook before it redisplays the menu bar.
27655 This is used to update submenus such as Buffers,
27656 whose contents depend on various data. */);
27657 Vmenu_bar_update_hook
= Qnil
;
27659 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27660 doc
: /* Frame for which we are updating a menu.
27661 The enable predicate for a menu binding should check this variable. */);
27662 Vmenu_updating_frame
= Qnil
;
27664 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27665 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27666 inhibit_menubar_update
= 0;
27668 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27669 doc
: /* Prefix prepended to all continuation lines at display time.
27670 The value may be a string, an image, or a stretch-glyph; it is
27671 interpreted in the same way as the value of a `display' text property.
27673 This variable is overridden by any `wrap-prefix' text or overlay
27676 To add a prefix to non-continuation lines, use `line-prefix'. */);
27677 Vwrap_prefix
= Qnil
;
27678 staticpro (&Qwrap_prefix
);
27679 Qwrap_prefix
= intern_c_string ("wrap-prefix");
27680 Fmake_variable_buffer_local (Qwrap_prefix
);
27682 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27683 doc
: /* Prefix prepended to all non-continuation lines at display time.
27684 The value may be a string, an image, or a stretch-glyph; it is
27685 interpreted in the same way as the value of a `display' text property.
27687 This variable is overridden by any `line-prefix' text or overlay
27690 To add a prefix to continuation lines, use `wrap-prefix'. */);
27691 Vline_prefix
= Qnil
;
27692 staticpro (&Qline_prefix
);
27693 Qline_prefix
= intern_c_string ("line-prefix");
27694 Fmake_variable_buffer_local (Qline_prefix
);
27696 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27697 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27698 inhibit_eval_during_redisplay
= 0;
27700 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27701 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27702 inhibit_free_realized_faces
= 0;
27705 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27706 doc
: /* Inhibit try_window_id display optimization. */);
27707 inhibit_try_window_id
= 0;
27709 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27710 doc
: /* Inhibit try_window_reusing display optimization. */);
27711 inhibit_try_window_reusing
= 0;
27713 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27714 doc
: /* Inhibit try_cursor_movement display optimization. */);
27715 inhibit_try_cursor_movement
= 0;
27716 #endif /* GLYPH_DEBUG */
27718 DEFVAR_INT ("overline-margin", overline_margin
,
27719 doc
: /* *Space between overline and text, in pixels.
27720 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27721 margin to the caracter height. */);
27722 overline_margin
= 2;
27724 DEFVAR_INT ("underline-minimum-offset",
27725 underline_minimum_offset
,
27726 doc
: /* Minimum distance between baseline and underline.
27727 This can improve legibility of underlined text at small font sizes,
27728 particularly when using variable `x-use-underline-position-properties'
27729 with fonts that specify an UNDERLINE_POSITION relatively close to the
27730 baseline. The default value is 1. */);
27731 underline_minimum_offset
= 1;
27733 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27734 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27735 This feature only works when on a window system that can change
27736 cursor shapes. */);
27737 display_hourglass_p
= 1;
27739 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27740 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27741 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27743 hourglass_atimer
= NULL
;
27744 hourglass_shown_p
= 0;
27746 DEFSYM (Qglyphless_char
, "glyphless-char");
27747 DEFSYM (Qhex_code
, "hex-code");
27748 DEFSYM (Qempty_box
, "empty-box");
27749 DEFSYM (Qthin_space
, "thin-space");
27750 DEFSYM (Qzero_width
, "zero-width");
27752 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27753 /* Intern this now in case it isn't already done.
27754 Setting this variable twice is harmless.
27755 But don't staticpro it here--that is done in alloc.c. */
27756 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27757 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27759 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27760 doc
: /* Char-table defining glyphless characters.
27761 Each element, if non-nil, should be one of the following:
27762 an ASCII acronym string: display this string in a box
27763 `hex-code': display the hexadecimal code of a character in a box
27764 `empty-box': display as an empty box
27765 `thin-space': display as 1-pixel width space
27766 `zero-width': don't display
27767 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27768 display method for graphical terminals and text terminals respectively.
27769 GRAPHICAL and TEXT should each have one of the values listed above.
27771 The char-table has one extra slot to control the display of a character for
27772 which no font is found. This slot only takes effect on graphical terminals.
27773 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27774 `thin-space'. The default is `empty-box'. */);
27775 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27776 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27781 /* Initialize this module when Emacs starts. */
27786 Lisp_Object root_window
;
27787 struct window
*mini_w
;
27789 current_header_line_height
= current_mode_line_height
= -1;
27791 CHARPOS (this_line_start_pos
) = 0;
27793 mini_w
= XWINDOW (minibuf_window
);
27794 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27795 echo_area_window
= minibuf_window
;
27797 if (!noninteractive
)
27799 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27802 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27803 set_window_height (root_window
,
27804 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27806 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27807 set_window_height (minibuf_window
, 1, 0);
27809 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27810 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27812 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27813 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27814 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27816 /* The default ellipsis glyphs `...'. */
27817 for (i
= 0; i
< 3; ++i
)
27818 default_invis_vector
[i
] = make_number ('.');
27822 /* Allocate the buffer for frame titles.
27823 Also used for `format-mode-line'. */
27825 mode_line_noprop_buf
= (char *) xmalloc (size
);
27826 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27827 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27828 mode_line_target
= MODE_LINE_DISPLAY
;
27831 help_echo_showing_p
= 0;
27834 /* Since w32 does not support atimers, it defines its own implementation of
27835 the following three functions in w32fns.c. */
27838 /* Platform-independent portion of hourglass implementation. */
27840 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27842 hourglass_started (void)
27844 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27847 /* Cancel a currently active hourglass timer, and start a new one. */
27849 start_hourglass (void)
27851 #if defined (HAVE_WINDOW_SYSTEM)
27853 int secs
, usecs
= 0;
27855 cancel_hourglass ();
27857 if (INTEGERP (Vhourglass_delay
)
27858 && XINT (Vhourglass_delay
) > 0)
27859 secs
= XFASTINT (Vhourglass_delay
);
27860 else if (FLOATP (Vhourglass_delay
)
27861 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27864 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27865 secs
= XFASTINT (tem
);
27866 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27869 secs
= DEFAULT_HOURGLASS_DELAY
;
27871 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27872 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27873 show_hourglass
, NULL
);
27878 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27881 cancel_hourglass (void)
27883 #if defined (HAVE_WINDOW_SYSTEM)
27884 if (hourglass_atimer
)
27886 cancel_atimer (hourglass_atimer
);
27887 hourglass_atimer
= NULL
;
27890 if (hourglass_shown_p
)
27894 #endif /* ! WINDOWSNT */