1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
319 #ifndef FRAME_X_OUTPUT
320 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #define INFINITY 10000000
325 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
326 Lisp_Object Qwindow_scroll_functions
;
327 static Lisp_Object Qwindow_text_change_functions
;
328 static Lisp_Object Qredisplay_end_trigger_functions
;
329 Lisp_Object Qinhibit_point_motion_hooks
;
330 static Lisp_Object QCeval
, QCpropertize
;
331 Lisp_Object QCfile
, QCdata
;
332 static Lisp_Object Qfontified
;
333 static Lisp_Object Qgrow_only
;
334 static Lisp_Object Qinhibit_eval_during_redisplay
;
335 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
336 static Lisp_Object Qright_to_left
, Qleft_to_right
;
339 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
342 static Lisp_Object Qarrow
, Qhand
;
345 /* Holds the list (error). */
346 static Lisp_Object list_of_error
;
348 static Lisp_Object Qfontification_functions
;
350 static Lisp_Object Qwrap_prefix
;
351 static Lisp_Object Qline_prefix
;
353 /* Non-nil means don't actually do any redisplay. */
355 Lisp_Object Qinhibit_redisplay
;
357 /* Names of text properties relevant for redisplay. */
359 Lisp_Object Qdisplay
;
361 Lisp_Object Qspace
, QCalign_to
;
362 static Lisp_Object QCrelative_width
, QCrelative_height
;
363 Lisp_Object Qleft_margin
, Qright_margin
;
364 static Lisp_Object Qspace_width
, Qraise
;
365 static Lisp_Object Qslice
;
367 static Lisp_Object Qmargin
, Qpointer
;
368 static Lisp_Object Qline_height
;
370 #ifdef HAVE_WINDOW_SYSTEM
372 /* Test if overflow newline into fringe. Called with iterator IT
373 at or past right window margin, and with IT->current_x set. */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
376 (!NILP (Voverflow_newline_into_fringe) \
377 && FRAME_WINDOW_P ((IT)->f) \
378 && ((IT)->bidi_it.paragraph_dir == R2L \
379 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
380 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
381 && (IT)->current_x == (IT)->last_visible_x \
382 && (IT)->line_wrap != WORD_WRAP)
384 #else /* !HAVE_WINDOW_SYSTEM */
385 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
386 #endif /* HAVE_WINDOW_SYSTEM */
388 /* Test if the display element loaded in IT is a space or tab
389 character. This is used to determine word wrapping. */
391 #define IT_DISPLAYING_WHITESPACE(it) \
392 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
394 /* Name of the face used to highlight trailing whitespace. */
396 static Lisp_Object Qtrailing_whitespace
;
398 /* Name and number of the face used to highlight escape glyphs. */
400 static Lisp_Object Qescape_glyph
;
402 /* Name and number of the face used to highlight non-breaking spaces. */
404 static Lisp_Object Qnobreak_space
;
406 /* The symbol `image' which is the car of the lists used to represent
407 images in Lisp. Also a tool bar style. */
411 /* The image map types. */
413 static Lisp_Object QCpointer
;
414 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
416 /* Tool bar styles */
417 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
419 /* Non-zero means print newline to stdout before next mini-buffer
422 int noninteractive_need_newline
;
424 /* Non-zero means print newline to message log before next message. */
426 static int message_log_need_newline
;
428 /* Three markers that message_dolog uses.
429 It could allocate them itself, but that causes trouble
430 in handling memory-full errors. */
431 static Lisp_Object message_dolog_marker1
;
432 static Lisp_Object message_dolog_marker2
;
433 static Lisp_Object message_dolog_marker3
;
435 /* The buffer position of the first character appearing entirely or
436 partially on the line of the selected window which contains the
437 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
438 redisplay optimization in redisplay_internal. */
440 static struct text_pos this_line_start_pos
;
442 /* Number of characters past the end of the line above, including the
443 terminating newline. */
445 static struct text_pos this_line_end_pos
;
447 /* The vertical positions and the height of this line. */
449 static int this_line_vpos
;
450 static int this_line_y
;
451 static int this_line_pixel_height
;
453 /* X position at which this display line starts. Usually zero;
454 negative if first character is partially visible. */
456 static int this_line_start_x
;
458 /* The smallest character position seen by move_it_* functions as they
459 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
460 hscrolled lines, see display_line. */
462 static struct text_pos this_line_min_pos
;
464 /* Buffer that this_line_.* variables are referring to. */
466 static struct buffer
*this_line_buffer
;
469 /* Values of those variables at last redisplay are stored as
470 properties on `overlay-arrow-position' symbol. However, if
471 Voverlay_arrow_position is a marker, last-arrow-position is its
472 numerical position. */
474 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
476 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
477 properties on a symbol in overlay-arrow-variable-list. */
479 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
481 Lisp_Object Qmenu_bar_update_hook
;
483 /* Nonzero if an overlay arrow has been displayed in this window. */
485 static int overlay_arrow_seen
;
487 /* Number of windows showing the buffer of the selected window (or
488 another buffer with the same base buffer). keyboard.c refers to
493 /* Vector containing glyphs for an ellipsis `...'. */
495 static Lisp_Object default_invis_vector
[3];
497 /* This is the window where the echo area message was displayed. It
498 is always a mini-buffer window, but it may not be the same window
499 currently active as a mini-buffer. */
501 Lisp_Object echo_area_window
;
503 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
504 pushes the current message and the value of
505 message_enable_multibyte on the stack, the function restore_message
506 pops the stack and displays MESSAGE again. */
508 static Lisp_Object Vmessage_stack
;
510 /* Nonzero means multibyte characters were enabled when the echo area
511 message was specified. */
513 static int message_enable_multibyte
;
515 /* Nonzero if we should redraw the mode lines on the next redisplay. */
517 int update_mode_lines
;
519 /* Nonzero if window sizes or contents have changed since last
520 redisplay that finished. */
522 int windows_or_buffers_changed
;
524 /* Nonzero means a frame's cursor type has been changed. */
526 int cursor_type_changed
;
528 /* Nonzero after display_mode_line if %l was used and it displayed a
531 static int line_number_displayed
;
533 /* The name of the *Messages* buffer, a string. */
535 static Lisp_Object Vmessages_buffer_name
;
537 /* Current, index 0, and last displayed echo area message. Either
538 buffers from echo_buffers, or nil to indicate no message. */
540 Lisp_Object echo_area_buffer
[2];
542 /* The buffers referenced from echo_area_buffer. */
544 static Lisp_Object echo_buffer
[2];
546 /* A vector saved used in with_area_buffer to reduce consing. */
548 static Lisp_Object Vwith_echo_area_save_vector
;
550 /* Non-zero means display_echo_area should display the last echo area
551 message again. Set by redisplay_preserve_echo_area. */
553 static int display_last_displayed_message_p
;
555 /* Nonzero if echo area is being used by print; zero if being used by
558 static int message_buf_print
;
560 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
562 static Lisp_Object Qinhibit_menubar_update
;
563 static Lisp_Object Qmessage_truncate_lines
;
565 /* Set to 1 in clear_message to make redisplay_internal aware
566 of an emptied echo area. */
568 static int message_cleared_p
;
570 /* A scratch glyph row with contents used for generating truncation
571 glyphs. Also used in direct_output_for_insert. */
573 #define MAX_SCRATCH_GLYPHS 100
574 static struct glyph_row scratch_glyph_row
;
575 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
577 /* Ascent and height of the last line processed by move_it_to. */
579 static int last_max_ascent
, last_height
;
581 /* Non-zero if there's a help-echo in the echo area. */
583 int help_echo_showing_p
;
585 /* If >= 0, computed, exact values of mode-line and header-line height
586 to use in the macros CURRENT_MODE_LINE_HEIGHT and
587 CURRENT_HEADER_LINE_HEIGHT. */
589 int current_mode_line_height
, current_header_line_height
;
591 /* The maximum distance to look ahead for text properties. Values
592 that are too small let us call compute_char_face and similar
593 functions too often which is expensive. Values that are too large
594 let us call compute_char_face and alike too often because we
595 might not be interested in text properties that far away. */
597 #define TEXT_PROP_DISTANCE_LIMIT 100
599 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
600 iterator state and later restore it. This is needed because the
601 bidi iterator on bidi.c keeps a stacked cache of its states, which
602 is really a singleton. When we use scratch iterator objects to
603 move around the buffer, we can cause the bidi cache to be pushed or
604 popped, and therefore we need to restore the cache state when we
605 return to the original iterator. */
606 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
609 bidi_unshelve_cache (CACHE, 1); \
611 CACHE = bidi_shelve_cache (); \
614 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
616 if (pITORIG != pITCOPY) \
617 *(pITORIG) = *(pITCOPY); \
618 bidi_unshelve_cache (CACHE, 0); \
624 /* Non-zero means print traces of redisplay if compiled with
627 int trace_redisplay_p
;
629 #endif /* GLYPH_DEBUG */
631 #ifdef DEBUG_TRACE_MOVE
632 /* Non-zero means trace with TRACE_MOVE to stderr. */
635 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
637 #define TRACE_MOVE(x) (void) 0
640 static Lisp_Object Qauto_hscroll_mode
;
642 /* Buffer being redisplayed -- for redisplay_window_error. */
644 static struct buffer
*displayed_buffer
;
646 /* Value returned from text property handlers (see below). */
651 HANDLED_RECOMPUTE_PROPS
,
652 HANDLED_OVERLAY_STRING_CONSUMED
,
656 /* A description of text properties that redisplay is interested
661 /* The name of the property. */
664 /* A unique index for the property. */
667 /* A handler function called to set up iterator IT from the property
668 at IT's current position. Value is used to steer handle_stop. */
669 enum prop_handled (*handler
) (struct it
*it
);
672 static enum prop_handled
handle_face_prop (struct it
*);
673 static enum prop_handled
handle_invisible_prop (struct it
*);
674 static enum prop_handled
handle_display_prop (struct it
*);
675 static enum prop_handled
handle_composition_prop (struct it
*);
676 static enum prop_handled
handle_overlay_change (struct it
*);
677 static enum prop_handled
handle_fontified_prop (struct it
*);
679 /* Properties handled by iterators. */
681 static struct props it_props
[] =
683 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
684 /* Handle `face' before `display' because some sub-properties of
685 `display' need to know the face. */
686 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
687 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
688 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
689 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
693 /* Value is the position described by X. If X is a marker, value is
694 the marker_position of X. Otherwise, value is X. */
696 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
698 /* Enumeration returned by some move_it_.* functions internally. */
702 /* Not used. Undefined value. */
705 /* Move ended at the requested buffer position or ZV. */
706 MOVE_POS_MATCH_OR_ZV
,
708 /* Move ended at the requested X pixel position. */
711 /* Move within a line ended at the end of a line that must be
715 /* Move within a line ended at the end of a line that would
716 be displayed truncated. */
719 /* Move within a line ended at a line end. */
723 /* This counter is used to clear the face cache every once in a while
724 in redisplay_internal. It is incremented for each redisplay.
725 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
728 #define CLEAR_FACE_CACHE_COUNT 500
729 static int clear_face_cache_count
;
731 /* Similarly for the image cache. */
733 #ifdef HAVE_WINDOW_SYSTEM
734 #define CLEAR_IMAGE_CACHE_COUNT 101
735 static int clear_image_cache_count
;
737 /* Null glyph slice */
738 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
741 /* Non-zero while redisplay_internal is in progress. */
745 static Lisp_Object Qinhibit_free_realized_faces
;
747 /* If a string, XTread_socket generates an event to display that string.
748 (The display is done in read_char.) */
750 Lisp_Object help_echo_string
;
751 Lisp_Object help_echo_window
;
752 Lisp_Object help_echo_object
;
753 EMACS_INT help_echo_pos
;
755 /* Temporary variable for XTread_socket. */
757 Lisp_Object previous_help_echo_string
;
759 /* Platform-independent portion of hourglass implementation. */
761 /* Non-zero means an hourglass cursor is currently shown. */
762 int hourglass_shown_p
;
764 /* If non-null, an asynchronous timer that, when it expires, displays
765 an hourglass cursor on all frames. */
766 struct atimer
*hourglass_atimer
;
768 /* Name of the face used to display glyphless characters. */
769 Lisp_Object Qglyphless_char
;
771 /* Symbol for the purpose of Vglyphless_char_display. */
772 static Lisp_Object Qglyphless_char_display
;
774 /* Method symbols for Vglyphless_char_display. */
775 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
777 /* Default pixel width of `thin-space' display method. */
778 #define THIN_SPACE_WIDTH 1
780 /* Default number of seconds to wait before displaying an hourglass
782 #define DEFAULT_HOURGLASS_DELAY 1
785 /* Function prototypes. */
787 static void setup_for_ellipsis (struct it
*, int);
788 static void set_iterator_to_next (struct it
*, int);
789 static void mark_window_display_accurate_1 (struct window
*, int);
790 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
791 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
792 static int cursor_row_p (struct glyph_row
*);
793 static int redisplay_mode_lines (Lisp_Object
, int);
794 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
796 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
798 static void handle_line_prefix (struct it
*);
800 static void pint2str (char *, int, EMACS_INT
);
801 static void pint2hrstr (char *, int, EMACS_INT
);
802 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
804 static void reconsider_clip_changes (struct window
*, struct buffer
*);
805 static int text_outside_line_unchanged_p (struct window
*,
806 EMACS_INT
, EMACS_INT
);
807 static void store_mode_line_noprop_char (char);
808 static int store_mode_line_noprop (const char *, int, int);
809 static void handle_stop (struct it
*);
810 static void handle_stop_backwards (struct it
*, EMACS_INT
);
811 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
812 static void ensure_echo_area_buffers (void);
813 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
814 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
815 static int with_echo_area_buffer (struct window
*, int,
816 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
817 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void clear_garbaged_frames (void);
819 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void pop_message (void);
821 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
823 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int display_echo_area (struct window
*);
825 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
826 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
827 static Lisp_Object
unwind_redisplay (Lisp_Object
);
828 static int string_char_and_length (const unsigned char *, int *);
829 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
831 static int compute_window_start_on_continuation_line (struct window
*);
832 static Lisp_Object
safe_eval_handler (Lisp_Object
);
833 static void insert_left_trunc_glyphs (struct it
*);
834 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
836 static void extend_face_to_end_of_line (struct it
*);
837 static int append_space_for_newline (struct it
*, int);
838 static int cursor_row_fully_visible_p (struct window
*, int, int);
839 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
840 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
841 static int trailing_whitespace_p (EMACS_INT
);
842 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
843 static void push_it (struct it
*, struct text_pos
*);
844 static void pop_it (struct it
*);
845 static void sync_frame_with_window_matrix_rows (struct window
*);
846 static void select_frame_for_redisplay (Lisp_Object
);
847 static void redisplay_internal (void);
848 static int echo_area_display (int);
849 static void redisplay_windows (Lisp_Object
);
850 static void redisplay_window (Lisp_Object
, int);
851 static Lisp_Object
redisplay_window_error (Lisp_Object
);
852 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
853 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
854 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
855 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
857 static int update_menu_bar (struct frame
*, int, int);
858 static int try_window_reusing_current_matrix (struct window
*);
859 static int try_window_id (struct window
*);
860 static int display_line (struct it
*);
861 static int display_mode_lines (struct window
*);
862 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
863 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
864 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
865 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
866 static void display_menu_bar (struct window
*);
867 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
869 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
870 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
871 static void compute_line_metrics (struct it
*);
872 static void run_redisplay_end_trigger_hook (struct it
*);
873 static int get_overlay_strings (struct it
*, EMACS_INT
);
874 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
875 static void next_overlay_string (struct it
*);
876 static void reseat (struct it
*, struct text_pos
, int);
877 static void reseat_1 (struct it
*, struct text_pos
, int);
878 static void back_to_previous_visible_line_start (struct it
*);
879 void reseat_at_previous_visible_line_start (struct it
*);
880 static void reseat_at_next_visible_line_start (struct it
*, int);
881 static int next_element_from_ellipsis (struct it
*);
882 static int next_element_from_display_vector (struct it
*);
883 static int next_element_from_string (struct it
*);
884 static int next_element_from_c_string (struct it
*);
885 static int next_element_from_buffer (struct it
*);
886 static int next_element_from_composition (struct it
*);
887 static int next_element_from_image (struct it
*);
889 static int next_element_from_xwidget(struct it
*);
891 static int next_element_from_stretch (struct it
*);
892 static void load_overlay_strings (struct it
*, EMACS_INT
);
893 static int init_from_display_pos (struct it
*, struct window
*,
894 struct display_pos
*);
895 static void reseat_to_string (struct it
*, const char *,
896 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
897 static int get_next_display_element (struct it
*);
898 static enum move_it_result
899 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
900 enum move_operation_enum
);
901 void move_it_vertically_backward (struct it
*, int);
902 static void init_to_row_start (struct it
*, struct window
*,
904 static int init_to_row_end (struct it
*, struct window
*,
906 static void back_to_previous_line_start (struct it
*);
907 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
908 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
909 Lisp_Object
, EMACS_INT
);
910 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
911 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
912 static EMACS_INT
number_of_chars (const char *, int);
913 static void compute_stop_pos (struct it
*);
914 static void compute_string_pos (struct text_pos
*, struct text_pos
,
916 static int face_before_or_after_it_pos (struct it
*, int);
917 static EMACS_INT
next_overlay_change (EMACS_INT
);
918 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
919 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
920 static int handle_single_display_spec (struct it
*, Lisp_Object
,
921 Lisp_Object
, Lisp_Object
,
922 struct text_pos
*, EMACS_INT
, int, int);
923 static int underlying_face_id (struct it
*);
924 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
927 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
928 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
930 #ifdef HAVE_WINDOW_SYSTEM
932 static void x_consider_frame_title (Lisp_Object
);
933 static int tool_bar_lines_needed (struct frame
*, int *);
934 static void update_tool_bar (struct frame
*, int);
935 static void build_desired_tool_bar_string (struct frame
*f
);
936 static int redisplay_tool_bar (struct frame
*);
937 static void display_tool_bar_line (struct it
*, int);
938 static void notice_overwritten_cursor (struct window
*,
941 static void append_stretch_glyph (struct it
*, Lisp_Object
,
945 #endif /* HAVE_WINDOW_SYSTEM */
947 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
948 static int coords_in_mouse_face_p (struct window
*, int, int);
952 /***********************************************************************
953 Window display dimensions
954 ***********************************************************************/
956 /* Return the bottom boundary y-position for text lines in window W.
957 This is the first y position at which a line cannot start.
958 It is relative to the top of the window.
960 This is the height of W minus the height of a mode line, if any. */
963 window_text_bottom_y (struct window
*w
)
965 int height
= WINDOW_TOTAL_HEIGHT (w
);
967 if (WINDOW_WANTS_MODELINE_P (w
))
968 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
972 /* Return the pixel width of display area AREA of window W. AREA < 0
973 means return the total width of W, not including fringes to
974 the left and right of the window. */
977 window_box_width (struct window
*w
, int area
)
979 int cols
= XFASTINT (w
->total_cols
);
982 if (!w
->pseudo_window_p
)
984 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
986 if (area
== TEXT_AREA
)
988 if (INTEGERP (w
->left_margin_cols
))
989 cols
-= XFASTINT (w
->left_margin_cols
);
990 if (INTEGERP (w
->right_margin_cols
))
991 cols
-= XFASTINT (w
->right_margin_cols
);
992 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
994 else if (area
== LEFT_MARGIN_AREA
)
996 cols
= (INTEGERP (w
->left_margin_cols
)
997 ? XFASTINT (w
->left_margin_cols
) : 0);
1000 else if (area
== RIGHT_MARGIN_AREA
)
1002 cols
= (INTEGERP (w
->right_margin_cols
)
1003 ? XFASTINT (w
->right_margin_cols
) : 0);
1008 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1012 /* Return the pixel height of the display area of window W, not
1013 including mode lines of W, if any. */
1016 window_box_height (struct window
*w
)
1018 struct frame
*f
= XFRAME (w
->frame
);
1019 int height
= WINDOW_TOTAL_HEIGHT (w
);
1021 xassert (height
>= 0);
1023 /* Note: the code below that determines the mode-line/header-line
1024 height is essentially the same as that contained in the macro
1025 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1026 the appropriate glyph row has its `mode_line_p' flag set,
1027 and if it doesn't, uses estimate_mode_line_height instead. */
1029 if (WINDOW_WANTS_MODELINE_P (w
))
1031 struct glyph_row
*ml_row
1032 = (w
->current_matrix
&& w
->current_matrix
->rows
1033 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1035 if (ml_row
&& ml_row
->mode_line_p
)
1036 height
-= ml_row
->height
;
1038 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1041 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1043 struct glyph_row
*hl_row
1044 = (w
->current_matrix
&& w
->current_matrix
->rows
1045 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1047 if (hl_row
&& hl_row
->mode_line_p
)
1048 height
-= hl_row
->height
;
1050 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1053 /* With a very small font and a mode-line that's taller than
1054 default, we might end up with a negative height. */
1055 return max (0, height
);
1058 /* Return the window-relative coordinate of the left edge of display
1059 area AREA of window W. AREA < 0 means return the left edge of the
1060 whole window, to the right of the left fringe of W. */
1063 window_box_left_offset (struct window
*w
, int area
)
1067 if (w
->pseudo_window_p
)
1070 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1072 if (area
== TEXT_AREA
)
1073 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1074 + window_box_width (w
, LEFT_MARGIN_AREA
));
1075 else if (area
== RIGHT_MARGIN_AREA
)
1076 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1077 + window_box_width (w
, LEFT_MARGIN_AREA
)
1078 + window_box_width (w
, TEXT_AREA
)
1079 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1081 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1082 else if (area
== LEFT_MARGIN_AREA
1083 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1084 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1090 /* Return the window-relative coordinate of the right edge of display
1091 area AREA of window W. AREA < 0 means return the right edge of the
1092 whole window, to the left of the right fringe of W. */
1095 window_box_right_offset (struct window
*w
, int area
)
1097 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1100 /* Return the frame-relative coordinate of the left edge of display
1101 area AREA of window W. AREA < 0 means return the left edge of the
1102 whole window, to the right of the left fringe of W. */
1105 window_box_left (struct window
*w
, int area
)
1107 struct frame
*f
= XFRAME (w
->frame
);
1110 if (w
->pseudo_window_p
)
1111 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1113 x
= (WINDOW_LEFT_EDGE_X (w
)
1114 + window_box_left_offset (w
, area
));
1120 /* Return the frame-relative coordinate of the right edge of display
1121 area AREA of window W. AREA < 0 means return the right edge of the
1122 whole window, to the left of the right fringe of W. */
1125 window_box_right (struct window
*w
, int area
)
1127 return window_box_left (w
, area
) + window_box_width (w
, area
);
1130 /* Get the bounding box of the display area AREA of window W, without
1131 mode lines, in frame-relative coordinates. AREA < 0 means the
1132 whole window, not including the left and right fringes of
1133 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1134 coordinates of the upper-left corner of the box. Return in
1135 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1138 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1139 int *box_width
, int *box_height
)
1142 *box_width
= window_box_width (w
, area
);
1144 *box_height
= window_box_height (w
);
1146 *box_x
= window_box_left (w
, area
);
1149 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1150 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1151 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1156 /* Get the bounding box of the display area AREA of window W, without
1157 mode lines. AREA < 0 means the whole window, not including the
1158 left and right fringe of the window. Return in *TOP_LEFT_X
1159 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1160 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1161 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1165 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1166 int *bottom_right_x
, int *bottom_right_y
)
1168 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1170 *bottom_right_x
+= *top_left_x
;
1171 *bottom_right_y
+= *top_left_y
;
1176 /***********************************************************************
1178 ***********************************************************************/
1180 /* Return the bottom y-position of the line the iterator IT is in.
1181 This can modify IT's settings. */
1184 line_bottom_y (struct it
*it
)
1186 int line_height
= it
->max_ascent
+ it
->max_descent
;
1187 int line_top_y
= it
->current_y
;
1189 if (line_height
== 0)
1192 line_height
= last_height
;
1193 else if (IT_CHARPOS (*it
) < ZV
)
1195 move_it_by_lines (it
, 1);
1196 line_height
= (it
->max_ascent
|| it
->max_descent
1197 ? it
->max_ascent
+ it
->max_descent
1202 struct glyph_row
*row
= it
->glyph_row
;
1204 /* Use the default character height. */
1205 it
->glyph_row
= NULL
;
1206 it
->what
= IT_CHARACTER
;
1209 PRODUCE_GLYPHS (it
);
1210 line_height
= it
->ascent
+ it
->descent
;
1211 it
->glyph_row
= row
;
1215 return line_top_y
+ line_height
;
1218 /* Subroutine of pos_visible_p below. Extracts a display string, if
1219 any, from the display spec given as its argument. */
1221 string_from_display_spec (Lisp_Object spec
)
1225 while (CONSP (spec
))
1227 if (STRINGP (XCAR (spec
)))
1232 else if (VECTORP (spec
))
1236 for (i
= 0; i
< ASIZE (spec
); i
++)
1238 if (STRINGP (AREF (spec
, i
)))
1239 return AREF (spec
, i
);
1247 /* Return 1 if position CHARPOS is visible in window W.
1248 CHARPOS < 0 means return info about WINDOW_END position.
1249 If visible, set *X and *Y to pixel coordinates of top left corner.
1250 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1251 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1254 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1255 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1258 void *itdata
= bidi_shelve_cache ();
1259 struct text_pos top
;
1261 struct buffer
*old_buffer
= NULL
;
1263 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1266 if (XBUFFER (w
->buffer
) != current_buffer
)
1268 old_buffer
= current_buffer
;
1269 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1272 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w
))
1276 current_mode_line_height
1277 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1278 BVAR (current_buffer
, mode_line_format
));
1280 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1281 current_header_line_height
1282 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1283 BVAR (current_buffer
, header_line_format
));
1285 start_display (&it
, w
, top
);
1286 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1287 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1290 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1291 && IT_CHARPOS (it
) >= charpos
)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1296 && IT_CHARPOS (it
) <= charpos
)))
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1304 int top_x
= it
.current_x
;
1305 int top_y
= it
.current_y
;
1306 enum it_method it_method
= it
.method
;
1307 /* Calling line_bottom_y may change it.method, it.position, etc. */
1308 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1309 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1311 if (top_y
< window_top_y
)
1312 visible_p
= bottom_y
> window_top_y
;
1313 else if (top_y
< it
.last_visible_y
)
1317 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1319 /* We stopped on the last glyph of a display vector.
1320 Try and recompute. Hack alert! */
1321 if (charpos
< 2 || top
.charpos
>= charpos
)
1322 top_x
= it
.glyph_row
->x
;
1326 start_display (&it2
, w
, top
);
1327 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1328 get_next_display_element (&it2
);
1329 PRODUCE_GLYPHS (&it2
);
1330 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1331 || it2
.current_x
> it2
.last_visible_x
)
1332 top_x
= it
.glyph_row
->x
;
1335 top_x
= it2
.current_x
;
1336 top_y
= it2
.current_y
;
1340 else if (IT_CHARPOS (it
) != charpos
)
1342 Lisp_Object cpos
= make_number (charpos
);
1343 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1344 Lisp_Object string
= string_from_display_spec (spec
);
1345 int newline_in_string
= 0;
1347 if (STRINGP (string
))
1349 const char *s
= SSDATA (string
);
1350 const char *e
= s
+ SBYTES (string
);
1355 newline_in_string
= 1;
1360 /* The tricky code below is needed because there's a
1361 discrepancy between move_it_to and how we set cursor
1362 when the display line ends in a newline from a
1363 display string. move_it_to will stop _after_ such
1364 display strings, whereas set_cursor_from_row
1365 conspires with cursor_row_p to place the cursor on
1366 the first glyph produced from the display string. */
1368 /* We have overshoot PT because it is covered by a
1369 display property whose value is a string. If the
1370 string includes embedded newlines, we are also in the
1371 wrong display line. Backtrack to the correct line,
1372 where the display string begins. */
1373 if (newline_in_string
)
1375 Lisp_Object startpos
, endpos
;
1376 EMACS_INT start
, end
;
1379 /* Find the first and the last buffer positions
1380 covered by the display string. */
1382 Fnext_single_char_property_change (cpos
, Qdisplay
,
1385 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1387 start
= XFASTINT (startpos
);
1388 end
= XFASTINT (endpos
);
1389 /* Move to the last buffer position before the
1390 display property. */
1391 start_display (&it3
, w
, top
);
1392 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1393 /* Move forward one more line if the position before
1394 the display string is a newline or if it is the
1395 rightmost character on a line that is
1396 continued or word-wrapped. */
1397 if (it3
.method
== GET_FROM_BUFFER
1399 move_it_by_lines (&it3
, 1);
1400 else if (move_it_in_display_line_to (&it3
, -1,
1404 == MOVE_LINE_CONTINUED
)
1406 move_it_by_lines (&it3
, 1);
1407 /* When we are under word-wrap, the #$@%!
1408 move_it_by_lines moves 2 lines, so we need to
1410 if (it3
.line_wrap
== WORD_WRAP
)
1411 move_it_by_lines (&it3
, -1);
1414 /* Record the vertical coordinate of the display
1415 line where we wound up. */
1416 top_y
= it3
.current_y
;
1419 /* When characters are reordered for display,
1420 the character displayed to the left of the
1421 display string could be _after_ the display
1422 property in the logical order. Use the
1423 smallest vertical position of these two. */
1424 start_display (&it3
, w
, top
);
1425 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1426 if (it3
.current_y
< top_y
)
1427 top_y
= it3
.current_y
;
1429 /* Move from the top of the window to the beginning
1430 of the display line where the display string
1432 start_display (&it3
, w
, top
);
1433 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1434 /* Finally, advance the iterator until we hit the
1435 first display element whose character position is
1436 CHARPOS, or until the first newline from the
1437 display string, which signals the end of the
1439 while (get_next_display_element (&it3
))
1441 PRODUCE_GLYPHS (&it3
);
1442 if (IT_CHARPOS (it3
) == charpos
1443 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1445 set_iterator_to_next (&it3
, 0);
1447 top_x
= it3
.current_x
- it3
.pixel_width
;
1448 /* Normally, we would exit the above loop because we
1449 found the display element whose character
1450 position is CHARPOS. For the contingency that we
1451 didn't, and stopped at the first newline from the
1452 display string, move back over the glyphs
1453 produced from the string, until we find the
1454 rightmost glyph not from the string. */
1455 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1457 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1458 + it3
.glyph_row
->used
[TEXT_AREA
];
1460 while (EQ ((g
- 1)->object
, string
))
1463 top_x
-= g
->pixel_width
;
1465 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1466 + it3
.glyph_row
->used
[TEXT_AREA
]);
1472 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1473 *rtop
= max (0, window_top_y
- top_y
);
1474 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1475 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1476 - max (top_y
, window_top_y
)));
1482 /* We were asked to provide info about WINDOW_END. */
1484 void *it2data
= NULL
;
1486 SAVE_IT (it2
, it
, it2data
);
1487 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1488 move_it_by_lines (&it
, 1);
1489 if (charpos
< IT_CHARPOS (it
)
1490 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1493 RESTORE_IT (&it2
, &it2
, it2data
);
1494 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1496 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1497 *rtop
= max (0, -it2
.current_y
);
1498 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1499 - it
.last_visible_y
));
1500 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1502 - max (it2
.current_y
,
1503 WINDOW_HEADER_LINE_HEIGHT (w
))));
1507 bidi_unshelve_cache (it2data
, 1);
1509 bidi_unshelve_cache (itdata
, 0);
1512 set_buffer_internal_1 (old_buffer
);
1514 current_header_line_height
= current_mode_line_height
= -1;
1516 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1517 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1520 /* Debugging code. */
1522 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1523 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1525 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1532 /* Return the next character from STR. Return in *LEN the length of
1533 the character. This is like STRING_CHAR_AND_LENGTH but never
1534 returns an invalid character. If we find one, we return a `?', but
1535 with the length of the invalid character. */
1538 string_char_and_length (const unsigned char *str
, int *len
)
1542 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1543 if (!CHAR_VALID_P (c
))
1544 /* We may not change the length here because other places in Emacs
1545 don't use this function, i.e. they silently accept invalid
1554 /* Given a position POS containing a valid character and byte position
1555 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1557 static struct text_pos
1558 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1560 xassert (STRINGP (string
) && nchars
>= 0);
1562 if (STRING_MULTIBYTE (string
))
1564 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1569 string_char_and_length (p
, &len
);
1572 BYTEPOS (pos
) += len
;
1576 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1582 /* Value is the text position, i.e. character and byte position,
1583 for character position CHARPOS in STRING. */
1585 static inline struct text_pos
1586 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1588 struct text_pos pos
;
1589 xassert (STRINGP (string
));
1590 xassert (charpos
>= 0);
1591 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1596 /* Value is a text position, i.e. character and byte position, for
1597 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1598 means recognize multibyte characters. */
1600 static struct text_pos
1601 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1603 struct text_pos pos
;
1605 xassert (s
!= NULL
);
1606 xassert (charpos
>= 0);
1612 SET_TEXT_POS (pos
, 0, 0);
1615 string_char_and_length ((const unsigned char *) s
, &len
);
1618 BYTEPOS (pos
) += len
;
1622 SET_TEXT_POS (pos
, charpos
, charpos
);
1628 /* Value is the number of characters in C string S. MULTIBYTE_P
1629 non-zero means recognize multibyte characters. */
1632 number_of_chars (const char *s
, int multibyte_p
)
1638 EMACS_INT rest
= strlen (s
);
1640 const unsigned char *p
= (const unsigned char *) s
;
1642 for (nchars
= 0; rest
> 0; ++nchars
)
1644 string_char_and_length (p
, &len
);
1645 rest
-= len
, p
+= len
;
1649 nchars
= strlen (s
);
1655 /* Compute byte position NEWPOS->bytepos corresponding to
1656 NEWPOS->charpos. POS is a known position in string STRING.
1657 NEWPOS->charpos must be >= POS.charpos. */
1660 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1662 xassert (STRINGP (string
));
1663 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1665 if (STRING_MULTIBYTE (string
))
1666 *newpos
= string_pos_nchars_ahead (pos
, string
,
1667 CHARPOS (*newpos
) - CHARPOS (pos
));
1669 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1673 Return an estimation of the pixel height of mode or header lines on
1674 frame F. FACE_ID specifies what line's height to estimate. */
1677 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1679 #ifdef HAVE_WINDOW_SYSTEM
1680 if (FRAME_WINDOW_P (f
))
1682 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1684 /* This function is called so early when Emacs starts that the face
1685 cache and mode line face are not yet initialized. */
1686 if (FRAME_FACE_CACHE (f
))
1688 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1692 height
= FONT_HEIGHT (face
->font
);
1693 if (face
->box_line_width
> 0)
1694 height
+= 2 * face
->box_line_width
;
1705 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1706 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1707 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1708 not force the value into range. */
1711 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1712 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1715 #ifdef HAVE_WINDOW_SYSTEM
1716 if (FRAME_WINDOW_P (f
))
1718 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1719 even for negative values. */
1721 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1723 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1725 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1726 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1729 STORE_NATIVE_RECT (*bounds
,
1730 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1731 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1732 FRAME_COLUMN_WIDTH (f
) - 1,
1733 FRAME_LINE_HEIGHT (f
) - 1);
1739 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1740 pix_x
= FRAME_TOTAL_COLS (f
);
1744 else if (pix_y
> FRAME_LINES (f
))
1745 pix_y
= FRAME_LINES (f
);
1755 /* Find the glyph under window-relative coordinates X/Y in window W.
1756 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1757 strings. Return in *HPOS and *VPOS the row and column number of
1758 the glyph found. Return in *AREA the glyph area containing X.
1759 Value is a pointer to the glyph found or null if X/Y is not on
1760 text, or we can't tell because W's current matrix is not up to
1765 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1766 int *dx
, int *dy
, int *area
)
1768 struct glyph
*glyph
, *end
;
1769 struct glyph_row
*row
= NULL
;
1772 /* Find row containing Y. Give up if some row is not enabled. */
1773 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1775 row
= MATRIX_ROW (w
->current_matrix
, i
);
1776 if (!row
->enabled_p
)
1778 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1785 /* Give up if Y is not in the window. */
1786 if (i
== w
->current_matrix
->nrows
)
1789 /* Get the glyph area containing X. */
1790 if (w
->pseudo_window_p
)
1797 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1799 *area
= LEFT_MARGIN_AREA
;
1800 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1802 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1805 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1809 *area
= RIGHT_MARGIN_AREA
;
1810 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1814 /* Find glyph containing X. */
1815 glyph
= row
->glyphs
[*area
];
1816 end
= glyph
+ row
->used
[*area
];
1818 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1820 x
-= glyph
->pixel_width
;
1830 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1833 *hpos
= glyph
- row
->glyphs
[*area
];
1837 /* Convert frame-relative x/y to coordinates relative to window W.
1838 Takes pseudo-windows into account. */
1841 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1843 if (w
->pseudo_window_p
)
1845 /* A pseudo-window is always full-width, and starts at the
1846 left edge of the frame, plus a frame border. */
1847 struct frame
*f
= XFRAME (w
->frame
);
1848 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 *x
-= WINDOW_LEFT_EDGE_X (w
);
1854 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1858 #ifdef HAVE_WINDOW_SYSTEM
1861 Return in RECTS[] at most N clipping rectangles for glyph string S.
1862 Return the number of stored rectangles. */
1865 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1872 if (s
->row
->full_width_p
)
1874 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1875 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1876 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1878 /* Unless displaying a mode or menu bar line, which are always
1879 fully visible, clip to the visible part of the row. */
1880 if (s
->w
->pseudo_window_p
)
1881 r
.height
= s
->row
->visible_height
;
1883 r
.height
= s
->height
;
1887 /* This is a text line that may be partially visible. */
1888 r
.x
= window_box_left (s
->w
, s
->area
);
1889 r
.width
= window_box_width (s
->w
, s
->area
);
1890 r
.height
= s
->row
->visible_height
;
1894 if (r
.x
< s
->clip_head
->x
)
1896 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1897 r
.width
-= s
->clip_head
->x
- r
.x
;
1900 r
.x
= s
->clip_head
->x
;
1903 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1905 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1906 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1911 /* If S draws overlapping rows, it's sufficient to use the top and
1912 bottom of the window for clipping because this glyph string
1913 intentionally draws over other lines. */
1914 if (s
->for_overlaps
)
1916 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1917 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1919 /* Alas, the above simple strategy does not work for the
1920 environments with anti-aliased text: if the same text is
1921 drawn onto the same place multiple times, it gets thicker.
1922 If the overlap we are processing is for the erased cursor, we
1923 take the intersection with the rectangle of the cursor. */
1924 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1926 XRectangle rc
, r_save
= r
;
1928 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1929 rc
.y
= s
->w
->phys_cursor
.y
;
1930 rc
.width
= s
->w
->phys_cursor_width
;
1931 rc
.height
= s
->w
->phys_cursor_height
;
1933 x_intersect_rectangles (&r_save
, &rc
, &r
);
1938 /* Don't use S->y for clipping because it doesn't take partially
1939 visible lines into account. For example, it can be negative for
1940 partially visible lines at the top of a window. */
1941 if (!s
->row
->full_width_p
1942 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1943 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1945 r
.y
= max (0, s
->row
->y
);
1948 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1950 /* If drawing the cursor, don't let glyph draw outside its
1951 advertised boundaries. Cleartype does this under some circumstances. */
1952 if (s
->hl
== DRAW_CURSOR
)
1954 struct glyph
*glyph
= s
->first_glyph
;
1959 r
.width
-= s
->x
- r
.x
;
1962 r
.width
= min (r
.width
, glyph
->pixel_width
);
1964 /* If r.y is below window bottom, ensure that we still see a cursor. */
1965 height
= min (glyph
->ascent
+ glyph
->descent
,
1966 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1967 max_y
= window_text_bottom_y (s
->w
) - height
;
1968 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1969 if (s
->ybase
- glyph
->ascent
> max_y
)
1976 /* Don't draw cursor glyph taller than our actual glyph. */
1977 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1978 if (height
< r
.height
)
1980 max_y
= r
.y
+ r
.height
;
1981 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1982 r
.height
= min (max_y
- r
.y
, height
);
1989 XRectangle r_save
= r
;
1991 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1995 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1996 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1998 #ifdef CONVERT_FROM_XRECT
1999 CONVERT_FROM_XRECT (r
, *rects
);
2007 /* If we are processing overlapping and allowed to return
2008 multiple clipping rectangles, we exclude the row of the glyph
2009 string from the clipping rectangle. This is to avoid drawing
2010 the same text on the environment with anti-aliasing. */
2011 #ifdef CONVERT_FROM_XRECT
2014 XRectangle
*rs
= rects
;
2016 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2018 if (s
->for_overlaps
& OVERLAPS_PRED
)
2021 if (r
.y
+ r
.height
> row_y
)
2024 rs
[i
].height
= row_y
- r
.y
;
2030 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2033 if (r
.y
< row_y
+ s
->row
->visible_height
)
2035 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2037 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2038 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2047 #ifdef CONVERT_FROM_XRECT
2048 for (i
= 0; i
< n
; i
++)
2049 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2056 Return in *NR the clipping rectangle for glyph string S. */
2059 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2061 get_glyph_string_clip_rects (s
, nr
, 1);
2066 Return the position and height of the phys cursor in window W.
2067 Set w->phys_cursor_width to width of phys cursor.
2071 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2072 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2074 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2075 int x
, y
, wd
, h
, h0
, y0
;
2077 /* Compute the width of the rectangle to draw. If on a stretch
2078 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2079 rectangle as wide as the glyph, but use a canonical character
2081 wd
= glyph
->pixel_width
- 1;
2082 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2086 x
= w
->phys_cursor
.x
;
2093 if (glyph
->type
== STRETCH_GLYPH
2094 && !x_stretch_cursor_p
)
2095 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2096 w
->phys_cursor_width
= wd
;
2098 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2100 /* If y is below window bottom, ensure that we still see a cursor. */
2101 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2103 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2104 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2106 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2109 h
= max (h
- (y0
- y
) + 1, h0
);
2114 y0
= window_text_bottom_y (w
) - h0
;
2122 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2123 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2128 * Remember which glyph the mouse is over.
2132 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2136 struct glyph_row
*r
, *gr
, *end_row
;
2137 enum window_part part
;
2138 enum glyph_row_area area
;
2139 int x
, y
, width
, height
;
2141 /* Try to determine frame pixel position and size of the glyph under
2142 frame pixel coordinates X/Y on frame F. */
2144 if (!f
->glyphs_initialized_p
2145 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2148 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2149 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2153 w
= XWINDOW (window
);
2154 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2155 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2157 x
= window_relative_x_coord (w
, part
, gx
);
2158 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2160 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2161 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2163 if (w
->pseudo_window_p
)
2166 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2172 case ON_LEFT_MARGIN
:
2173 area
= LEFT_MARGIN_AREA
;
2176 case ON_RIGHT_MARGIN
:
2177 area
= RIGHT_MARGIN_AREA
;
2180 case ON_HEADER_LINE
:
2182 gr
= (part
== ON_HEADER_LINE
2183 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2184 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2187 goto text_glyph_row_found
;
2194 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2195 if (r
->y
+ r
->height
> y
)
2201 text_glyph_row_found
:
2204 struct glyph
*g
= gr
->glyphs
[area
];
2205 struct glyph
*end
= g
+ gr
->used
[area
];
2207 height
= gr
->height
;
2208 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2209 if (gx
+ g
->pixel_width
> x
)
2214 if (g
->type
== IMAGE_GLYPH
)
2216 /* Don't remember when mouse is over image, as
2217 image may have hot-spots. */
2218 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2221 width
= g
->pixel_width
;
2225 /* Use nominal char spacing at end of line. */
2227 gx
+= (x
/ width
) * width
;
2230 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2231 gx
+= window_box_left_offset (w
, area
);
2235 /* Use nominal line height at end of window. */
2236 gx
= (x
/ width
) * width
;
2238 gy
+= (y
/ height
) * height
;
2242 case ON_LEFT_FRINGE
:
2243 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2244 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2245 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2246 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2249 case ON_RIGHT_FRINGE
:
2250 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2251 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2252 : window_box_right_offset (w
, TEXT_AREA
));
2253 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2257 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2259 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2260 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2261 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2263 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2267 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2268 if (r
->y
+ r
->height
> y
)
2275 height
= gr
->height
;
2278 /* Use nominal line height at end of window. */
2280 gy
+= (y
/ height
) * height
;
2287 /* If there is no glyph under the mouse, then we divide the screen
2288 into a grid of the smallest glyph in the frame, and use that
2291 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2292 round down even for negative values. */
2298 gx
= (gx
/ width
) * width
;
2299 gy
= (gy
/ height
) * height
;
2304 gx
+= WINDOW_LEFT_EDGE_X (w
);
2305 gy
+= WINDOW_TOP_EDGE_Y (w
);
2308 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2310 /* Visible feedback for debugging. */
2313 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2314 f
->output_data
.x
->normal_gc
,
2315 gx
, gy
, width
, height
);
2321 #endif /* HAVE_WINDOW_SYSTEM */
2324 /***********************************************************************
2325 Lisp form evaluation
2326 ***********************************************************************/
2328 /* Error handler for safe_eval and safe_call. */
2331 safe_eval_handler (Lisp_Object arg
)
2333 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2338 /* Evaluate SEXPR and return the result, or nil if something went
2339 wrong. Prevent redisplay during the evaluation. */
2341 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2342 Return the result, or nil if something went wrong. Prevent
2343 redisplay during the evaluation. */
2346 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2350 if (inhibit_eval_during_redisplay
)
2354 int count
= SPECPDL_INDEX ();
2355 struct gcpro gcpro1
;
2358 gcpro1
.nvars
= nargs
;
2359 specbind (Qinhibit_redisplay
, Qt
);
2360 /* Use Qt to ensure debugger does not run,
2361 so there is no possibility of wanting to redisplay. */
2362 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2365 val
= unbind_to (count
, val
);
2372 /* Call function FN with one argument ARG.
2373 Return the result, or nil if something went wrong. */
2376 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2378 Lisp_Object args
[2];
2381 return safe_call (2, args
);
2384 static Lisp_Object Qeval
;
2387 safe_eval (Lisp_Object sexpr
)
2389 return safe_call1 (Qeval
, sexpr
);
2392 /* Call function FN with one argument ARG.
2393 Return the result, or nil if something went wrong. */
2396 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2398 Lisp_Object args
[3];
2402 return safe_call (3, args
);
2407 /***********************************************************************
2409 ***********************************************************************/
2413 /* Define CHECK_IT to perform sanity checks on iterators.
2414 This is for debugging. It is too slow to do unconditionally. */
2417 check_it (struct it
*it
)
2419 if (it
->method
== GET_FROM_STRING
)
2421 xassert (STRINGP (it
->string
));
2422 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2426 xassert (IT_STRING_CHARPOS (*it
) < 0);
2427 if (it
->method
== GET_FROM_BUFFER
)
2429 /* Check that character and byte positions agree. */
2430 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2435 xassert (it
->current
.dpvec_index
>= 0);
2437 xassert (it
->current
.dpvec_index
< 0);
2440 #define CHECK_IT(IT) check_it ((IT))
2444 #define CHECK_IT(IT) (void) 0
2449 #if GLYPH_DEBUG && XASSERTS
2451 /* Check that the window end of window W is what we expect it
2452 to be---the last row in the current matrix displaying text. */
2455 check_window_end (struct window
*w
)
2457 if (!MINI_WINDOW_P (w
)
2458 && !NILP (w
->window_end_valid
))
2460 struct glyph_row
*row
;
2461 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2462 XFASTINT (w
->window_end_vpos
)),
2464 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2465 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2469 #define CHECK_WINDOW_END(W) check_window_end ((W))
2473 #define CHECK_WINDOW_END(W) (void) 0
2479 /***********************************************************************
2480 Iterator initialization
2481 ***********************************************************************/
2483 /* Initialize IT for displaying current_buffer in window W, starting
2484 at character position CHARPOS. CHARPOS < 0 means that no buffer
2485 position is specified which is useful when the iterator is assigned
2486 a position later. BYTEPOS is the byte position corresponding to
2487 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2489 If ROW is not null, calls to produce_glyphs with IT as parameter
2490 will produce glyphs in that row.
2492 BASE_FACE_ID is the id of a base face to use. It must be one of
2493 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2494 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2495 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2497 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2498 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2499 will be initialized to use the corresponding mode line glyph row of
2500 the desired matrix of W. */
2503 init_iterator (struct it
*it
, struct window
*w
,
2504 EMACS_INT charpos
, EMACS_INT bytepos
,
2505 struct glyph_row
*row
, enum face_id base_face_id
)
2507 int highlight_region_p
;
2508 enum face_id remapped_base_face_id
= base_face_id
;
2510 /* Some precondition checks. */
2511 xassert (w
!= NULL
&& it
!= NULL
);
2512 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2515 /* If face attributes have been changed since the last redisplay,
2516 free realized faces now because they depend on face definitions
2517 that might have changed. Don't free faces while there might be
2518 desired matrices pending which reference these faces. */
2519 if (face_change_count
&& !inhibit_free_realized_faces
)
2521 face_change_count
= 0;
2522 free_all_realized_faces (Qnil
);
2525 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2526 if (! NILP (Vface_remapping_alist
))
2527 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2529 /* Use one of the mode line rows of W's desired matrix if
2533 if (base_face_id
== MODE_LINE_FACE_ID
2534 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2535 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2536 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2537 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2541 memset (it
, 0, sizeof *it
);
2542 it
->current
.overlay_string_index
= -1;
2543 it
->current
.dpvec_index
= -1;
2544 it
->base_face_id
= remapped_base_face_id
;
2546 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2547 it
->paragraph_embedding
= L2R
;
2548 it
->bidi_it
.string
.lstring
= Qnil
;
2549 it
->bidi_it
.string
.s
= NULL
;
2550 it
->bidi_it
.string
.bufpos
= 0;
2552 /* The window in which we iterate over current_buffer: */
2553 XSETWINDOW (it
->window
, w
);
2555 it
->f
= XFRAME (w
->frame
);
2559 /* Extra space between lines (on window systems only). */
2560 if (base_face_id
== DEFAULT_FACE_ID
2561 && FRAME_WINDOW_P (it
->f
))
2563 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2564 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2565 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2566 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2567 * FRAME_LINE_HEIGHT (it
->f
));
2568 else if (it
->f
->extra_line_spacing
> 0)
2569 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2570 it
->max_extra_line_spacing
= 0;
2573 /* If realized faces have been removed, e.g. because of face
2574 attribute changes of named faces, recompute them. When running
2575 in batch mode, the face cache of the initial frame is null. If
2576 we happen to get called, make a dummy face cache. */
2577 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2578 init_frame_faces (it
->f
);
2579 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2580 recompute_basic_faces (it
->f
);
2582 /* Current value of the `slice', `space-width', and 'height' properties. */
2583 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2584 it
->space_width
= Qnil
;
2585 it
->font_height
= Qnil
;
2586 it
->override_ascent
= -1;
2588 /* Are control characters displayed as `^C'? */
2589 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2591 /* -1 means everything between a CR and the following line end
2592 is invisible. >0 means lines indented more than this value are
2594 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2595 ? XINT (BVAR (current_buffer
, selective_display
))
2596 : (!NILP (BVAR (current_buffer
, selective_display
))
2598 it
->selective_display_ellipsis_p
2599 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2601 /* Display table to use. */
2602 it
->dp
= window_display_table (w
);
2604 /* Are multibyte characters enabled in current_buffer? */
2605 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2607 /* Non-zero if we should highlight the region. */
2609 = (!NILP (Vtransient_mark_mode
)
2610 && !NILP (BVAR (current_buffer
, mark_active
))
2611 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2613 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2614 start and end of a visible region in window IT->w. Set both to
2615 -1 to indicate no region. */
2616 if (highlight_region_p
2617 /* Maybe highlight only in selected window. */
2618 && (/* Either show region everywhere. */
2619 highlight_nonselected_windows
2620 /* Or show region in the selected window. */
2621 || w
== XWINDOW (selected_window
)
2622 /* Or show the region if we are in the mini-buffer and W is
2623 the window the mini-buffer refers to. */
2624 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2625 && WINDOWP (minibuf_selected_window
)
2626 && w
== XWINDOW (minibuf_selected_window
))))
2628 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2629 it
->region_beg_charpos
= min (PT
, markpos
);
2630 it
->region_end_charpos
= max (PT
, markpos
);
2633 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2635 /* Get the position at which the redisplay_end_trigger hook should
2636 be run, if it is to be run at all. */
2637 if (MARKERP (w
->redisplay_end_trigger
)
2638 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2639 it
->redisplay_end_trigger_charpos
2640 = marker_position (w
->redisplay_end_trigger
);
2641 else if (INTEGERP (w
->redisplay_end_trigger
))
2642 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2644 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2646 /* Are lines in the display truncated? */
2647 if (base_face_id
!= DEFAULT_FACE_ID
2648 || XINT (it
->w
->hscroll
)
2649 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2650 && ((!NILP (Vtruncate_partial_width_windows
)
2651 && !INTEGERP (Vtruncate_partial_width_windows
))
2652 || (INTEGERP (Vtruncate_partial_width_windows
)
2653 && (WINDOW_TOTAL_COLS (it
->w
)
2654 < XINT (Vtruncate_partial_width_windows
))))))
2655 it
->line_wrap
= TRUNCATE
;
2656 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2657 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2658 ? WINDOW_WRAP
: WORD_WRAP
;
2660 it
->line_wrap
= TRUNCATE
;
2662 /* Get dimensions of truncation and continuation glyphs. These are
2663 displayed as fringe bitmaps under X, so we don't need them for such
2665 if (!FRAME_WINDOW_P (it
->f
))
2667 if (it
->line_wrap
== TRUNCATE
)
2669 /* We will need the truncation glyph. */
2670 xassert (it
->glyph_row
== NULL
);
2671 produce_special_glyphs (it
, IT_TRUNCATION
);
2672 it
->truncation_pixel_width
= it
->pixel_width
;
2676 /* We will need the continuation glyph. */
2677 xassert (it
->glyph_row
== NULL
);
2678 produce_special_glyphs (it
, IT_CONTINUATION
);
2679 it
->continuation_pixel_width
= it
->pixel_width
;
2682 /* Reset these values to zero because the produce_special_glyphs
2683 above has changed them. */
2684 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2685 it
->phys_ascent
= it
->phys_descent
= 0;
2688 /* Set this after getting the dimensions of truncation and
2689 continuation glyphs, so that we don't produce glyphs when calling
2690 produce_special_glyphs, above. */
2691 it
->glyph_row
= row
;
2692 it
->area
= TEXT_AREA
;
2694 /* Forget any previous info about this row being reversed. */
2696 it
->glyph_row
->reversed_p
= 0;
2698 /* Get the dimensions of the display area. The display area
2699 consists of the visible window area plus a horizontally scrolled
2700 part to the left of the window. All x-values are relative to the
2701 start of this total display area. */
2702 if (base_face_id
!= DEFAULT_FACE_ID
)
2704 /* Mode lines, menu bar in terminal frames. */
2705 it
->first_visible_x
= 0;
2706 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2711 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2712 it
->last_visible_x
= (it
->first_visible_x
2713 + window_box_width (w
, TEXT_AREA
));
2715 /* If we truncate lines, leave room for the truncator glyph(s) at
2716 the right margin. Otherwise, leave room for the continuation
2717 glyph(s). Truncation and continuation glyphs are not inserted
2718 for window-based redisplay. */
2719 if (!FRAME_WINDOW_P (it
->f
))
2721 if (it
->line_wrap
== TRUNCATE
)
2722 it
->last_visible_x
-= it
->truncation_pixel_width
;
2724 it
->last_visible_x
-= it
->continuation_pixel_width
;
2727 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2728 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2731 /* Leave room for a border glyph. */
2732 if (!FRAME_WINDOW_P (it
->f
)
2733 && !WINDOW_RIGHTMOST_P (it
->w
))
2734 it
->last_visible_x
-= 1;
2736 it
->last_visible_y
= window_text_bottom_y (w
);
2738 /* For mode lines and alike, arrange for the first glyph having a
2739 left box line if the face specifies a box. */
2740 if (base_face_id
!= DEFAULT_FACE_ID
)
2744 it
->face_id
= remapped_base_face_id
;
2746 /* If we have a boxed mode line, make the first character appear
2747 with a left box line. */
2748 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2749 if (face
->box
!= FACE_NO_BOX
)
2750 it
->start_of_box_run_p
= 1;
2753 /* If a buffer position was specified, set the iterator there,
2754 getting overlays and face properties from that position. */
2755 if (charpos
>= BUF_BEG (current_buffer
))
2757 it
->end_charpos
= ZV
;
2758 IT_CHARPOS (*it
) = charpos
;
2760 /* We will rely on `reseat' to set this up properly, via
2761 handle_face_prop. */
2762 it
->face_id
= it
->base_face_id
;
2764 /* Compute byte position if not specified. */
2765 if (bytepos
< charpos
)
2766 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2768 IT_BYTEPOS (*it
) = bytepos
;
2770 it
->start
= it
->current
;
2771 /* Do we need to reorder bidirectional text? Not if this is a
2772 unibyte buffer: by definition, none of the single-byte
2773 characters are strong R2L, so no reordering is needed. And
2774 bidi.c doesn't support unibyte buffers anyway. Also, don't
2775 reorder while we are loading loadup.el, since the tables of
2776 character properties needed for reordering are not yet
2780 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2783 /* If we are to reorder bidirectional text, init the bidi
2787 /* Note the paragraph direction that this buffer wants to
2789 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2791 it
->paragraph_embedding
= L2R
;
2792 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2794 it
->paragraph_embedding
= R2L
;
2796 it
->paragraph_embedding
= NEUTRAL_DIR
;
2797 bidi_unshelve_cache (NULL
, 0);
2798 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2802 /* Compute faces etc. */
2803 reseat (it
, it
->current
.pos
, 1);
2810 /* Initialize IT for the display of window W with window start POS. */
2813 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2815 struct glyph_row
*row
;
2816 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2818 row
= w
->desired_matrix
->rows
+ first_vpos
;
2819 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2820 it
->first_vpos
= first_vpos
;
2822 /* Don't reseat to previous visible line start if current start
2823 position is in a string or image. */
2824 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2826 int start_at_line_beg_p
;
2827 int first_y
= it
->current_y
;
2829 /* If window start is not at a line start, skip forward to POS to
2830 get the correct continuation lines width. */
2831 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2832 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2833 if (!start_at_line_beg_p
)
2837 reseat_at_previous_visible_line_start (it
);
2838 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2840 new_x
= it
->current_x
+ it
->pixel_width
;
2842 /* If lines are continued, this line may end in the middle
2843 of a multi-glyph character (e.g. a control character
2844 displayed as \003, or in the middle of an overlay
2845 string). In this case move_it_to above will not have
2846 taken us to the start of the continuation line but to the
2847 end of the continued line. */
2848 if (it
->current_x
> 0
2849 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2850 && (/* And glyph doesn't fit on the line. */
2851 new_x
> it
->last_visible_x
2852 /* Or it fits exactly and we're on a window
2854 || (new_x
== it
->last_visible_x
2855 && FRAME_WINDOW_P (it
->f
))))
2857 if ((it
->current
.dpvec_index
>= 0
2858 || it
->current
.overlay_string_index
>= 0)
2859 /* If we are on a newline from a display vector or
2860 overlay string, then we are already at the end of
2861 a screen line; no need to go to the next line in
2862 that case, as this line is not really continued.
2863 (If we do go to the next line, C-e will not DTRT.) */
2866 set_iterator_to_next (it
, 1);
2867 move_it_in_display_line_to (it
, -1, -1, 0);
2870 it
->continuation_lines_width
+= it
->current_x
;
2872 /* If the character at POS is displayed via a display
2873 vector, move_it_to above stops at the final glyph of
2874 IT->dpvec. To make the caller redisplay that character
2875 again (a.k.a. start at POS), we need to reset the
2876 dpvec_index to the beginning of IT->dpvec. */
2877 else if (it
->current
.dpvec_index
>= 0)
2878 it
->current
.dpvec_index
= 0;
2880 /* We're starting a new display line, not affected by the
2881 height of the continued line, so clear the appropriate
2882 fields in the iterator structure. */
2883 it
->max_ascent
= it
->max_descent
= 0;
2884 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2886 it
->current_y
= first_y
;
2888 it
->current_x
= it
->hpos
= 0;
2894 /* Return 1 if POS is a position in ellipses displayed for invisible
2895 text. W is the window we display, for text property lookup. */
2898 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2900 Lisp_Object prop
, window
;
2902 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2904 /* If POS specifies a position in a display vector, this might
2905 be for an ellipsis displayed for invisible text. We won't
2906 get the iterator set up for delivering that ellipsis unless
2907 we make sure that it gets aware of the invisible text. */
2908 if (pos
->dpvec_index
>= 0
2909 && pos
->overlay_string_index
< 0
2910 && CHARPOS (pos
->string_pos
) < 0
2912 && (XSETWINDOW (window
, w
),
2913 prop
= Fget_char_property (make_number (charpos
),
2914 Qinvisible
, window
),
2915 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2917 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2919 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2926 /* Initialize IT for stepping through current_buffer in window W,
2927 starting at position POS that includes overlay string and display
2928 vector/ control character translation position information. Value
2929 is zero if there are overlay strings with newlines at POS. */
2932 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2934 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2935 int i
, overlay_strings_with_newlines
= 0;
2937 /* If POS specifies a position in a display vector, this might
2938 be for an ellipsis displayed for invisible text. We won't
2939 get the iterator set up for delivering that ellipsis unless
2940 we make sure that it gets aware of the invisible text. */
2941 if (in_ellipses_for_invisible_text_p (pos
, w
))
2947 /* Keep in mind: the call to reseat in init_iterator skips invisible
2948 text, so we might end up at a position different from POS. This
2949 is only a problem when POS is a row start after a newline and an
2950 overlay starts there with an after-string, and the overlay has an
2951 invisible property. Since we don't skip invisible text in
2952 display_line and elsewhere immediately after consuming the
2953 newline before the row start, such a POS will not be in a string,
2954 but the call to init_iterator below will move us to the
2956 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2958 /* This only scans the current chunk -- it should scan all chunks.
2959 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2960 to 16 in 22.1 to make this a lesser problem. */
2961 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2963 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2964 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2966 while (s
< e
&& *s
!= '\n')
2971 overlay_strings_with_newlines
= 1;
2976 /* If position is within an overlay string, set up IT to the right
2978 if (pos
->overlay_string_index
>= 0)
2982 /* If the first overlay string happens to have a `display'
2983 property for an image, the iterator will be set up for that
2984 image, and we have to undo that setup first before we can
2985 correct the overlay string index. */
2986 if (it
->method
== GET_FROM_IMAGE
)
2989 /* We already have the first chunk of overlay strings in
2990 IT->overlay_strings. Load more until the one for
2991 pos->overlay_string_index is in IT->overlay_strings. */
2992 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2994 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2995 it
->current
.overlay_string_index
= 0;
2998 load_overlay_strings (it
, 0);
2999 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3003 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3004 relative_index
= (it
->current
.overlay_string_index
3005 % OVERLAY_STRING_CHUNK_SIZE
);
3006 it
->string
= it
->overlay_strings
[relative_index
];
3007 xassert (STRINGP (it
->string
));
3008 it
->current
.string_pos
= pos
->string_pos
;
3009 it
->method
= GET_FROM_STRING
;
3012 if (CHARPOS (pos
->string_pos
) >= 0)
3014 /* Recorded position is not in an overlay string, but in another
3015 string. This can only be a string from a `display' property.
3016 IT should already be filled with that string. */
3017 it
->current
.string_pos
= pos
->string_pos
;
3018 xassert (STRINGP (it
->string
));
3021 /* Restore position in display vector translations, control
3022 character translations or ellipses. */
3023 if (pos
->dpvec_index
>= 0)
3025 if (it
->dpvec
== NULL
)
3026 get_next_display_element (it
);
3027 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3028 it
->current
.dpvec_index
= pos
->dpvec_index
;
3032 return !overlay_strings_with_newlines
;
3036 /* Initialize IT for stepping through current_buffer in window W
3037 starting at ROW->start. */
3040 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3042 init_from_display_pos (it
, w
, &row
->start
);
3043 it
->start
= row
->start
;
3044 it
->continuation_lines_width
= row
->continuation_lines_width
;
3049 /* Initialize IT for stepping through current_buffer in window W
3050 starting in the line following ROW, i.e. starting at ROW->end.
3051 Value is zero if there are overlay strings with newlines at ROW's
3055 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3059 if (init_from_display_pos (it
, w
, &row
->end
))
3061 if (row
->continued_p
)
3062 it
->continuation_lines_width
3063 = row
->continuation_lines_width
+ row
->pixel_width
;
3074 /***********************************************************************
3076 ***********************************************************************/
3078 /* Called when IT reaches IT->stop_charpos. Handle text property and
3079 overlay changes. Set IT->stop_charpos to the next position where
3083 handle_stop (struct it
*it
)
3085 enum prop_handled handled
;
3086 int handle_overlay_change_p
;
3090 it
->current
.dpvec_index
= -1;
3091 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3092 it
->ignore_overlay_strings_at_pos_p
= 0;
3095 /* Use face of preceding text for ellipsis (if invisible) */
3096 if (it
->selective_display_ellipsis_p
)
3097 it
->saved_face_id
= it
->face_id
;
3101 handled
= HANDLED_NORMALLY
;
3103 /* Call text property handlers. */
3104 for (p
= it_props
; p
->handler
; ++p
)
3106 handled
= p
->handler (it
);
3108 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3110 else if (handled
== HANDLED_RETURN
)
3112 /* We still want to show before and after strings from
3113 overlays even if the actual buffer text is replaced. */
3114 if (!handle_overlay_change_p
3116 || !get_overlay_strings_1 (it
, 0, 0))
3119 setup_for_ellipsis (it
, 0);
3120 /* When handling a display spec, we might load an
3121 empty string. In that case, discard it here. We
3122 used to discard it in handle_single_display_spec,
3123 but that causes get_overlay_strings_1, above, to
3124 ignore overlay strings that we must check. */
3125 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3129 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3133 it
->ignore_overlay_strings_at_pos_p
= 1;
3134 it
->string_from_display_prop_p
= 0;
3135 it
->from_disp_prop_p
= 0;
3136 handle_overlay_change_p
= 0;
3138 handled
= HANDLED_RECOMPUTE_PROPS
;
3141 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3142 handle_overlay_change_p
= 0;
3145 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3147 /* Don't check for overlay strings below when set to deliver
3148 characters from a display vector. */
3149 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3150 handle_overlay_change_p
= 0;
3152 /* Handle overlay changes.
3153 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3154 if it finds overlays. */
3155 if (handle_overlay_change_p
)
3156 handled
= handle_overlay_change (it
);
3161 setup_for_ellipsis (it
, 0);
3165 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3167 /* Determine where to stop next. */
3168 if (handled
== HANDLED_NORMALLY
)
3169 compute_stop_pos (it
);
3173 /* Compute IT->stop_charpos from text property and overlay change
3174 information for IT's current position. */
3177 compute_stop_pos (struct it
*it
)
3179 register INTERVAL iv
, next_iv
;
3180 Lisp_Object object
, limit
, position
;
3181 EMACS_INT charpos
, bytepos
;
3183 if (STRINGP (it
->string
))
3185 /* Strings are usually short, so don't limit the search for
3187 it
->stop_charpos
= it
->end_charpos
;
3188 object
= it
->string
;
3190 charpos
= IT_STRING_CHARPOS (*it
);
3191 bytepos
= IT_STRING_BYTEPOS (*it
);
3197 /* If end_charpos is out of range for some reason, such as a
3198 misbehaving display function, rationalize it (Bug#5984). */
3199 if (it
->end_charpos
> ZV
)
3200 it
->end_charpos
= ZV
;
3201 it
->stop_charpos
= it
->end_charpos
;
3203 /* If next overlay change is in front of the current stop pos
3204 (which is IT->end_charpos), stop there. Note: value of
3205 next_overlay_change is point-max if no overlay change
3207 charpos
= IT_CHARPOS (*it
);
3208 bytepos
= IT_BYTEPOS (*it
);
3209 pos
= next_overlay_change (charpos
);
3210 if (pos
< it
->stop_charpos
)
3211 it
->stop_charpos
= pos
;
3213 /* If showing the region, we have to stop at the region
3214 start or end because the face might change there. */
3215 if (it
->region_beg_charpos
> 0)
3217 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3218 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3219 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3220 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3223 /* Set up variables for computing the stop position from text
3224 property changes. */
3225 XSETBUFFER (object
, current_buffer
);
3226 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3229 /* Get the interval containing IT's position. Value is a null
3230 interval if there isn't such an interval. */
3231 position
= make_number (charpos
);
3232 iv
= validate_interval_range (object
, &position
, &position
, 0);
3233 if (!NULL_INTERVAL_P (iv
))
3235 Lisp_Object values_here
[LAST_PROP_IDX
];
3238 /* Get properties here. */
3239 for (p
= it_props
; p
->handler
; ++p
)
3240 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3242 /* Look for an interval following iv that has different
3244 for (next_iv
= next_interval (iv
);
3245 (!NULL_INTERVAL_P (next_iv
)
3247 || XFASTINT (limit
) > next_iv
->position
));
3248 next_iv
= next_interval (next_iv
))
3250 for (p
= it_props
; p
->handler
; ++p
)
3252 Lisp_Object new_value
;
3254 new_value
= textget (next_iv
->plist
, *p
->name
);
3255 if (!EQ (values_here
[p
->idx
], new_value
))
3263 if (!NULL_INTERVAL_P (next_iv
))
3265 if (INTEGERP (limit
)
3266 && next_iv
->position
>= XFASTINT (limit
))
3267 /* No text property change up to limit. */
3268 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3270 /* Text properties change in next_iv. */
3271 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3275 if (it
->cmp_it
.id
< 0)
3277 EMACS_INT stoppos
= it
->end_charpos
;
3279 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3281 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3282 stoppos
, it
->string
);
3285 xassert (STRINGP (it
->string
)
3286 || (it
->stop_charpos
>= BEGV
3287 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3291 /* Return the position of the next overlay change after POS in
3292 current_buffer. Value is point-max if no overlay change
3293 follows. This is like `next-overlay-change' but doesn't use
3297 next_overlay_change (EMACS_INT pos
)
3299 ptrdiff_t i
, noverlays
;
3301 Lisp_Object
*overlays
;
3303 /* Get all overlays at the given position. */
3304 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3306 /* If any of these overlays ends before endpos,
3307 use its ending point instead. */
3308 for (i
= 0; i
< noverlays
; ++i
)
3313 oend
= OVERLAY_END (overlays
[i
]);
3314 oendpos
= OVERLAY_POSITION (oend
);
3315 endpos
= min (endpos
, oendpos
);
3321 /* How many characters forward to search for a display property or
3322 display string. Searching too far forward makes the bidi display
3323 sluggish, especially in small windows. */
3324 #define MAX_DISP_SCAN 250
3326 /* Return the character position of a display string at or after
3327 position specified by POSITION. If no display string exists at or
3328 after POSITION, return ZV. A display string is either an overlay
3329 with `display' property whose value is a string, or a `display'
3330 text property whose value is a string. STRING is data about the
3331 string to iterate; if STRING->lstring is nil, we are iterating a
3332 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3333 on a GUI frame. DISP_PROP is set to zero if we searched
3334 MAX_DISP_SCAN characters forward without finding any display
3335 strings, non-zero otherwise. It is set to 2 if the display string
3336 uses any kind of `(space ...)' spec that will produce a stretch of
3337 white space in the text area. */
3339 compute_display_string_pos (struct text_pos
*position
,
3340 struct bidi_string_data
*string
,
3341 int frame_window_p
, int *disp_prop
)
3343 /* OBJECT = nil means current buffer. */
3344 Lisp_Object object
=
3345 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3346 Lisp_Object pos
, spec
, limpos
;
3347 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3348 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3349 EMACS_INT begb
= string_p
? 0 : BEGV
;
3350 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3352 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3353 struct text_pos tpos
;
3359 /* We don't support display properties whose values are strings
3360 that have display string properties. */
3361 || string
->from_disp_str
3362 /* C strings cannot have display properties. */
3363 || (string
->s
&& !STRINGP (object
)))
3369 /* If the character at CHARPOS is where the display string begins,
3371 pos
= make_number (charpos
);
3372 if (STRINGP (object
))
3373 bufpos
= string
->bufpos
;
3377 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3379 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3382 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3390 /* Look forward for the first character with a `display' property
3391 that will replace the underlying text when displayed. */
3392 limpos
= make_number (lim
);
3394 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3395 CHARPOS (tpos
) = XFASTINT (pos
);
3396 if (CHARPOS (tpos
) >= lim
)
3401 if (STRINGP (object
))
3402 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3404 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3405 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3406 if (!STRINGP (object
))
3407 bufpos
= CHARPOS (tpos
);
3408 } while (NILP (spec
)
3409 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3410 bufpos
, frame_window_p
)));
3414 return CHARPOS (tpos
);
3417 /* Return the character position of the end of the display string that
3418 started at CHARPOS. If there's no display string at CHARPOS,
3419 return -1. A display string is either an overlay with `display'
3420 property whose value is a string or a `display' text property whose
3421 value is a string. */
3423 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3425 /* OBJECT = nil means current buffer. */
3426 Lisp_Object object
=
3427 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3428 Lisp_Object pos
= make_number (charpos
);
3430 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3432 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3435 /* It could happen that the display property or overlay was removed
3436 since we found it in compute_display_string_pos above. One way
3437 this can happen is if JIT font-lock was called (through
3438 handle_fontified_prop), and jit-lock-functions remove text
3439 properties or overlays from the portion of buffer that includes
3440 CHARPOS. Muse mode is known to do that, for example. In this
3441 case, we return -1 to the caller, to signal that no display
3442 string is actually present at CHARPOS. See bidi_fetch_char for
3443 how this is handled.
3445 An alternative would be to never look for display properties past
3446 it->stop_charpos. But neither compute_display_string_pos nor
3447 bidi_fetch_char that calls it know or care where the next
3449 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3452 /* Look forward for the first character where the `display' property
3454 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3456 return XFASTINT (pos
);
3461 /***********************************************************************
3463 ***********************************************************************/
3465 /* Handle changes in the `fontified' property of the current buffer by
3466 calling hook functions from Qfontification_functions to fontify
3469 static enum prop_handled
3470 handle_fontified_prop (struct it
*it
)
3472 Lisp_Object prop
, pos
;
3473 enum prop_handled handled
= HANDLED_NORMALLY
;
3475 if (!NILP (Vmemory_full
))
3478 /* Get the value of the `fontified' property at IT's current buffer
3479 position. (The `fontified' property doesn't have a special
3480 meaning in strings.) If the value is nil, call functions from
3481 Qfontification_functions. */
3482 if (!STRINGP (it
->string
)
3484 && !NILP (Vfontification_functions
)
3485 && !NILP (Vrun_hooks
)
3486 && (pos
= make_number (IT_CHARPOS (*it
)),
3487 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3488 /* Ignore the special cased nil value always present at EOB since
3489 no amount of fontifying will be able to change it. */
3490 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3492 int count
= SPECPDL_INDEX ();
3494 struct buffer
*obuf
= current_buffer
;
3495 int begv
= BEGV
, zv
= ZV
;
3496 int old_clip_changed
= current_buffer
->clip_changed
;
3498 val
= Vfontification_functions
;
3499 specbind (Qfontification_functions
, Qnil
);
3501 xassert (it
->end_charpos
== ZV
);
3503 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3504 safe_call1 (val
, pos
);
3507 Lisp_Object fns
, fn
;
3508 struct gcpro gcpro1
, gcpro2
;
3513 for (; CONSP (val
); val
= XCDR (val
))
3519 /* A value of t indicates this hook has a local
3520 binding; it means to run the global binding too.
3521 In a global value, t should not occur. If it
3522 does, we must ignore it to avoid an endless
3524 for (fns
= Fdefault_value (Qfontification_functions
);
3530 safe_call1 (fn
, pos
);
3534 safe_call1 (fn
, pos
);
3540 unbind_to (count
, Qnil
);
3542 /* Fontification functions routinely call `save-restriction'.
3543 Normally, this tags clip_changed, which can confuse redisplay
3544 (see discussion in Bug#6671). Since we don't perform any
3545 special handling of fontification changes in the case where
3546 `save-restriction' isn't called, there's no point doing so in
3547 this case either. So, if the buffer's restrictions are
3548 actually left unchanged, reset clip_changed. */
3549 if (obuf
== current_buffer
)
3551 if (begv
== BEGV
&& zv
== ZV
)
3552 current_buffer
->clip_changed
= old_clip_changed
;
3554 /* There isn't much we can reasonably do to protect against
3555 misbehaving fontification, but here's a fig leaf. */
3556 else if (!NILP (BVAR (obuf
, name
)))
3557 set_buffer_internal_1 (obuf
);
3559 /* The fontification code may have added/removed text.
3560 It could do even a lot worse, but let's at least protect against
3561 the most obvious case where only the text past `pos' gets changed',
3562 as is/was done in grep.el where some escapes sequences are turned
3563 into face properties (bug#7876). */
3564 it
->end_charpos
= ZV
;
3566 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3567 something. This avoids an endless loop if they failed to
3568 fontify the text for which reason ever. */
3569 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3570 handled
= HANDLED_RECOMPUTE_PROPS
;
3578 /***********************************************************************
3580 ***********************************************************************/
3582 /* Set up iterator IT from face properties at its current position.
3583 Called from handle_stop. */
3585 static enum prop_handled
3586 handle_face_prop (struct it
*it
)
3589 EMACS_INT next_stop
;
3591 if (!STRINGP (it
->string
))
3594 = face_at_buffer_position (it
->w
,
3596 it
->region_beg_charpos
,
3597 it
->region_end_charpos
,
3600 + TEXT_PROP_DISTANCE_LIMIT
),
3601 0, it
->base_face_id
);
3603 /* Is this a start of a run of characters with box face?
3604 Caveat: this can be called for a freshly initialized
3605 iterator; face_id is -1 in this case. We know that the new
3606 face will not change until limit, i.e. if the new face has a
3607 box, all characters up to limit will have one. But, as
3608 usual, we don't know whether limit is really the end. */
3609 if (new_face_id
!= it
->face_id
)
3611 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3613 /* If new face has a box but old face has not, this is
3614 the start of a run of characters with box, i.e. it has
3615 a shadow on the left side. The value of face_id of the
3616 iterator will be -1 if this is the initial call that gets
3617 the face. In this case, we have to look in front of IT's
3618 position and see whether there is a face != new_face_id. */
3619 it
->start_of_box_run_p
3620 = (new_face
->box
!= FACE_NO_BOX
3621 && (it
->face_id
>= 0
3622 || IT_CHARPOS (*it
) == BEG
3623 || new_face_id
!= face_before_it_pos (it
)));
3624 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3632 Lisp_Object from_overlay
3633 = (it
->current
.overlay_string_index
>= 0
3634 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3637 /* See if we got to this string directly or indirectly from
3638 an overlay property. That includes the before-string or
3639 after-string of an overlay, strings in display properties
3640 provided by an overlay, their text properties, etc.
3642 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3643 if (! NILP (from_overlay
))
3644 for (i
= it
->sp
- 1; i
>= 0; i
--)
3646 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3648 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3649 else if (! NILP (it
->stack
[i
].from_overlay
))
3650 from_overlay
= it
->stack
[i
].from_overlay
;
3652 if (!NILP (from_overlay
))
3656 if (! NILP (from_overlay
))
3658 bufpos
= IT_CHARPOS (*it
);
3659 /* For a string from an overlay, the base face depends
3660 only on text properties and ignores overlays. */
3662 = face_for_overlay_string (it
->w
,
3664 it
->region_beg_charpos
,
3665 it
->region_end_charpos
,
3668 + TEXT_PROP_DISTANCE_LIMIT
),
3676 /* For strings from a `display' property, use the face at
3677 IT's current buffer position as the base face to merge
3678 with, so that overlay strings appear in the same face as
3679 surrounding text, unless they specify their own
3681 base_face_id
= it
->string_from_prefix_prop_p
3683 : underlying_face_id (it
);
3686 new_face_id
= face_at_string_position (it
->w
,
3688 IT_STRING_CHARPOS (*it
),
3690 it
->region_beg_charpos
,
3691 it
->region_end_charpos
,
3695 /* Is this a start of a run of characters with box? Caveat:
3696 this can be called for a freshly allocated iterator; face_id
3697 is -1 is this case. We know that the new face will not
3698 change until the next check pos, i.e. if the new face has a
3699 box, all characters up to that position will have a
3700 box. But, as usual, we don't know whether that position
3701 is really the end. */
3702 if (new_face_id
!= it
->face_id
)
3704 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3705 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3707 /* If new face has a box but old face hasn't, this is the
3708 start of a run of characters with box, i.e. it has a
3709 shadow on the left side. */
3710 it
->start_of_box_run_p
3711 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3712 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3716 it
->face_id
= new_face_id
;
3717 return HANDLED_NORMALLY
;
3721 /* Return the ID of the face ``underlying'' IT's current position,
3722 which is in a string. If the iterator is associated with a
3723 buffer, return the face at IT's current buffer position.
3724 Otherwise, use the iterator's base_face_id. */
3727 underlying_face_id (struct it
*it
)
3729 int face_id
= it
->base_face_id
, i
;
3731 xassert (STRINGP (it
->string
));
3733 for (i
= it
->sp
- 1; i
>= 0; --i
)
3734 if (NILP (it
->stack
[i
].string
))
3735 face_id
= it
->stack
[i
].face_id
;
3741 /* Compute the face one character before or after the current position
3742 of IT, in the visual order. BEFORE_P non-zero means get the face
3743 in front (to the left in L2R paragraphs, to the right in R2L
3744 paragraphs) of IT's screen position. Value is the ID of the face. */
3747 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3750 EMACS_INT next_check_charpos
;
3752 void *it_copy_data
= NULL
;
3754 xassert (it
->s
== NULL
);
3756 if (STRINGP (it
->string
))
3758 EMACS_INT bufpos
, charpos
;
3761 /* No face change past the end of the string (for the case
3762 we are padding with spaces). No face change before the
3764 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3765 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3770 /* Set charpos to the position before or after IT's current
3771 position, in the logical order, which in the non-bidi
3772 case is the same as the visual order. */
3774 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3775 else if (it
->what
== IT_COMPOSITION
)
3776 /* For composition, we must check the character after the
3778 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3780 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3786 /* With bidi iteration, the character before the current
3787 in the visual order cannot be found by simple
3788 iteration, because "reverse" reordering is not
3789 supported. Instead, we need to use the move_it_*
3790 family of functions. */
3791 /* Ignore face changes before the first visible
3792 character on this display line. */
3793 if (it
->current_x
<= it
->first_visible_x
)
3795 SAVE_IT (it_copy
, *it
, it_copy_data
);
3796 /* Implementation note: Since move_it_in_display_line
3797 works in the iterator geometry, and thinks the first
3798 character is always the leftmost, even in R2L lines,
3799 we don't need to distinguish between the R2L and L2R
3801 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3802 it_copy
.current_x
- 1, MOVE_TO_X
);
3803 charpos
= IT_STRING_CHARPOS (it_copy
);
3804 RESTORE_IT (it
, it
, it_copy_data
);
3808 /* Set charpos to the string position of the character
3809 that comes after IT's current position in the visual
3811 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3815 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3817 charpos
= it_copy
.bidi_it
.charpos
;
3820 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3822 if (it
->current
.overlay_string_index
>= 0)
3823 bufpos
= IT_CHARPOS (*it
);
3827 base_face_id
= underlying_face_id (it
);
3829 /* Get the face for ASCII, or unibyte. */
3830 face_id
= face_at_string_position (it
->w
,
3834 it
->region_beg_charpos
,
3835 it
->region_end_charpos
,
3836 &next_check_charpos
,
3839 /* Correct the face for charsets different from ASCII. Do it
3840 for the multibyte case only. The face returned above is
3841 suitable for unibyte text if IT->string is unibyte. */
3842 if (STRING_MULTIBYTE (it
->string
))
3844 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3845 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3847 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3849 c
= string_char_and_length (p
, &len
);
3850 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3855 struct text_pos pos
;
3857 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3858 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3861 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3862 pos
= it
->current
.pos
;
3867 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3870 if (it
->what
== IT_COMPOSITION
)
3872 /* For composition, we must check the position after
3874 pos
.charpos
+= it
->cmp_it
.nchars
;
3875 pos
.bytepos
+= it
->len
;
3878 INC_TEXT_POS (pos
, it
->multibyte_p
);
3885 /* With bidi iteration, the character before the current
3886 in the visual order cannot be found by simple
3887 iteration, because "reverse" reordering is not
3888 supported. Instead, we need to use the move_it_*
3889 family of functions. */
3890 /* Ignore face changes before the first visible
3891 character on this display line. */
3892 if (it
->current_x
<= it
->first_visible_x
)
3894 SAVE_IT (it_copy
, *it
, it_copy_data
);
3895 /* Implementation note: Since move_it_in_display_line
3896 works in the iterator geometry, and thinks the first
3897 character is always the leftmost, even in R2L lines,
3898 we don't need to distinguish between the R2L and L2R
3900 move_it_in_display_line (&it_copy
, ZV
,
3901 it_copy
.current_x
- 1, MOVE_TO_X
);
3902 pos
= it_copy
.current
.pos
;
3903 RESTORE_IT (it
, it
, it_copy_data
);
3907 /* Set charpos to the buffer position of the character
3908 that comes after IT's current position in the visual
3910 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3914 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3917 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3920 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3922 /* Determine face for CHARSET_ASCII, or unibyte. */
3923 face_id
= face_at_buffer_position (it
->w
,
3925 it
->region_beg_charpos
,
3926 it
->region_end_charpos
,
3927 &next_check_charpos
,
3930 /* Correct the face for charsets different from ASCII. Do it
3931 for the multibyte case only. The face returned above is
3932 suitable for unibyte text if current_buffer is unibyte. */
3933 if (it
->multibyte_p
)
3935 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3936 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3937 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3946 /***********************************************************************
3948 ***********************************************************************/
3950 /* Set up iterator IT from invisible properties at its current
3951 position. Called from handle_stop. */
3953 static enum prop_handled
3954 handle_invisible_prop (struct it
*it
)
3956 enum prop_handled handled
= HANDLED_NORMALLY
;
3958 if (STRINGP (it
->string
))
3960 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3962 /* Get the value of the invisible text property at the
3963 current position. Value will be nil if there is no such
3965 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3966 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3969 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3973 handled
= HANDLED_RECOMPUTE_PROPS
;
3975 /* Get the position at which the next change of the
3976 invisible text property can be found in IT->string.
3977 Value will be nil if the property value is the same for
3978 all the rest of IT->string. */
3979 XSETINT (limit
, SCHARS (it
->string
));
3980 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3983 /* Text at current position is invisible. The next
3984 change in the property is at position end_charpos.
3985 Move IT's current position to that position. */
3986 if (INTEGERP (end_charpos
)
3987 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3989 struct text_pos old
;
3992 old
= it
->current
.string_pos
;
3993 oldpos
= CHARPOS (old
);
3996 if (it
->bidi_it
.first_elt
3997 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3998 bidi_paragraph_init (it
->paragraph_embedding
,
4000 /* Bidi-iterate out of the invisible text. */
4003 bidi_move_to_visually_next (&it
->bidi_it
);
4005 while (oldpos
<= it
->bidi_it
.charpos
4006 && it
->bidi_it
.charpos
< endpos
);
4008 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4009 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4010 if (IT_CHARPOS (*it
) >= endpos
)
4011 it
->prev_stop
= endpos
;
4015 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4016 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4021 /* The rest of the string is invisible. If this is an
4022 overlay string, proceed with the next overlay string
4023 or whatever comes and return a character from there. */
4024 if (it
->current
.overlay_string_index
>= 0)
4026 next_overlay_string (it
);
4027 /* Don't check for overlay strings when we just
4028 finished processing them. */
4029 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4033 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4034 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4042 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4043 Lisp_Object pos
, prop
, overlay
;
4045 /* First of all, is there invisible text at this position? */
4046 tem
= start_charpos
= IT_CHARPOS (*it
);
4047 pos
= make_number (tem
);
4048 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4050 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4052 /* If we are on invisible text, skip over it. */
4053 if (invis_p
&& start_charpos
< it
->end_charpos
)
4055 /* Record whether we have to display an ellipsis for the
4057 int display_ellipsis_p
= invis_p
== 2;
4059 handled
= HANDLED_RECOMPUTE_PROPS
;
4061 /* Loop skipping over invisible text. The loop is left at
4062 ZV or with IT on the first char being visible again. */
4065 /* Try to skip some invisible text. Return value is the
4066 position reached which can be equal to where we start
4067 if there is nothing invisible there. This skips both
4068 over invisible text properties and overlays with
4069 invisible property. */
4070 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4072 /* If we skipped nothing at all we weren't at invisible
4073 text in the first place. If everything to the end of
4074 the buffer was skipped, end the loop. */
4075 if (newpos
== tem
|| newpos
>= ZV
)
4079 /* We skipped some characters but not necessarily
4080 all there are. Check if we ended up on visible
4081 text. Fget_char_property returns the property of
4082 the char before the given position, i.e. if we
4083 get invis_p = 0, this means that the char at
4084 newpos is visible. */
4085 pos
= make_number (newpos
);
4086 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4087 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4090 /* If we ended up on invisible text, proceed to
4091 skip starting with next_stop. */
4095 /* If there are adjacent invisible texts, don't lose the
4096 second one's ellipsis. */
4098 display_ellipsis_p
= 1;
4102 /* The position newpos is now either ZV or on visible text. */
4105 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4107 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4109 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4111 /* If the invisible text ends on a newline or on a
4112 character after a newline, we can avoid the costly,
4113 character by character, bidi iteration to NEWPOS, and
4114 instead simply reseat the iterator there. That's
4115 because all bidi reordering information is tossed at
4116 the newline. This is a big win for modes that hide
4117 complete lines, like Outline, Org, etc. */
4118 if (on_newline
|| after_newline
)
4120 struct text_pos tpos
;
4121 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4123 SET_TEXT_POS (tpos
, newpos
, bpos
);
4124 reseat_1 (it
, tpos
, 0);
4125 /* If we reseat on a newline/ZV, we need to prep the
4126 bidi iterator for advancing to the next character
4127 after the newline/EOB, keeping the current paragraph
4128 direction (so that PRODUCE_GLYPHS does TRT wrt
4129 prepending/appending glyphs to a glyph row). */
4132 it
->bidi_it
.first_elt
= 0;
4133 it
->bidi_it
.paragraph_dir
= pdir
;
4134 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4135 it
->bidi_it
.nchars
= 1;
4136 it
->bidi_it
.ch_len
= 1;
4139 else /* Must use the slow method. */
4141 /* With bidi iteration, the region of invisible text
4142 could start and/or end in the middle of a
4143 non-base embedding level. Therefore, we need to
4144 skip invisible text using the bidi iterator,
4145 starting at IT's current position, until we find
4146 ourselves outside of the invisible text.
4147 Skipping invisible text _after_ bidi iteration
4148 avoids affecting the visual order of the
4149 displayed text when invisible properties are
4150 added or removed. */
4151 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4153 /* If we were `reseat'ed to a new paragraph,
4154 determine the paragraph base direction. We
4155 need to do it now because
4156 next_element_from_buffer may not have a
4157 chance to do it, if we are going to skip any
4158 text at the beginning, which resets the
4160 bidi_paragraph_init (it
->paragraph_embedding
,
4165 bidi_move_to_visually_next (&it
->bidi_it
);
4167 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4168 && it
->bidi_it
.charpos
< newpos
);
4169 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4170 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4171 /* If we overstepped NEWPOS, record its position in
4172 the iterator, so that we skip invisible text if
4173 later the bidi iteration lands us in the
4174 invisible region again. */
4175 if (IT_CHARPOS (*it
) >= newpos
)
4176 it
->prev_stop
= newpos
;
4181 IT_CHARPOS (*it
) = newpos
;
4182 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4185 /* If there are before-strings at the start of invisible
4186 text, and the text is invisible because of a text
4187 property, arrange to show before-strings because 20.x did
4188 it that way. (If the text is invisible because of an
4189 overlay property instead of a text property, this is
4190 already handled in the overlay code.) */
4192 && get_overlay_strings (it
, it
->stop_charpos
))
4194 handled
= HANDLED_RECOMPUTE_PROPS
;
4195 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4197 else if (display_ellipsis_p
)
4199 /* Make sure that the glyphs of the ellipsis will get
4200 correct `charpos' values. If we would not update
4201 it->position here, the glyphs would belong to the
4202 last visible character _before_ the invisible
4203 text, which confuses `set_cursor_from_row'.
4205 We use the last invisible position instead of the
4206 first because this way the cursor is always drawn on
4207 the first "." of the ellipsis, whenever PT is inside
4208 the invisible text. Otherwise the cursor would be
4209 placed _after_ the ellipsis when the point is after the
4210 first invisible character. */
4211 if (!STRINGP (it
->object
))
4213 it
->position
.charpos
= newpos
- 1;
4214 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4217 /* Let the ellipsis display before
4218 considering any properties of the following char.
4219 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4220 handled
= HANDLED_RETURN
;
4229 /* Make iterator IT return `...' next.
4230 Replaces LEN characters from buffer. */
4233 setup_for_ellipsis (struct it
*it
, int len
)
4235 /* Use the display table definition for `...'. Invalid glyphs
4236 will be handled by the method returning elements from dpvec. */
4237 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4239 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4240 it
->dpvec
= v
->contents
;
4241 it
->dpend
= v
->contents
+ v
->header
.size
;
4245 /* Default `...'. */
4246 it
->dpvec
= default_invis_vector
;
4247 it
->dpend
= default_invis_vector
+ 3;
4250 it
->dpvec_char_len
= len
;
4251 it
->current
.dpvec_index
= 0;
4252 it
->dpvec_face_id
= -1;
4254 /* Remember the current face id in case glyphs specify faces.
4255 IT's face is restored in set_iterator_to_next.
4256 saved_face_id was set to preceding char's face in handle_stop. */
4257 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4258 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4260 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4266 /***********************************************************************
4268 ***********************************************************************/
4270 /* Set up iterator IT from `display' property at its current position.
4271 Called from handle_stop.
4272 We return HANDLED_RETURN if some part of the display property
4273 overrides the display of the buffer text itself.
4274 Otherwise we return HANDLED_NORMALLY. */
4276 static enum prop_handled
4277 handle_display_prop (struct it
*it
)
4279 Lisp_Object propval
, object
, overlay
;
4280 struct text_pos
*position
;
4282 /* Nonzero if some property replaces the display of the text itself. */
4283 int display_replaced_p
= 0;
4285 if (STRINGP (it
->string
))
4287 object
= it
->string
;
4288 position
= &it
->current
.string_pos
;
4289 bufpos
= CHARPOS (it
->current
.pos
);
4293 XSETWINDOW (object
, it
->w
);
4294 position
= &it
->current
.pos
;
4295 bufpos
= CHARPOS (*position
);
4298 /* Reset those iterator values set from display property values. */
4299 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4300 it
->space_width
= Qnil
;
4301 it
->font_height
= Qnil
;
4304 /* We don't support recursive `display' properties, i.e. string
4305 values that have a string `display' property, that have a string
4306 `display' property etc. */
4307 if (!it
->string_from_display_prop_p
)
4308 it
->area
= TEXT_AREA
;
4310 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4311 Qdisplay
, object
, &overlay
);
4313 return HANDLED_NORMALLY
;
4314 /* Now OVERLAY is the overlay that gave us this property, or nil
4315 if it was a text property. */
4317 if (!STRINGP (it
->string
))
4318 object
= it
->w
->buffer
;
4320 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4322 FRAME_WINDOW_P (it
->f
));
4324 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4327 /* Subroutine of handle_display_prop. Returns non-zero if the display
4328 specification in SPEC is a replacing specification, i.e. it would
4329 replace the text covered by `display' property with something else,
4330 such as an image or a display string. If SPEC includes any kind or
4331 `(space ...) specification, the value is 2; this is used by
4332 compute_display_string_pos, which see.
4334 See handle_single_display_spec for documentation of arguments.
4335 frame_window_p is non-zero if the window being redisplayed is on a
4336 GUI frame; this argument is used only if IT is NULL, see below.
4338 IT can be NULL, if this is called by the bidi reordering code
4339 through compute_display_string_pos, which see. In that case, this
4340 function only examines SPEC, but does not otherwise "handle" it, in
4341 the sense that it doesn't set up members of IT from the display
4344 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4345 Lisp_Object overlay
, struct text_pos
*position
,
4346 EMACS_INT bufpos
, int frame_window_p
)
4348 int replacing_p
= 0;
4352 /* Simple specifications. */
4353 && !EQ (XCAR (spec
), Qimage
)
4354 #ifdef HAVE_XWIDGETS
4355 && !EQ (XCAR (spec
), Qxwidget
)
4357 && !EQ (XCAR (spec
), Qspace
)
4358 && !EQ (XCAR (spec
), Qwhen
)
4359 && !EQ (XCAR (spec
), Qslice
)
4360 && !EQ (XCAR (spec
), Qspace_width
)
4361 && !EQ (XCAR (spec
), Qheight
)
4362 && !EQ (XCAR (spec
), Qraise
)
4363 /* Marginal area specifications. */
4364 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4365 && !EQ (XCAR (spec
), Qleft_fringe
)
4366 && !EQ (XCAR (spec
), Qright_fringe
)
4367 && !NILP (XCAR (spec
)))
4369 for (; CONSP (spec
); spec
= XCDR (spec
))
4371 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4372 overlay
, position
, bufpos
,
4373 replacing_p
, frame_window_p
)))
4376 /* If some text in a string is replaced, `position' no
4377 longer points to the position of `object'. */
4378 if (!it
|| STRINGP (object
))
4383 else if (VECTORP (spec
))
4386 for (i
= 0; i
< ASIZE (spec
); ++i
)
4387 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4388 overlay
, position
, bufpos
,
4389 replacing_p
, frame_window_p
)))
4392 /* If some text in a string is replaced, `position' no
4393 longer points to the position of `object'. */
4394 if (!it
|| STRINGP (object
))
4400 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4401 position
, bufpos
, 0,
4409 /* Value is the position of the end of the `display' property starting
4410 at START_POS in OBJECT. */
4412 static struct text_pos
4413 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4416 struct text_pos end_pos
;
4418 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4419 Qdisplay
, object
, Qnil
);
4420 CHARPOS (end_pos
) = XFASTINT (end
);
4421 if (STRINGP (object
))
4422 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4424 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4430 /* Set up IT from a single `display' property specification SPEC. OBJECT
4431 is the object in which the `display' property was found. *POSITION
4432 is the position in OBJECT at which the `display' property was found.
4433 BUFPOS is the buffer position of OBJECT (different from POSITION if
4434 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4435 previously saw a display specification which already replaced text
4436 display with something else, for example an image; we ignore such
4437 properties after the first one has been processed.
4439 OVERLAY is the overlay this `display' property came from,
4440 or nil if it was a text property.
4442 If SPEC is a `space' or `image' specification, and in some other
4443 cases too, set *POSITION to the position where the `display'
4446 If IT is NULL, only examine the property specification in SPEC, but
4447 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4448 is intended to be displayed in a window on a GUI frame.
4450 Value is non-zero if something was found which replaces the display
4451 of buffer or string text. */
4454 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4455 Lisp_Object overlay
, struct text_pos
*position
,
4456 EMACS_INT bufpos
, int display_replaced_p
,
4460 Lisp_Object location
, value
;
4461 struct text_pos start_pos
= *position
;
4464 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4465 If the result is non-nil, use VALUE instead of SPEC. */
4467 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4476 if (!NILP (form
) && !EQ (form
, Qt
))
4478 int count
= SPECPDL_INDEX ();
4479 struct gcpro gcpro1
;
4481 /* Bind `object' to the object having the `display' property, a
4482 buffer or string. Bind `position' to the position in the
4483 object where the property was found, and `buffer-position'
4484 to the current position in the buffer. */
4487 XSETBUFFER (object
, current_buffer
);
4488 specbind (Qobject
, object
);
4489 specbind (Qposition
, make_number (CHARPOS (*position
)));
4490 specbind (Qbuffer_position
, make_number (bufpos
));
4492 form
= safe_eval (form
);
4494 unbind_to (count
, Qnil
);
4500 /* Handle `(height HEIGHT)' specifications. */
4502 && EQ (XCAR (spec
), Qheight
)
4503 && CONSP (XCDR (spec
)))
4507 if (!FRAME_WINDOW_P (it
->f
))
4510 it
->font_height
= XCAR (XCDR (spec
));
4511 if (!NILP (it
->font_height
))
4513 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4514 int new_height
= -1;
4516 if (CONSP (it
->font_height
)
4517 && (EQ (XCAR (it
->font_height
), Qplus
)
4518 || EQ (XCAR (it
->font_height
), Qminus
))
4519 && CONSP (XCDR (it
->font_height
))
4520 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4522 /* `(+ N)' or `(- N)' where N is an integer. */
4523 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4524 if (EQ (XCAR (it
->font_height
), Qplus
))
4526 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4528 else if (FUNCTIONP (it
->font_height
))
4530 /* Call function with current height as argument.
4531 Value is the new height. */
4533 height
= safe_call1 (it
->font_height
,
4534 face
->lface
[LFACE_HEIGHT_INDEX
]);
4535 if (NUMBERP (height
))
4536 new_height
= XFLOATINT (height
);
4538 else if (NUMBERP (it
->font_height
))
4540 /* Value is a multiple of the canonical char height. */
4543 f
= FACE_FROM_ID (it
->f
,
4544 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4545 new_height
= (XFLOATINT (it
->font_height
)
4546 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4550 /* Evaluate IT->font_height with `height' bound to the
4551 current specified height to get the new height. */
4552 int count
= SPECPDL_INDEX ();
4554 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4555 value
= safe_eval (it
->font_height
);
4556 unbind_to (count
, Qnil
);
4558 if (NUMBERP (value
))
4559 new_height
= XFLOATINT (value
);
4563 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4570 /* Handle `(space-width WIDTH)'. */
4572 && EQ (XCAR (spec
), Qspace_width
)
4573 && CONSP (XCDR (spec
)))
4577 if (!FRAME_WINDOW_P (it
->f
))
4580 value
= XCAR (XCDR (spec
));
4581 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4582 it
->space_width
= value
;
4588 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4590 && EQ (XCAR (spec
), Qslice
))
4596 if (!FRAME_WINDOW_P (it
->f
))
4599 if (tem
= XCDR (spec
), CONSP (tem
))
4601 it
->slice
.x
= XCAR (tem
);
4602 if (tem
= XCDR (tem
), CONSP (tem
))
4604 it
->slice
.y
= XCAR (tem
);
4605 if (tem
= XCDR (tem
), CONSP (tem
))
4607 it
->slice
.width
= XCAR (tem
);
4608 if (tem
= XCDR (tem
), CONSP (tem
))
4609 it
->slice
.height
= XCAR (tem
);
4618 /* Handle `(raise FACTOR)'. */
4620 && EQ (XCAR (spec
), Qraise
)
4621 && CONSP (XCDR (spec
)))
4625 if (!FRAME_WINDOW_P (it
->f
))
4628 #ifdef HAVE_WINDOW_SYSTEM
4629 value
= XCAR (XCDR (spec
));
4630 if (NUMBERP (value
))
4632 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4633 it
->voffset
= - (XFLOATINT (value
)
4634 * (FONT_HEIGHT (face
->font
)));
4636 #endif /* HAVE_WINDOW_SYSTEM */
4642 /* Don't handle the other kinds of display specifications
4643 inside a string that we got from a `display' property. */
4644 if (it
&& it
->string_from_display_prop_p
)
4647 /* Characters having this form of property are not displayed, so
4648 we have to find the end of the property. */
4651 start_pos
= *position
;
4652 *position
= display_prop_end (it
, object
, start_pos
);
4656 /* Stop the scan at that end position--we assume that all
4657 text properties change there. */
4659 it
->stop_charpos
= position
->charpos
;
4661 /* Handle `(left-fringe BITMAP [FACE])'
4662 and `(right-fringe BITMAP [FACE])'. */
4664 && (EQ (XCAR (spec
), Qleft_fringe
)
4665 || EQ (XCAR (spec
), Qright_fringe
))
4666 && CONSP (XCDR (spec
)))
4672 if (!FRAME_WINDOW_P (it
->f
))
4673 /* If we return here, POSITION has been advanced
4674 across the text with this property. */
4677 else if (!frame_window_p
)
4680 #ifdef HAVE_WINDOW_SYSTEM
4681 value
= XCAR (XCDR (spec
));
4682 if (!SYMBOLP (value
)
4683 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4684 /* If we return here, POSITION has been advanced
4685 across the text with this property. */
4690 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4692 if (CONSP (XCDR (XCDR (spec
))))
4694 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4695 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4701 /* Save current settings of IT so that we can restore them
4702 when we are finished with the glyph property value. */
4703 push_it (it
, position
);
4705 it
->area
= TEXT_AREA
;
4706 it
->what
= IT_IMAGE
;
4707 it
->image_id
= -1; /* no image */
4708 it
->position
= start_pos
;
4709 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4710 it
->method
= GET_FROM_IMAGE
;
4711 it
->from_overlay
= Qnil
;
4712 it
->face_id
= face_id
;
4713 it
->from_disp_prop_p
= 1;
4715 /* Say that we haven't consumed the characters with
4716 `display' property yet. The call to pop_it in
4717 set_iterator_to_next will clean this up. */
4718 *position
= start_pos
;
4720 if (EQ (XCAR (spec
), Qleft_fringe
))
4722 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4723 it
->left_user_fringe_face_id
= face_id
;
4727 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4728 it
->right_user_fringe_face_id
= face_id
;
4731 #endif /* HAVE_WINDOW_SYSTEM */
4735 /* Prepare to handle `((margin left-margin) ...)',
4736 `((margin right-margin) ...)' and `((margin nil) ...)'
4737 prefixes for display specifications. */
4738 location
= Qunbound
;
4739 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4743 value
= XCDR (spec
);
4745 value
= XCAR (value
);
4748 if (EQ (XCAR (tem
), Qmargin
)
4749 && (tem
= XCDR (tem
),
4750 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4752 || EQ (tem
, Qleft_margin
)
4753 || EQ (tem
, Qright_margin
))))
4757 if (EQ (location
, Qunbound
))
4763 /* After this point, VALUE is the property after any
4764 margin prefix has been stripped. It must be a string,
4765 an image specification, or `(space ...)'.
4767 LOCATION specifies where to display: `left-margin',
4768 `right-margin' or nil. */
4770 valid_p
= (STRINGP (value
)
4771 #ifdef HAVE_WINDOW_SYSTEM
4772 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4773 && valid_image_p (value
))
4774 #endif /* not HAVE_WINDOW_SYSTEM */
4775 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4776 #ifdef HAVE_XWIDGETS
4781 if (valid_p
&& !display_replaced_p
)
4787 /* Callers need to know whether the display spec is any kind
4788 of `(space ...)' spec that is about to affect text-area
4790 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4795 /* Save current settings of IT so that we can restore them
4796 when we are finished with the glyph property value. */
4797 push_it (it
, position
);
4798 it
->from_overlay
= overlay
;
4799 it
->from_disp_prop_p
= 1;
4801 if (NILP (location
))
4802 it
->area
= TEXT_AREA
;
4803 else if (EQ (location
, Qleft_margin
))
4804 it
->area
= LEFT_MARGIN_AREA
;
4806 it
->area
= RIGHT_MARGIN_AREA
;
4808 if (STRINGP (value
))
4811 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4812 it
->current
.overlay_string_index
= -1;
4813 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4814 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4815 it
->method
= GET_FROM_STRING
;
4816 it
->stop_charpos
= 0;
4818 it
->base_level_stop
= 0;
4819 it
->string_from_display_prop_p
= 1;
4820 /* Say that we haven't consumed the characters with
4821 `display' property yet. The call to pop_it in
4822 set_iterator_to_next will clean this up. */
4823 if (BUFFERP (object
))
4824 *position
= start_pos
;
4826 /* Force paragraph direction to be that of the parent
4827 object. If the parent object's paragraph direction is
4828 not yet determined, default to L2R. */
4829 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4830 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4832 it
->paragraph_embedding
= L2R
;
4834 /* Set up the bidi iterator for this display string. */
4837 it
->bidi_it
.string
.lstring
= it
->string
;
4838 it
->bidi_it
.string
.s
= NULL
;
4839 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4840 it
->bidi_it
.string
.bufpos
= bufpos
;
4841 it
->bidi_it
.string
.from_disp_str
= 1;
4842 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4843 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4846 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4848 it
->method
= GET_FROM_STRETCH
;
4850 *position
= it
->position
= start_pos
;
4851 retval
= 1 + (it
->area
== TEXT_AREA
);
4853 #ifdef HAVE_XWIDGETS
4854 else if (XWIDGETP(value
))
4856 //printf("handle_single_display_spec: im an xwidget!!\n");
4857 it
->what
= IT_XWIDGET
;
4858 it
->method
= GET_FROM_XWIDGET
;
4859 it
->position
= start_pos
;
4860 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4861 *position
= start_pos
;
4863 it
->xwidget
= lookup_xwidget(value
);
4866 #ifdef HAVE_WINDOW_SYSTEM
4869 it
->what
= IT_IMAGE
;
4870 it
->image_id
= lookup_image (it
->f
, value
);
4871 it
->position
= start_pos
;
4872 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4873 it
->method
= GET_FROM_IMAGE
;
4875 /* Say that we haven't consumed the characters with
4876 `display' property yet. The call to pop_it in
4877 set_iterator_to_next will clean this up. */
4878 *position
= start_pos
;
4880 #endif /* HAVE_WINDOW_SYSTEM */
4885 /* Invalid property or property not supported. Restore
4886 POSITION to what it was before. */
4887 *position
= start_pos
;
4891 /* Check if PROP is a display property value whose text should be
4892 treated as intangible. OVERLAY is the overlay from which PROP
4893 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4894 specify the buffer position covered by PROP. */
4897 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4898 EMACS_INT charpos
, EMACS_INT bytepos
)
4900 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4901 struct text_pos position
;
4903 SET_TEXT_POS (position
, charpos
, bytepos
);
4904 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4905 &position
, charpos
, frame_window_p
);
4909 /* Return 1 if PROP is a display sub-property value containing STRING.
4911 Implementation note: this and the following function are really
4912 special cases of handle_display_spec and
4913 handle_single_display_spec, and should ideally use the same code.
4914 Until they do, these two pairs must be consistent and must be
4915 modified in sync. */
4918 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4920 if (EQ (string
, prop
))
4923 /* Skip over `when FORM'. */
4924 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4929 /* Actually, the condition following `when' should be eval'ed,
4930 like handle_single_display_spec does, and we should return
4931 zero if it evaluates to nil. However, this function is
4932 called only when the buffer was already displayed and some
4933 glyph in the glyph matrix was found to come from a display
4934 string. Therefore, the condition was already evaluated, and
4935 the result was non-nil, otherwise the display string wouldn't
4936 have been displayed and we would have never been called for
4937 this property. Thus, we can skip the evaluation and assume
4938 its result is non-nil. */
4943 /* Skip over `margin LOCATION'. */
4944 if (EQ (XCAR (prop
), Qmargin
))
4955 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4959 /* Return 1 if STRING appears in the `display' property PROP. */
4962 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4965 && !EQ (XCAR (prop
), Qwhen
)
4966 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4968 /* A list of sub-properties. */
4969 while (CONSP (prop
))
4971 if (single_display_spec_string_p (XCAR (prop
), string
))
4976 else if (VECTORP (prop
))
4978 /* A vector of sub-properties. */
4980 for (i
= 0; i
< ASIZE (prop
); ++i
)
4981 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4985 return single_display_spec_string_p (prop
, string
);
4990 /* Look for STRING in overlays and text properties in the current
4991 buffer, between character positions FROM and TO (excluding TO).
4992 BACK_P non-zero means look back (in this case, TO is supposed to be
4994 Value is the first character position where STRING was found, or
4995 zero if it wasn't found before hitting TO.
4997 This function may only use code that doesn't eval because it is
4998 called asynchronously from note_mouse_highlight. */
5001 string_buffer_position_lim (Lisp_Object string
,
5002 EMACS_INT from
, EMACS_INT to
, int back_p
)
5004 Lisp_Object limit
, prop
, pos
;
5007 pos
= make_number (from
);
5009 if (!back_p
) /* looking forward */
5011 limit
= make_number (min (to
, ZV
));
5012 while (!found
&& !EQ (pos
, limit
))
5014 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5015 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5018 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5022 else /* looking back */
5024 limit
= make_number (max (to
, BEGV
));
5025 while (!found
&& !EQ (pos
, limit
))
5027 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5028 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5031 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5036 return found
? XINT (pos
) : 0;
5039 /* Determine which buffer position in current buffer STRING comes from.
5040 AROUND_CHARPOS is an approximate position where it could come from.
5041 Value is the buffer position or 0 if it couldn't be determined.
5043 This function is necessary because we don't record buffer positions
5044 in glyphs generated from strings (to keep struct glyph small).
5045 This function may only use code that doesn't eval because it is
5046 called asynchronously from note_mouse_highlight. */
5049 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5051 const int MAX_DISTANCE
= 1000;
5052 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5053 around_charpos
+ MAX_DISTANCE
,
5057 found
= string_buffer_position_lim (string
, around_charpos
,
5058 around_charpos
- MAX_DISTANCE
, 1);
5064 /***********************************************************************
5065 `composition' property
5066 ***********************************************************************/
5068 /* Set up iterator IT from `composition' property at its current
5069 position. Called from handle_stop. */
5071 static enum prop_handled
5072 handle_composition_prop (struct it
*it
)
5074 Lisp_Object prop
, string
;
5075 EMACS_INT pos
, pos_byte
, start
, end
;
5077 if (STRINGP (it
->string
))
5081 pos
= IT_STRING_CHARPOS (*it
);
5082 pos_byte
= IT_STRING_BYTEPOS (*it
);
5083 string
= it
->string
;
5084 s
= SDATA (string
) + pos_byte
;
5085 it
->c
= STRING_CHAR (s
);
5089 pos
= IT_CHARPOS (*it
);
5090 pos_byte
= IT_BYTEPOS (*it
);
5092 it
->c
= FETCH_CHAR (pos_byte
);
5095 /* If there's a valid composition and point is not inside of the
5096 composition (in the case that the composition is from the current
5097 buffer), draw a glyph composed from the composition components. */
5098 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5099 && COMPOSITION_VALID_P (start
, end
, prop
)
5100 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5103 /* As we can't handle this situation (perhaps font-lock added
5104 a new composition), we just return here hoping that next
5105 redisplay will detect this composition much earlier. */
5106 return HANDLED_NORMALLY
;
5109 if (STRINGP (it
->string
))
5110 pos_byte
= string_char_to_byte (it
->string
, start
);
5112 pos_byte
= CHAR_TO_BYTE (start
);
5114 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5117 if (it
->cmp_it
.id
>= 0)
5120 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5121 it
->cmp_it
.nglyphs
= -1;
5125 return HANDLED_NORMALLY
;
5130 /***********************************************************************
5132 ***********************************************************************/
5134 /* The following structure is used to record overlay strings for
5135 later sorting in load_overlay_strings. */
5137 struct overlay_entry
5139 Lisp_Object overlay
;
5146 /* Set up iterator IT from overlay strings at its current position.
5147 Called from handle_stop. */
5149 static enum prop_handled
5150 handle_overlay_change (struct it
*it
)
5152 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5153 return HANDLED_RECOMPUTE_PROPS
;
5155 return HANDLED_NORMALLY
;
5159 /* Set up the next overlay string for delivery by IT, if there is an
5160 overlay string to deliver. Called by set_iterator_to_next when the
5161 end of the current overlay string is reached. If there are more
5162 overlay strings to display, IT->string and
5163 IT->current.overlay_string_index are set appropriately here.
5164 Otherwise IT->string is set to nil. */
5167 next_overlay_string (struct it
*it
)
5169 ++it
->current
.overlay_string_index
;
5170 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5172 /* No more overlay strings. Restore IT's settings to what
5173 they were before overlay strings were processed, and
5174 continue to deliver from current_buffer. */
5176 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5179 || (NILP (it
->string
)
5180 && it
->method
== GET_FROM_BUFFER
5181 && it
->stop_charpos
>= BEGV
5182 && it
->stop_charpos
<= it
->end_charpos
));
5183 it
->current
.overlay_string_index
= -1;
5184 it
->n_overlay_strings
= 0;
5185 it
->overlay_strings_charpos
= -1;
5186 /* If there's an empty display string on the stack, pop the
5187 stack, to resync the bidi iterator with IT's position. Such
5188 empty strings are pushed onto the stack in
5189 get_overlay_strings_1. */
5190 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5193 /* If we're at the end of the buffer, record that we have
5194 processed the overlay strings there already, so that
5195 next_element_from_buffer doesn't try it again. */
5196 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5197 it
->overlay_strings_at_end_processed_p
= 1;
5201 /* There are more overlay strings to process. If
5202 IT->current.overlay_string_index has advanced to a position
5203 where we must load IT->overlay_strings with more strings, do
5204 it. We must load at the IT->overlay_strings_charpos where
5205 IT->n_overlay_strings was originally computed; when invisible
5206 text is present, this might not be IT_CHARPOS (Bug#7016). */
5207 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5209 if (it
->current
.overlay_string_index
&& i
== 0)
5210 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5212 /* Initialize IT to deliver display elements from the overlay
5214 it
->string
= it
->overlay_strings
[i
];
5215 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5216 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5217 it
->method
= GET_FROM_STRING
;
5218 it
->stop_charpos
= 0;
5219 if (it
->cmp_it
.stop_pos
>= 0)
5220 it
->cmp_it
.stop_pos
= 0;
5222 it
->base_level_stop
= 0;
5224 /* Set up the bidi iterator for this overlay string. */
5227 it
->bidi_it
.string
.lstring
= it
->string
;
5228 it
->bidi_it
.string
.s
= NULL
;
5229 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5230 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5231 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5232 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5233 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5241 /* Compare two overlay_entry structures E1 and E2. Used as a
5242 comparison function for qsort in load_overlay_strings. Overlay
5243 strings for the same position are sorted so that
5245 1. All after-strings come in front of before-strings, except
5246 when they come from the same overlay.
5248 2. Within after-strings, strings are sorted so that overlay strings
5249 from overlays with higher priorities come first.
5251 2. Within before-strings, strings are sorted so that overlay
5252 strings from overlays with higher priorities come last.
5254 Value is analogous to strcmp. */
5258 compare_overlay_entries (const void *e1
, const void *e2
)
5260 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5261 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5264 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5266 /* Let after-strings appear in front of before-strings if
5267 they come from different overlays. */
5268 if (EQ (entry1
->overlay
, entry2
->overlay
))
5269 result
= entry1
->after_string_p
? 1 : -1;
5271 result
= entry1
->after_string_p
? -1 : 1;
5273 else if (entry1
->after_string_p
)
5274 /* After-strings sorted in order of decreasing priority. */
5275 result
= entry2
->priority
- entry1
->priority
;
5277 /* Before-strings sorted in order of increasing priority. */
5278 result
= entry1
->priority
- entry2
->priority
;
5284 /* Load the vector IT->overlay_strings with overlay strings from IT's
5285 current buffer position, or from CHARPOS if that is > 0. Set
5286 IT->n_overlays to the total number of overlay strings found.
5288 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5289 a time. On entry into load_overlay_strings,
5290 IT->current.overlay_string_index gives the number of overlay
5291 strings that have already been loaded by previous calls to this
5294 IT->add_overlay_start contains an additional overlay start
5295 position to consider for taking overlay strings from, if non-zero.
5296 This position comes into play when the overlay has an `invisible'
5297 property, and both before and after-strings. When we've skipped to
5298 the end of the overlay, because of its `invisible' property, we
5299 nevertheless want its before-string to appear.
5300 IT->add_overlay_start will contain the overlay start position
5303 Overlay strings are sorted so that after-string strings come in
5304 front of before-string strings. Within before and after-strings,
5305 strings are sorted by overlay priority. See also function
5306 compare_overlay_entries. */
5309 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5311 Lisp_Object overlay
, window
, str
, invisible
;
5312 struct Lisp_Overlay
*ov
;
5313 EMACS_INT start
, end
;
5315 int n
= 0, i
, j
, invis_p
;
5316 struct overlay_entry
*entries
5317 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5320 charpos
= IT_CHARPOS (*it
);
5322 /* Append the overlay string STRING of overlay OVERLAY to vector
5323 `entries' which has size `size' and currently contains `n'
5324 elements. AFTER_P non-zero means STRING is an after-string of
5326 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5329 Lisp_Object priority; \
5333 int new_size = 2 * size; \
5334 struct overlay_entry *old = entries; \
5336 (struct overlay_entry *) alloca (new_size \
5337 * sizeof *entries); \
5338 memcpy (entries, old, size * sizeof *entries); \
5342 entries[n].string = (STRING); \
5343 entries[n].overlay = (OVERLAY); \
5344 priority = Foverlay_get ((OVERLAY), Qpriority); \
5345 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5346 entries[n].after_string_p = (AFTER_P); \
5351 /* Process overlay before the overlay center. */
5352 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5354 XSETMISC (overlay
, ov
);
5355 xassert (OVERLAYP (overlay
));
5356 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5357 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5362 /* Skip this overlay if it doesn't start or end at IT's current
5364 if (end
!= charpos
&& start
!= charpos
)
5367 /* Skip this overlay if it doesn't apply to IT->w. */
5368 window
= Foverlay_get (overlay
, Qwindow
);
5369 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5372 /* If the text ``under'' the overlay is invisible, both before-
5373 and after-strings from this overlay are visible; start and
5374 end position are indistinguishable. */
5375 invisible
= Foverlay_get (overlay
, Qinvisible
);
5376 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5378 /* If overlay has a non-empty before-string, record it. */
5379 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5380 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5382 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5384 /* If overlay has a non-empty after-string, record it. */
5385 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5386 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5388 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5391 /* Process overlays after the overlay center. */
5392 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5394 XSETMISC (overlay
, ov
);
5395 xassert (OVERLAYP (overlay
));
5396 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5397 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5399 if (start
> charpos
)
5402 /* Skip this overlay if it doesn't start or end at IT's current
5404 if (end
!= charpos
&& start
!= charpos
)
5407 /* Skip this overlay if it doesn't apply to IT->w. */
5408 window
= Foverlay_get (overlay
, Qwindow
);
5409 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5412 /* If the text ``under'' the overlay is invisible, it has a zero
5413 dimension, and both before- and after-strings apply. */
5414 invisible
= Foverlay_get (overlay
, Qinvisible
);
5415 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5417 /* If overlay has a non-empty before-string, record it. */
5418 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5419 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5421 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5423 /* If overlay has a non-empty after-string, record it. */
5424 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5425 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5427 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5430 #undef RECORD_OVERLAY_STRING
5434 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5436 /* Record number of overlay strings, and where we computed it. */
5437 it
->n_overlay_strings
= n
;
5438 it
->overlay_strings_charpos
= charpos
;
5440 /* IT->current.overlay_string_index is the number of overlay strings
5441 that have already been consumed by IT. Copy some of the
5442 remaining overlay strings to IT->overlay_strings. */
5444 j
= it
->current
.overlay_string_index
;
5445 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5447 it
->overlay_strings
[i
] = entries
[j
].string
;
5448 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5455 /* Get the first chunk of overlay strings at IT's current buffer
5456 position, or at CHARPOS if that is > 0. Value is non-zero if at
5457 least one overlay string was found. */
5460 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5462 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5463 process. This fills IT->overlay_strings with strings, and sets
5464 IT->n_overlay_strings to the total number of strings to process.
5465 IT->pos.overlay_string_index has to be set temporarily to zero
5466 because load_overlay_strings needs this; it must be set to -1
5467 when no overlay strings are found because a zero value would
5468 indicate a position in the first overlay string. */
5469 it
->current
.overlay_string_index
= 0;
5470 load_overlay_strings (it
, charpos
);
5472 /* If we found overlay strings, set up IT to deliver display
5473 elements from the first one. Otherwise set up IT to deliver
5474 from current_buffer. */
5475 if (it
->n_overlay_strings
)
5477 /* Make sure we know settings in current_buffer, so that we can
5478 restore meaningful values when we're done with the overlay
5481 compute_stop_pos (it
);
5482 xassert (it
->face_id
>= 0);
5484 /* Save IT's settings. They are restored after all overlay
5485 strings have been processed. */
5486 xassert (!compute_stop_p
|| it
->sp
== 0);
5488 /* When called from handle_stop, there might be an empty display
5489 string loaded. In that case, don't bother saving it. But
5490 don't use this optimization with the bidi iterator, since we
5491 need the corresponding pop_it call to resync the bidi
5492 iterator's position with IT's position, after we are done
5493 with the overlay strings. (The corresponding call to pop_it
5494 in case of an empty display string is in
5495 next_overlay_string.) */
5497 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5500 /* Set up IT to deliver display elements from the first overlay
5502 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5503 it
->string
= it
->overlay_strings
[0];
5504 it
->from_overlay
= Qnil
;
5505 it
->stop_charpos
= 0;
5506 xassert (STRINGP (it
->string
));
5507 it
->end_charpos
= SCHARS (it
->string
);
5509 it
->base_level_stop
= 0;
5510 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5511 it
->method
= GET_FROM_STRING
;
5512 it
->from_disp_prop_p
= 0;
5514 /* Force paragraph direction to be that of the parent
5516 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5517 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5519 it
->paragraph_embedding
= L2R
;
5521 /* Set up the bidi iterator for this overlay string. */
5524 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5526 it
->bidi_it
.string
.lstring
= it
->string
;
5527 it
->bidi_it
.string
.s
= NULL
;
5528 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5529 it
->bidi_it
.string
.bufpos
= pos
;
5530 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5531 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5532 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5537 it
->current
.overlay_string_index
= -1;
5542 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5545 it
->method
= GET_FROM_BUFFER
;
5547 (void) get_overlay_strings_1 (it
, charpos
, 1);
5551 /* Value is non-zero if we found at least one overlay string. */
5552 return STRINGP (it
->string
);
5557 /***********************************************************************
5558 Saving and restoring state
5559 ***********************************************************************/
5561 /* Save current settings of IT on IT->stack. Called, for example,
5562 before setting up IT for an overlay string, to be able to restore
5563 IT's settings to what they were after the overlay string has been
5564 processed. If POSITION is non-NULL, it is the position to save on
5565 the stack instead of IT->position. */
5568 push_it (struct it
*it
, struct text_pos
*position
)
5570 struct iterator_stack_entry
*p
;
5572 xassert (it
->sp
< IT_STACK_SIZE
);
5573 p
= it
->stack
+ it
->sp
;
5575 p
->stop_charpos
= it
->stop_charpos
;
5576 p
->prev_stop
= it
->prev_stop
;
5577 p
->base_level_stop
= it
->base_level_stop
;
5578 p
->cmp_it
= it
->cmp_it
;
5579 xassert (it
->face_id
>= 0);
5580 p
->face_id
= it
->face_id
;
5581 p
->string
= it
->string
;
5582 p
->method
= it
->method
;
5583 p
->from_overlay
= it
->from_overlay
;
5586 case GET_FROM_IMAGE
:
5587 p
->u
.image
.object
= it
->object
;
5588 p
->u
.image
.image_id
= it
->image_id
;
5589 p
->u
.image
.slice
= it
->slice
;
5591 case GET_FROM_STRETCH
:
5592 p
->u
.stretch
.object
= it
->object
;
5594 #ifdef HAVE_XWIDGETS
5595 case GET_FROM_XWIDGET
:
5596 p
->u
.xwidget
.object
= it
->object
;
5600 p
->position
= position
? *position
: it
->position
;
5601 p
->current
= it
->current
;
5602 p
->end_charpos
= it
->end_charpos
;
5603 p
->string_nchars
= it
->string_nchars
;
5605 p
->multibyte_p
= it
->multibyte_p
;
5606 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5607 p
->space_width
= it
->space_width
;
5608 p
->font_height
= it
->font_height
;
5609 p
->voffset
= it
->voffset
;
5610 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5611 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5612 p
->display_ellipsis_p
= 0;
5613 p
->line_wrap
= it
->line_wrap
;
5614 p
->bidi_p
= it
->bidi_p
;
5615 p
->paragraph_embedding
= it
->paragraph_embedding
;
5616 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5619 /* Save the state of the bidi iterator as well. */
5621 bidi_push_it (&it
->bidi_it
);
5625 iterate_out_of_display_property (struct it
*it
)
5627 int buffer_p
= BUFFERP (it
->object
);
5628 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5629 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5631 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5633 /* Maybe initialize paragraph direction. If we are at the beginning
5634 of a new paragraph, next_element_from_buffer may not have a
5635 chance to do that. */
5636 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5637 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5638 /* prev_stop can be zero, so check against BEGV as well. */
5639 while (it
->bidi_it
.charpos
>= bob
5640 && it
->prev_stop
<= it
->bidi_it
.charpos
5641 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5642 && it
->bidi_it
.charpos
< eob
)
5643 bidi_move_to_visually_next (&it
->bidi_it
);
5644 /* Record the stop_pos we just crossed, for when we cross it
5646 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5647 it
->prev_stop
= CHARPOS (it
->position
);
5648 /* If we ended up not where pop_it put us, resync IT's
5649 positional members with the bidi iterator. */
5650 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5651 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5653 it
->current
.pos
= it
->position
;
5655 it
->current
.string_pos
= it
->position
;
5658 /* Restore IT's settings from IT->stack. Called, for example, when no
5659 more overlay strings must be processed, and we return to delivering
5660 display elements from a buffer, or when the end of a string from a
5661 `display' property is reached and we return to delivering display
5662 elements from an overlay string, or from a buffer. */
5665 pop_it (struct it
*it
)
5667 struct iterator_stack_entry
*p
;
5668 int from_display_prop
= it
->from_disp_prop_p
;
5670 xassert (it
->sp
> 0);
5672 p
= it
->stack
+ it
->sp
;
5673 it
->stop_charpos
= p
->stop_charpos
;
5674 it
->prev_stop
= p
->prev_stop
;
5675 it
->base_level_stop
= p
->base_level_stop
;
5676 it
->cmp_it
= p
->cmp_it
;
5677 it
->face_id
= p
->face_id
;
5678 it
->current
= p
->current
;
5679 it
->position
= p
->position
;
5680 it
->string
= p
->string
;
5681 it
->from_overlay
= p
->from_overlay
;
5682 if (NILP (it
->string
))
5683 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5684 it
->method
= p
->method
;
5687 case GET_FROM_IMAGE
:
5688 it
->image_id
= p
->u
.image
.image_id
;
5689 it
->object
= p
->u
.image
.object
;
5690 it
->slice
= p
->u
.image
.slice
;
5692 #ifdef HAVE_XWIDGETS
5693 case GET_FROM_XWIDGET
:
5694 it
->object
= p
->u
.xwidget
.object
;
5697 case GET_FROM_STRETCH
:
5698 it
->object
= p
->u
.stretch
.object
;
5700 case GET_FROM_BUFFER
:
5701 it
->object
= it
->w
->buffer
;
5703 case GET_FROM_STRING
:
5704 it
->object
= it
->string
;
5706 case GET_FROM_DISPLAY_VECTOR
:
5708 it
->method
= GET_FROM_C_STRING
;
5709 else if (STRINGP (it
->string
))
5710 it
->method
= GET_FROM_STRING
;
5713 it
->method
= GET_FROM_BUFFER
;
5714 it
->object
= it
->w
->buffer
;
5717 it
->end_charpos
= p
->end_charpos
;
5718 it
->string_nchars
= p
->string_nchars
;
5720 it
->multibyte_p
= p
->multibyte_p
;
5721 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5722 it
->space_width
= p
->space_width
;
5723 it
->font_height
= p
->font_height
;
5724 it
->voffset
= p
->voffset
;
5725 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5726 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5727 it
->line_wrap
= p
->line_wrap
;
5728 it
->bidi_p
= p
->bidi_p
;
5729 it
->paragraph_embedding
= p
->paragraph_embedding
;
5730 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5733 bidi_pop_it (&it
->bidi_it
);
5734 /* Bidi-iterate until we get out of the portion of text, if any,
5735 covered by a `display' text property or by an overlay with
5736 `display' property. (We cannot just jump there, because the
5737 internal coherency of the bidi iterator state can not be
5738 preserved across such jumps.) We also must determine the
5739 paragraph base direction if the overlay we just processed is
5740 at the beginning of a new paragraph. */
5741 if (from_display_prop
5742 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5743 iterate_out_of_display_property (it
);
5745 xassert ((BUFFERP (it
->object
)
5746 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5747 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5748 || (STRINGP (it
->object
)
5749 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5750 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5751 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5757 /***********************************************************************
5759 ***********************************************************************/
5761 /* Set IT's current position to the previous line start. */
5764 back_to_previous_line_start (struct it
*it
)
5766 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5767 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5771 /* Move IT to the next line start.
5773 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5774 we skipped over part of the text (as opposed to moving the iterator
5775 continuously over the text). Otherwise, don't change the value
5778 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5779 iterator on the newline, if it was found.
5781 Newlines may come from buffer text, overlay strings, or strings
5782 displayed via the `display' property. That's the reason we can't
5783 simply use find_next_newline_no_quit.
5785 Note that this function may not skip over invisible text that is so
5786 because of text properties and immediately follows a newline. If
5787 it would, function reseat_at_next_visible_line_start, when called
5788 from set_iterator_to_next, would effectively make invisible
5789 characters following a newline part of the wrong glyph row, which
5790 leads to wrong cursor motion. */
5793 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5794 struct bidi_it
*bidi_it_prev
)
5796 EMACS_INT old_selective
;
5797 int newline_found_p
, n
;
5798 const int MAX_NEWLINE_DISTANCE
= 500;
5800 /* If already on a newline, just consume it to avoid unintended
5801 skipping over invisible text below. */
5802 if (it
->what
== IT_CHARACTER
5804 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5806 if (it
->bidi_p
&& bidi_it_prev
)
5807 *bidi_it_prev
= it
->bidi_it
;
5808 set_iterator_to_next (it
, 0);
5813 /* Don't handle selective display in the following. It's (a)
5814 unnecessary because it's done by the caller, and (b) leads to an
5815 infinite recursion because next_element_from_ellipsis indirectly
5816 calls this function. */
5817 old_selective
= it
->selective
;
5820 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5821 from buffer text. */
5822 for (n
= newline_found_p
= 0;
5823 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5824 n
+= STRINGP (it
->string
) ? 0 : 1)
5826 if (!get_next_display_element (it
))
5828 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5829 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5830 *bidi_it_prev
= it
->bidi_it
;
5831 set_iterator_to_next (it
, 0);
5834 /* If we didn't find a newline near enough, see if we can use a
5836 if (!newline_found_p
)
5838 EMACS_INT start
= IT_CHARPOS (*it
);
5839 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5842 xassert (!STRINGP (it
->string
));
5844 /* If there isn't any `display' property in sight, and no
5845 overlays, we can just use the position of the newline in
5847 if (it
->stop_charpos
>= limit
5848 || ((pos
= Fnext_single_property_change (make_number (start
),
5850 make_number (limit
)),
5852 && next_overlay_change (start
) == ZV
))
5856 IT_CHARPOS (*it
) = limit
;
5857 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5861 struct bidi_it bprev
;
5863 /* Help bidi.c avoid expensive searches for display
5864 properties and overlays, by telling it that there are
5865 none up to `limit'. */
5866 if (it
->bidi_it
.disp_pos
< limit
)
5868 it
->bidi_it
.disp_pos
= limit
;
5869 it
->bidi_it
.disp_prop
= 0;
5872 bprev
= it
->bidi_it
;
5873 bidi_move_to_visually_next (&it
->bidi_it
);
5874 } while (it
->bidi_it
.charpos
!= limit
);
5875 IT_CHARPOS (*it
) = limit
;
5876 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5878 *bidi_it_prev
= bprev
;
5880 *skipped_p
= newline_found_p
= 1;
5884 while (get_next_display_element (it
)
5885 && !newline_found_p
)
5887 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5888 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5889 *bidi_it_prev
= it
->bidi_it
;
5890 set_iterator_to_next (it
, 0);
5895 it
->selective
= old_selective
;
5896 return newline_found_p
;
5900 /* Set IT's current position to the previous visible line start. Skip
5901 invisible text that is so either due to text properties or due to
5902 selective display. Caution: this does not change IT->current_x and
5906 back_to_previous_visible_line_start (struct it
*it
)
5908 while (IT_CHARPOS (*it
) > BEGV
)
5910 back_to_previous_line_start (it
);
5912 if (IT_CHARPOS (*it
) <= BEGV
)
5915 /* If selective > 0, then lines indented more than its value are
5917 if (it
->selective
> 0
5918 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5922 /* Check the newline before point for invisibility. */
5925 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5926 Qinvisible
, it
->window
);
5927 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5931 if (IT_CHARPOS (*it
) <= BEGV
)
5936 void *it2data
= NULL
;
5939 Lisp_Object val
, overlay
;
5941 SAVE_IT (it2
, *it
, it2data
);
5943 /* If newline is part of a composition, continue from start of composition */
5944 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5945 && beg
< IT_CHARPOS (*it
))
5948 /* If newline is replaced by a display property, find start of overlay
5949 or interval and continue search from that point. */
5950 pos
= --IT_CHARPOS (it2
);
5953 bidi_unshelve_cache (NULL
, 0);
5954 it2
.string_from_display_prop_p
= 0;
5955 it2
.from_disp_prop_p
= 0;
5956 if (handle_display_prop (&it2
) == HANDLED_RETURN
5957 && !NILP (val
= get_char_property_and_overlay
5958 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5959 && (OVERLAYP (overlay
)
5960 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5961 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5963 RESTORE_IT (it
, it
, it2data
);
5967 /* Newline is not replaced by anything -- so we are done. */
5968 RESTORE_IT (it
, it
, it2data
);
5974 IT_CHARPOS (*it
) = beg
;
5975 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5979 it
->continuation_lines_width
= 0;
5981 xassert (IT_CHARPOS (*it
) >= BEGV
);
5982 xassert (IT_CHARPOS (*it
) == BEGV
5983 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5988 /* Reseat iterator IT at the previous visible line start. Skip
5989 invisible text that is so either due to text properties or due to
5990 selective display. At the end, update IT's overlay information,
5991 face information etc. */
5994 reseat_at_previous_visible_line_start (struct it
*it
)
5996 back_to_previous_visible_line_start (it
);
5997 reseat (it
, it
->current
.pos
, 1);
6002 /* Reseat iterator IT on the next visible line start in the current
6003 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6004 preceding the line start. Skip over invisible text that is so
6005 because of selective display. Compute faces, overlays etc at the
6006 new position. Note that this function does not skip over text that
6007 is invisible because of text properties. */
6010 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6012 int newline_found_p
, skipped_p
= 0;
6013 struct bidi_it bidi_it_prev
;
6015 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6017 /* Skip over lines that are invisible because they are indented
6018 more than the value of IT->selective. */
6019 if (it
->selective
> 0)
6020 while (IT_CHARPOS (*it
) < ZV
6021 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6024 xassert (IT_BYTEPOS (*it
) == BEGV
6025 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6027 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6030 /* Position on the newline if that's what's requested. */
6031 if (on_newline_p
&& newline_found_p
)
6033 if (STRINGP (it
->string
))
6035 if (IT_STRING_CHARPOS (*it
) > 0)
6039 --IT_STRING_CHARPOS (*it
);
6040 --IT_STRING_BYTEPOS (*it
);
6044 /* We need to restore the bidi iterator to the state
6045 it had on the newline, and resync the IT's
6046 position with that. */
6047 it
->bidi_it
= bidi_it_prev
;
6048 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6049 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6053 else if (IT_CHARPOS (*it
) > BEGV
)
6062 /* We need to restore the bidi iterator to the state it
6063 had on the newline and resync IT with that. */
6064 it
->bidi_it
= bidi_it_prev
;
6065 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6066 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6068 reseat (it
, it
->current
.pos
, 0);
6072 reseat (it
, it
->current
.pos
, 0);
6079 /***********************************************************************
6080 Changing an iterator's position
6081 ***********************************************************************/
6083 /* Change IT's current position to POS in current_buffer. If FORCE_P
6084 is non-zero, always check for text properties at the new position.
6085 Otherwise, text properties are only looked up if POS >=
6086 IT->check_charpos of a property. */
6089 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6091 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6093 reseat_1 (it
, pos
, 0);
6095 /* Determine where to check text properties. Avoid doing it
6096 where possible because text property lookup is very expensive. */
6098 || CHARPOS (pos
) > it
->stop_charpos
6099 || CHARPOS (pos
) < original_pos
)
6103 /* For bidi iteration, we need to prime prev_stop and
6104 base_level_stop with our best estimations. */
6105 /* Implementation note: Of course, POS is not necessarily a
6106 stop position, so assigning prev_pos to it is a lie; we
6107 should have called compute_stop_backwards. However, if
6108 the current buffer does not include any R2L characters,
6109 that call would be a waste of cycles, because the
6110 iterator will never move back, and thus never cross this
6111 "fake" stop position. So we delay that backward search
6112 until the time we really need it, in next_element_from_buffer. */
6113 if (CHARPOS (pos
) != it
->prev_stop
)
6114 it
->prev_stop
= CHARPOS (pos
);
6115 if (CHARPOS (pos
) < it
->base_level_stop
)
6116 it
->base_level_stop
= 0; /* meaning it's unknown */
6122 it
->prev_stop
= it
->base_level_stop
= 0;
6131 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6132 IT->stop_pos to POS, also. */
6135 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6137 /* Don't call this function when scanning a C string. */
6138 xassert (it
->s
== NULL
);
6140 /* POS must be a reasonable value. */
6141 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6143 it
->current
.pos
= it
->position
= pos
;
6144 it
->end_charpos
= ZV
;
6146 it
->current
.dpvec_index
= -1;
6147 it
->current
.overlay_string_index
= -1;
6148 IT_STRING_CHARPOS (*it
) = -1;
6149 IT_STRING_BYTEPOS (*it
) = -1;
6151 it
->method
= GET_FROM_BUFFER
;
6152 it
->object
= it
->w
->buffer
;
6153 it
->area
= TEXT_AREA
;
6154 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6156 it
->string_from_display_prop_p
= 0;
6157 it
->string_from_prefix_prop_p
= 0;
6159 it
->from_disp_prop_p
= 0;
6160 it
->face_before_selective_p
= 0;
6163 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6165 bidi_unshelve_cache (NULL
, 0);
6166 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6167 it
->bidi_it
.string
.s
= NULL
;
6168 it
->bidi_it
.string
.lstring
= Qnil
;
6169 it
->bidi_it
.string
.bufpos
= 0;
6170 it
->bidi_it
.string
.unibyte
= 0;
6175 it
->stop_charpos
= CHARPOS (pos
);
6176 it
->base_level_stop
= CHARPOS (pos
);
6181 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6182 If S is non-null, it is a C string to iterate over. Otherwise,
6183 STRING gives a Lisp string to iterate over.
6185 If PRECISION > 0, don't return more then PRECISION number of
6186 characters from the string.
6188 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6189 characters have been returned. FIELD_WIDTH < 0 means an infinite
6192 MULTIBYTE = 0 means disable processing of multibyte characters,
6193 MULTIBYTE > 0 means enable it,
6194 MULTIBYTE < 0 means use IT->multibyte_p.
6196 IT must be initialized via a prior call to init_iterator before
6197 calling this function. */
6200 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6201 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6204 /* No region in strings. */
6205 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6207 /* No text property checks performed by default, but see below. */
6208 it
->stop_charpos
= -1;
6210 /* Set iterator position and end position. */
6211 memset (&it
->current
, 0, sizeof it
->current
);
6212 it
->current
.overlay_string_index
= -1;
6213 it
->current
.dpvec_index
= -1;
6214 xassert (charpos
>= 0);
6216 /* If STRING is specified, use its multibyteness, otherwise use the
6217 setting of MULTIBYTE, if specified. */
6219 it
->multibyte_p
= multibyte
> 0;
6221 /* Bidirectional reordering of strings is controlled by the default
6222 value of bidi-display-reordering. Don't try to reorder while
6223 loading loadup.el, as the necessary character property tables are
6224 not yet available. */
6227 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6231 xassert (STRINGP (string
));
6232 it
->string
= string
;
6234 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6235 it
->method
= GET_FROM_STRING
;
6236 it
->current
.string_pos
= string_pos (charpos
, string
);
6240 it
->bidi_it
.string
.lstring
= string
;
6241 it
->bidi_it
.string
.s
= NULL
;
6242 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6243 it
->bidi_it
.string
.bufpos
= 0;
6244 it
->bidi_it
.string
.from_disp_str
= 0;
6245 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6246 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6247 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6252 it
->s
= (const unsigned char *) s
;
6255 /* Note that we use IT->current.pos, not it->current.string_pos,
6256 for displaying C strings. */
6257 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6258 if (it
->multibyte_p
)
6260 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6261 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6265 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6266 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6271 it
->bidi_it
.string
.lstring
= Qnil
;
6272 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6273 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6274 it
->bidi_it
.string
.bufpos
= 0;
6275 it
->bidi_it
.string
.from_disp_str
= 0;
6276 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6277 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6280 it
->method
= GET_FROM_C_STRING
;
6283 /* PRECISION > 0 means don't return more than PRECISION characters
6285 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6287 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6289 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6292 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6293 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6294 FIELD_WIDTH < 0 means infinite field width. This is useful for
6295 padding with `-' at the end of a mode line. */
6296 if (field_width
< 0)
6297 field_width
= INFINITY
;
6298 /* Implementation note: We deliberately don't enlarge
6299 it->bidi_it.string.schars here to fit it->end_charpos, because
6300 the bidi iterator cannot produce characters out of thin air. */
6301 if (field_width
> it
->end_charpos
- charpos
)
6302 it
->end_charpos
= charpos
+ field_width
;
6304 /* Use the standard display table for displaying strings. */
6305 if (DISP_TABLE_P (Vstandard_display_table
))
6306 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6308 it
->stop_charpos
= charpos
;
6309 it
->prev_stop
= charpos
;
6310 it
->base_level_stop
= 0;
6313 it
->bidi_it
.first_elt
= 1;
6314 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6315 it
->bidi_it
.disp_pos
= -1;
6317 if (s
== NULL
&& it
->multibyte_p
)
6319 EMACS_INT endpos
= SCHARS (it
->string
);
6320 if (endpos
> it
->end_charpos
)
6321 endpos
= it
->end_charpos
;
6322 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6330 /***********************************************************************
6332 ***********************************************************************/
6334 /* Map enum it_method value to corresponding next_element_from_* function. */
6336 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6338 next_element_from_buffer
,
6339 next_element_from_display_vector
,
6340 next_element_from_string
,
6341 next_element_from_c_string
,
6342 next_element_from_image
,
6343 next_element_from_stretch
6344 #ifdef HAVE_XWIDGETS
6345 ,next_element_from_xwidget
6349 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6352 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6353 (possibly with the following characters). */
6355 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6356 ((IT)->cmp_it.id >= 0 \
6357 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6358 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6359 END_CHARPOS, (IT)->w, \
6360 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6364 /* Lookup the char-table Vglyphless_char_display for character C (-1
6365 if we want information for no-font case), and return the display
6366 method symbol. By side-effect, update it->what and
6367 it->glyphless_method. This function is called from
6368 get_next_display_element for each character element, and from
6369 x_produce_glyphs when no suitable font was found. */
6372 lookup_glyphless_char_display (int c
, struct it
*it
)
6374 Lisp_Object glyphless_method
= Qnil
;
6376 if (CHAR_TABLE_P (Vglyphless_char_display
)
6377 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6381 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6382 if (CONSP (glyphless_method
))
6383 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6384 ? XCAR (glyphless_method
)
6385 : XCDR (glyphless_method
);
6388 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6392 if (NILP (glyphless_method
))
6395 /* The default is to display the character by a proper font. */
6397 /* The default for the no-font case is to display an empty box. */
6398 glyphless_method
= Qempty_box
;
6400 if (EQ (glyphless_method
, Qzero_width
))
6403 return glyphless_method
;
6404 /* This method can't be used for the no-font case. */
6405 glyphless_method
= Qempty_box
;
6407 if (EQ (glyphless_method
, Qthin_space
))
6408 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6409 else if (EQ (glyphless_method
, Qempty_box
))
6410 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6411 else if (EQ (glyphless_method
, Qhex_code
))
6412 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6413 else if (STRINGP (glyphless_method
))
6414 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6417 /* Invalid value. We use the default method. */
6418 glyphless_method
= Qnil
;
6421 it
->what
= IT_GLYPHLESS
;
6422 return glyphless_method
;
6425 /* Load IT's display element fields with information about the next
6426 display element from the current position of IT. Value is zero if
6427 end of buffer (or C string) is reached. */
6429 static struct frame
*last_escape_glyph_frame
= NULL
;
6430 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6431 static int last_escape_glyph_merged_face_id
= 0;
6433 struct frame
*last_glyphless_glyph_frame
= NULL
;
6434 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6435 int last_glyphless_glyph_merged_face_id
= 0;
6438 get_next_display_element (struct it
*it
)
6440 /* Non-zero means that we found a display element. Zero means that
6441 we hit the end of what we iterate over. Performance note: the
6442 function pointer `method' used here turns out to be faster than
6443 using a sequence of if-statements. */
6447 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6449 if (it
->what
== IT_CHARACTER
)
6451 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6452 and only if (a) the resolved directionality of that character
6454 /* FIXME: Do we need an exception for characters from display
6456 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6457 it
->c
= bidi_mirror_char (it
->c
);
6458 /* Map via display table or translate control characters.
6459 IT->c, IT->len etc. have been set to the next character by
6460 the function call above. If we have a display table, and it
6461 contains an entry for IT->c, translate it. Don't do this if
6462 IT->c itself comes from a display table, otherwise we could
6463 end up in an infinite recursion. (An alternative could be to
6464 count the recursion depth of this function and signal an
6465 error when a certain maximum depth is reached.) Is it worth
6467 if (success_p
&& it
->dpvec
== NULL
)
6470 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6471 int nonascii_space_p
= 0;
6472 int nonascii_hyphen_p
= 0;
6473 int c
= it
->c
; /* This is the character to display. */
6475 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6477 xassert (SINGLE_BYTE_CHAR_P (c
));
6478 if (unibyte_display_via_language_environment
)
6480 c
= DECODE_CHAR (unibyte
, c
);
6482 c
= BYTE8_TO_CHAR (it
->c
);
6485 c
= BYTE8_TO_CHAR (it
->c
);
6489 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6492 struct Lisp_Vector
*v
= XVECTOR (dv
);
6494 /* Return the first character from the display table
6495 entry, if not empty. If empty, don't display the
6496 current character. */
6499 it
->dpvec_char_len
= it
->len
;
6500 it
->dpvec
= v
->contents
;
6501 it
->dpend
= v
->contents
+ v
->header
.size
;
6502 it
->current
.dpvec_index
= 0;
6503 it
->dpvec_face_id
= -1;
6504 it
->saved_face_id
= it
->face_id
;
6505 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6510 set_iterator_to_next (it
, 0);
6515 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6517 if (it
->what
== IT_GLYPHLESS
)
6519 /* Don't display this character. */
6520 set_iterator_to_next (it
, 0);
6524 /* If `nobreak-char-display' is non-nil, we display
6525 non-ASCII spaces and hyphens specially. */
6526 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6529 nonascii_space_p
= 1;
6530 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6531 nonascii_hyphen_p
= 1;
6534 /* Translate control characters into `\003' or `^C' form.
6535 Control characters coming from a display table entry are
6536 currently not translated because we use IT->dpvec to hold
6537 the translation. This could easily be changed but I
6538 don't believe that it is worth doing.
6540 The characters handled by `nobreak-char-display' must be
6543 Non-printable characters and raw-byte characters are also
6544 translated to octal form. */
6545 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6546 ? (it
->area
!= TEXT_AREA
6547 /* In mode line, treat \n, \t like other crl chars. */
6550 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6551 || (c
!= '\n' && c
!= '\t'))
6553 || nonascii_hyphen_p
6555 || ! CHAR_PRINTABLE_P (c
))))
6557 /* C is a control character, non-ASCII space/hyphen,
6558 raw-byte, or a non-printable character which must be
6559 displayed either as '\003' or as `^C' where the '\\'
6560 and '^' can be defined in the display table. Fill
6561 IT->ctl_chars with glyphs for what we have to
6562 display. Then, set IT->dpvec to these glyphs. */
6566 EMACS_INT lface_id
= 0;
6569 /* Handle control characters with ^. */
6571 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6575 g
= '^'; /* default glyph for Control */
6576 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6578 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6579 && GLYPH_CODE_CHAR_VALID_P (gc
))
6581 g
= GLYPH_CODE_CHAR (gc
);
6582 lface_id
= GLYPH_CODE_FACE (gc
);
6586 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6588 else if (it
->f
== last_escape_glyph_frame
6589 && it
->face_id
== last_escape_glyph_face_id
)
6591 face_id
= last_escape_glyph_merged_face_id
;
6595 /* Merge the escape-glyph face into the current face. */
6596 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6598 last_escape_glyph_frame
= it
->f
;
6599 last_escape_glyph_face_id
= it
->face_id
;
6600 last_escape_glyph_merged_face_id
= face_id
;
6603 XSETINT (it
->ctl_chars
[0], g
);
6604 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6606 goto display_control
;
6609 /* Handle non-ascii space in the mode where it only gets
6612 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6614 /* Merge `nobreak-space' into the current face. */
6615 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6617 XSETINT (it
->ctl_chars
[0], ' ');
6619 goto display_control
;
6622 /* Handle sequences that start with the "escape glyph". */
6624 /* the default escape glyph is \. */
6625 escape_glyph
= '\\';
6628 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6629 && GLYPH_CODE_CHAR_VALID_P (gc
))
6631 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6632 lface_id
= GLYPH_CODE_FACE (gc
);
6636 /* The display table specified a face.
6637 Merge it into face_id and also into escape_glyph. */
6638 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6641 else if (it
->f
== last_escape_glyph_frame
6642 && it
->face_id
== last_escape_glyph_face_id
)
6644 face_id
= last_escape_glyph_merged_face_id
;
6648 /* Merge the escape-glyph face into the current face. */
6649 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6651 last_escape_glyph_frame
= it
->f
;
6652 last_escape_glyph_face_id
= it
->face_id
;
6653 last_escape_glyph_merged_face_id
= face_id
;
6656 /* Draw non-ASCII hyphen with just highlighting: */
6658 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6660 XSETINT (it
->ctl_chars
[0], '-');
6662 goto display_control
;
6665 /* Draw non-ASCII space/hyphen with escape glyph: */
6667 if (nonascii_space_p
|| nonascii_hyphen_p
)
6669 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6670 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6672 goto display_control
;
6679 if (CHAR_BYTE8_P (c
))
6680 /* Display \200 instead of \17777600. */
6681 c
= CHAR_TO_BYTE8 (c
);
6682 len
= sprintf (str
, "%03o", c
);
6684 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6685 for (i
= 0; i
< len
; i
++)
6686 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6691 /* Set up IT->dpvec and return first character from it. */
6692 it
->dpvec_char_len
= it
->len
;
6693 it
->dpvec
= it
->ctl_chars
;
6694 it
->dpend
= it
->dpvec
+ ctl_len
;
6695 it
->current
.dpvec_index
= 0;
6696 it
->dpvec_face_id
= face_id
;
6697 it
->saved_face_id
= it
->face_id
;
6698 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6702 it
->char_to_display
= c
;
6706 it
->char_to_display
= it
->c
;
6710 /* Adjust face id for a multibyte character. There are no multibyte
6711 character in unibyte text. */
6712 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6715 && FRAME_WINDOW_P (it
->f
))
6717 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6719 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6721 /* Automatic composition with glyph-string. */
6722 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6724 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6728 EMACS_INT pos
= (it
->s
? -1
6729 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6730 : IT_CHARPOS (*it
));
6733 if (it
->what
== IT_CHARACTER
)
6734 c
= it
->char_to_display
;
6737 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6741 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6742 /* TAB in a composition means display glyphs with
6743 padding space on the left or right. */
6744 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6747 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6752 /* Is this character the last one of a run of characters with
6753 box? If yes, set IT->end_of_box_run_p to 1. */
6757 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6759 int face_id
= underlying_face_id (it
);
6760 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6764 if (face
->box
== FACE_NO_BOX
)
6766 /* If the box comes from face properties in a
6767 display string, check faces in that string. */
6768 int string_face_id
= face_after_it_pos (it
);
6769 it
->end_of_box_run_p
6770 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6773 /* Otherwise, the box comes from the underlying face.
6774 If this is the last string character displayed, check
6775 the next buffer location. */
6776 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6777 && (it
->current
.overlay_string_index
6778 == it
->n_overlay_strings
- 1))
6782 struct text_pos pos
= it
->current
.pos
;
6783 INC_TEXT_POS (pos
, it
->multibyte_p
);
6785 next_face_id
= face_at_buffer_position
6786 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6787 it
->region_end_charpos
, &ignore
,
6788 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6790 it
->end_of_box_run_p
6791 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6798 int face_id
= face_after_it_pos (it
);
6799 it
->end_of_box_run_p
6800 = (face_id
!= it
->face_id
6801 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6805 /* Value is 0 if end of buffer or string reached. */
6810 /* Move IT to the next display element.
6812 RESEAT_P non-zero means if called on a newline in buffer text,
6813 skip to the next visible line start.
6815 Functions get_next_display_element and set_iterator_to_next are
6816 separate because I find this arrangement easier to handle than a
6817 get_next_display_element function that also increments IT's
6818 position. The way it is we can first look at an iterator's current
6819 display element, decide whether it fits on a line, and if it does,
6820 increment the iterator position. The other way around we probably
6821 would either need a flag indicating whether the iterator has to be
6822 incremented the next time, or we would have to implement a
6823 decrement position function which would not be easy to write. */
6826 set_iterator_to_next (struct it
*it
, int reseat_p
)
6828 /* Reset flags indicating start and end of a sequence of characters
6829 with box. Reset them at the start of this function because
6830 moving the iterator to a new position might set them. */
6831 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6835 case GET_FROM_BUFFER
:
6836 /* The current display element of IT is a character from
6837 current_buffer. Advance in the buffer, and maybe skip over
6838 invisible lines that are so because of selective display. */
6839 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6840 reseat_at_next_visible_line_start (it
, 0);
6841 else if (it
->cmp_it
.id
>= 0)
6843 /* We are currently getting glyphs from a composition. */
6848 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6849 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6850 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6852 it
->cmp_it
.from
= it
->cmp_it
.to
;
6857 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6859 it
->end_charpos
, Qnil
);
6862 else if (! it
->cmp_it
.reversed_p
)
6864 /* Composition created while scanning forward. */
6865 /* Update IT's char/byte positions to point to the first
6866 character of the next grapheme cluster, or to the
6867 character visually after the current composition. */
6868 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6869 bidi_move_to_visually_next (&it
->bidi_it
);
6870 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6871 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6873 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6875 /* Proceed to the next grapheme cluster. */
6876 it
->cmp_it
.from
= it
->cmp_it
.to
;
6880 /* No more grapheme clusters in this composition.
6881 Find the next stop position. */
6882 EMACS_INT stop
= it
->end_charpos
;
6883 if (it
->bidi_it
.scan_dir
< 0)
6884 /* Now we are scanning backward and don't know
6887 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6888 IT_BYTEPOS (*it
), stop
, Qnil
);
6893 /* Composition created while scanning backward. */
6894 /* Update IT's char/byte positions to point to the last
6895 character of the previous grapheme cluster, or the
6896 character visually after the current composition. */
6897 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6898 bidi_move_to_visually_next (&it
->bidi_it
);
6899 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6900 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6901 if (it
->cmp_it
.from
> 0)
6903 /* Proceed to the previous grapheme cluster. */
6904 it
->cmp_it
.to
= it
->cmp_it
.from
;
6908 /* No more grapheme clusters in this composition.
6909 Find the next stop position. */
6910 EMACS_INT stop
= it
->end_charpos
;
6911 if (it
->bidi_it
.scan_dir
< 0)
6912 /* Now we are scanning backward and don't know
6915 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6916 IT_BYTEPOS (*it
), stop
, Qnil
);
6922 xassert (it
->len
!= 0);
6926 IT_BYTEPOS (*it
) += it
->len
;
6927 IT_CHARPOS (*it
) += 1;
6931 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6932 /* If this is a new paragraph, determine its base
6933 direction (a.k.a. its base embedding level). */
6934 if (it
->bidi_it
.new_paragraph
)
6935 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6936 bidi_move_to_visually_next (&it
->bidi_it
);
6937 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6938 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6939 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6941 /* As the scan direction was changed, we must
6942 re-compute the stop position for composition. */
6943 EMACS_INT stop
= it
->end_charpos
;
6944 if (it
->bidi_it
.scan_dir
< 0)
6946 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6947 IT_BYTEPOS (*it
), stop
, Qnil
);
6950 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6954 case GET_FROM_C_STRING
:
6955 /* Current display element of IT is from a C string. */
6957 /* If the string position is beyond string's end, it means
6958 next_element_from_c_string is padding the string with
6959 blanks, in which case we bypass the bidi iterator,
6960 because it cannot deal with such virtual characters. */
6961 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6963 IT_BYTEPOS (*it
) += it
->len
;
6964 IT_CHARPOS (*it
) += 1;
6968 bidi_move_to_visually_next (&it
->bidi_it
);
6969 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6970 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6974 case GET_FROM_DISPLAY_VECTOR
:
6975 /* Current display element of IT is from a display table entry.
6976 Advance in the display table definition. Reset it to null if
6977 end reached, and continue with characters from buffers/
6979 ++it
->current
.dpvec_index
;
6981 /* Restore face of the iterator to what they were before the
6982 display vector entry (these entries may contain faces). */
6983 it
->face_id
= it
->saved_face_id
;
6985 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6987 int recheck_faces
= it
->ellipsis_p
;
6990 it
->method
= GET_FROM_C_STRING
;
6991 else if (STRINGP (it
->string
))
6992 it
->method
= GET_FROM_STRING
;
6995 it
->method
= GET_FROM_BUFFER
;
6996 it
->object
= it
->w
->buffer
;
7000 it
->current
.dpvec_index
= -1;
7002 /* Skip over characters which were displayed via IT->dpvec. */
7003 if (it
->dpvec_char_len
< 0)
7004 reseat_at_next_visible_line_start (it
, 1);
7005 else if (it
->dpvec_char_len
> 0)
7007 if (it
->method
== GET_FROM_STRING
7008 && it
->n_overlay_strings
> 0)
7009 it
->ignore_overlay_strings_at_pos_p
= 1;
7010 it
->len
= it
->dpvec_char_len
;
7011 set_iterator_to_next (it
, reseat_p
);
7014 /* Maybe recheck faces after display vector */
7016 it
->stop_charpos
= IT_CHARPOS (*it
);
7020 case GET_FROM_STRING
:
7021 /* Current display element is a character from a Lisp string. */
7022 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
7023 if (it
->cmp_it
.id
>= 0)
7029 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7030 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7031 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7032 it
->cmp_it
.from
= it
->cmp_it
.to
;
7036 composition_compute_stop_pos (&it
->cmp_it
,
7037 IT_STRING_CHARPOS (*it
),
7038 IT_STRING_BYTEPOS (*it
),
7039 it
->end_charpos
, it
->string
);
7042 else if (! it
->cmp_it
.reversed_p
)
7044 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7045 bidi_move_to_visually_next (&it
->bidi_it
);
7046 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7047 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7049 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7050 it
->cmp_it
.from
= it
->cmp_it
.to
;
7053 EMACS_INT stop
= it
->end_charpos
;
7054 if (it
->bidi_it
.scan_dir
< 0)
7056 composition_compute_stop_pos (&it
->cmp_it
,
7057 IT_STRING_CHARPOS (*it
),
7058 IT_STRING_BYTEPOS (*it
), stop
,
7064 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7065 bidi_move_to_visually_next (&it
->bidi_it
);
7066 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7067 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7068 if (it
->cmp_it
.from
> 0)
7069 it
->cmp_it
.to
= it
->cmp_it
.from
;
7072 EMACS_INT stop
= it
->end_charpos
;
7073 if (it
->bidi_it
.scan_dir
< 0)
7075 composition_compute_stop_pos (&it
->cmp_it
,
7076 IT_STRING_CHARPOS (*it
),
7077 IT_STRING_BYTEPOS (*it
), stop
,
7085 /* If the string position is beyond string's end, it
7086 means next_element_from_string is padding the string
7087 with blanks, in which case we bypass the bidi
7088 iterator, because it cannot deal with such virtual
7090 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7092 IT_STRING_BYTEPOS (*it
) += it
->len
;
7093 IT_STRING_CHARPOS (*it
) += 1;
7097 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7099 bidi_move_to_visually_next (&it
->bidi_it
);
7100 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7101 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7102 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7104 EMACS_INT stop
= it
->end_charpos
;
7106 if (it
->bidi_it
.scan_dir
< 0)
7108 composition_compute_stop_pos (&it
->cmp_it
,
7109 IT_STRING_CHARPOS (*it
),
7110 IT_STRING_BYTEPOS (*it
), stop
,
7116 consider_string_end
:
7118 if (it
->current
.overlay_string_index
>= 0)
7120 /* IT->string is an overlay string. Advance to the
7121 next, if there is one. */
7122 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7125 next_overlay_string (it
);
7127 setup_for_ellipsis (it
, 0);
7132 /* IT->string is not an overlay string. If we reached
7133 its end, and there is something on IT->stack, proceed
7134 with what is on the stack. This can be either another
7135 string, this time an overlay string, or a buffer. */
7136 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7140 if (it
->method
== GET_FROM_STRING
)
7141 goto consider_string_end
;
7146 case GET_FROM_IMAGE
:
7147 case GET_FROM_STRETCH
:
7148 #ifdef HAVE_XWIDGETS
7149 case GET_FROM_XWIDGET
:
7151 /* The position etc with which we have to proceed are on
7152 the stack. The position may be at the end of a string,
7153 if the `display' property takes up the whole string. */
7154 xassert (it
->sp
> 0);
7156 if (it
->method
== GET_FROM_STRING
)
7157 goto consider_string_end
;
7161 /* There are no other methods defined, so this should be a bug. */
7165 xassert (it
->method
!= GET_FROM_STRING
7166 || (STRINGP (it
->string
)
7167 && IT_STRING_CHARPOS (*it
) >= 0));
7170 /* Load IT's display element fields with information about the next
7171 display element which comes from a display table entry or from the
7172 result of translating a control character to one of the forms `^C'
7175 IT->dpvec holds the glyphs to return as characters.
7176 IT->saved_face_id holds the face id before the display vector--it
7177 is restored into IT->face_id in set_iterator_to_next. */
7180 next_element_from_display_vector (struct it
*it
)
7185 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7187 it
->face_id
= it
->saved_face_id
;
7189 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7190 That seemed totally bogus - so I changed it... */
7191 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7193 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7195 it
->c
= GLYPH_CODE_CHAR (gc
);
7196 it
->len
= CHAR_BYTES (it
->c
);
7198 /* The entry may contain a face id to use. Such a face id is
7199 the id of a Lisp face, not a realized face. A face id of
7200 zero means no face is specified. */
7201 if (it
->dpvec_face_id
>= 0)
7202 it
->face_id
= it
->dpvec_face_id
;
7205 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7207 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7212 /* Display table entry is invalid. Return a space. */
7213 it
->c
= ' ', it
->len
= 1;
7215 /* Don't change position and object of the iterator here. They are
7216 still the values of the character that had this display table
7217 entry or was translated, and that's what we want. */
7218 it
->what
= IT_CHARACTER
;
7222 /* Get the first element of string/buffer in the visual order, after
7223 being reseated to a new position in a string or a buffer. */
7225 get_visually_first_element (struct it
*it
)
7227 int string_p
= STRINGP (it
->string
) || it
->s
;
7228 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7229 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7231 if (STRINGP (it
->string
))
7233 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7234 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7238 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7239 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7242 if (it
->bidi_it
.charpos
== eob
)
7244 /* Nothing to do, but reset the FIRST_ELT flag, like
7245 bidi_paragraph_init does, because we are not going to
7247 it
->bidi_it
.first_elt
= 0;
7249 else if (it
->bidi_it
.charpos
== bob
7251 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7252 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7254 /* If we are at the beginning of a line/string, we can produce
7255 the next element right away. */
7256 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7257 bidi_move_to_visually_next (&it
->bidi_it
);
7261 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7263 /* We need to prime the bidi iterator starting at the line's or
7264 string's beginning, before we will be able to produce the
7267 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7270 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7272 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7274 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7277 /* Now return to buffer/string position where we were asked
7278 to get the next display element, and produce that. */
7279 bidi_move_to_visually_next (&it
->bidi_it
);
7281 while (it
->bidi_it
.bytepos
!= orig_bytepos
7282 && it
->bidi_it
.charpos
< eob
);
7285 /* Adjust IT's position information to where we ended up. */
7286 if (STRINGP (it
->string
))
7288 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7289 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7293 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7294 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7297 if (STRINGP (it
->string
) || !it
->s
)
7299 EMACS_INT stop
, charpos
, bytepos
;
7301 if (STRINGP (it
->string
))
7304 stop
= SCHARS (it
->string
);
7305 if (stop
> it
->end_charpos
)
7306 stop
= it
->end_charpos
;
7307 charpos
= IT_STRING_CHARPOS (*it
);
7308 bytepos
= IT_STRING_BYTEPOS (*it
);
7312 stop
= it
->end_charpos
;
7313 charpos
= IT_CHARPOS (*it
);
7314 bytepos
= IT_BYTEPOS (*it
);
7316 if (it
->bidi_it
.scan_dir
< 0)
7318 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7323 /* Load IT with the next display element from Lisp string IT->string.
7324 IT->current.string_pos is the current position within the string.
7325 If IT->current.overlay_string_index >= 0, the Lisp string is an
7329 next_element_from_string (struct it
*it
)
7331 struct text_pos position
;
7333 xassert (STRINGP (it
->string
));
7334 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7335 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7336 position
= it
->current
.string_pos
;
7338 /* With bidi reordering, the character to display might not be the
7339 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7340 that we were reseat()ed to a new string, whose paragraph
7341 direction is not known. */
7342 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7344 get_visually_first_element (it
);
7345 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7348 /* Time to check for invisible text? */
7349 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7351 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7354 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7355 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7357 /* With bidi non-linear iteration, we could find
7358 ourselves far beyond the last computed stop_charpos,
7359 with several other stop positions in between that we
7360 missed. Scan them all now, in buffer's logical
7361 order, until we find and handle the last stop_charpos
7362 that precedes our current position. */
7363 handle_stop_backwards (it
, it
->stop_charpos
);
7364 return GET_NEXT_DISPLAY_ELEMENT (it
);
7370 /* Take note of the stop position we just moved
7371 across, for when we will move back across it. */
7372 it
->prev_stop
= it
->stop_charpos
;
7373 /* If we are at base paragraph embedding level, take
7374 note of the last stop position seen at this
7376 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7377 it
->base_level_stop
= it
->stop_charpos
;
7381 /* Since a handler may have changed IT->method, we must
7383 return GET_NEXT_DISPLAY_ELEMENT (it
);
7387 /* If we are before prev_stop, we may have overstepped
7388 on our way backwards a stop_pos, and if so, we need
7389 to handle that stop_pos. */
7390 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7391 /* We can sometimes back up for reasons that have nothing
7392 to do with bidi reordering. E.g., compositions. The
7393 code below is only needed when we are above the base
7394 embedding level, so test for that explicitly. */
7395 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7397 /* If we lost track of base_level_stop, we have no better
7398 place for handle_stop_backwards to start from than string
7399 beginning. This happens, e.g., when we were reseated to
7400 the previous screenful of text by vertical-motion. */
7401 if (it
->base_level_stop
<= 0
7402 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7403 it
->base_level_stop
= 0;
7404 handle_stop_backwards (it
, it
->base_level_stop
);
7405 return GET_NEXT_DISPLAY_ELEMENT (it
);
7409 if (it
->current
.overlay_string_index
>= 0)
7411 /* Get the next character from an overlay string. In overlay
7412 strings, there is no field width or padding with spaces to
7414 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7419 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7420 IT_STRING_BYTEPOS (*it
),
7421 it
->bidi_it
.scan_dir
< 0
7423 : SCHARS (it
->string
))
7424 && next_element_from_composition (it
))
7428 else if (STRING_MULTIBYTE (it
->string
))
7430 const unsigned char *s
= (SDATA (it
->string
)
7431 + IT_STRING_BYTEPOS (*it
));
7432 it
->c
= string_char_and_length (s
, &it
->len
);
7436 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7442 /* Get the next character from a Lisp string that is not an
7443 overlay string. Such strings come from the mode line, for
7444 example. We may have to pad with spaces, or truncate the
7445 string. See also next_element_from_c_string. */
7446 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7451 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7453 /* Pad with spaces. */
7454 it
->c
= ' ', it
->len
= 1;
7455 CHARPOS (position
) = BYTEPOS (position
) = -1;
7457 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7458 IT_STRING_BYTEPOS (*it
),
7459 it
->bidi_it
.scan_dir
< 0
7461 : it
->string_nchars
)
7462 && next_element_from_composition (it
))
7466 else if (STRING_MULTIBYTE (it
->string
))
7468 const unsigned char *s
= (SDATA (it
->string
)
7469 + IT_STRING_BYTEPOS (*it
));
7470 it
->c
= string_char_and_length (s
, &it
->len
);
7474 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7479 /* Record what we have and where it came from. */
7480 it
->what
= IT_CHARACTER
;
7481 it
->object
= it
->string
;
7482 it
->position
= position
;
7487 /* Load IT with next display element from C string IT->s.
7488 IT->string_nchars is the maximum number of characters to return
7489 from the string. IT->end_charpos may be greater than
7490 IT->string_nchars when this function is called, in which case we
7491 may have to return padding spaces. Value is zero if end of string
7492 reached, including padding spaces. */
7495 next_element_from_c_string (struct it
*it
)
7500 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7501 it
->what
= IT_CHARACTER
;
7502 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7505 /* With bidi reordering, the character to display might not be the
7506 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7507 we were reseated to a new string, whose paragraph direction is
7509 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7510 get_visually_first_element (it
);
7512 /* IT's position can be greater than IT->string_nchars in case a
7513 field width or precision has been specified when the iterator was
7515 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7517 /* End of the game. */
7521 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7523 /* Pad with spaces. */
7524 it
->c
= ' ', it
->len
= 1;
7525 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7527 else if (it
->multibyte_p
)
7528 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7530 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7536 /* Set up IT to return characters from an ellipsis, if appropriate.
7537 The definition of the ellipsis glyphs may come from a display table
7538 entry. This function fills IT with the first glyph from the
7539 ellipsis if an ellipsis is to be displayed. */
7542 next_element_from_ellipsis (struct it
*it
)
7544 if (it
->selective_display_ellipsis_p
)
7545 setup_for_ellipsis (it
, it
->len
);
7548 /* The face at the current position may be different from the
7549 face we find after the invisible text. Remember what it
7550 was in IT->saved_face_id, and signal that it's there by
7551 setting face_before_selective_p. */
7552 it
->saved_face_id
= it
->face_id
;
7553 it
->method
= GET_FROM_BUFFER
;
7554 it
->object
= it
->w
->buffer
;
7555 reseat_at_next_visible_line_start (it
, 1);
7556 it
->face_before_selective_p
= 1;
7559 return GET_NEXT_DISPLAY_ELEMENT (it
);
7563 /* Deliver an image display element. The iterator IT is already
7564 filled with image information (done in handle_display_prop). Value
7569 next_element_from_image (struct it
*it
)
7571 it
->what
= IT_IMAGE
;
7572 it
->ignore_overlay_strings_at_pos_p
= 0;
7576 #ifdef HAVE_XWIDGETS
7577 /* im not sure about this FIXME JAVE*/
7579 next_element_from_xwidget (struct it
*it
)
7581 it
->what
= IT_XWIDGET
;
7582 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
7583 //this is shaky because why do we set "what" if we dont set the other parts??
7584 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
7590 /* Fill iterator IT with next display element from a stretch glyph
7591 property. IT->object is the value of the text property. Value is
7595 next_element_from_stretch (struct it
*it
)
7597 it
->what
= IT_STRETCH
;
7601 /* Scan backwards from IT's current position until we find a stop
7602 position, or until BEGV. This is called when we find ourself
7603 before both the last known prev_stop and base_level_stop while
7604 reordering bidirectional text. */
7607 compute_stop_pos_backwards (struct it
*it
)
7609 const int SCAN_BACK_LIMIT
= 1000;
7610 struct text_pos pos
;
7611 struct display_pos save_current
= it
->current
;
7612 struct text_pos save_position
= it
->position
;
7613 EMACS_INT charpos
= IT_CHARPOS (*it
);
7614 EMACS_INT where_we_are
= charpos
;
7615 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7616 EMACS_INT save_end_pos
= it
->end_charpos
;
7618 xassert (NILP (it
->string
) && !it
->s
);
7619 xassert (it
->bidi_p
);
7623 it
->end_charpos
= min (charpos
+ 1, ZV
);
7624 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7625 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7626 reseat_1 (it
, pos
, 0);
7627 compute_stop_pos (it
);
7628 /* We must advance forward, right? */
7629 if (it
->stop_charpos
<= charpos
)
7632 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7634 if (it
->stop_charpos
<= where_we_are
)
7635 it
->prev_stop
= it
->stop_charpos
;
7637 it
->prev_stop
= BEGV
;
7639 it
->current
= save_current
;
7640 it
->position
= save_position
;
7641 it
->stop_charpos
= save_stop_pos
;
7642 it
->end_charpos
= save_end_pos
;
7645 /* Scan forward from CHARPOS in the current buffer/string, until we
7646 find a stop position > current IT's position. Then handle the stop
7647 position before that. This is called when we bump into a stop
7648 position while reordering bidirectional text. CHARPOS should be
7649 the last previously processed stop_pos (or BEGV/0, if none were
7650 processed yet) whose position is less that IT's current
7654 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7656 int bufp
= !STRINGP (it
->string
);
7657 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7658 struct display_pos save_current
= it
->current
;
7659 struct text_pos save_position
= it
->position
;
7660 struct text_pos pos1
;
7661 EMACS_INT next_stop
;
7663 /* Scan in strict logical order. */
7664 xassert (it
->bidi_p
);
7668 it
->prev_stop
= charpos
;
7671 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7672 reseat_1 (it
, pos1
, 0);
7675 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7676 compute_stop_pos (it
);
7677 /* We must advance forward, right? */
7678 if (it
->stop_charpos
<= it
->prev_stop
)
7680 charpos
= it
->stop_charpos
;
7682 while (charpos
<= where_we_are
);
7685 it
->current
= save_current
;
7686 it
->position
= save_position
;
7687 next_stop
= it
->stop_charpos
;
7688 it
->stop_charpos
= it
->prev_stop
;
7690 it
->stop_charpos
= next_stop
;
7693 /* Load IT with the next display element from current_buffer. Value
7694 is zero if end of buffer reached. IT->stop_charpos is the next
7695 position at which to stop and check for text properties or buffer
7699 next_element_from_buffer (struct it
*it
)
7703 xassert (IT_CHARPOS (*it
) >= BEGV
);
7704 xassert (NILP (it
->string
) && !it
->s
);
7705 xassert (!it
->bidi_p
7706 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7707 && it
->bidi_it
.string
.s
== NULL
));
7709 /* With bidi reordering, the character to display might not be the
7710 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7711 we were reseat()ed to a new buffer position, which is potentially
7712 a different paragraph. */
7713 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7715 get_visually_first_element (it
);
7716 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7719 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7721 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7723 int overlay_strings_follow_p
;
7725 /* End of the game, except when overlay strings follow that
7726 haven't been returned yet. */
7727 if (it
->overlay_strings_at_end_processed_p
)
7728 overlay_strings_follow_p
= 0;
7731 it
->overlay_strings_at_end_processed_p
= 1;
7732 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7735 if (overlay_strings_follow_p
)
7736 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7740 it
->position
= it
->current
.pos
;
7744 else if (!(!it
->bidi_p
7745 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7746 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7748 /* With bidi non-linear iteration, we could find ourselves
7749 far beyond the last computed stop_charpos, with several
7750 other stop positions in between that we missed. Scan
7751 them all now, in buffer's logical order, until we find
7752 and handle the last stop_charpos that precedes our
7753 current position. */
7754 handle_stop_backwards (it
, it
->stop_charpos
);
7755 return GET_NEXT_DISPLAY_ELEMENT (it
);
7761 /* Take note of the stop position we just moved across,
7762 for when we will move back across it. */
7763 it
->prev_stop
= it
->stop_charpos
;
7764 /* If we are at base paragraph embedding level, take
7765 note of the last stop position seen at this
7767 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7768 it
->base_level_stop
= it
->stop_charpos
;
7771 return GET_NEXT_DISPLAY_ELEMENT (it
);
7775 /* If we are before prev_stop, we may have overstepped on
7776 our way backwards a stop_pos, and if so, we need to
7777 handle that stop_pos. */
7778 && IT_CHARPOS (*it
) < it
->prev_stop
7779 /* We can sometimes back up for reasons that have nothing
7780 to do with bidi reordering. E.g., compositions. The
7781 code below is only needed when we are above the base
7782 embedding level, so test for that explicitly. */
7783 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7785 if (it
->base_level_stop
<= 0
7786 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7788 /* If we lost track of base_level_stop, we need to find
7789 prev_stop by looking backwards. This happens, e.g., when
7790 we were reseated to the previous screenful of text by
7792 it
->base_level_stop
= BEGV
;
7793 compute_stop_pos_backwards (it
);
7794 handle_stop_backwards (it
, it
->prev_stop
);
7797 handle_stop_backwards (it
, it
->base_level_stop
);
7798 return GET_NEXT_DISPLAY_ELEMENT (it
);
7802 /* No face changes, overlays etc. in sight, so just return a
7803 character from current_buffer. */
7807 /* Maybe run the redisplay end trigger hook. Performance note:
7808 This doesn't seem to cost measurable time. */
7809 if (it
->redisplay_end_trigger_charpos
7811 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7812 run_redisplay_end_trigger_hook (it
);
7814 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7815 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7817 && next_element_from_composition (it
))
7822 /* Get the next character, maybe multibyte. */
7823 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7824 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7825 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7827 it
->c
= *p
, it
->len
= 1;
7829 /* Record what we have and where it came from. */
7830 it
->what
= IT_CHARACTER
;
7831 it
->object
= it
->w
->buffer
;
7832 it
->position
= it
->current
.pos
;
7834 /* Normally we return the character found above, except when we
7835 really want to return an ellipsis for selective display. */
7840 /* A value of selective > 0 means hide lines indented more
7841 than that number of columns. */
7842 if (it
->selective
> 0
7843 && IT_CHARPOS (*it
) + 1 < ZV
7844 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7845 IT_BYTEPOS (*it
) + 1,
7848 success_p
= next_element_from_ellipsis (it
);
7849 it
->dpvec_char_len
= -1;
7852 else if (it
->c
== '\r' && it
->selective
== -1)
7854 /* A value of selective == -1 means that everything from the
7855 CR to the end of the line is invisible, with maybe an
7856 ellipsis displayed for it. */
7857 success_p
= next_element_from_ellipsis (it
);
7858 it
->dpvec_char_len
= -1;
7863 /* Value is zero if end of buffer reached. */
7864 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7869 /* Run the redisplay end trigger hook for IT. */
7872 run_redisplay_end_trigger_hook (struct it
*it
)
7874 Lisp_Object args
[3];
7876 /* IT->glyph_row should be non-null, i.e. we should be actually
7877 displaying something, or otherwise we should not run the hook. */
7878 xassert (it
->glyph_row
);
7880 /* Set up hook arguments. */
7881 args
[0] = Qredisplay_end_trigger_functions
;
7882 args
[1] = it
->window
;
7883 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7884 it
->redisplay_end_trigger_charpos
= 0;
7886 /* Since we are *trying* to run these functions, don't try to run
7887 them again, even if they get an error. */
7888 it
->w
->redisplay_end_trigger
= Qnil
;
7889 Frun_hook_with_args (3, args
);
7891 /* Notice if it changed the face of the character we are on. */
7892 handle_face_prop (it
);
7896 /* Deliver a composition display element. Unlike the other
7897 next_element_from_XXX, this function is not registered in the array
7898 get_next_element[]. It is called from next_element_from_buffer and
7899 next_element_from_string when necessary. */
7902 next_element_from_composition (struct it
*it
)
7904 it
->what
= IT_COMPOSITION
;
7905 it
->len
= it
->cmp_it
.nbytes
;
7906 if (STRINGP (it
->string
))
7910 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7911 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7914 it
->position
= it
->current
.string_pos
;
7915 it
->object
= it
->string
;
7916 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7917 IT_STRING_BYTEPOS (*it
), it
->string
);
7923 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7924 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7927 if (it
->bidi_it
.new_paragraph
)
7928 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7929 /* Resync the bidi iterator with IT's new position.
7930 FIXME: this doesn't support bidirectional text. */
7931 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7932 bidi_move_to_visually_next (&it
->bidi_it
);
7936 it
->position
= it
->current
.pos
;
7937 it
->object
= it
->w
->buffer
;
7938 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7939 IT_BYTEPOS (*it
), Qnil
);
7946 /***********************************************************************
7947 Moving an iterator without producing glyphs
7948 ***********************************************************************/
7950 /* Check if iterator is at a position corresponding to a valid buffer
7951 position after some move_it_ call. */
7953 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7954 ((it)->method == GET_FROM_STRING \
7955 ? IT_STRING_CHARPOS (*it) == 0 \
7959 /* Move iterator IT to a specified buffer or X position within one
7960 line on the display without producing glyphs.
7962 OP should be a bit mask including some or all of these bits:
7963 MOVE_TO_X: Stop upon reaching x-position TO_X.
7964 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7965 Regardless of OP's value, stop upon reaching the end of the display line.
7967 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7968 This means, in particular, that TO_X includes window's horizontal
7971 The return value has several possible values that
7972 say what condition caused the scan to stop:
7974 MOVE_POS_MATCH_OR_ZV
7975 - when TO_POS or ZV was reached.
7978 -when TO_X was reached before TO_POS or ZV were reached.
7981 - when we reached the end of the display area and the line must
7985 - when we reached the end of the display area and the line is
7989 - when we stopped at a line end, i.e. a newline or a CR and selective
7992 static enum move_it_result
7993 move_it_in_display_line_to (struct it
*it
,
7994 EMACS_INT to_charpos
, int to_x
,
7995 enum move_operation_enum op
)
7997 enum move_it_result result
= MOVE_UNDEFINED
;
7998 struct glyph_row
*saved_glyph_row
;
7999 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8000 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8001 void *ppos_data
= NULL
;
8003 enum it_method prev_method
= it
->method
;
8004 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
8005 int saw_smaller_pos
= prev_pos
< to_charpos
;
8007 /* Don't produce glyphs in produce_glyphs. */
8008 saved_glyph_row
= it
->glyph_row
;
8009 it
->glyph_row
= NULL
;
8011 /* Use wrap_it to save a copy of IT wherever a word wrap could
8012 occur. Use atpos_it to save a copy of IT at the desired buffer
8013 position, if found, so that we can scan ahead and check if the
8014 word later overshoots the window edge. Use atx_it similarly, for
8020 /* Use ppos_it under bidi reordering to save a copy of IT for the
8021 position > CHARPOS that is the closest to CHARPOS. We restore
8022 that position in IT when we have scanned the entire display line
8023 without finding a match for CHARPOS and all the character
8024 positions are greater than CHARPOS. */
8027 SAVE_IT (ppos_it
, *it
, ppos_data
);
8028 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8029 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8030 SAVE_IT (ppos_it
, *it
, ppos_data
);
8033 #define BUFFER_POS_REACHED_P() \
8034 ((op & MOVE_TO_POS) != 0 \
8035 && BUFFERP (it->object) \
8036 && (IT_CHARPOS (*it) == to_charpos \
8038 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8039 && IT_CHARPOS (*it) > to_charpos) \
8040 || (it->what == IT_COMPOSITION \
8041 && ((IT_CHARPOS (*it) > to_charpos \
8042 && to_charpos >= it->cmp_it.charpos) \
8043 || (IT_CHARPOS (*it) < to_charpos \
8044 && to_charpos <= it->cmp_it.charpos)))) \
8045 && (it->method == GET_FROM_BUFFER \
8046 || (it->method == GET_FROM_DISPLAY_VECTOR \
8047 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8049 /* If there's a line-/wrap-prefix, handle it. */
8050 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8051 && it
->current_y
< it
->last_visible_y
)
8052 handle_line_prefix (it
);
8054 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8055 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8059 int x
, i
, ascent
= 0, descent
= 0;
8061 /* Utility macro to reset an iterator with x, ascent, and descent. */
8062 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8063 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8064 (IT)->max_descent = descent)
8066 /* Stop if we move beyond TO_CHARPOS (after an image or a
8067 display string or stretch glyph). */
8068 if ((op
& MOVE_TO_POS
) != 0
8069 && BUFFERP (it
->object
)
8070 && it
->method
== GET_FROM_BUFFER
8072 /* When the iterator is at base embedding level, we
8073 are guaranteed that characters are delivered for
8074 display in strictly increasing order of their
8075 buffer positions. */
8076 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8077 && IT_CHARPOS (*it
) > to_charpos
)
8079 && (prev_method
== GET_FROM_IMAGE
8080 || prev_method
== GET_FROM_STRETCH
8081 || prev_method
== GET_FROM_STRING
)
8082 /* Passed TO_CHARPOS from left to right. */
8083 && ((prev_pos
< to_charpos
8084 && IT_CHARPOS (*it
) > to_charpos
)
8085 /* Passed TO_CHARPOS from right to left. */
8086 || (prev_pos
> to_charpos
8087 && IT_CHARPOS (*it
) < to_charpos
)))))
8089 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8091 result
= MOVE_POS_MATCH_OR_ZV
;
8094 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8095 /* If wrap_it is valid, the current position might be in a
8096 word that is wrapped. So, save the iterator in
8097 atpos_it and continue to see if wrapping happens. */
8098 SAVE_IT (atpos_it
, *it
, atpos_data
);
8101 /* Stop when ZV reached.
8102 We used to stop here when TO_CHARPOS reached as well, but that is
8103 too soon if this glyph does not fit on this line. So we handle it
8104 explicitly below. */
8105 if (!get_next_display_element (it
))
8107 result
= MOVE_POS_MATCH_OR_ZV
;
8111 if (it
->line_wrap
== TRUNCATE
)
8113 if (BUFFER_POS_REACHED_P ())
8115 result
= MOVE_POS_MATCH_OR_ZV
;
8121 if (it
->line_wrap
== WORD_WRAP
)
8123 if (IT_DISPLAYING_WHITESPACE (it
))
8127 /* We have reached a glyph that follows one or more
8128 whitespace characters. If the position is
8129 already found, we are done. */
8130 if (atpos_it
.sp
>= 0)
8132 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8133 result
= MOVE_POS_MATCH_OR_ZV
;
8138 RESTORE_IT (it
, &atx_it
, atx_data
);
8139 result
= MOVE_X_REACHED
;
8142 /* Otherwise, we can wrap here. */
8143 SAVE_IT (wrap_it
, *it
, wrap_data
);
8149 /* Remember the line height for the current line, in case
8150 the next element doesn't fit on the line. */
8151 ascent
= it
->max_ascent
;
8152 descent
= it
->max_descent
;
8154 /* The call to produce_glyphs will get the metrics of the
8155 display element IT is loaded with. Record the x-position
8156 before this display element, in case it doesn't fit on the
8160 PRODUCE_GLYPHS (it
);
8162 if (it
->area
!= TEXT_AREA
)
8164 prev_method
= it
->method
;
8165 if (it
->method
== GET_FROM_BUFFER
)
8166 prev_pos
= IT_CHARPOS (*it
);
8167 set_iterator_to_next (it
, 1);
8168 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8169 SET_TEXT_POS (this_line_min_pos
,
8170 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8172 && (op
& MOVE_TO_POS
)
8173 && IT_CHARPOS (*it
) > to_charpos
8174 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8175 SAVE_IT (ppos_it
, *it
, ppos_data
);
8179 /* The number of glyphs we get back in IT->nglyphs will normally
8180 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8181 character on a terminal frame, or (iii) a line end. For the
8182 second case, IT->nglyphs - 1 padding glyphs will be present.
8183 (On X frames, there is only one glyph produced for a
8184 composite character.)
8186 The behavior implemented below means, for continuation lines,
8187 that as many spaces of a TAB as fit on the current line are
8188 displayed there. For terminal frames, as many glyphs of a
8189 multi-glyph character are displayed in the current line, too.
8190 This is what the old redisplay code did, and we keep it that
8191 way. Under X, the whole shape of a complex character must
8192 fit on the line or it will be completely displayed in the
8195 Note that both for tabs and padding glyphs, all glyphs have
8199 /* More than one glyph or glyph doesn't fit on line. All
8200 glyphs have the same width. */
8201 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8203 int x_before_this_char
= x
;
8204 int hpos_before_this_char
= it
->hpos
;
8206 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8208 new_x
= x
+ single_glyph_width
;
8210 /* We want to leave anything reaching TO_X to the caller. */
8211 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8213 if (BUFFER_POS_REACHED_P ())
8215 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8216 goto buffer_pos_reached
;
8217 if (atpos_it
.sp
< 0)
8219 SAVE_IT (atpos_it
, *it
, atpos_data
);
8220 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8225 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8228 result
= MOVE_X_REACHED
;
8233 SAVE_IT (atx_it
, *it
, atx_data
);
8234 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8239 if (/* Lines are continued. */
8240 it
->line_wrap
!= TRUNCATE
8241 && (/* And glyph doesn't fit on the line. */
8242 new_x
> it
->last_visible_x
8243 /* Or it fits exactly and we're on a window
8245 || (new_x
== it
->last_visible_x
8246 && FRAME_WINDOW_P (it
->f
))))
8248 if (/* IT->hpos == 0 means the very first glyph
8249 doesn't fit on the line, e.g. a wide image. */
8251 || (new_x
== it
->last_visible_x
8252 && FRAME_WINDOW_P (it
->f
)))
8255 it
->current_x
= new_x
;
8257 /* The character's last glyph just barely fits
8259 if (i
== it
->nglyphs
- 1)
8261 /* If this is the destination position,
8262 return a position *before* it in this row,
8263 now that we know it fits in this row. */
8264 if (BUFFER_POS_REACHED_P ())
8266 if (it
->line_wrap
!= WORD_WRAP
8269 it
->hpos
= hpos_before_this_char
;
8270 it
->current_x
= x_before_this_char
;
8271 result
= MOVE_POS_MATCH_OR_ZV
;
8274 if (it
->line_wrap
== WORD_WRAP
8277 SAVE_IT (atpos_it
, *it
, atpos_data
);
8278 atpos_it
.current_x
= x_before_this_char
;
8279 atpos_it
.hpos
= hpos_before_this_char
;
8283 prev_method
= it
->method
;
8284 if (it
->method
== GET_FROM_BUFFER
)
8285 prev_pos
= IT_CHARPOS (*it
);
8286 set_iterator_to_next (it
, 1);
8287 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8288 SET_TEXT_POS (this_line_min_pos
,
8289 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8290 /* On graphical terminals, newlines may
8291 "overflow" into the fringe if
8292 overflow-newline-into-fringe is non-nil.
8293 On text-only terminals, newlines may
8294 overflow into the last glyph on the
8296 if (!FRAME_WINDOW_P (it
->f
)
8297 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8299 if (!get_next_display_element (it
))
8301 result
= MOVE_POS_MATCH_OR_ZV
;
8304 if (BUFFER_POS_REACHED_P ())
8306 if (ITERATOR_AT_END_OF_LINE_P (it
))
8307 result
= MOVE_POS_MATCH_OR_ZV
;
8309 result
= MOVE_LINE_CONTINUED
;
8312 if (ITERATOR_AT_END_OF_LINE_P (it
))
8314 result
= MOVE_NEWLINE_OR_CR
;
8321 IT_RESET_X_ASCENT_DESCENT (it
);
8323 if (wrap_it
.sp
>= 0)
8325 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8330 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8332 result
= MOVE_LINE_CONTINUED
;
8336 if (BUFFER_POS_REACHED_P ())
8338 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8339 goto buffer_pos_reached
;
8340 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8342 SAVE_IT (atpos_it
, *it
, atpos_data
);
8343 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8347 if (new_x
> it
->first_visible_x
)
8349 /* Glyph is visible. Increment number of glyphs that
8350 would be displayed. */
8355 if (result
!= MOVE_UNDEFINED
)
8358 else if (BUFFER_POS_REACHED_P ())
8361 IT_RESET_X_ASCENT_DESCENT (it
);
8362 result
= MOVE_POS_MATCH_OR_ZV
;
8365 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8367 /* Stop when TO_X specified and reached. This check is
8368 necessary here because of lines consisting of a line end,
8369 only. The line end will not produce any glyphs and we
8370 would never get MOVE_X_REACHED. */
8371 xassert (it
->nglyphs
== 0);
8372 result
= MOVE_X_REACHED
;
8376 /* Is this a line end? If yes, we're done. */
8377 if (ITERATOR_AT_END_OF_LINE_P (it
))
8379 /* If we are past TO_CHARPOS, but never saw any character
8380 positions smaller than TO_CHARPOS, return
8381 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8383 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8385 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8387 if (IT_CHARPOS (ppos_it
) < ZV
)
8389 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8390 result
= MOVE_POS_MATCH_OR_ZV
;
8393 goto buffer_pos_reached
;
8395 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8396 && IT_CHARPOS (*it
) > to_charpos
)
8397 goto buffer_pos_reached
;
8399 result
= MOVE_NEWLINE_OR_CR
;
8402 result
= MOVE_NEWLINE_OR_CR
;
8406 prev_method
= it
->method
;
8407 if (it
->method
== GET_FROM_BUFFER
)
8408 prev_pos
= IT_CHARPOS (*it
);
8409 /* The current display element has been consumed. Advance
8411 set_iterator_to_next (it
, 1);
8412 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8413 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8414 if (IT_CHARPOS (*it
) < to_charpos
)
8415 saw_smaller_pos
= 1;
8417 && (op
& MOVE_TO_POS
)
8418 && IT_CHARPOS (*it
) >= to_charpos
8419 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8420 SAVE_IT (ppos_it
, *it
, ppos_data
);
8422 /* Stop if lines are truncated and IT's current x-position is
8423 past the right edge of the window now. */
8424 if (it
->line_wrap
== TRUNCATE
8425 && it
->current_x
>= it
->last_visible_x
)
8427 if (!FRAME_WINDOW_P (it
->f
)
8428 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8432 if ((at_eob_p
= !get_next_display_element (it
))
8433 || BUFFER_POS_REACHED_P ()
8434 /* If we are past TO_CHARPOS, but never saw any
8435 character positions smaller than TO_CHARPOS,
8436 return MOVE_POS_MATCH_OR_ZV, like the
8437 unidirectional display did. */
8438 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8440 && IT_CHARPOS (*it
) > to_charpos
))
8443 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8444 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8445 result
= MOVE_POS_MATCH_OR_ZV
;
8448 if (ITERATOR_AT_END_OF_LINE_P (it
))
8450 result
= MOVE_NEWLINE_OR_CR
;
8454 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8456 && IT_CHARPOS (*it
) > to_charpos
)
8458 if (IT_CHARPOS (ppos_it
) < ZV
)
8459 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8460 result
= MOVE_POS_MATCH_OR_ZV
;
8463 result
= MOVE_LINE_TRUNCATED
;
8466 #undef IT_RESET_X_ASCENT_DESCENT
8469 #undef BUFFER_POS_REACHED_P
8471 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8472 restore the saved iterator. */
8473 if (atpos_it
.sp
>= 0)
8474 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8475 else if (atx_it
.sp
>= 0)
8476 RESTORE_IT (it
, &atx_it
, atx_data
);
8481 bidi_unshelve_cache (atpos_data
, 1);
8483 bidi_unshelve_cache (atx_data
, 1);
8485 bidi_unshelve_cache (wrap_data
, 1);
8487 bidi_unshelve_cache (ppos_data
, 1);
8489 /* Restore the iterator settings altered at the beginning of this
8491 it
->glyph_row
= saved_glyph_row
;
8495 /* For external use. */
8497 move_it_in_display_line (struct it
*it
,
8498 EMACS_INT to_charpos
, int to_x
,
8499 enum move_operation_enum op
)
8501 if (it
->line_wrap
== WORD_WRAP
8502 && (op
& MOVE_TO_X
))
8505 void *save_data
= NULL
;
8508 SAVE_IT (save_it
, *it
, save_data
);
8509 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8510 /* When word-wrap is on, TO_X may lie past the end
8511 of a wrapped line. Then it->current is the
8512 character on the next line, so backtrack to the
8513 space before the wrap point. */
8514 if (skip
== MOVE_LINE_CONTINUED
)
8516 int prev_x
= max (it
->current_x
- 1, 0);
8517 RESTORE_IT (it
, &save_it
, save_data
);
8518 move_it_in_display_line_to
8519 (it
, -1, prev_x
, MOVE_TO_X
);
8522 bidi_unshelve_cache (save_data
, 1);
8525 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8529 /* Move IT forward until it satisfies one or more of the criteria in
8530 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8532 OP is a bit-mask that specifies where to stop, and in particular,
8533 which of those four position arguments makes a difference. See the
8534 description of enum move_operation_enum.
8536 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8537 screen line, this function will set IT to the next position that is
8538 displayed to the right of TO_CHARPOS on the screen. */
8541 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8543 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8544 int line_height
, line_start_x
= 0, reached
= 0;
8545 void *backup_data
= NULL
;
8549 if (op
& MOVE_TO_VPOS
)
8551 /* If no TO_CHARPOS and no TO_X specified, stop at the
8552 start of the line TO_VPOS. */
8553 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8555 if (it
->vpos
== to_vpos
)
8561 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8565 /* TO_VPOS >= 0 means stop at TO_X in the line at
8566 TO_VPOS, or at TO_POS, whichever comes first. */
8567 if (it
->vpos
== to_vpos
)
8573 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8575 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8580 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8582 /* We have reached TO_X but not in the line we want. */
8583 skip
= move_it_in_display_line_to (it
, to_charpos
,
8585 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8593 else if (op
& MOVE_TO_Y
)
8595 struct it it_backup
;
8597 if (it
->line_wrap
== WORD_WRAP
)
8598 SAVE_IT (it_backup
, *it
, backup_data
);
8600 /* TO_Y specified means stop at TO_X in the line containing
8601 TO_Y---or at TO_CHARPOS if this is reached first. The
8602 problem is that we can't really tell whether the line
8603 contains TO_Y before we have completely scanned it, and
8604 this may skip past TO_X. What we do is to first scan to
8607 If TO_X is not specified, use a TO_X of zero. The reason
8608 is to make the outcome of this function more predictable.
8609 If we didn't use TO_X == 0, we would stop at the end of
8610 the line which is probably not what a caller would expect
8612 skip
= move_it_in_display_line_to
8613 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8614 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8616 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8617 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8619 else if (skip
== MOVE_X_REACHED
)
8621 /* If TO_X was reached, we want to know whether TO_Y is
8622 in the line. We know this is the case if the already
8623 scanned glyphs make the line tall enough. Otherwise,
8624 we must check by scanning the rest of the line. */
8625 line_height
= it
->max_ascent
+ it
->max_descent
;
8626 if (to_y
>= it
->current_y
8627 && to_y
< it
->current_y
+ line_height
)
8632 SAVE_IT (it_backup
, *it
, backup_data
);
8633 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8634 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8636 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8637 line_height
= it
->max_ascent
+ it
->max_descent
;
8638 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8640 if (to_y
>= it
->current_y
8641 && to_y
< it
->current_y
+ line_height
)
8643 /* If TO_Y is in this line and TO_X was reached
8644 above, we scanned too far. We have to restore
8645 IT's settings to the ones before skipping. */
8646 RESTORE_IT (it
, &it_backup
, backup_data
);
8652 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8658 /* Check whether TO_Y is in this line. */
8659 line_height
= it
->max_ascent
+ it
->max_descent
;
8660 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8662 if (to_y
>= it
->current_y
8663 && to_y
< it
->current_y
+ line_height
)
8665 /* When word-wrap is on, TO_X may lie past the end
8666 of a wrapped line. Then it->current is the
8667 character on the next line, so backtrack to the
8668 space before the wrap point. */
8669 if (skip
== MOVE_LINE_CONTINUED
8670 && it
->line_wrap
== WORD_WRAP
)
8672 int prev_x
= max (it
->current_x
- 1, 0);
8673 RESTORE_IT (it
, &it_backup
, backup_data
);
8674 skip
= move_it_in_display_line_to
8675 (it
, -1, prev_x
, MOVE_TO_X
);
8684 else if (BUFFERP (it
->object
)
8685 && (it
->method
== GET_FROM_BUFFER
8686 || it
->method
== GET_FROM_STRETCH
)
8687 && IT_CHARPOS (*it
) >= to_charpos
8688 /* Under bidi iteration, a call to set_iterator_to_next
8689 can scan far beyond to_charpos if the initial
8690 portion of the next line needs to be reordered. In
8691 that case, give move_it_in_display_line_to another
8694 && it
->bidi_it
.scan_dir
== -1))
8695 skip
= MOVE_POS_MATCH_OR_ZV
;
8697 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8701 case MOVE_POS_MATCH_OR_ZV
:
8705 case MOVE_NEWLINE_OR_CR
:
8706 set_iterator_to_next (it
, 1);
8707 it
->continuation_lines_width
= 0;
8710 case MOVE_LINE_TRUNCATED
:
8711 it
->continuation_lines_width
= 0;
8712 reseat_at_next_visible_line_start (it
, 0);
8713 if ((op
& MOVE_TO_POS
) != 0
8714 && IT_CHARPOS (*it
) > to_charpos
)
8721 case MOVE_LINE_CONTINUED
:
8722 /* For continued lines ending in a tab, some of the glyphs
8723 associated with the tab are displayed on the current
8724 line. Since it->current_x does not include these glyphs,
8725 we use it->last_visible_x instead. */
8728 it
->continuation_lines_width
+= it
->last_visible_x
;
8729 /* When moving by vpos, ensure that the iterator really
8730 advances to the next line (bug#847, bug#969). Fixme:
8731 do we need to do this in other circumstances? */
8732 if (it
->current_x
!= it
->last_visible_x
8733 && (op
& MOVE_TO_VPOS
)
8734 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8736 line_start_x
= it
->current_x
+ it
->pixel_width
8737 - it
->last_visible_x
;
8738 set_iterator_to_next (it
, 0);
8742 it
->continuation_lines_width
+= it
->current_x
;
8749 /* Reset/increment for the next run. */
8750 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8751 it
->current_x
= line_start_x
;
8754 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8756 last_height
= it
->max_ascent
+ it
->max_descent
;
8757 last_max_ascent
= it
->max_ascent
;
8758 it
->max_ascent
= it
->max_descent
= 0;
8763 /* On text terminals, we may stop at the end of a line in the middle
8764 of a multi-character glyph. If the glyph itself is continued,
8765 i.e. it is actually displayed on the next line, don't treat this
8766 stopping point as valid; move to the next line instead (unless
8767 that brings us offscreen). */
8768 if (!FRAME_WINDOW_P (it
->f
)
8770 && IT_CHARPOS (*it
) == to_charpos
8771 && it
->what
== IT_CHARACTER
8773 && it
->line_wrap
== WINDOW_WRAP
8774 && it
->current_x
== it
->last_visible_x
- 1
8777 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8779 it
->continuation_lines_width
+= it
->current_x
;
8780 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8781 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8783 last_height
= it
->max_ascent
+ it
->max_descent
;
8784 last_max_ascent
= it
->max_ascent
;
8788 bidi_unshelve_cache (backup_data
, 1);
8790 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8794 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8796 If DY > 0, move IT backward at least that many pixels. DY = 0
8797 means move IT backward to the preceding line start or BEGV. This
8798 function may move over more than DY pixels if IT->current_y - DY
8799 ends up in the middle of a line; in this case IT->current_y will be
8800 set to the top of the line moved to. */
8803 move_it_vertically_backward (struct it
*it
, int dy
)
8807 void *it2data
= NULL
, *it3data
= NULL
;
8808 EMACS_INT start_pos
;
8813 start_pos
= IT_CHARPOS (*it
);
8815 /* Estimate how many newlines we must move back. */
8816 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8818 /* Set the iterator's position that many lines back. */
8819 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8820 back_to_previous_visible_line_start (it
);
8822 /* Reseat the iterator here. When moving backward, we don't want
8823 reseat to skip forward over invisible text, set up the iterator
8824 to deliver from overlay strings at the new position etc. So,
8825 use reseat_1 here. */
8826 reseat_1 (it
, it
->current
.pos
, 1);
8828 /* We are now surely at a line start. */
8829 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8830 reordering is in effect. */
8831 it
->continuation_lines_width
= 0;
8833 /* Move forward and see what y-distance we moved. First move to the
8834 start of the next line so that we get its height. We need this
8835 height to be able to tell whether we reached the specified
8837 SAVE_IT (it2
, *it
, it2data
);
8838 it2
.max_ascent
= it2
.max_descent
= 0;
8841 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8842 MOVE_TO_POS
| MOVE_TO_VPOS
);
8844 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8845 /* If we are in a display string which starts at START_POS,
8846 and that display string includes a newline, and we are
8847 right after that newline (i.e. at the beginning of a
8848 display line), exit the loop, because otherwise we will
8849 infloop, since move_it_to will see that it is already at
8850 START_POS and will not move. */
8851 || (it2
.method
== GET_FROM_STRING
8852 && IT_CHARPOS (it2
) == start_pos
8853 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8854 xassert (IT_CHARPOS (*it
) >= BEGV
);
8855 SAVE_IT (it3
, it2
, it3data
);
8857 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8858 xassert (IT_CHARPOS (*it
) >= BEGV
);
8859 /* H is the actual vertical distance from the position in *IT
8860 and the starting position. */
8861 h
= it2
.current_y
- it
->current_y
;
8862 /* NLINES is the distance in number of lines. */
8863 nlines
= it2
.vpos
- it
->vpos
;
8865 /* Correct IT's y and vpos position
8866 so that they are relative to the starting point. */
8872 /* DY == 0 means move to the start of the screen line. The
8873 value of nlines is > 0 if continuation lines were involved,
8874 or if the original IT position was at start of a line. */
8875 RESTORE_IT (it
, it
, it2data
);
8877 move_it_by_lines (it
, nlines
);
8878 /* The above code moves us to some position NLINES down,
8879 usually to its first glyph (leftmost in an L2R line), but
8880 that's not necessarily the start of the line, under bidi
8881 reordering. We want to get to the character position
8882 that is immediately after the newline of the previous
8885 && !it
->continuation_lines_width
8886 && !STRINGP (it
->string
)
8887 && IT_CHARPOS (*it
) > BEGV
8888 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8891 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8893 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8895 bidi_unshelve_cache (it3data
, 1);
8899 /* The y-position we try to reach, relative to *IT.
8900 Note that H has been subtracted in front of the if-statement. */
8901 int target_y
= it
->current_y
+ h
- dy
;
8902 int y0
= it3
.current_y
;
8906 RESTORE_IT (&it3
, &it3
, it3data
);
8907 y1
= line_bottom_y (&it3
);
8908 line_height
= y1
- y0
;
8909 RESTORE_IT (it
, it
, it2data
);
8910 /* If we did not reach target_y, try to move further backward if
8911 we can. If we moved too far backward, try to move forward. */
8912 if (target_y
< it
->current_y
8913 /* This is heuristic. In a window that's 3 lines high, with
8914 a line height of 13 pixels each, recentering with point
8915 on the bottom line will try to move -39/2 = 19 pixels
8916 backward. Try to avoid moving into the first line. */
8917 && (it
->current_y
- target_y
8918 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8919 && IT_CHARPOS (*it
) > BEGV
)
8921 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8922 target_y
- it
->current_y
));
8923 dy
= it
->current_y
- target_y
;
8924 goto move_further_back
;
8926 else if (target_y
>= it
->current_y
+ line_height
8927 && IT_CHARPOS (*it
) < ZV
)
8929 /* Should move forward by at least one line, maybe more.
8931 Note: Calling move_it_by_lines can be expensive on
8932 terminal frames, where compute_motion is used (via
8933 vmotion) to do the job, when there are very long lines
8934 and truncate-lines is nil. That's the reason for
8935 treating terminal frames specially here. */
8937 if (!FRAME_WINDOW_P (it
->f
))
8938 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8943 move_it_by_lines (it
, 1);
8945 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8952 /* Move IT by a specified amount of pixel lines DY. DY negative means
8953 move backwards. DY = 0 means move to start of screen line. At the
8954 end, IT will be on the start of a screen line. */
8957 move_it_vertically (struct it
*it
, int dy
)
8960 move_it_vertically_backward (it
, -dy
);
8963 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8964 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8965 MOVE_TO_POS
| MOVE_TO_Y
);
8966 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8968 /* If buffer ends in ZV without a newline, move to the start of
8969 the line to satisfy the post-condition. */
8970 if (IT_CHARPOS (*it
) == ZV
8972 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8973 move_it_by_lines (it
, 0);
8978 /* Move iterator IT past the end of the text line it is in. */
8981 move_it_past_eol (struct it
*it
)
8983 enum move_it_result rc
;
8985 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8986 if (rc
== MOVE_NEWLINE_OR_CR
)
8987 set_iterator_to_next (it
, 0);
8991 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8992 negative means move up. DVPOS == 0 means move to the start of the
8995 Optimization idea: If we would know that IT->f doesn't use
8996 a face with proportional font, we could be faster for
8997 truncate-lines nil. */
9000 move_it_by_lines (struct it
*it
, int dvpos
)
9003 /* The commented-out optimization uses vmotion on terminals. This
9004 gives bad results, because elements like it->what, on which
9005 callers such as pos_visible_p rely, aren't updated. */
9006 /* struct position pos;
9007 if (!FRAME_WINDOW_P (it->f))
9009 struct text_pos textpos;
9011 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9012 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9013 reseat (it, textpos, 1);
9014 it->vpos += pos.vpos;
9015 it->current_y += pos.vpos;
9021 /* DVPOS == 0 means move to the start of the screen line. */
9022 move_it_vertically_backward (it
, 0);
9023 /* Let next call to line_bottom_y calculate real line height */
9028 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9029 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9031 /* Only move to the next buffer position if we ended up in a
9032 string from display property, not in an overlay string
9033 (before-string or after-string). That is because the
9034 latter don't conceal the underlying buffer position, so
9035 we can ask to move the iterator to the exact position we
9036 are interested in. Note that, even if we are already at
9037 IT_CHARPOS (*it), the call below is not a no-op, as it
9038 will detect that we are at the end of the string, pop the
9039 iterator, and compute it->current_x and it->hpos
9041 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9042 -1, -1, -1, MOVE_TO_POS
);
9048 void *it2data
= NULL
;
9049 EMACS_INT start_charpos
, i
;
9051 /* Start at the beginning of the screen line containing IT's
9052 position. This may actually move vertically backwards,
9053 in case of overlays, so adjust dvpos accordingly. */
9055 move_it_vertically_backward (it
, 0);
9058 /* Go back -DVPOS visible lines and reseat the iterator there. */
9059 start_charpos
= IT_CHARPOS (*it
);
9060 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9061 back_to_previous_visible_line_start (it
);
9062 reseat (it
, it
->current
.pos
, 1);
9064 /* Move further back if we end up in a string or an image. */
9065 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9067 /* First try to move to start of display line. */
9069 move_it_vertically_backward (it
, 0);
9071 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9073 /* If start of line is still in string or image,
9074 move further back. */
9075 back_to_previous_visible_line_start (it
);
9076 reseat (it
, it
->current
.pos
, 1);
9080 it
->current_x
= it
->hpos
= 0;
9082 /* Above call may have moved too far if continuation lines
9083 are involved. Scan forward and see if it did. */
9084 SAVE_IT (it2
, *it
, it2data
);
9085 it2
.vpos
= it2
.current_y
= 0;
9086 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9087 it
->vpos
-= it2
.vpos
;
9088 it
->current_y
-= it2
.current_y
;
9089 it
->current_x
= it
->hpos
= 0;
9091 /* If we moved too far back, move IT some lines forward. */
9092 if (it2
.vpos
> -dvpos
)
9094 int delta
= it2
.vpos
+ dvpos
;
9096 RESTORE_IT (&it2
, &it2
, it2data
);
9097 SAVE_IT (it2
, *it
, it2data
);
9098 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9099 /* Move back again if we got too far ahead. */
9100 if (IT_CHARPOS (*it
) >= start_charpos
)
9101 RESTORE_IT (it
, &it2
, it2data
);
9103 bidi_unshelve_cache (it2data
, 1);
9106 RESTORE_IT (it
, it
, it2data
);
9110 /* Return 1 if IT points into the middle of a display vector. */
9113 in_display_vector_p (struct it
*it
)
9115 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9116 && it
->current
.dpvec_index
> 0
9117 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9121 /***********************************************************************
9123 ***********************************************************************/
9126 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9130 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9132 Lisp_Object args
[3];
9133 Lisp_Object msg
, fmt
;
9136 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9139 /* Do nothing if called asynchronously. Inserting text into
9140 a buffer may call after-change-functions and alike and
9141 that would means running Lisp asynchronously. */
9142 if (handling_signal
)
9146 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9148 args
[0] = fmt
= build_string (format
);
9151 msg
= Fformat (3, args
);
9153 len
= SBYTES (msg
) + 1;
9154 SAFE_ALLOCA (buffer
, char *, len
);
9155 memcpy (buffer
, SDATA (msg
), len
);
9157 message_dolog (buffer
, len
- 1, 1, 0);
9164 /* Output a newline in the *Messages* buffer if "needs" one. */
9167 message_log_maybe_newline (void)
9169 if (message_log_need_newline
)
9170 message_dolog ("", 0, 1, 0);
9174 /* Add a string M of length NBYTES to the message log, optionally
9175 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9176 nonzero, means interpret the contents of M as multibyte. This
9177 function calls low-level routines in order to bypass text property
9178 hooks, etc. which might not be safe to run.
9180 This may GC (insert may run before/after change hooks),
9181 so the buffer M must NOT point to a Lisp string. */
9184 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9186 const unsigned char *msg
= (const unsigned char *) m
;
9188 if (!NILP (Vmemory_full
))
9191 if (!NILP (Vmessage_log_max
))
9193 struct buffer
*oldbuf
;
9194 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9195 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9196 EMACS_INT point_at_end
= 0;
9197 EMACS_INT zv_at_end
= 0;
9198 Lisp_Object old_deactivate_mark
, tem
;
9199 struct gcpro gcpro1
;
9201 old_deactivate_mark
= Vdeactivate_mark
;
9202 oldbuf
= current_buffer
;
9203 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9204 BVAR (current_buffer
, undo_list
) = Qt
;
9206 oldpoint
= message_dolog_marker1
;
9207 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9208 oldbegv
= message_dolog_marker2
;
9209 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9210 oldzv
= message_dolog_marker3
;
9211 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9212 GCPRO1 (old_deactivate_mark
);
9220 BEGV_BYTE
= BEG_BYTE
;
9223 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9225 /* Insert the string--maybe converting multibyte to single byte
9226 or vice versa, so that all the text fits the buffer. */
9228 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9234 /* Convert a multibyte string to single-byte
9235 for the *Message* buffer. */
9236 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9238 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9239 work
[0] = (ASCII_CHAR_P (c
)
9241 : multibyte_char_to_unibyte (c
));
9242 insert_1_both (work
, 1, 1, 1, 0, 0);
9245 else if (! multibyte
9246 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9250 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9251 /* Convert a single-byte string to multibyte
9252 for the *Message* buffer. */
9253 for (i
= 0; i
< nbytes
; i
++)
9256 MAKE_CHAR_MULTIBYTE (c
);
9257 char_bytes
= CHAR_STRING (c
, str
);
9258 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9262 insert_1 (m
, nbytes
, 1, 0, 0);
9266 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9268 insert_1 ("\n", 1, 1, 0, 0);
9270 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9272 this_bol_byte
= PT_BYTE
;
9274 /* See if this line duplicates the previous one.
9275 If so, combine duplicates. */
9278 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9280 prev_bol_byte
= PT_BYTE
;
9282 dups
= message_log_check_duplicate (prev_bol_byte
,
9286 del_range_both (prev_bol
, prev_bol_byte
,
9287 this_bol
, this_bol_byte
, 0);
9290 char dupstr
[sizeof " [ times]"
9291 + INT_STRLEN_BOUND (printmax_t
)];
9294 /* If you change this format, don't forget to also
9295 change message_log_check_duplicate. */
9296 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9297 duplen
= strlen (dupstr
);
9298 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9299 insert_1 (dupstr
, duplen
, 1, 0, 1);
9304 /* If we have more than the desired maximum number of lines
9305 in the *Messages* buffer now, delete the oldest ones.
9306 This is safe because we don't have undo in this buffer. */
9308 if (NATNUMP (Vmessage_log_max
))
9310 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9311 -XFASTINT (Vmessage_log_max
) - 1, 0);
9312 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9315 BEGV
= XMARKER (oldbegv
)->charpos
;
9316 BEGV_BYTE
= marker_byte_position (oldbegv
);
9325 ZV
= XMARKER (oldzv
)->charpos
;
9326 ZV_BYTE
= marker_byte_position (oldzv
);
9330 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9332 /* We can't do Fgoto_char (oldpoint) because it will run some
9334 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9335 XMARKER (oldpoint
)->bytepos
);
9338 unchain_marker (XMARKER (oldpoint
));
9339 unchain_marker (XMARKER (oldbegv
));
9340 unchain_marker (XMARKER (oldzv
));
9342 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9343 set_buffer_internal (oldbuf
);
9345 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9346 message_log_need_newline
= !nlflag
;
9347 Vdeactivate_mark
= old_deactivate_mark
;
9352 /* We are at the end of the buffer after just having inserted a newline.
9353 (Note: We depend on the fact we won't be crossing the gap.)
9354 Check to see if the most recent message looks a lot like the previous one.
9355 Return 0 if different, 1 if the new one should just replace it, or a
9356 value N > 1 if we should also append " [N times]". */
9359 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9362 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9364 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9365 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9367 for (i
= 0; i
< len
; i
++)
9369 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9377 if (*p1
++ == ' ' && *p1
++ == '[')
9380 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9381 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9388 /* Display an echo area message M with a specified length of NBYTES
9389 bytes. The string may include null characters. If M is 0, clear
9390 out any existing message, and let the mini-buffer text show
9393 This may GC, so the buffer M must NOT point to a Lisp string. */
9396 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9398 /* First flush out any partial line written with print. */
9399 message_log_maybe_newline ();
9401 message_dolog (m
, nbytes
, 1, multibyte
);
9402 message2_nolog (m
, nbytes
, multibyte
);
9406 /* The non-logging counterpart of message2. */
9409 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9411 struct frame
*sf
= SELECTED_FRAME ();
9412 message_enable_multibyte
= multibyte
;
9414 if (FRAME_INITIAL_P (sf
))
9416 if (noninteractive_need_newline
)
9417 putc ('\n', stderr
);
9418 noninteractive_need_newline
= 0;
9420 fwrite (m
, nbytes
, 1, stderr
);
9421 if (cursor_in_echo_area
== 0)
9422 fprintf (stderr
, "\n");
9425 /* A null message buffer means that the frame hasn't really been
9426 initialized yet. Error messages get reported properly by
9427 cmd_error, so this must be just an informative message; toss it. */
9428 else if (INTERACTIVE
9429 && sf
->glyphs_initialized_p
9430 && FRAME_MESSAGE_BUF (sf
))
9432 Lisp_Object mini_window
;
9435 /* Get the frame containing the mini-buffer
9436 that the selected frame is using. */
9437 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9438 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9440 FRAME_SAMPLE_VISIBILITY (f
);
9441 if (FRAME_VISIBLE_P (sf
)
9442 && ! FRAME_VISIBLE_P (f
))
9443 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9447 set_message (m
, Qnil
, nbytes
, multibyte
);
9448 if (minibuffer_auto_raise
)
9449 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9452 clear_message (1, 1);
9454 do_pending_window_change (0);
9455 echo_area_display (1);
9456 do_pending_window_change (0);
9457 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9458 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9463 /* Display an echo area message M with a specified length of NBYTES
9464 bytes. The string may include null characters. If M is not a
9465 string, clear out any existing message, and let the mini-buffer
9468 This function cancels echoing. */
9471 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9473 struct gcpro gcpro1
;
9476 clear_message (1,1);
9479 /* First flush out any partial line written with print. */
9480 message_log_maybe_newline ();
9486 SAFE_ALLOCA (buffer
, char *, nbytes
);
9487 memcpy (buffer
, SDATA (m
), nbytes
);
9488 message_dolog (buffer
, nbytes
, 1, multibyte
);
9491 message3_nolog (m
, nbytes
, multibyte
);
9497 /* The non-logging version of message3.
9498 This does not cancel echoing, because it is used for echoing.
9499 Perhaps we need to make a separate function for echoing
9500 and make this cancel echoing. */
9503 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9505 struct frame
*sf
= SELECTED_FRAME ();
9506 message_enable_multibyte
= multibyte
;
9508 if (FRAME_INITIAL_P (sf
))
9510 if (noninteractive_need_newline
)
9511 putc ('\n', stderr
);
9512 noninteractive_need_newline
= 0;
9514 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9515 if (cursor_in_echo_area
== 0)
9516 fprintf (stderr
, "\n");
9519 /* A null message buffer means that the frame hasn't really been
9520 initialized yet. Error messages get reported properly by
9521 cmd_error, so this must be just an informative message; toss it. */
9522 else if (INTERACTIVE
9523 && sf
->glyphs_initialized_p
9524 && FRAME_MESSAGE_BUF (sf
))
9526 Lisp_Object mini_window
;
9530 /* Get the frame containing the mini-buffer
9531 that the selected frame is using. */
9532 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9533 frame
= XWINDOW (mini_window
)->frame
;
9536 FRAME_SAMPLE_VISIBILITY (f
);
9537 if (FRAME_VISIBLE_P (sf
)
9538 && !FRAME_VISIBLE_P (f
))
9539 Fmake_frame_visible (frame
);
9541 if (STRINGP (m
) && SCHARS (m
) > 0)
9543 set_message (NULL
, m
, nbytes
, multibyte
);
9544 if (minibuffer_auto_raise
)
9545 Fraise_frame (frame
);
9546 /* Assume we are not echoing.
9547 (If we are, echo_now will override this.) */
9548 echo_message_buffer
= Qnil
;
9551 clear_message (1, 1);
9553 do_pending_window_change (0);
9554 echo_area_display (1);
9555 do_pending_window_change (0);
9556 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9557 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9562 /* Display a null-terminated echo area message M. If M is 0, clear
9563 out any existing message, and let the mini-buffer text show through.
9565 The buffer M must continue to exist until after the echo area gets
9566 cleared or some other message gets displayed there. Do not pass
9567 text that is stored in a Lisp string. Do not pass text in a buffer
9568 that was alloca'd. */
9571 message1 (const char *m
)
9573 message2 (m
, (m
? strlen (m
) : 0), 0);
9577 /* The non-logging counterpart of message1. */
9580 message1_nolog (const char *m
)
9582 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9585 /* Display a message M which contains a single %s
9586 which gets replaced with STRING. */
9589 message_with_string (const char *m
, Lisp_Object string
, int log
)
9591 CHECK_STRING (string
);
9597 if (noninteractive_need_newline
)
9598 putc ('\n', stderr
);
9599 noninteractive_need_newline
= 0;
9600 fprintf (stderr
, m
, SDATA (string
));
9601 if (!cursor_in_echo_area
)
9602 fprintf (stderr
, "\n");
9606 else if (INTERACTIVE
)
9608 /* The frame whose minibuffer we're going to display the message on.
9609 It may be larger than the selected frame, so we need
9610 to use its buffer, not the selected frame's buffer. */
9611 Lisp_Object mini_window
;
9612 struct frame
*f
, *sf
= SELECTED_FRAME ();
9614 /* Get the frame containing the minibuffer
9615 that the selected frame is using. */
9616 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9617 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9619 /* A null message buffer means that the frame hasn't really been
9620 initialized yet. Error messages get reported properly by
9621 cmd_error, so this must be just an informative message; toss it. */
9622 if (FRAME_MESSAGE_BUF (f
))
9624 Lisp_Object args
[2], msg
;
9625 struct gcpro gcpro1
, gcpro2
;
9627 args
[0] = build_string (m
);
9628 args
[1] = msg
= string
;
9629 GCPRO2 (args
[0], msg
);
9632 msg
= Fformat (2, args
);
9635 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9637 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9641 /* Print should start at the beginning of the message
9642 buffer next time. */
9643 message_buf_print
= 0;
9649 /* Dump an informative message to the minibuf. If M is 0, clear out
9650 any existing message, and let the mini-buffer text show through. */
9653 vmessage (const char *m
, va_list ap
)
9659 if (noninteractive_need_newline
)
9660 putc ('\n', stderr
);
9661 noninteractive_need_newline
= 0;
9662 vfprintf (stderr
, m
, ap
);
9663 if (cursor_in_echo_area
== 0)
9664 fprintf (stderr
, "\n");
9668 else if (INTERACTIVE
)
9670 /* The frame whose mini-buffer we're going to display the message
9671 on. It may be larger than the selected frame, so we need to
9672 use its buffer, not the selected frame's buffer. */
9673 Lisp_Object mini_window
;
9674 struct frame
*f
, *sf
= SELECTED_FRAME ();
9676 /* Get the frame containing the mini-buffer
9677 that the selected frame is using. */
9678 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9679 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9681 /* A null message buffer means that the frame hasn't really been
9682 initialized yet. Error messages get reported properly by
9683 cmd_error, so this must be just an informative message; toss
9685 if (FRAME_MESSAGE_BUF (f
))
9691 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9692 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9694 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9699 /* Print should start at the beginning of the message
9700 buffer next time. */
9701 message_buf_print
= 0;
9707 message (const char *m
, ...)
9717 /* The non-logging version of message. */
9720 message_nolog (const char *m
, ...)
9722 Lisp_Object old_log_max
;
9725 old_log_max
= Vmessage_log_max
;
9726 Vmessage_log_max
= Qnil
;
9728 Vmessage_log_max
= old_log_max
;
9734 /* Display the current message in the current mini-buffer. This is
9735 only called from error handlers in process.c, and is not time
9739 update_echo_area (void)
9741 if (!NILP (echo_area_buffer
[0]))
9744 string
= Fcurrent_message ();
9745 message3 (string
, SBYTES (string
),
9746 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9751 /* Make sure echo area buffers in `echo_buffers' are live.
9752 If they aren't, make new ones. */
9755 ensure_echo_area_buffers (void)
9759 for (i
= 0; i
< 2; ++i
)
9760 if (!BUFFERP (echo_buffer
[i
])
9761 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9764 Lisp_Object old_buffer
;
9767 old_buffer
= echo_buffer
[i
];
9768 sprintf (name
, " *Echo Area %d*", i
);
9769 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9770 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9771 /* to force word wrap in echo area -
9772 it was decided to postpone this*/
9773 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9775 for (j
= 0; j
< 2; ++j
)
9776 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9777 echo_area_buffer
[j
] = echo_buffer
[i
];
9782 /* Call FN with args A1..A4 with either the current or last displayed
9783 echo_area_buffer as current buffer.
9785 WHICH zero means use the current message buffer
9786 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9787 from echo_buffer[] and clear it.
9789 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9790 suitable buffer from echo_buffer[] and clear it.
9792 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9793 that the current message becomes the last displayed one, make
9794 choose a suitable buffer for echo_area_buffer[0], and clear it.
9796 Value is what FN returns. */
9799 with_echo_area_buffer (struct window
*w
, int which
,
9800 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9801 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9804 int this_one
, the_other
, clear_buffer_p
, rc
;
9805 int count
= SPECPDL_INDEX ();
9807 /* If buffers aren't live, make new ones. */
9808 ensure_echo_area_buffers ();
9813 this_one
= 0, the_other
= 1;
9815 this_one
= 1, the_other
= 0;
9818 this_one
= 0, the_other
= 1;
9821 /* We need a fresh one in case the current echo buffer equals
9822 the one containing the last displayed echo area message. */
9823 if (!NILP (echo_area_buffer
[this_one
])
9824 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9825 echo_area_buffer
[this_one
] = Qnil
;
9828 /* Choose a suitable buffer from echo_buffer[] is we don't
9830 if (NILP (echo_area_buffer
[this_one
]))
9832 echo_area_buffer
[this_one
]
9833 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9834 ? echo_buffer
[the_other
]
9835 : echo_buffer
[this_one
]);
9839 buffer
= echo_area_buffer
[this_one
];
9841 /* Don't get confused by reusing the buffer used for echoing
9842 for a different purpose. */
9843 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9846 record_unwind_protect (unwind_with_echo_area_buffer
,
9847 with_echo_area_buffer_unwind_data (w
));
9849 /* Make the echo area buffer current. Note that for display
9850 purposes, it is not necessary that the displayed window's buffer
9851 == current_buffer, except for text property lookup. So, let's
9852 only set that buffer temporarily here without doing a full
9853 Fset_window_buffer. We must also change w->pointm, though,
9854 because otherwise an assertions in unshow_buffer fails, and Emacs
9856 set_buffer_internal_1 (XBUFFER (buffer
));
9860 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9863 BVAR (current_buffer
, undo_list
) = Qt
;
9864 BVAR (current_buffer
, read_only
) = Qnil
;
9865 specbind (Qinhibit_read_only
, Qt
);
9866 specbind (Qinhibit_modification_hooks
, Qt
);
9868 if (clear_buffer_p
&& Z
> BEG
)
9871 xassert (BEGV
>= BEG
);
9872 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9874 rc
= fn (a1
, a2
, a3
, a4
);
9876 xassert (BEGV
>= BEG
);
9877 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9879 unbind_to (count
, Qnil
);
9884 /* Save state that should be preserved around the call to the function
9885 FN called in with_echo_area_buffer. */
9888 with_echo_area_buffer_unwind_data (struct window
*w
)
9891 Lisp_Object vector
, tmp
;
9893 /* Reduce consing by keeping one vector in
9894 Vwith_echo_area_save_vector. */
9895 vector
= Vwith_echo_area_save_vector
;
9896 Vwith_echo_area_save_vector
= Qnil
;
9899 vector
= Fmake_vector (make_number (7), Qnil
);
9901 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9902 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9903 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9907 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9908 ASET (vector
, i
, w
->buffer
); ++i
;
9909 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9910 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9915 for (; i
< end
; ++i
)
9916 ASET (vector
, i
, Qnil
);
9919 xassert (i
== ASIZE (vector
));
9924 /* Restore global state from VECTOR which was created by
9925 with_echo_area_buffer_unwind_data. */
9928 unwind_with_echo_area_buffer (Lisp_Object vector
)
9930 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9931 Vdeactivate_mark
= AREF (vector
, 1);
9932 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9934 if (WINDOWP (AREF (vector
, 3)))
9937 Lisp_Object buffer
, charpos
, bytepos
;
9939 w
= XWINDOW (AREF (vector
, 3));
9940 buffer
= AREF (vector
, 4);
9941 charpos
= AREF (vector
, 5);
9942 bytepos
= AREF (vector
, 6);
9945 set_marker_both (w
->pointm
, buffer
,
9946 XFASTINT (charpos
), XFASTINT (bytepos
));
9949 Vwith_echo_area_save_vector
= vector
;
9954 /* Set up the echo area for use by print functions. MULTIBYTE_P
9955 non-zero means we will print multibyte. */
9958 setup_echo_area_for_printing (int multibyte_p
)
9960 /* If we can't find an echo area any more, exit. */
9961 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9964 ensure_echo_area_buffers ();
9966 if (!message_buf_print
)
9968 /* A message has been output since the last time we printed.
9969 Choose a fresh echo area buffer. */
9970 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9971 echo_area_buffer
[0] = echo_buffer
[1];
9973 echo_area_buffer
[0] = echo_buffer
[0];
9975 /* Switch to that buffer and clear it. */
9976 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9977 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9981 int count
= SPECPDL_INDEX ();
9982 specbind (Qinhibit_read_only
, Qt
);
9983 /* Note that undo recording is always disabled. */
9985 unbind_to (count
, Qnil
);
9987 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9989 /* Set up the buffer for the multibyteness we need. */
9991 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9992 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9994 /* Raise the frame containing the echo area. */
9995 if (minibuffer_auto_raise
)
9997 struct frame
*sf
= SELECTED_FRAME ();
9998 Lisp_Object mini_window
;
9999 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10000 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10003 message_log_maybe_newline ();
10004 message_buf_print
= 1;
10008 if (NILP (echo_area_buffer
[0]))
10010 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10011 echo_area_buffer
[0] = echo_buffer
[1];
10013 echo_area_buffer
[0] = echo_buffer
[0];
10016 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10018 /* Someone switched buffers between print requests. */
10019 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10020 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10026 /* Display an echo area message in window W. Value is non-zero if W's
10027 height is changed. If display_last_displayed_message_p is
10028 non-zero, display the message that was last displayed, otherwise
10029 display the current message. */
10032 display_echo_area (struct window
*w
)
10034 int i
, no_message_p
, window_height_changed_p
, count
;
10036 /* Temporarily disable garbage collections while displaying the echo
10037 area. This is done because a GC can print a message itself.
10038 That message would modify the echo area buffer's contents while a
10039 redisplay of the buffer is going on, and seriously confuse
10041 count
= inhibit_garbage_collection ();
10043 /* If there is no message, we must call display_echo_area_1
10044 nevertheless because it resizes the window. But we will have to
10045 reset the echo_area_buffer in question to nil at the end because
10046 with_echo_area_buffer will sets it to an empty buffer. */
10047 i
= display_last_displayed_message_p
? 1 : 0;
10048 no_message_p
= NILP (echo_area_buffer
[i
]);
10050 window_height_changed_p
10051 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10052 display_echo_area_1
,
10053 (intptr_t) w
, Qnil
, 0, 0);
10056 echo_area_buffer
[i
] = Qnil
;
10058 unbind_to (count
, Qnil
);
10059 return window_height_changed_p
;
10063 /* Helper for display_echo_area. Display the current buffer which
10064 contains the current echo area message in window W, a mini-window,
10065 a pointer to which is passed in A1. A2..A4 are currently not used.
10066 Change the height of W so that all of the message is displayed.
10067 Value is non-zero if height of W was changed. */
10070 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10073 struct window
*w
= (struct window
*) i1
;
10074 Lisp_Object window
;
10075 struct text_pos start
;
10076 int window_height_changed_p
= 0;
10078 /* Do this before displaying, so that we have a large enough glyph
10079 matrix for the display. If we can't get enough space for the
10080 whole text, display the last N lines. That works by setting w->start. */
10081 window_height_changed_p
= resize_mini_window (w
, 0);
10083 /* Use the starting position chosen by resize_mini_window. */
10084 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10087 clear_glyph_matrix (w
->desired_matrix
);
10088 XSETWINDOW (window
, w
);
10089 try_window (window
, start
, 0);
10091 return window_height_changed_p
;
10095 /* Resize the echo area window to exactly the size needed for the
10096 currently displayed message, if there is one. If a mini-buffer
10097 is active, don't shrink it. */
10100 resize_echo_area_exactly (void)
10102 if (BUFFERP (echo_area_buffer
[0])
10103 && WINDOWP (echo_area_window
))
10105 struct window
*w
= XWINDOW (echo_area_window
);
10107 Lisp_Object resize_exactly
;
10109 if (minibuf_level
== 0)
10110 resize_exactly
= Qt
;
10112 resize_exactly
= Qnil
;
10114 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10115 (intptr_t) w
, resize_exactly
,
10119 ++windows_or_buffers_changed
;
10120 ++update_mode_lines
;
10121 redisplay_internal ();
10127 /* Callback function for with_echo_area_buffer, when used from
10128 resize_echo_area_exactly. A1 contains a pointer to the window to
10129 resize, EXACTLY non-nil means resize the mini-window exactly to the
10130 size of the text displayed. A3 and A4 are not used. Value is what
10131 resize_mini_window returns. */
10134 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10137 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10141 /* Resize mini-window W to fit the size of its contents. EXACT_P
10142 means size the window exactly to the size needed. Otherwise, it's
10143 only enlarged until W's buffer is empty.
10145 Set W->start to the right place to begin display. If the whole
10146 contents fit, start at the beginning. Otherwise, start so as
10147 to make the end of the contents appear. This is particularly
10148 important for y-or-n-p, but seems desirable generally.
10150 Value is non-zero if the window height has been changed. */
10153 resize_mini_window (struct window
*w
, int exact_p
)
10155 struct frame
*f
= XFRAME (w
->frame
);
10156 int window_height_changed_p
= 0;
10158 xassert (MINI_WINDOW_P (w
));
10160 /* By default, start display at the beginning. */
10161 set_marker_both (w
->start
, w
->buffer
,
10162 BUF_BEGV (XBUFFER (w
->buffer
)),
10163 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10165 /* Don't resize windows while redisplaying a window; it would
10166 confuse redisplay functions when the size of the window they are
10167 displaying changes from under them. Such a resizing can happen,
10168 for instance, when which-func prints a long message while
10169 we are running fontification-functions. We're running these
10170 functions with safe_call which binds inhibit-redisplay to t. */
10171 if (!NILP (Vinhibit_redisplay
))
10174 /* Nil means don't try to resize. */
10175 if (NILP (Vresize_mini_windows
)
10176 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10179 if (!FRAME_MINIBUF_ONLY_P (f
))
10182 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10183 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10184 int height
, max_height
;
10185 int unit
= FRAME_LINE_HEIGHT (f
);
10186 struct text_pos start
;
10187 struct buffer
*old_current_buffer
= NULL
;
10189 if (current_buffer
!= XBUFFER (w
->buffer
))
10191 old_current_buffer
= current_buffer
;
10192 set_buffer_internal (XBUFFER (w
->buffer
));
10195 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10197 /* Compute the max. number of lines specified by the user. */
10198 if (FLOATP (Vmax_mini_window_height
))
10199 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10200 else if (INTEGERP (Vmax_mini_window_height
))
10201 max_height
= XINT (Vmax_mini_window_height
);
10203 max_height
= total_height
/ 4;
10205 /* Correct that max. height if it's bogus. */
10206 max_height
= max (1, max_height
);
10207 max_height
= min (total_height
, max_height
);
10209 /* Find out the height of the text in the window. */
10210 if (it
.line_wrap
== TRUNCATE
)
10215 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10216 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10217 height
= it
.current_y
+ last_height
;
10219 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10220 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10221 height
= (height
+ unit
- 1) / unit
;
10224 /* Compute a suitable window start. */
10225 if (height
> max_height
)
10227 height
= max_height
;
10228 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10229 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10230 start
= it
.current
.pos
;
10233 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10234 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10236 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10238 /* Let it grow only, until we display an empty message, in which
10239 case the window shrinks again. */
10240 if (height
> WINDOW_TOTAL_LINES (w
))
10242 int old_height
= WINDOW_TOTAL_LINES (w
);
10243 freeze_window_starts (f
, 1);
10244 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10245 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10247 else if (height
< WINDOW_TOTAL_LINES (w
)
10248 && (exact_p
|| BEGV
== ZV
))
10250 int old_height
= WINDOW_TOTAL_LINES (w
);
10251 freeze_window_starts (f
, 0);
10252 shrink_mini_window (w
);
10253 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10258 /* Always resize to exact size needed. */
10259 if (height
> WINDOW_TOTAL_LINES (w
))
10261 int old_height
= WINDOW_TOTAL_LINES (w
);
10262 freeze_window_starts (f
, 1);
10263 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10264 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10266 else if (height
< WINDOW_TOTAL_LINES (w
))
10268 int old_height
= WINDOW_TOTAL_LINES (w
);
10269 freeze_window_starts (f
, 0);
10270 shrink_mini_window (w
);
10274 freeze_window_starts (f
, 1);
10275 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10278 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10282 if (old_current_buffer
)
10283 set_buffer_internal (old_current_buffer
);
10286 return window_height_changed_p
;
10290 /* Value is the current message, a string, or nil if there is no
10291 current message. */
10294 current_message (void)
10298 if (!BUFFERP (echo_area_buffer
[0]))
10302 with_echo_area_buffer (0, 0, current_message_1
,
10303 (intptr_t) &msg
, Qnil
, 0, 0);
10305 echo_area_buffer
[0] = Qnil
;
10313 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10316 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10319 *msg
= make_buffer_string (BEG
, Z
, 1);
10326 /* Push the current message on Vmessage_stack for later restoration
10327 by restore_message. Value is non-zero if the current message isn't
10328 empty. This is a relatively infrequent operation, so it's not
10329 worth optimizing. */
10332 push_message (void)
10335 msg
= current_message ();
10336 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10337 return STRINGP (msg
);
10341 /* Restore message display from the top of Vmessage_stack. */
10344 restore_message (void)
10348 xassert (CONSP (Vmessage_stack
));
10349 msg
= XCAR (Vmessage_stack
);
10351 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10353 message3_nolog (msg
, 0, 0);
10357 /* Handler for record_unwind_protect calling pop_message. */
10360 pop_message_unwind (Lisp_Object dummy
)
10366 /* Pop the top-most entry off Vmessage_stack. */
10371 xassert (CONSP (Vmessage_stack
));
10372 Vmessage_stack
= XCDR (Vmessage_stack
);
10376 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10377 exits. If the stack is not empty, we have a missing pop_message
10381 check_message_stack (void)
10383 if (!NILP (Vmessage_stack
))
10388 /* Truncate to NCHARS what will be displayed in the echo area the next
10389 time we display it---but don't redisplay it now. */
10392 truncate_echo_area (EMACS_INT nchars
)
10395 echo_area_buffer
[0] = Qnil
;
10396 /* A null message buffer means that the frame hasn't really been
10397 initialized yet. Error messages get reported properly by
10398 cmd_error, so this must be just an informative message; toss it. */
10399 else if (!noninteractive
10401 && !NILP (echo_area_buffer
[0]))
10403 struct frame
*sf
= SELECTED_FRAME ();
10404 if (FRAME_MESSAGE_BUF (sf
))
10405 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10410 /* Helper function for truncate_echo_area. Truncate the current
10411 message to at most NCHARS characters. */
10414 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10416 if (BEG
+ nchars
< Z
)
10417 del_range (BEG
+ nchars
, Z
);
10419 echo_area_buffer
[0] = Qnil
;
10424 /* Set the current message to a substring of S or STRING.
10426 If STRING is a Lisp string, set the message to the first NBYTES
10427 bytes from STRING. NBYTES zero means use the whole string. If
10428 STRING is multibyte, the message will be displayed multibyte.
10430 If S is not null, set the message to the first LEN bytes of S. LEN
10431 zero means use the whole string. MULTIBYTE_P non-zero means S is
10432 multibyte. Display the message multibyte in that case.
10434 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10435 to t before calling set_message_1 (which calls insert).
10439 set_message (const char *s
, Lisp_Object string
,
10440 EMACS_INT nbytes
, int multibyte_p
)
10442 message_enable_multibyte
10443 = ((s
&& multibyte_p
)
10444 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10446 with_echo_area_buffer (0, -1, set_message_1
,
10447 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10448 message_buf_print
= 0;
10449 help_echo_showing_p
= 0;
10453 /* Helper function for set_message. Arguments have the same meaning
10454 as there, with A1 corresponding to S and A2 corresponding to STRING
10455 This function is called with the echo area buffer being
10459 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10462 const char *s
= (const char *) i1
;
10463 const unsigned char *msg
= (const unsigned char *) s
;
10464 Lisp_Object string
= a2
;
10466 /* Change multibyteness of the echo buffer appropriately. */
10467 if (message_enable_multibyte
10468 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10469 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10471 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10472 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10473 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10475 /* Insert new message at BEG. */
10476 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10478 if (STRINGP (string
))
10483 nbytes
= SBYTES (string
);
10484 nchars
= string_byte_to_char (string
, nbytes
);
10486 /* This function takes care of single/multibyte conversion. We
10487 just have to ensure that the echo area buffer has the right
10488 setting of enable_multibyte_characters. */
10489 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10494 nbytes
= strlen (s
);
10496 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10498 /* Convert from multi-byte to single-byte. */
10503 /* Convert a multibyte string to single-byte. */
10504 for (i
= 0; i
< nbytes
; i
+= n
)
10506 c
= string_char_and_length (msg
+ i
, &n
);
10507 work
[0] = (ASCII_CHAR_P (c
)
10509 : multibyte_char_to_unibyte (c
));
10510 insert_1_both (work
, 1, 1, 1, 0, 0);
10513 else if (!multibyte_p
10514 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10516 /* Convert from single-byte to multi-byte. */
10519 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10521 /* Convert a single-byte string to multibyte. */
10522 for (i
= 0; i
< nbytes
; i
++)
10525 MAKE_CHAR_MULTIBYTE (c
);
10526 n
= CHAR_STRING (c
, str
);
10527 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10531 insert_1 (s
, nbytes
, 1, 0, 0);
10538 /* Clear messages. CURRENT_P non-zero means clear the current
10539 message. LAST_DISPLAYED_P non-zero means clear the message
10543 clear_message (int current_p
, int last_displayed_p
)
10547 echo_area_buffer
[0] = Qnil
;
10548 message_cleared_p
= 1;
10551 if (last_displayed_p
)
10552 echo_area_buffer
[1] = Qnil
;
10554 message_buf_print
= 0;
10557 /* Clear garbaged frames.
10559 This function is used where the old redisplay called
10560 redraw_garbaged_frames which in turn called redraw_frame which in
10561 turn called clear_frame. The call to clear_frame was a source of
10562 flickering. I believe a clear_frame is not necessary. It should
10563 suffice in the new redisplay to invalidate all current matrices,
10564 and ensure a complete redisplay of all windows. */
10567 clear_garbaged_frames (void)
10569 if (frame_garbaged
)
10571 Lisp_Object tail
, frame
;
10572 int changed_count
= 0;
10574 FOR_EACH_FRAME (tail
, frame
)
10576 struct frame
*f
= XFRAME (frame
);
10578 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10582 Fredraw_frame (frame
);
10583 f
->force_flush_display_p
= 1;
10585 clear_current_matrices (f
);
10592 frame_garbaged
= 0;
10594 ++windows_or_buffers_changed
;
10599 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10600 is non-zero update selected_frame. Value is non-zero if the
10601 mini-windows height has been changed. */
10604 echo_area_display (int update_frame_p
)
10606 Lisp_Object mini_window
;
10609 int window_height_changed_p
= 0;
10610 struct frame
*sf
= SELECTED_FRAME ();
10612 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10613 w
= XWINDOW (mini_window
);
10614 f
= XFRAME (WINDOW_FRAME (w
));
10616 /* Don't display if frame is invisible or not yet initialized. */
10617 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10620 #ifdef HAVE_WINDOW_SYSTEM
10621 /* When Emacs starts, selected_frame may be the initial terminal
10622 frame. If we let this through, a message would be displayed on
10624 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10626 #endif /* HAVE_WINDOW_SYSTEM */
10628 /* Redraw garbaged frames. */
10629 if (frame_garbaged
)
10630 clear_garbaged_frames ();
10632 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10634 echo_area_window
= mini_window
;
10635 window_height_changed_p
= display_echo_area (w
);
10636 w
->must_be_updated_p
= 1;
10638 /* Update the display, unless called from redisplay_internal.
10639 Also don't update the screen during redisplay itself. The
10640 update will happen at the end of redisplay, and an update
10641 here could cause confusion. */
10642 if (update_frame_p
&& !redisplaying_p
)
10646 /* If the display update has been interrupted by pending
10647 input, update mode lines in the frame. Due to the
10648 pending input, it might have been that redisplay hasn't
10649 been called, so that mode lines above the echo area are
10650 garbaged. This looks odd, so we prevent it here. */
10651 if (!display_completed
)
10652 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10654 if (window_height_changed_p
10655 /* Don't do this if Emacs is shutting down. Redisplay
10656 needs to run hooks. */
10657 && !NILP (Vrun_hooks
))
10659 /* Must update other windows. Likewise as in other
10660 cases, don't let this update be interrupted by
10662 int count
= SPECPDL_INDEX ();
10663 specbind (Qredisplay_dont_pause
, Qt
);
10664 windows_or_buffers_changed
= 1;
10665 redisplay_internal ();
10666 unbind_to (count
, Qnil
);
10668 else if (FRAME_WINDOW_P (f
) && n
== 0)
10670 /* Window configuration is the same as before.
10671 Can do with a display update of the echo area,
10672 unless we displayed some mode lines. */
10673 update_single_window (w
, 1);
10674 FRAME_RIF (f
)->flush_display (f
);
10677 update_frame (f
, 1, 1);
10679 /* If cursor is in the echo area, make sure that the next
10680 redisplay displays the minibuffer, so that the cursor will
10681 be replaced with what the minibuffer wants. */
10682 if (cursor_in_echo_area
)
10683 ++windows_or_buffers_changed
;
10686 else if (!EQ (mini_window
, selected_window
))
10687 windows_or_buffers_changed
++;
10689 /* Last displayed message is now the current message. */
10690 echo_area_buffer
[1] = echo_area_buffer
[0];
10691 /* Inform read_char that we're not echoing. */
10692 echo_message_buffer
= Qnil
;
10694 /* Prevent redisplay optimization in redisplay_internal by resetting
10695 this_line_start_pos. This is done because the mini-buffer now
10696 displays the message instead of its buffer text. */
10697 if (EQ (mini_window
, selected_window
))
10698 CHARPOS (this_line_start_pos
) = 0;
10700 return window_height_changed_p
;
10705 /***********************************************************************
10706 Mode Lines and Frame Titles
10707 ***********************************************************************/
10709 /* A buffer for constructing non-propertized mode-line strings and
10710 frame titles in it; allocated from the heap in init_xdisp and
10711 resized as needed in store_mode_line_noprop_char. */
10713 static char *mode_line_noprop_buf
;
10715 /* The buffer's end, and a current output position in it. */
10717 static char *mode_line_noprop_buf_end
;
10718 static char *mode_line_noprop_ptr
;
10720 #define MODE_LINE_NOPROP_LEN(start) \
10721 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10724 MODE_LINE_DISPLAY
= 0,
10728 } mode_line_target
;
10730 /* Alist that caches the results of :propertize.
10731 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10732 static Lisp_Object mode_line_proptrans_alist
;
10734 /* List of strings making up the mode-line. */
10735 static Lisp_Object mode_line_string_list
;
10737 /* Base face property when building propertized mode line string. */
10738 static Lisp_Object mode_line_string_face
;
10739 static Lisp_Object mode_line_string_face_prop
;
10742 /* Unwind data for mode line strings */
10744 static Lisp_Object Vmode_line_unwind_vector
;
10747 format_mode_line_unwind_data (struct buffer
*obuf
,
10749 int save_proptrans
)
10751 Lisp_Object vector
, tmp
;
10753 /* Reduce consing by keeping one vector in
10754 Vwith_echo_area_save_vector. */
10755 vector
= Vmode_line_unwind_vector
;
10756 Vmode_line_unwind_vector
= Qnil
;
10759 vector
= Fmake_vector (make_number (8), Qnil
);
10761 ASET (vector
, 0, make_number (mode_line_target
));
10762 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10763 ASET (vector
, 2, mode_line_string_list
);
10764 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10765 ASET (vector
, 4, mode_line_string_face
);
10766 ASET (vector
, 5, mode_line_string_face_prop
);
10769 XSETBUFFER (tmp
, obuf
);
10772 ASET (vector
, 6, tmp
);
10773 ASET (vector
, 7, owin
);
10779 unwind_format_mode_line (Lisp_Object vector
)
10781 mode_line_target
= XINT (AREF (vector
, 0));
10782 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10783 mode_line_string_list
= AREF (vector
, 2);
10784 if (! EQ (AREF (vector
, 3), Qt
))
10785 mode_line_proptrans_alist
= AREF (vector
, 3);
10786 mode_line_string_face
= AREF (vector
, 4);
10787 mode_line_string_face_prop
= AREF (vector
, 5);
10789 if (!NILP (AREF (vector
, 7)))
10790 /* Select window before buffer, since it may change the buffer. */
10791 Fselect_window (AREF (vector
, 7), Qt
);
10793 if (!NILP (AREF (vector
, 6)))
10795 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10796 ASET (vector
, 6, Qnil
);
10799 Vmode_line_unwind_vector
= vector
;
10804 /* Store a single character C for the frame title in mode_line_noprop_buf.
10805 Re-allocate mode_line_noprop_buf if necessary. */
10808 store_mode_line_noprop_char (char c
)
10810 /* If output position has reached the end of the allocated buffer,
10811 increase the buffer's size. */
10812 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10814 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10815 ptrdiff_t size
= len
;
10816 mode_line_noprop_buf
=
10817 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10818 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10819 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10822 *mode_line_noprop_ptr
++ = c
;
10826 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10827 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10828 characters that yield more columns than PRECISION; PRECISION <= 0
10829 means copy the whole string. Pad with spaces until FIELD_WIDTH
10830 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10831 pad. Called from display_mode_element when it is used to build a
10835 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10837 const unsigned char *str
= (const unsigned char *) string
;
10839 EMACS_INT dummy
, nbytes
;
10841 /* Copy at most PRECISION chars from STR. */
10842 nbytes
= strlen (string
);
10843 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10845 store_mode_line_noprop_char (*str
++);
10847 /* Fill up with spaces until FIELD_WIDTH reached. */
10848 while (field_width
> 0
10849 && n
< field_width
)
10851 store_mode_line_noprop_char (' ');
10858 /***********************************************************************
10860 ***********************************************************************/
10862 #ifdef HAVE_WINDOW_SYSTEM
10864 /* Set the title of FRAME, if it has changed. The title format is
10865 Vicon_title_format if FRAME is iconified, otherwise it is
10866 frame_title_format. */
10869 x_consider_frame_title (Lisp_Object frame
)
10871 struct frame
*f
= XFRAME (frame
);
10873 if (FRAME_WINDOW_P (f
)
10874 || FRAME_MINIBUF_ONLY_P (f
)
10875 || f
->explicit_name
)
10877 /* Do we have more than one visible frame on this X display? */
10880 ptrdiff_t title_start
;
10884 int count
= SPECPDL_INDEX ();
10886 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10888 Lisp_Object other_frame
= XCAR (tail
);
10889 struct frame
*tf
= XFRAME (other_frame
);
10892 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10893 && !FRAME_MINIBUF_ONLY_P (tf
)
10894 && !EQ (other_frame
, tip_frame
)
10895 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10899 /* Set global variable indicating that multiple frames exist. */
10900 multiple_frames
= CONSP (tail
);
10902 /* Switch to the buffer of selected window of the frame. Set up
10903 mode_line_target so that display_mode_element will output into
10904 mode_line_noprop_buf; then display the title. */
10905 record_unwind_protect (unwind_format_mode_line
,
10906 format_mode_line_unwind_data
10907 (current_buffer
, selected_window
, 0));
10909 Fselect_window (f
->selected_window
, Qt
);
10910 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10911 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10913 mode_line_target
= MODE_LINE_TITLE
;
10914 title_start
= MODE_LINE_NOPROP_LEN (0);
10915 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10916 NULL
, DEFAULT_FACE_ID
);
10917 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10918 len
= MODE_LINE_NOPROP_LEN (title_start
);
10919 title
= mode_line_noprop_buf
+ title_start
;
10920 unbind_to (count
, Qnil
);
10922 /* Set the title only if it's changed. This avoids consing in
10923 the common case where it hasn't. (If it turns out that we've
10924 already wasted too much time by walking through the list with
10925 display_mode_element, then we might need to optimize at a
10926 higher level than this.) */
10927 if (! STRINGP (f
->name
)
10928 || SBYTES (f
->name
) != len
10929 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10930 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10934 #endif /* not HAVE_WINDOW_SYSTEM */
10939 /***********************************************************************
10941 ***********************************************************************/
10944 /* Prepare for redisplay by updating menu-bar item lists when
10945 appropriate. This can call eval. */
10948 prepare_menu_bars (void)
10951 struct gcpro gcpro1
, gcpro2
;
10953 Lisp_Object tooltip_frame
;
10955 #ifdef HAVE_WINDOW_SYSTEM
10956 tooltip_frame
= tip_frame
;
10958 tooltip_frame
= Qnil
;
10961 /* Update all frame titles based on their buffer names, etc. We do
10962 this before the menu bars so that the buffer-menu will show the
10963 up-to-date frame titles. */
10964 #ifdef HAVE_WINDOW_SYSTEM
10965 if (windows_or_buffers_changed
|| update_mode_lines
)
10967 Lisp_Object tail
, frame
;
10969 FOR_EACH_FRAME (tail
, frame
)
10971 f
= XFRAME (frame
);
10972 if (!EQ (frame
, tooltip_frame
)
10973 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10974 x_consider_frame_title (frame
);
10977 #endif /* HAVE_WINDOW_SYSTEM */
10979 /* Update the menu bar item lists, if appropriate. This has to be
10980 done before any actual redisplay or generation of display lines. */
10981 all_windows
= (update_mode_lines
10982 || buffer_shared
> 1
10983 || windows_or_buffers_changed
);
10986 Lisp_Object tail
, frame
;
10987 int count
= SPECPDL_INDEX ();
10988 /* 1 means that update_menu_bar has run its hooks
10989 so any further calls to update_menu_bar shouldn't do so again. */
10990 int menu_bar_hooks_run
= 0;
10992 record_unwind_save_match_data ();
10994 FOR_EACH_FRAME (tail
, frame
)
10996 f
= XFRAME (frame
);
10998 /* Ignore tooltip frame. */
10999 if (EQ (frame
, tooltip_frame
))
11002 /* If a window on this frame changed size, report that to
11003 the user and clear the size-change flag. */
11004 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11006 Lisp_Object functions
;
11008 /* Clear flag first in case we get an error below. */
11009 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11010 functions
= Vwindow_size_change_functions
;
11011 GCPRO2 (tail
, functions
);
11013 while (CONSP (functions
))
11015 if (!EQ (XCAR (functions
), Qt
))
11016 call1 (XCAR (functions
), frame
);
11017 functions
= XCDR (functions
);
11023 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11024 #ifdef HAVE_WINDOW_SYSTEM
11025 update_tool_bar (f
, 0);
11028 if (windows_or_buffers_changed
11030 ns_set_doc_edited (f
, Fbuffer_modified_p
11031 (XWINDOW (f
->selected_window
)->buffer
));
11036 unbind_to (count
, Qnil
);
11040 struct frame
*sf
= SELECTED_FRAME ();
11041 update_menu_bar (sf
, 1, 0);
11042 #ifdef HAVE_WINDOW_SYSTEM
11043 update_tool_bar (sf
, 1);
11049 /* Update the menu bar item list for frame F. This has to be done
11050 before we start to fill in any display lines, because it can call
11053 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11055 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11056 already ran the menu bar hooks for this redisplay, so there
11057 is no need to run them again. The return value is the
11058 updated value of this flag, to pass to the next call. */
11061 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11063 Lisp_Object window
;
11064 register struct window
*w
;
11066 /* If called recursively during a menu update, do nothing. This can
11067 happen when, for instance, an activate-menubar-hook causes a
11069 if (inhibit_menubar_update
)
11072 window
= FRAME_SELECTED_WINDOW (f
);
11073 w
= XWINDOW (window
);
11075 if (FRAME_WINDOW_P (f
)
11077 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11078 || defined (HAVE_NS) || defined (USE_GTK)
11079 FRAME_EXTERNAL_MENU_BAR (f
)
11081 FRAME_MENU_BAR_LINES (f
) > 0
11083 : FRAME_MENU_BAR_LINES (f
) > 0)
11085 /* If the user has switched buffers or windows, we need to
11086 recompute to reflect the new bindings. But we'll
11087 recompute when update_mode_lines is set too; that means
11088 that people can use force-mode-line-update to request
11089 that the menu bar be recomputed. The adverse effect on
11090 the rest of the redisplay algorithm is about the same as
11091 windows_or_buffers_changed anyway. */
11092 if (windows_or_buffers_changed
11093 /* This used to test w->update_mode_line, but we believe
11094 there is no need to recompute the menu in that case. */
11095 || update_mode_lines
11096 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11097 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11098 != !NILP (w
->last_had_star
))
11099 || ((!NILP (Vtransient_mark_mode
)
11100 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11101 != !NILP (w
->region_showing
)))
11103 struct buffer
*prev
= current_buffer
;
11104 int count
= SPECPDL_INDEX ();
11106 specbind (Qinhibit_menubar_update
, Qt
);
11108 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11109 if (save_match_data
)
11110 record_unwind_save_match_data ();
11111 if (NILP (Voverriding_local_map_menu_flag
))
11113 specbind (Qoverriding_terminal_local_map
, Qnil
);
11114 specbind (Qoverriding_local_map
, Qnil
);
11119 /* Run the Lucid hook. */
11120 safe_run_hooks (Qactivate_menubar_hook
);
11122 /* If it has changed current-menubar from previous value,
11123 really recompute the menu-bar from the value. */
11124 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11125 call0 (Qrecompute_lucid_menubar
);
11127 safe_run_hooks (Qmenu_bar_update_hook
);
11132 XSETFRAME (Vmenu_updating_frame
, f
);
11133 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11135 /* Redisplay the menu bar in case we changed it. */
11136 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11137 || defined (HAVE_NS) || defined (USE_GTK)
11138 if (FRAME_WINDOW_P (f
))
11140 #if defined (HAVE_NS)
11141 /* All frames on Mac OS share the same menubar. So only
11142 the selected frame should be allowed to set it. */
11143 if (f
== SELECTED_FRAME ())
11145 set_frame_menubar (f
, 0, 0);
11148 /* On a terminal screen, the menu bar is an ordinary screen
11149 line, and this makes it get updated. */
11150 w
->update_mode_line
= Qt
;
11151 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11152 /* In the non-toolkit version, the menu bar is an ordinary screen
11153 line, and this makes it get updated. */
11154 w
->update_mode_line
= Qt
;
11155 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11157 unbind_to (count
, Qnil
);
11158 set_buffer_internal_1 (prev
);
11167 /***********************************************************************
11169 ***********************************************************************/
11171 #ifdef HAVE_WINDOW_SYSTEM
11174 Nominal cursor position -- where to draw output.
11175 HPOS and VPOS are window relative glyph matrix coordinates.
11176 X and Y are window relative pixel coordinates. */
11178 struct cursor_pos output_cursor
;
11182 Set the global variable output_cursor to CURSOR. All cursor
11183 positions are relative to updated_window. */
11186 set_output_cursor (struct cursor_pos
*cursor
)
11188 output_cursor
.hpos
= cursor
->hpos
;
11189 output_cursor
.vpos
= cursor
->vpos
;
11190 output_cursor
.x
= cursor
->x
;
11191 output_cursor
.y
= cursor
->y
;
11196 Set a nominal cursor position.
11198 HPOS and VPOS are column/row positions in a window glyph matrix. X
11199 and Y are window text area relative pixel positions.
11201 If this is done during an update, updated_window will contain the
11202 window that is being updated and the position is the future output
11203 cursor position for that window. If updated_window is null, use
11204 selected_window and display the cursor at the given position. */
11207 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11211 /* If updated_window is not set, work on selected_window. */
11212 if (updated_window
)
11213 w
= updated_window
;
11215 w
= XWINDOW (selected_window
);
11217 /* Set the output cursor. */
11218 output_cursor
.hpos
= hpos
;
11219 output_cursor
.vpos
= vpos
;
11220 output_cursor
.x
= x
;
11221 output_cursor
.y
= y
;
11223 /* If not called as part of an update, really display the cursor.
11224 This will also set the cursor position of W. */
11225 if (updated_window
== NULL
)
11228 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11229 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11230 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11235 #endif /* HAVE_WINDOW_SYSTEM */
11238 /***********************************************************************
11240 ***********************************************************************/
11242 #ifdef HAVE_WINDOW_SYSTEM
11244 /* Where the mouse was last time we reported a mouse event. */
11246 FRAME_PTR last_mouse_frame
;
11248 /* Tool-bar item index of the item on which a mouse button was pressed
11251 int last_tool_bar_item
;
11255 update_tool_bar_unwind (Lisp_Object frame
)
11257 selected_frame
= frame
;
11261 /* Update the tool-bar item list for frame F. This has to be done
11262 before we start to fill in any display lines. Called from
11263 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11264 and restore it here. */
11267 update_tool_bar (struct frame
*f
, int save_match_data
)
11269 #if defined (USE_GTK) || defined (HAVE_NS)
11270 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11272 int do_update
= WINDOWP (f
->tool_bar_window
)
11273 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11278 Lisp_Object window
;
11281 window
= FRAME_SELECTED_WINDOW (f
);
11282 w
= XWINDOW (window
);
11284 /* If the user has switched buffers or windows, we need to
11285 recompute to reflect the new bindings. But we'll
11286 recompute when update_mode_lines is set too; that means
11287 that people can use force-mode-line-update to request
11288 that the menu bar be recomputed. The adverse effect on
11289 the rest of the redisplay algorithm is about the same as
11290 windows_or_buffers_changed anyway. */
11291 if (windows_or_buffers_changed
11292 || !NILP (w
->update_mode_line
)
11293 || update_mode_lines
11294 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11295 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11296 != !NILP (w
->last_had_star
))
11297 || ((!NILP (Vtransient_mark_mode
)
11298 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11299 != !NILP (w
->region_showing
)))
11301 struct buffer
*prev
= current_buffer
;
11302 int count
= SPECPDL_INDEX ();
11303 Lisp_Object frame
, new_tool_bar
;
11304 int new_n_tool_bar
;
11305 struct gcpro gcpro1
;
11307 /* Set current_buffer to the buffer of the selected
11308 window of the frame, so that we get the right local
11310 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11312 /* Save match data, if we must. */
11313 if (save_match_data
)
11314 record_unwind_save_match_data ();
11316 /* Make sure that we don't accidentally use bogus keymaps. */
11317 if (NILP (Voverriding_local_map_menu_flag
))
11319 specbind (Qoverriding_terminal_local_map
, Qnil
);
11320 specbind (Qoverriding_local_map
, Qnil
);
11323 GCPRO1 (new_tool_bar
);
11325 /* We must temporarily set the selected frame to this frame
11326 before calling tool_bar_items, because the calculation of
11327 the tool-bar keymap uses the selected frame (see
11328 `tool-bar-make-keymap' in tool-bar.el). */
11329 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11330 XSETFRAME (frame
, f
);
11331 selected_frame
= frame
;
11333 /* Build desired tool-bar items from keymaps. */
11334 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11337 /* Redisplay the tool-bar if we changed it. */
11338 if (new_n_tool_bar
!= f
->n_tool_bar_items
11339 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11341 /* Redisplay that happens asynchronously due to an expose event
11342 may access f->tool_bar_items. Make sure we update both
11343 variables within BLOCK_INPUT so no such event interrupts. */
11345 f
->tool_bar_items
= new_tool_bar
;
11346 f
->n_tool_bar_items
= new_n_tool_bar
;
11347 w
->update_mode_line
= Qt
;
11353 unbind_to (count
, Qnil
);
11354 set_buffer_internal_1 (prev
);
11360 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11361 F's desired tool-bar contents. F->tool_bar_items must have
11362 been set up previously by calling prepare_menu_bars. */
11365 build_desired_tool_bar_string (struct frame
*f
)
11367 int i
, size
, size_needed
;
11368 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11369 Lisp_Object image
, plist
, props
;
11371 image
= plist
= props
= Qnil
;
11372 GCPRO3 (image
, plist
, props
);
11374 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11375 Otherwise, make a new string. */
11377 /* The size of the string we might be able to reuse. */
11378 size
= (STRINGP (f
->desired_tool_bar_string
)
11379 ? SCHARS (f
->desired_tool_bar_string
)
11382 /* We need one space in the string for each image. */
11383 size_needed
= f
->n_tool_bar_items
;
11385 /* Reuse f->desired_tool_bar_string, if possible. */
11386 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11387 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11388 make_number (' '));
11391 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11392 Fremove_text_properties (make_number (0), make_number (size
),
11393 props
, f
->desired_tool_bar_string
);
11396 /* Put a `display' property on the string for the images to display,
11397 put a `menu_item' property on tool-bar items with a value that
11398 is the index of the item in F's tool-bar item vector. */
11399 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11401 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11403 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11404 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11405 int hmargin
, vmargin
, relief
, idx
, end
;
11407 /* If image is a vector, choose the image according to the
11409 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11410 if (VECTORP (image
))
11414 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11415 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11418 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11419 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11421 xassert (ASIZE (image
) >= idx
);
11422 image
= AREF (image
, idx
);
11427 /* Ignore invalid image specifications. */
11428 if (!valid_image_p (image
))
11431 /* Display the tool-bar button pressed, or depressed. */
11432 plist
= Fcopy_sequence (XCDR (image
));
11434 /* Compute margin and relief to draw. */
11435 relief
= (tool_bar_button_relief
>= 0
11436 ? tool_bar_button_relief
11437 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11438 hmargin
= vmargin
= relief
;
11440 if (INTEGERP (Vtool_bar_button_margin
)
11441 && XINT (Vtool_bar_button_margin
) > 0)
11443 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11444 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11446 else if (CONSP (Vtool_bar_button_margin
))
11448 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11449 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11450 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11452 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11453 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11454 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11457 if (auto_raise_tool_bar_buttons_p
)
11459 /* Add a `:relief' property to the image spec if the item is
11463 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11470 /* If image is selected, display it pressed, i.e. with a
11471 negative relief. If it's not selected, display it with a
11473 plist
= Fplist_put (plist
, QCrelief
,
11475 ? make_number (-relief
)
11476 : make_number (relief
)));
11481 /* Put a margin around the image. */
11482 if (hmargin
|| vmargin
)
11484 if (hmargin
== vmargin
)
11485 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11487 plist
= Fplist_put (plist
, QCmargin
,
11488 Fcons (make_number (hmargin
),
11489 make_number (vmargin
)));
11492 /* If button is not enabled, and we don't have special images
11493 for the disabled state, make the image appear disabled by
11494 applying an appropriate algorithm to it. */
11495 if (!enabled_p
&& idx
< 0)
11496 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11498 /* Put a `display' text property on the string for the image to
11499 display. Put a `menu-item' property on the string that gives
11500 the start of this item's properties in the tool-bar items
11502 image
= Fcons (Qimage
, plist
);
11503 props
= list4 (Qdisplay
, image
,
11504 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11506 /* Let the last image hide all remaining spaces in the tool bar
11507 string. The string can be longer than needed when we reuse a
11508 previous string. */
11509 if (i
+ 1 == f
->n_tool_bar_items
)
11510 end
= SCHARS (f
->desired_tool_bar_string
);
11513 Fadd_text_properties (make_number (i
), make_number (end
),
11514 props
, f
->desired_tool_bar_string
);
11522 /* Display one line of the tool-bar of frame IT->f.
11524 HEIGHT specifies the desired height of the tool-bar line.
11525 If the actual height of the glyph row is less than HEIGHT, the
11526 row's height is increased to HEIGHT, and the icons are centered
11527 vertically in the new height.
11529 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11530 count a final empty row in case the tool-bar width exactly matches
11535 display_tool_bar_line (struct it
*it
, int height
)
11537 struct glyph_row
*row
= it
->glyph_row
;
11538 int max_x
= it
->last_visible_x
;
11539 struct glyph
*last
;
11541 prepare_desired_row (row
);
11542 row
->y
= it
->current_y
;
11544 /* Note that this isn't made use of if the face hasn't a box,
11545 so there's no need to check the face here. */
11546 it
->start_of_box_run_p
= 1;
11548 while (it
->current_x
< max_x
)
11550 int x
, n_glyphs_before
, i
, nglyphs
;
11551 struct it it_before
;
11553 /* Get the next display element. */
11554 if (!get_next_display_element (it
))
11556 /* Don't count empty row if we are counting needed tool-bar lines. */
11557 if (height
< 0 && !it
->hpos
)
11562 /* Produce glyphs. */
11563 n_glyphs_before
= row
->used
[TEXT_AREA
];
11566 PRODUCE_GLYPHS (it
);
11568 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11570 x
= it_before
.current_x
;
11571 while (i
< nglyphs
)
11573 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11575 if (x
+ glyph
->pixel_width
> max_x
)
11577 /* Glyph doesn't fit on line. Backtrack. */
11578 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11580 /* If this is the only glyph on this line, it will never fit on the
11581 tool-bar, so skip it. But ensure there is at least one glyph,
11582 so we don't accidentally disable the tool-bar. */
11583 if (n_glyphs_before
== 0
11584 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11590 x
+= glyph
->pixel_width
;
11594 /* Stop at line end. */
11595 if (ITERATOR_AT_END_OF_LINE_P (it
))
11598 set_iterator_to_next (it
, 1);
11603 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11605 /* Use default face for the border below the tool bar.
11607 FIXME: When auto-resize-tool-bars is grow-only, there is
11608 no additional border below the possibly empty tool-bar lines.
11609 So to make the extra empty lines look "normal", we have to
11610 use the tool-bar face for the border too. */
11611 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11612 it
->face_id
= DEFAULT_FACE_ID
;
11614 extend_face_to_end_of_line (it
);
11615 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11616 last
->right_box_line_p
= 1;
11617 if (last
== row
->glyphs
[TEXT_AREA
])
11618 last
->left_box_line_p
= 1;
11620 /* Make line the desired height and center it vertically. */
11621 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11623 /* Don't add more than one line height. */
11624 height
%= FRAME_LINE_HEIGHT (it
->f
);
11625 it
->max_ascent
+= height
/ 2;
11626 it
->max_descent
+= (height
+ 1) / 2;
11629 compute_line_metrics (it
);
11631 /* If line is empty, make it occupy the rest of the tool-bar. */
11632 if (!row
->displays_text_p
)
11634 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11635 row
->visible_height
= row
->height
;
11636 row
->ascent
= row
->phys_ascent
= 0;
11637 row
->extra_line_spacing
= 0;
11640 row
->full_width_p
= 1;
11641 row
->continued_p
= 0;
11642 row
->truncated_on_left_p
= 0;
11643 row
->truncated_on_right_p
= 0;
11645 it
->current_x
= it
->hpos
= 0;
11646 it
->current_y
+= row
->height
;
11652 /* Max tool-bar height. */
11654 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11655 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11657 /* Value is the number of screen lines needed to make all tool-bar
11658 items of frame F visible. The number of actual rows needed is
11659 returned in *N_ROWS if non-NULL. */
11662 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11664 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11666 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11667 the desired matrix, so use (unused) mode-line row as temporary row to
11668 avoid destroying the first tool-bar row. */
11669 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11671 /* Initialize an iterator for iteration over
11672 F->desired_tool_bar_string in the tool-bar window of frame F. */
11673 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11674 it
.first_visible_x
= 0;
11675 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11676 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11677 it
.paragraph_embedding
= L2R
;
11679 while (!ITERATOR_AT_END_P (&it
))
11681 clear_glyph_row (temp_row
);
11682 it
.glyph_row
= temp_row
;
11683 display_tool_bar_line (&it
, -1);
11685 clear_glyph_row (temp_row
);
11687 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11689 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11691 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11695 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11697 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11698 (Lisp_Object frame
)
11705 frame
= selected_frame
;
11707 CHECK_FRAME (frame
);
11708 f
= XFRAME (frame
);
11710 if (WINDOWP (f
->tool_bar_window
)
11711 && (w
= XWINDOW (f
->tool_bar_window
),
11712 WINDOW_TOTAL_LINES (w
) > 0))
11714 update_tool_bar (f
, 1);
11715 if (f
->n_tool_bar_items
)
11717 build_desired_tool_bar_string (f
);
11718 nlines
= tool_bar_lines_needed (f
, NULL
);
11722 return make_number (nlines
);
11726 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11727 height should be changed. */
11730 redisplay_tool_bar (struct frame
*f
)
11734 struct glyph_row
*row
;
11736 #if defined (USE_GTK) || defined (HAVE_NS)
11737 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11738 update_frame_tool_bar (f
);
11742 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11743 do anything. This means you must start with tool-bar-lines
11744 non-zero to get the auto-sizing effect. Or in other words, you
11745 can turn off tool-bars by specifying tool-bar-lines zero. */
11746 if (!WINDOWP (f
->tool_bar_window
)
11747 || (w
= XWINDOW (f
->tool_bar_window
),
11748 WINDOW_TOTAL_LINES (w
) == 0))
11751 /* Set up an iterator for the tool-bar window. */
11752 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11753 it
.first_visible_x
= 0;
11754 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11755 row
= it
.glyph_row
;
11757 /* Build a string that represents the contents of the tool-bar. */
11758 build_desired_tool_bar_string (f
);
11759 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11760 /* FIXME: This should be controlled by a user option. But it
11761 doesn't make sense to have an R2L tool bar if the menu bar cannot
11762 be drawn also R2L, and making the menu bar R2L is tricky due
11763 toolkit-specific code that implements it. If an R2L tool bar is
11764 ever supported, display_tool_bar_line should also be augmented to
11765 call unproduce_glyphs like display_line and display_string
11767 it
.paragraph_embedding
= L2R
;
11769 if (f
->n_tool_bar_rows
== 0)
11773 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11774 nlines
!= WINDOW_TOTAL_LINES (w
)))
11777 int old_height
= WINDOW_TOTAL_LINES (w
);
11779 XSETFRAME (frame
, f
);
11780 Fmodify_frame_parameters (frame
,
11781 Fcons (Fcons (Qtool_bar_lines
,
11782 make_number (nlines
)),
11784 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11786 clear_glyph_matrix (w
->desired_matrix
);
11787 fonts_changed_p
= 1;
11793 /* Display as many lines as needed to display all tool-bar items. */
11795 if (f
->n_tool_bar_rows
> 0)
11797 int border
, rows
, height
, extra
;
11799 if (INTEGERP (Vtool_bar_border
))
11800 border
= XINT (Vtool_bar_border
);
11801 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11802 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11803 else if (EQ (Vtool_bar_border
, Qborder_width
))
11804 border
= f
->border_width
;
11810 rows
= f
->n_tool_bar_rows
;
11811 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11812 extra
= it
.last_visible_y
- border
- height
* rows
;
11814 while (it
.current_y
< it
.last_visible_y
)
11817 if (extra
> 0 && rows
-- > 0)
11819 h
= (extra
+ rows
- 1) / rows
;
11822 display_tool_bar_line (&it
, height
+ h
);
11827 while (it
.current_y
< it
.last_visible_y
)
11828 display_tool_bar_line (&it
, 0);
11831 /* It doesn't make much sense to try scrolling in the tool-bar
11832 window, so don't do it. */
11833 w
->desired_matrix
->no_scrolling_p
= 1;
11834 w
->must_be_updated_p
= 1;
11836 if (!NILP (Vauto_resize_tool_bars
))
11838 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11839 int change_height_p
= 0;
11841 /* If we couldn't display everything, change the tool-bar's
11842 height if there is room for more. */
11843 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11844 && it
.current_y
< max_tool_bar_height
)
11845 change_height_p
= 1;
11847 row
= it
.glyph_row
- 1;
11849 /* If there are blank lines at the end, except for a partially
11850 visible blank line at the end that is smaller than
11851 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11852 if (!row
->displays_text_p
11853 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11854 change_height_p
= 1;
11856 /* If row displays tool-bar items, but is partially visible,
11857 change the tool-bar's height. */
11858 if (row
->displays_text_p
11859 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11860 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11861 change_height_p
= 1;
11863 /* Resize windows as needed by changing the `tool-bar-lines'
11864 frame parameter. */
11865 if (change_height_p
)
11868 int old_height
= WINDOW_TOTAL_LINES (w
);
11870 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11872 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11873 && !f
->minimize_tool_bar_window_p
)
11874 ? (nlines
> old_height
)
11875 : (nlines
!= old_height
));
11876 f
->minimize_tool_bar_window_p
= 0;
11878 if (change_height_p
)
11880 XSETFRAME (frame
, f
);
11881 Fmodify_frame_parameters (frame
,
11882 Fcons (Fcons (Qtool_bar_lines
,
11883 make_number (nlines
)),
11885 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11887 clear_glyph_matrix (w
->desired_matrix
);
11888 f
->n_tool_bar_rows
= nrows
;
11889 fonts_changed_p
= 1;
11896 f
->minimize_tool_bar_window_p
= 0;
11901 /* Get information about the tool-bar item which is displayed in GLYPH
11902 on frame F. Return in *PROP_IDX the index where tool-bar item
11903 properties start in F->tool_bar_items. Value is zero if
11904 GLYPH doesn't display a tool-bar item. */
11907 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11913 /* This function can be called asynchronously, which means we must
11914 exclude any possibility that Fget_text_property signals an
11916 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11917 charpos
= max (0, charpos
);
11919 /* Get the text property `menu-item' at pos. The value of that
11920 property is the start index of this item's properties in
11921 F->tool_bar_items. */
11922 prop
= Fget_text_property (make_number (charpos
),
11923 Qmenu_item
, f
->current_tool_bar_string
);
11924 if (INTEGERP (prop
))
11926 *prop_idx
= XINT (prop
);
11936 /* Get information about the tool-bar item at position X/Y on frame F.
11937 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11938 the current matrix of the tool-bar window of F, or NULL if not
11939 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11940 item in F->tool_bar_items. Value is
11942 -1 if X/Y is not on a tool-bar item
11943 0 if X/Y is on the same item that was highlighted before.
11947 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11948 int *hpos
, int *vpos
, int *prop_idx
)
11950 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11951 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11954 /* Find the glyph under X/Y. */
11955 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11956 if (*glyph
== NULL
)
11959 /* Get the start of this tool-bar item's properties in
11960 f->tool_bar_items. */
11961 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11964 /* Is mouse on the highlighted item? */
11965 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11966 && *vpos
>= hlinfo
->mouse_face_beg_row
11967 && *vpos
<= hlinfo
->mouse_face_end_row
11968 && (*vpos
> hlinfo
->mouse_face_beg_row
11969 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11970 && (*vpos
< hlinfo
->mouse_face_end_row
11971 || *hpos
< hlinfo
->mouse_face_end_col
11972 || hlinfo
->mouse_face_past_end
))
11980 Handle mouse button event on the tool-bar of frame F, at
11981 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11982 0 for button release. MODIFIERS is event modifiers for button
11986 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11987 unsigned int modifiers
)
11989 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11990 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11991 int hpos
, vpos
, prop_idx
;
11992 struct glyph
*glyph
;
11993 Lisp_Object enabled_p
;
11995 /* If not on the highlighted tool-bar item, return. */
11996 frame_to_window_pixel_xy (w
, &x
, &y
);
11997 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12000 /* If item is disabled, do nothing. */
12001 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12002 if (NILP (enabled_p
))
12007 /* Show item in pressed state. */
12008 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12009 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12010 last_tool_bar_item
= prop_idx
;
12014 Lisp_Object key
, frame
;
12015 struct input_event event
;
12016 EVENT_INIT (event
);
12018 /* Show item in released state. */
12019 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12020 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12022 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12024 XSETFRAME (frame
, f
);
12025 event
.kind
= TOOL_BAR_EVENT
;
12026 event
.frame_or_window
= frame
;
12028 kbd_buffer_store_event (&event
);
12030 event
.kind
= TOOL_BAR_EVENT
;
12031 event
.frame_or_window
= frame
;
12033 event
.modifiers
= modifiers
;
12034 kbd_buffer_store_event (&event
);
12035 last_tool_bar_item
= -1;
12040 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12041 tool-bar window-relative coordinates X/Y. Called from
12042 note_mouse_highlight. */
12045 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12047 Lisp_Object window
= f
->tool_bar_window
;
12048 struct window
*w
= XWINDOW (window
);
12049 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12050 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12052 struct glyph
*glyph
;
12053 struct glyph_row
*row
;
12055 Lisp_Object enabled_p
;
12057 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12058 int mouse_down_p
, rc
;
12060 /* Function note_mouse_highlight is called with negative X/Y
12061 values when mouse moves outside of the frame. */
12062 if (x
<= 0 || y
<= 0)
12064 clear_mouse_face (hlinfo
);
12068 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12071 /* Not on tool-bar item. */
12072 clear_mouse_face (hlinfo
);
12076 /* On same tool-bar item as before. */
12077 goto set_help_echo
;
12079 clear_mouse_face (hlinfo
);
12081 /* Mouse is down, but on different tool-bar item? */
12082 mouse_down_p
= (dpyinfo
->grabbed
12083 && f
== last_mouse_frame
12084 && FRAME_LIVE_P (f
));
12086 && last_tool_bar_item
!= prop_idx
)
12089 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12090 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12092 /* If tool-bar item is not enabled, don't highlight it. */
12093 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12094 if (!NILP (enabled_p
))
12096 /* Compute the x-position of the glyph. In front and past the
12097 image is a space. We include this in the highlighted area. */
12098 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12099 for (i
= x
= 0; i
< hpos
; ++i
)
12100 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12102 /* Record this as the current active region. */
12103 hlinfo
->mouse_face_beg_col
= hpos
;
12104 hlinfo
->mouse_face_beg_row
= vpos
;
12105 hlinfo
->mouse_face_beg_x
= x
;
12106 hlinfo
->mouse_face_beg_y
= row
->y
;
12107 hlinfo
->mouse_face_past_end
= 0;
12109 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12110 hlinfo
->mouse_face_end_row
= vpos
;
12111 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12112 hlinfo
->mouse_face_end_y
= row
->y
;
12113 hlinfo
->mouse_face_window
= window
;
12114 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12116 /* Display it as active. */
12117 show_mouse_face (hlinfo
, draw
);
12118 hlinfo
->mouse_face_image_state
= draw
;
12123 /* Set help_echo_string to a help string to display for this tool-bar item.
12124 XTread_socket does the rest. */
12125 help_echo_object
= help_echo_window
= Qnil
;
12126 help_echo_pos
= -1;
12127 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12128 if (NILP (help_echo_string
))
12129 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12132 #endif /* HAVE_WINDOW_SYSTEM */
12136 /************************************************************************
12137 Horizontal scrolling
12138 ************************************************************************/
12140 static int hscroll_window_tree (Lisp_Object
);
12141 static int hscroll_windows (Lisp_Object
);
12143 /* For all leaf windows in the window tree rooted at WINDOW, set their
12144 hscroll value so that PT is (i) visible in the window, and (ii) so
12145 that it is not within a certain margin at the window's left and
12146 right border. Value is non-zero if any window's hscroll has been
12150 hscroll_window_tree (Lisp_Object window
)
12152 int hscrolled_p
= 0;
12153 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12154 int hscroll_step_abs
= 0;
12155 double hscroll_step_rel
= 0;
12157 if (hscroll_relative_p
)
12159 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12160 if (hscroll_step_rel
< 0)
12162 hscroll_relative_p
= 0;
12163 hscroll_step_abs
= 0;
12166 else if (INTEGERP (Vhscroll_step
))
12168 hscroll_step_abs
= XINT (Vhscroll_step
);
12169 if (hscroll_step_abs
< 0)
12170 hscroll_step_abs
= 0;
12173 hscroll_step_abs
= 0;
12175 while (WINDOWP (window
))
12177 struct window
*w
= XWINDOW (window
);
12179 if (WINDOWP (w
->hchild
))
12180 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12181 else if (WINDOWP (w
->vchild
))
12182 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12183 else if (w
->cursor
.vpos
>= 0)
12186 int text_area_width
;
12187 struct glyph_row
*current_cursor_row
12188 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12189 struct glyph_row
*desired_cursor_row
12190 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12191 struct glyph_row
*cursor_row
12192 = (desired_cursor_row
->enabled_p
12193 ? desired_cursor_row
12194 : current_cursor_row
);
12195 int row_r2l_p
= cursor_row
->reversed_p
;
12197 text_area_width
= window_box_width (w
, TEXT_AREA
);
12199 /* Scroll when cursor is inside this scroll margin. */
12200 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12202 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12203 /* For left-to-right rows, hscroll when cursor is either
12204 (i) inside the right hscroll margin, or (ii) if it is
12205 inside the left margin and the window is already
12208 && ((XFASTINT (w
->hscroll
)
12209 && w
->cursor
.x
<= h_margin
)
12210 || (cursor_row
->enabled_p
12211 && cursor_row
->truncated_on_right_p
12212 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12213 /* For right-to-left rows, the logic is similar,
12214 except that rules for scrolling to left and right
12215 are reversed. E.g., if cursor.x <= h_margin, we
12216 need to hscroll "to the right" unconditionally,
12217 and that will scroll the screen to the left so as
12218 to reveal the next portion of the row. */
12220 && ((cursor_row
->enabled_p
12221 /* FIXME: It is confusing to set the
12222 truncated_on_right_p flag when R2L rows
12223 are actually truncated on the left. */
12224 && cursor_row
->truncated_on_right_p
12225 && w
->cursor
.x
<= h_margin
)
12226 || (XFASTINT (w
->hscroll
)
12227 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12231 struct buffer
*saved_current_buffer
;
12235 /* Find point in a display of infinite width. */
12236 saved_current_buffer
= current_buffer
;
12237 current_buffer
= XBUFFER (w
->buffer
);
12239 if (w
== XWINDOW (selected_window
))
12243 pt
= marker_position (w
->pointm
);
12244 pt
= max (BEGV
, pt
);
12248 /* Move iterator to pt starting at cursor_row->start in
12249 a line with infinite width. */
12250 init_to_row_start (&it
, w
, cursor_row
);
12251 it
.last_visible_x
= INFINITY
;
12252 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12253 current_buffer
= saved_current_buffer
;
12255 /* Position cursor in window. */
12256 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12257 hscroll
= max (0, (it
.current_x
12258 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12259 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12260 : (text_area_width
/ 2))))
12261 / FRAME_COLUMN_WIDTH (it
.f
);
12262 else if ((!row_r2l_p
12263 && w
->cursor
.x
>= text_area_width
- h_margin
)
12264 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12266 if (hscroll_relative_p
)
12267 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12270 wanted_x
= text_area_width
12271 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12274 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12278 if (hscroll_relative_p
)
12279 wanted_x
= text_area_width
* hscroll_step_rel
12282 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12285 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12287 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12289 /* Don't prevent redisplay optimizations if hscroll
12290 hasn't changed, as it will unnecessarily slow down
12292 if (XFASTINT (w
->hscroll
) != hscroll
)
12294 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12295 w
->hscroll
= make_number (hscroll
);
12304 /* Value is non-zero if hscroll of any leaf window has been changed. */
12305 return hscrolled_p
;
12309 /* Set hscroll so that cursor is visible and not inside horizontal
12310 scroll margins for all windows in the tree rooted at WINDOW. See
12311 also hscroll_window_tree above. Value is non-zero if any window's
12312 hscroll has been changed. If it has, desired matrices on the frame
12313 of WINDOW are cleared. */
12316 hscroll_windows (Lisp_Object window
)
12318 int hscrolled_p
= hscroll_window_tree (window
);
12320 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12321 return hscrolled_p
;
12326 /************************************************************************
12328 ************************************************************************/
12330 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12331 to a non-zero value. This is sometimes handy to have in a debugger
12336 /* First and last unchanged row for try_window_id. */
12338 static int debug_first_unchanged_at_end_vpos
;
12339 static int debug_last_unchanged_at_beg_vpos
;
12341 /* Delta vpos and y. */
12343 static int debug_dvpos
, debug_dy
;
12345 /* Delta in characters and bytes for try_window_id. */
12347 static EMACS_INT debug_delta
, debug_delta_bytes
;
12349 /* Values of window_end_pos and window_end_vpos at the end of
12352 static EMACS_INT debug_end_vpos
;
12354 /* Append a string to W->desired_matrix->method. FMT is a printf
12355 format string. If trace_redisplay_p is non-zero also printf the
12356 resulting string to stderr. */
12358 static void debug_method_add (struct window
*, char const *, ...)
12359 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12362 debug_method_add (struct window
*w
, char const *fmt
, ...)
12365 char *method
= w
->desired_matrix
->method
;
12366 int len
= strlen (method
);
12367 int size
= sizeof w
->desired_matrix
->method
;
12368 int remaining
= size
- len
- 1;
12371 va_start (ap
, fmt
);
12372 vsprintf (buffer
, fmt
, ap
);
12374 if (len
&& remaining
)
12377 --remaining
, ++len
;
12380 strncpy (method
+ len
, buffer
, remaining
);
12382 if (trace_redisplay_p
)
12383 fprintf (stderr
, "%p (%s): %s\n",
12385 ((BUFFERP (w
->buffer
)
12386 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12387 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12392 #endif /* GLYPH_DEBUG */
12395 /* Value is non-zero if all changes in window W, which displays
12396 current_buffer, are in the text between START and END. START is a
12397 buffer position, END is given as a distance from Z. Used in
12398 redisplay_internal for display optimization. */
12401 text_outside_line_unchanged_p (struct window
*w
,
12402 EMACS_INT start
, EMACS_INT end
)
12404 int unchanged_p
= 1;
12406 /* If text or overlays have changed, see where. */
12407 if (XFASTINT (w
->last_modified
) < MODIFF
12408 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12410 /* Gap in the line? */
12411 if (GPT
< start
|| Z
- GPT
< end
)
12414 /* Changes start in front of the line, or end after it? */
12416 && (BEG_UNCHANGED
< start
- 1
12417 || END_UNCHANGED
< end
))
12420 /* If selective display, can't optimize if changes start at the
12421 beginning of the line. */
12423 && INTEGERP (BVAR (current_buffer
, selective_display
))
12424 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12425 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12428 /* If there are overlays at the start or end of the line, these
12429 may have overlay strings with newlines in them. A change at
12430 START, for instance, may actually concern the display of such
12431 overlay strings as well, and they are displayed on different
12432 lines. So, quickly rule out this case. (For the future, it
12433 might be desirable to implement something more telling than
12434 just BEG/END_UNCHANGED.) */
12437 if (BEG
+ BEG_UNCHANGED
== start
12438 && overlay_touches_p (start
))
12440 if (END_UNCHANGED
== end
12441 && overlay_touches_p (Z
- end
))
12445 /* Under bidi reordering, adding or deleting a character in the
12446 beginning of a paragraph, before the first strong directional
12447 character, can change the base direction of the paragraph (unless
12448 the buffer specifies a fixed paragraph direction), which will
12449 require to redisplay the whole paragraph. It might be worthwhile
12450 to find the paragraph limits and widen the range of redisplayed
12451 lines to that, but for now just give up this optimization. */
12452 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12453 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12457 return unchanged_p
;
12461 /* Do a frame update, taking possible shortcuts into account. This is
12462 the main external entry point for redisplay.
12464 If the last redisplay displayed an echo area message and that message
12465 is no longer requested, we clear the echo area or bring back the
12466 mini-buffer if that is in use. */
12471 redisplay_internal ();
12476 overlay_arrow_string_or_property (Lisp_Object var
)
12480 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12483 return Voverlay_arrow_string
;
12486 /* Return 1 if there are any overlay-arrows in current_buffer. */
12488 overlay_arrow_in_current_buffer_p (void)
12492 for (vlist
= Voverlay_arrow_variable_list
;
12494 vlist
= XCDR (vlist
))
12496 Lisp_Object var
= XCAR (vlist
);
12499 if (!SYMBOLP (var
))
12501 val
= find_symbol_value (var
);
12503 && current_buffer
== XMARKER (val
)->buffer
)
12510 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12514 overlay_arrows_changed_p (void)
12518 for (vlist
= Voverlay_arrow_variable_list
;
12520 vlist
= XCDR (vlist
))
12522 Lisp_Object var
= XCAR (vlist
);
12523 Lisp_Object val
, pstr
;
12525 if (!SYMBOLP (var
))
12527 val
= find_symbol_value (var
);
12528 if (!MARKERP (val
))
12530 if (! EQ (COERCE_MARKER (val
),
12531 Fget (var
, Qlast_arrow_position
))
12532 || ! (pstr
= overlay_arrow_string_or_property (var
),
12533 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12539 /* Mark overlay arrows to be updated on next redisplay. */
12542 update_overlay_arrows (int up_to_date
)
12546 for (vlist
= Voverlay_arrow_variable_list
;
12548 vlist
= XCDR (vlist
))
12550 Lisp_Object var
= XCAR (vlist
);
12552 if (!SYMBOLP (var
))
12555 if (up_to_date
> 0)
12557 Lisp_Object val
= find_symbol_value (var
);
12558 Fput (var
, Qlast_arrow_position
,
12559 COERCE_MARKER (val
));
12560 Fput (var
, Qlast_arrow_string
,
12561 overlay_arrow_string_or_property (var
));
12563 else if (up_to_date
< 0
12564 || !NILP (Fget (var
, Qlast_arrow_position
)))
12566 Fput (var
, Qlast_arrow_position
, Qt
);
12567 Fput (var
, Qlast_arrow_string
, Qt
);
12573 /* Return overlay arrow string to display at row.
12574 Return integer (bitmap number) for arrow bitmap in left fringe.
12575 Return nil if no overlay arrow. */
12578 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12582 for (vlist
= Voverlay_arrow_variable_list
;
12584 vlist
= XCDR (vlist
))
12586 Lisp_Object var
= XCAR (vlist
);
12589 if (!SYMBOLP (var
))
12592 val
= find_symbol_value (var
);
12595 && current_buffer
== XMARKER (val
)->buffer
12596 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12598 if (FRAME_WINDOW_P (it
->f
)
12599 /* FIXME: if ROW->reversed_p is set, this should test
12600 the right fringe, not the left one. */
12601 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12603 #ifdef HAVE_WINDOW_SYSTEM
12604 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12607 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12608 return make_number (fringe_bitmap
);
12611 return make_number (-1); /* Use default arrow bitmap */
12613 return overlay_arrow_string_or_property (var
);
12620 /* Return 1 if point moved out of or into a composition. Otherwise
12621 return 0. PREV_BUF and PREV_PT are the last point buffer and
12622 position. BUF and PT are the current point buffer and position. */
12625 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12626 struct buffer
*buf
, EMACS_INT pt
)
12628 EMACS_INT start
, end
;
12630 Lisp_Object buffer
;
12632 XSETBUFFER (buffer
, buf
);
12633 /* Check a composition at the last point if point moved within the
12635 if (prev_buf
== buf
)
12638 /* Point didn't move. */
12641 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12642 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12643 && COMPOSITION_VALID_P (start
, end
, prop
)
12644 && start
< prev_pt
&& end
> prev_pt
)
12645 /* The last point was within the composition. Return 1 iff
12646 point moved out of the composition. */
12647 return (pt
<= start
|| pt
>= end
);
12650 /* Check a composition at the current point. */
12651 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12652 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12653 && COMPOSITION_VALID_P (start
, end
, prop
)
12654 && start
< pt
&& end
> pt
);
12658 /* Reconsider the setting of B->clip_changed which is displayed
12662 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12664 if (b
->clip_changed
12665 && !NILP (w
->window_end_valid
)
12666 && w
->current_matrix
->buffer
== b
12667 && w
->current_matrix
->zv
== BUF_ZV (b
)
12668 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12669 b
->clip_changed
= 0;
12671 /* If display wasn't paused, and W is not a tool bar window, see if
12672 point has been moved into or out of a composition. In that case,
12673 we set b->clip_changed to 1 to force updating the screen. If
12674 b->clip_changed has already been set to 1, we can skip this
12676 if (!b
->clip_changed
12677 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12681 if (w
== XWINDOW (selected_window
))
12684 pt
= marker_position (w
->pointm
);
12686 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12687 || pt
!= XINT (w
->last_point
))
12688 && check_point_in_composition (w
->current_matrix
->buffer
,
12689 XINT (w
->last_point
),
12690 XBUFFER (w
->buffer
), pt
))
12691 b
->clip_changed
= 1;
12696 /* Select FRAME to forward the values of frame-local variables into C
12697 variables so that the redisplay routines can access those values
12701 select_frame_for_redisplay (Lisp_Object frame
)
12703 Lisp_Object tail
, tem
;
12704 Lisp_Object old
= selected_frame
;
12705 struct Lisp_Symbol
*sym
;
12707 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12709 selected_frame
= frame
;
12712 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12713 if (CONSP (XCAR (tail
))
12714 && (tem
= XCAR (XCAR (tail
)),
12716 && (sym
= indirect_variable (XSYMBOL (tem
)),
12717 sym
->redirect
== SYMBOL_LOCALIZED
)
12718 && sym
->val
.blv
->frame_local
)
12719 /* Use find_symbol_value rather than Fsymbol_value
12720 to avoid an error if it is void. */
12721 find_symbol_value (tem
);
12722 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12726 #define STOP_POLLING \
12727 do { if (! polling_stopped_here) stop_polling (); \
12728 polling_stopped_here = 1; } while (0)
12730 #define RESUME_POLLING \
12731 do { if (polling_stopped_here) start_polling (); \
12732 polling_stopped_here = 0; } while (0)
12735 /* Perhaps in the future avoid recentering windows if it
12736 is not necessary; currently that causes some problems. */
12739 redisplay_internal (void)
12741 struct window
*w
= XWINDOW (selected_window
);
12745 int must_finish
= 0;
12746 struct text_pos tlbufpos
, tlendpos
;
12747 int number_of_visible_frames
;
12750 int polling_stopped_here
= 0;
12751 Lisp_Object old_frame
= selected_frame
;
12753 /* Non-zero means redisplay has to consider all windows on all
12754 frames. Zero means, only selected_window is considered. */
12755 int consider_all_windows_p
;
12757 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12759 /* No redisplay if running in batch mode or frame is not yet fully
12760 initialized, or redisplay is explicitly turned off by setting
12761 Vinhibit_redisplay. */
12762 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12763 || !NILP (Vinhibit_redisplay
))
12766 /* Don't examine these until after testing Vinhibit_redisplay.
12767 When Emacs is shutting down, perhaps because its connection to
12768 X has dropped, we should not look at them at all. */
12769 fr
= XFRAME (w
->frame
);
12770 sf
= SELECTED_FRAME ();
12772 if (!fr
->glyphs_initialized_p
)
12775 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12776 if (popup_activated ())
12780 /* I don't think this happens but let's be paranoid. */
12781 if (redisplaying_p
)
12784 /* Record a function that resets redisplaying_p to its old value
12785 when we leave this function. */
12786 count
= SPECPDL_INDEX ();
12787 record_unwind_protect (unwind_redisplay
,
12788 Fcons (make_number (redisplaying_p
), selected_frame
));
12790 specbind (Qinhibit_free_realized_faces
, Qnil
);
12793 Lisp_Object tail
, frame
;
12795 FOR_EACH_FRAME (tail
, frame
)
12797 struct frame
*f
= XFRAME (frame
);
12798 f
->already_hscrolled_p
= 0;
12803 /* Remember the currently selected window. */
12806 if (!EQ (old_frame
, selected_frame
)
12807 && FRAME_LIVE_P (XFRAME (old_frame
)))
12808 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12809 selected_frame and selected_window to be temporarily out-of-sync so
12810 when we come back here via `goto retry', we need to resync because we
12811 may need to run Elisp code (via prepare_menu_bars). */
12812 select_frame_for_redisplay (old_frame
);
12815 reconsider_clip_changes (w
, current_buffer
);
12816 last_escape_glyph_frame
= NULL
;
12817 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12818 last_glyphless_glyph_frame
= NULL
;
12819 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12821 /* If new fonts have been loaded that make a glyph matrix adjustment
12822 necessary, do it. */
12823 if (fonts_changed_p
)
12825 adjust_glyphs (NULL
);
12826 ++windows_or_buffers_changed
;
12827 fonts_changed_p
= 0;
12830 /* If face_change_count is non-zero, init_iterator will free all
12831 realized faces, which includes the faces referenced from current
12832 matrices. So, we can't reuse current matrices in this case. */
12833 if (face_change_count
)
12834 ++windows_or_buffers_changed
;
12836 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12837 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12839 /* Since frames on a single ASCII terminal share the same
12840 display area, displaying a different frame means redisplay
12841 the whole thing. */
12842 windows_or_buffers_changed
++;
12843 SET_FRAME_GARBAGED (sf
);
12845 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12847 FRAME_TTY (sf
)->previous_frame
= sf
;
12850 /* Set the visible flags for all frames. Do this before checking
12851 for resized or garbaged frames; they want to know if their frames
12852 are visible. See the comment in frame.h for
12853 FRAME_SAMPLE_VISIBILITY. */
12855 Lisp_Object tail
, frame
;
12857 number_of_visible_frames
= 0;
12859 FOR_EACH_FRAME (tail
, frame
)
12861 struct frame
*f
= XFRAME (frame
);
12863 FRAME_SAMPLE_VISIBILITY (f
);
12864 if (FRAME_VISIBLE_P (f
))
12865 ++number_of_visible_frames
;
12866 clear_desired_matrices (f
);
12870 /* Notice any pending interrupt request to change frame size. */
12871 do_pending_window_change (1);
12873 /* do_pending_window_change could change the selected_window due to
12874 frame resizing which makes the selected window too small. */
12875 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12878 reconsider_clip_changes (w
, current_buffer
);
12881 /* Clear frames marked as garbaged. */
12882 if (frame_garbaged
)
12883 clear_garbaged_frames ();
12885 /* Build menubar and tool-bar items. */
12886 if (NILP (Vmemory_full
))
12887 prepare_menu_bars ();
12889 if (windows_or_buffers_changed
)
12890 update_mode_lines
++;
12892 /* Detect case that we need to write or remove a star in the mode line. */
12893 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12895 w
->update_mode_line
= Qt
;
12896 if (buffer_shared
> 1)
12897 update_mode_lines
++;
12900 /* Avoid invocation of point motion hooks by `current_column' below. */
12901 count1
= SPECPDL_INDEX ();
12902 specbind (Qinhibit_point_motion_hooks
, Qt
);
12904 /* If %c is in the mode line, update it if needed. */
12905 if (!NILP (w
->column_number_displayed
)
12906 /* This alternative quickly identifies a common case
12907 where no change is needed. */
12908 && !(PT
== XFASTINT (w
->last_point
)
12909 && XFASTINT (w
->last_modified
) >= MODIFF
12910 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12911 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12912 w
->update_mode_line
= Qt
;
12914 unbind_to (count1
, Qnil
);
12916 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12918 /* The variable buffer_shared is set in redisplay_window and
12919 indicates that we redisplay a buffer in different windows. See
12921 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12922 || cursor_type_changed
);
12924 /* If specs for an arrow have changed, do thorough redisplay
12925 to ensure we remove any arrow that should no longer exist. */
12926 if (overlay_arrows_changed_p ())
12927 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12929 /* Normally the message* functions will have already displayed and
12930 updated the echo area, but the frame may have been trashed, or
12931 the update may have been preempted, so display the echo area
12932 again here. Checking message_cleared_p captures the case that
12933 the echo area should be cleared. */
12934 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12935 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12936 || (message_cleared_p
12937 && minibuf_level
== 0
12938 /* If the mini-window is currently selected, this means the
12939 echo-area doesn't show through. */
12940 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12942 int window_height_changed_p
= echo_area_display (0);
12945 /* If we don't display the current message, don't clear the
12946 message_cleared_p flag, because, if we did, we wouldn't clear
12947 the echo area in the next redisplay which doesn't preserve
12949 if (!display_last_displayed_message_p
)
12950 message_cleared_p
= 0;
12952 if (fonts_changed_p
)
12954 else if (window_height_changed_p
)
12956 consider_all_windows_p
= 1;
12957 ++update_mode_lines
;
12958 ++windows_or_buffers_changed
;
12960 /* If window configuration was changed, frames may have been
12961 marked garbaged. Clear them or we will experience
12962 surprises wrt scrolling. */
12963 if (frame_garbaged
)
12964 clear_garbaged_frames ();
12967 else if (EQ (selected_window
, minibuf_window
)
12968 && (current_buffer
->clip_changed
12969 || XFASTINT (w
->last_modified
) < MODIFF
12970 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12971 && resize_mini_window (w
, 0))
12973 /* Resized active mini-window to fit the size of what it is
12974 showing if its contents might have changed. */
12976 /* FIXME: this causes all frames to be updated, which seems unnecessary
12977 since only the current frame needs to be considered. This function needs
12978 to be rewritten with two variables, consider_all_windows and
12979 consider_all_frames. */
12980 consider_all_windows_p
= 1;
12981 ++windows_or_buffers_changed
;
12982 ++update_mode_lines
;
12984 /* If window configuration was changed, frames may have been
12985 marked garbaged. Clear them or we will experience
12986 surprises wrt scrolling. */
12987 if (frame_garbaged
)
12988 clear_garbaged_frames ();
12992 /* If showing the region, and mark has changed, we must redisplay
12993 the whole window. The assignment to this_line_start_pos prevents
12994 the optimization directly below this if-statement. */
12995 if (((!NILP (Vtransient_mark_mode
)
12996 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12997 != !NILP (w
->region_showing
))
12998 || (!NILP (w
->region_showing
)
12999 && !EQ (w
->region_showing
,
13000 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13001 CHARPOS (this_line_start_pos
) = 0;
13003 /* Optimize the case that only the line containing the cursor in the
13004 selected window has changed. Variables starting with this_ are
13005 set in display_line and record information about the line
13006 containing the cursor. */
13007 tlbufpos
= this_line_start_pos
;
13008 tlendpos
= this_line_end_pos
;
13009 if (!consider_all_windows_p
13010 && CHARPOS (tlbufpos
) > 0
13011 && NILP (w
->update_mode_line
)
13012 && !current_buffer
->clip_changed
13013 && !current_buffer
->prevent_redisplay_optimizations_p
13014 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13015 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13016 /* Make sure recorded data applies to current buffer, etc. */
13017 && this_line_buffer
== current_buffer
13018 && current_buffer
== XBUFFER (w
->buffer
)
13019 && NILP (w
->force_start
)
13020 && NILP (w
->optional_new_start
)
13021 /* Point must be on the line that we have info recorded about. */
13022 && PT
>= CHARPOS (tlbufpos
)
13023 && PT
<= Z
- CHARPOS (tlendpos
)
13024 /* All text outside that line, including its final newline,
13025 must be unchanged. */
13026 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13027 CHARPOS (tlendpos
)))
13029 if (CHARPOS (tlbufpos
) > BEGV
13030 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13031 && (CHARPOS (tlbufpos
) == ZV
13032 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13033 /* Former continuation line has disappeared by becoming empty. */
13035 else if (XFASTINT (w
->last_modified
) < MODIFF
13036 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
13037 || MINI_WINDOW_P (w
))
13039 /* We have to handle the case of continuation around a
13040 wide-column character (see the comment in indent.c around
13043 For instance, in the following case:
13045 -------- Insert --------
13046 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13047 J_I_ ==> J_I_ `^^' are cursors.
13051 As we have to redraw the line above, we cannot use this
13055 int line_height_before
= this_line_pixel_height
;
13057 /* Note that start_display will handle the case that the
13058 line starting at tlbufpos is a continuation line. */
13059 start_display (&it
, w
, tlbufpos
);
13061 /* Implementation note: It this still necessary? */
13062 if (it
.current_x
!= this_line_start_x
)
13065 TRACE ((stderr
, "trying display optimization 1\n"));
13066 w
->cursor
.vpos
= -1;
13067 overlay_arrow_seen
= 0;
13068 it
.vpos
= this_line_vpos
;
13069 it
.current_y
= this_line_y
;
13070 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13071 display_line (&it
);
13073 /* If line contains point, is not continued,
13074 and ends at same distance from eob as before, we win. */
13075 if (w
->cursor
.vpos
>= 0
13076 /* Line is not continued, otherwise this_line_start_pos
13077 would have been set to 0 in display_line. */
13078 && CHARPOS (this_line_start_pos
)
13079 /* Line ends as before. */
13080 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13081 /* Line has same height as before. Otherwise other lines
13082 would have to be shifted up or down. */
13083 && this_line_pixel_height
== line_height_before
)
13085 /* If this is not the window's last line, we must adjust
13086 the charstarts of the lines below. */
13087 if (it
.current_y
< it
.last_visible_y
)
13089 struct glyph_row
*row
13090 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13091 EMACS_INT delta
, delta_bytes
;
13093 /* We used to distinguish between two cases here,
13094 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13095 when the line ends in a newline or the end of the
13096 buffer's accessible portion. But both cases did
13097 the same, so they were collapsed. */
13099 - CHARPOS (tlendpos
)
13100 - MATRIX_ROW_START_CHARPOS (row
));
13101 delta_bytes
= (Z_BYTE
13102 - BYTEPOS (tlendpos
)
13103 - MATRIX_ROW_START_BYTEPOS (row
));
13105 increment_matrix_positions (w
->current_matrix
,
13106 this_line_vpos
+ 1,
13107 w
->current_matrix
->nrows
,
13108 delta
, delta_bytes
);
13111 /* If this row displays text now but previously didn't,
13112 or vice versa, w->window_end_vpos may have to be
13114 if ((it
.glyph_row
- 1)->displays_text_p
)
13116 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13117 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13119 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13120 && this_line_vpos
> 0)
13121 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13122 w
->window_end_valid
= Qnil
;
13124 /* Update hint: No need to try to scroll in update_window. */
13125 w
->desired_matrix
->no_scrolling_p
= 1;
13128 *w
->desired_matrix
->method
= 0;
13129 debug_method_add (w
, "optimization 1");
13132 //debug optimization movement issue
13133 //w->desired_matrix->no_scrolling_p = 1;
13134 //*w->desired_matrix->method = 0;
13135 //debug_method_add (w, "optimization 1");
13138 #ifdef HAVE_WINDOW_SYSTEM
13139 update_window_fringes (w
, 0);
13146 else if (/* Cursor position hasn't changed. */
13147 PT
== XFASTINT (w
->last_point
)
13148 /* Make sure the cursor was last displayed
13149 in this window. Otherwise we have to reposition it. */
13150 && 0 <= w
->cursor
.vpos
13151 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13155 do_pending_window_change (1);
13156 /* If selected_window changed, redisplay again. */
13157 if (WINDOWP (selected_window
)
13158 && (w
= XWINDOW (selected_window
)) != sw
)
13161 /* We used to always goto end_of_redisplay here, but this
13162 isn't enough if we have a blinking cursor. */
13163 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13164 goto end_of_redisplay
;
13168 /* If highlighting the region, or if the cursor is in the echo area,
13169 then we can't just move the cursor. */
13170 else if (! (!NILP (Vtransient_mark_mode
)
13171 && !NILP (BVAR (current_buffer
, mark_active
)))
13172 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13173 || highlight_nonselected_windows
)
13174 && NILP (w
->region_showing
)
13175 && NILP (Vshow_trailing_whitespace
)
13176 && !cursor_in_echo_area
)
13179 struct glyph_row
*row
;
13181 /* Skip from tlbufpos to PT and see where it is. Note that
13182 PT may be in invisible text. If so, we will end at the
13183 next visible position. */
13184 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13185 NULL
, DEFAULT_FACE_ID
);
13186 it
.current_x
= this_line_start_x
;
13187 it
.current_y
= this_line_y
;
13188 it
.vpos
= this_line_vpos
;
13190 /* The call to move_it_to stops in front of PT, but
13191 moves over before-strings. */
13192 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13194 if (it
.vpos
== this_line_vpos
13195 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13198 xassert (this_line_vpos
== it
.vpos
);
13199 xassert (this_line_y
== it
.current_y
);
13200 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13202 *w
->desired_matrix
->method
= 0;
13203 debug_method_add (w
, "optimization 3");
13212 /* Text changed drastically or point moved off of line. */
13213 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13216 CHARPOS (this_line_start_pos
) = 0;
13217 consider_all_windows_p
|= buffer_shared
> 1;
13218 ++clear_face_cache_count
;
13219 #ifdef HAVE_WINDOW_SYSTEM
13220 ++clear_image_cache_count
;
13223 /* Build desired matrices, and update the display. If
13224 consider_all_windows_p is non-zero, do it for all windows on all
13225 frames. Otherwise do it for selected_window, only. */
13227 if (consider_all_windows_p
)
13229 Lisp_Object tail
, frame
;
13231 FOR_EACH_FRAME (tail
, frame
)
13232 XFRAME (frame
)->updated_p
= 0;
13234 /* Recompute # windows showing selected buffer. This will be
13235 incremented each time such a window is displayed. */
13238 FOR_EACH_FRAME (tail
, frame
)
13240 struct frame
*f
= XFRAME (frame
);
13242 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13244 if (! EQ (frame
, selected_frame
))
13245 /* Select the frame, for the sake of frame-local
13247 select_frame_for_redisplay (frame
);
13249 /* Mark all the scroll bars to be removed; we'll redeem
13250 the ones we want when we redisplay their windows. */
13251 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13252 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13254 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13255 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13257 /* The X error handler may have deleted that frame. */
13258 if (!FRAME_LIVE_P (f
))
13261 /* Any scroll bars which redisplay_windows should have
13262 nuked should now go away. */
13263 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13264 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13266 /* If fonts changed, display again. */
13267 /* ??? rms: I suspect it is a mistake to jump all the way
13268 back to retry here. It should just retry this frame. */
13269 if (fonts_changed_p
)
13272 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13274 /* See if we have to hscroll. */
13275 if (!f
->already_hscrolled_p
)
13277 f
->already_hscrolled_p
= 1;
13278 if (hscroll_windows (f
->root_window
))
13282 /* Prevent various kinds of signals during display
13283 update. stdio is not robust about handling
13284 signals, which can cause an apparent I/O
13286 if (interrupt_input
)
13287 unrequest_sigio ();
13290 /* Update the display. */
13291 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13292 pending
|= update_frame (f
, 0, 0);
13298 if (!EQ (old_frame
, selected_frame
)
13299 && FRAME_LIVE_P (XFRAME (old_frame
)))
13300 /* We played a bit fast-and-loose above and allowed selected_frame
13301 and selected_window to be temporarily out-of-sync but let's make
13302 sure this stays contained. */
13303 select_frame_for_redisplay (old_frame
);
13304 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13308 /* Do the mark_window_display_accurate after all windows have
13309 been redisplayed because this call resets flags in buffers
13310 which are needed for proper redisplay. */
13311 FOR_EACH_FRAME (tail
, frame
)
13313 struct frame
*f
= XFRAME (frame
);
13316 mark_window_display_accurate (f
->root_window
, 1);
13317 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13318 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13323 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13325 Lisp_Object mini_window
;
13326 struct frame
*mini_frame
;
13328 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13329 /* Use list_of_error, not Qerror, so that
13330 we catch only errors and don't run the debugger. */
13331 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13333 redisplay_window_error
);
13335 /* Compare desired and current matrices, perform output. */
13338 /* If fonts changed, display again. */
13339 if (fonts_changed_p
)
13342 /* Prevent various kinds of signals during display update.
13343 stdio is not robust about handling signals,
13344 which can cause an apparent I/O error. */
13345 if (interrupt_input
)
13346 unrequest_sigio ();
13349 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13351 if (hscroll_windows (selected_window
))
13354 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13355 pending
= update_frame (sf
, 0, 0);
13358 /* We may have called echo_area_display at the top of this
13359 function. If the echo area is on another frame, that may
13360 have put text on a frame other than the selected one, so the
13361 above call to update_frame would not have caught it. Catch
13363 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13364 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13366 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13368 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13369 pending
|= update_frame (mini_frame
, 0, 0);
13370 if (!pending
&& hscroll_windows (mini_window
))
13375 /* If display was paused because of pending input, make sure we do a
13376 thorough update the next time. */
13379 /* Prevent the optimization at the beginning of
13380 redisplay_internal that tries a single-line update of the
13381 line containing the cursor in the selected window. */
13382 CHARPOS (this_line_start_pos
) = 0;
13384 /* Let the overlay arrow be updated the next time. */
13385 update_overlay_arrows (0);
13387 /* If we pause after scrolling, some rows in the current
13388 matrices of some windows are not valid. */
13389 if (!WINDOW_FULL_WIDTH_P (w
)
13390 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13391 update_mode_lines
= 1;
13395 if (!consider_all_windows_p
)
13397 /* This has already been done above if
13398 consider_all_windows_p is set. */
13399 mark_window_display_accurate_1 (w
, 1);
13401 /* Say overlay arrows are up to date. */
13402 update_overlay_arrows (1);
13404 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13405 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13408 update_mode_lines
= 0;
13409 windows_or_buffers_changed
= 0;
13410 cursor_type_changed
= 0;
13413 /* Start SIGIO interrupts coming again. Having them off during the
13414 code above makes it less likely one will discard output, but not
13415 impossible, since there might be stuff in the system buffer here.
13416 But it is much hairier to try to do anything about that. */
13417 if (interrupt_input
)
13421 /* If a frame has become visible which was not before, redisplay
13422 again, so that we display it. Expose events for such a frame
13423 (which it gets when becoming visible) don't call the parts of
13424 redisplay constructing glyphs, so simply exposing a frame won't
13425 display anything in this case. So, we have to display these
13426 frames here explicitly. */
13429 Lisp_Object tail
, frame
;
13432 FOR_EACH_FRAME (tail
, frame
)
13434 int this_is_visible
= 0;
13436 if (XFRAME (frame
)->visible
)
13437 this_is_visible
= 1;
13438 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13439 if (XFRAME (frame
)->visible
)
13440 this_is_visible
= 1;
13442 if (this_is_visible
)
13446 if (new_count
!= number_of_visible_frames
)
13447 windows_or_buffers_changed
++;
13450 /* Change frame size now if a change is pending. */
13451 do_pending_window_change (1);
13453 /* If we just did a pending size change, or have additional
13454 visible frames, or selected_window changed, redisplay again. */
13455 if ((windows_or_buffers_changed
&& !pending
)
13456 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13459 /* Clear the face and image caches.
13461 We used to do this only if consider_all_windows_p. But the cache
13462 needs to be cleared if a timer creates images in the current
13463 buffer (e.g. the test case in Bug#6230). */
13465 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13467 clear_face_cache (0);
13468 clear_face_cache_count
= 0;
13471 #ifdef HAVE_WINDOW_SYSTEM
13472 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13474 clear_image_caches (Qnil
);
13475 clear_image_cache_count
= 0;
13477 #endif /* HAVE_WINDOW_SYSTEM */
13480 unbind_to (count
, Qnil
);
13485 /* Redisplay, but leave alone any recent echo area message unless
13486 another message has been requested in its place.
13488 This is useful in situations where you need to redisplay but no
13489 user action has occurred, making it inappropriate for the message
13490 area to be cleared. See tracking_off and
13491 wait_reading_process_output for examples of these situations.
13493 FROM_WHERE is an integer saying from where this function was
13494 called. This is useful for debugging. */
13497 redisplay_preserve_echo_area (int from_where
)
13499 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13501 if (!NILP (echo_area_buffer
[1]))
13503 /* We have a previously displayed message, but no current
13504 message. Redisplay the previous message. */
13505 display_last_displayed_message_p
= 1;
13506 redisplay_internal ();
13507 display_last_displayed_message_p
= 0;
13510 redisplay_internal ();
13512 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13513 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13514 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13518 /* Function registered with record_unwind_protect in
13519 redisplay_internal. Reset redisplaying_p to the value it had
13520 before redisplay_internal was called, and clear
13521 prevent_freeing_realized_faces_p. It also selects the previously
13522 selected frame, unless it has been deleted (by an X connection
13523 failure during redisplay, for example). */
13526 unwind_redisplay (Lisp_Object val
)
13528 Lisp_Object old_redisplaying_p
, old_frame
;
13530 old_redisplaying_p
= XCAR (val
);
13531 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13532 old_frame
= XCDR (val
);
13533 if (! EQ (old_frame
, selected_frame
)
13534 && FRAME_LIVE_P (XFRAME (old_frame
)))
13535 select_frame_for_redisplay (old_frame
);
13540 /* Mark the display of window W as accurate or inaccurate. If
13541 ACCURATE_P is non-zero mark display of W as accurate. If
13542 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13543 redisplay_internal is called. */
13546 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13548 if (BUFFERP (w
->buffer
))
13550 struct buffer
*b
= XBUFFER (w
->buffer
);
13553 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13554 w
->last_overlay_modified
13555 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13557 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13561 b
->clip_changed
= 0;
13562 b
->prevent_redisplay_optimizations_p
= 0;
13564 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13565 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13566 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13567 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13569 w
->current_matrix
->buffer
= b
;
13570 w
->current_matrix
->begv
= BUF_BEGV (b
);
13571 w
->current_matrix
->zv
= BUF_ZV (b
);
13573 w
->last_cursor
= w
->cursor
;
13574 w
->last_cursor_off_p
= w
->cursor_off_p
;
13576 if (w
== XWINDOW (selected_window
))
13577 w
->last_point
= make_number (BUF_PT (b
));
13579 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13585 w
->window_end_valid
= w
->buffer
;
13586 w
->update_mode_line
= Qnil
;
13591 /* Mark the display of windows in the window tree rooted at WINDOW as
13592 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13593 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13594 be redisplayed the next time redisplay_internal is called. */
13597 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13601 for (; !NILP (window
); window
= w
->next
)
13603 w
= XWINDOW (window
);
13604 mark_window_display_accurate_1 (w
, accurate_p
);
13606 if (!NILP (w
->vchild
))
13607 mark_window_display_accurate (w
->vchild
, accurate_p
);
13608 if (!NILP (w
->hchild
))
13609 mark_window_display_accurate (w
->hchild
, accurate_p
);
13614 update_overlay_arrows (1);
13618 /* Force a thorough redisplay the next time by setting
13619 last_arrow_position and last_arrow_string to t, which is
13620 unequal to any useful value of Voverlay_arrow_... */
13621 update_overlay_arrows (-1);
13626 /* Return value in display table DP (Lisp_Char_Table *) for character
13627 C. Since a display table doesn't have any parent, we don't have to
13628 follow parent. Do not call this function directly but use the
13629 macro DISP_CHAR_VECTOR. */
13632 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13636 if (ASCII_CHAR_P (c
))
13639 if (SUB_CHAR_TABLE_P (val
))
13640 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13646 XSETCHAR_TABLE (table
, dp
);
13647 val
= char_table_ref (table
, c
);
13656 /***********************************************************************
13658 ***********************************************************************/
13660 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13663 redisplay_windows (Lisp_Object window
)
13665 while (!NILP (window
))
13667 struct window
*w
= XWINDOW (window
);
13669 if (!NILP (w
->hchild
))
13670 redisplay_windows (w
->hchild
);
13671 else if (!NILP (w
->vchild
))
13672 redisplay_windows (w
->vchild
);
13673 else if (!NILP (w
->buffer
))
13675 displayed_buffer
= XBUFFER (w
->buffer
);
13676 /* Use list_of_error, not Qerror, so that
13677 we catch only errors and don't run the debugger. */
13678 internal_condition_case_1 (redisplay_window_0
, window
,
13680 redisplay_window_error
);
13688 redisplay_window_error (Lisp_Object ignore
)
13690 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13695 redisplay_window_0 (Lisp_Object window
)
13697 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13698 redisplay_window (window
, 0);
13703 redisplay_window_1 (Lisp_Object window
)
13705 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13706 redisplay_window (window
, 1);
13711 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13712 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13713 which positions recorded in ROW differ from current buffer
13716 Return 0 if cursor is not on this row, 1 otherwise. */
13719 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13720 struct glyph_matrix
*matrix
,
13721 EMACS_INT delta
, EMACS_INT delta_bytes
,
13724 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13725 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13726 struct glyph
*cursor
= NULL
;
13727 /* The last known character position in row. */
13728 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13730 EMACS_INT pt_old
= PT
- delta
;
13731 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13732 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13733 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13734 /* A glyph beyond the edge of TEXT_AREA which we should never
13736 struct glyph
*glyphs_end
= end
;
13737 /* Non-zero means we've found a match for cursor position, but that
13738 glyph has the avoid_cursor_p flag set. */
13739 int match_with_avoid_cursor
= 0;
13740 /* Non-zero means we've seen at least one glyph that came from a
13742 int string_seen
= 0;
13743 /* Largest and smallest buffer positions seen so far during scan of
13745 EMACS_INT bpos_max
= pos_before
;
13746 EMACS_INT bpos_min
= pos_after
;
13747 /* Last buffer position covered by an overlay string with an integer
13748 `cursor' property. */
13749 EMACS_INT bpos_covered
= 0;
13750 /* Non-zero means the display string on which to display the cursor
13751 comes from a text property, not from an overlay. */
13752 int string_from_text_prop
= 0;
13754 /* Skip over glyphs not having an object at the start and the end of
13755 the row. These are special glyphs like truncation marks on
13756 terminal frames. */
13757 if (row
->displays_text_p
)
13759 if (!row
->reversed_p
)
13762 && INTEGERP (glyph
->object
)
13763 && glyph
->charpos
< 0)
13765 x
+= glyph
->pixel_width
;
13769 && INTEGERP ((end
- 1)->object
)
13770 /* CHARPOS is zero for blanks and stretch glyphs
13771 inserted by extend_face_to_end_of_line. */
13772 && (end
- 1)->charpos
<= 0)
13774 glyph_before
= glyph
- 1;
13781 /* If the glyph row is reversed, we need to process it from back
13782 to front, so swap the edge pointers. */
13783 glyphs_end
= end
= glyph
- 1;
13784 glyph
+= row
->used
[TEXT_AREA
] - 1;
13786 while (glyph
> end
+ 1
13787 && INTEGERP (glyph
->object
)
13788 && glyph
->charpos
< 0)
13791 x
-= glyph
->pixel_width
;
13793 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13795 /* By default, in reversed rows we put the cursor on the
13796 rightmost (first in the reading order) glyph. */
13797 for (g
= end
+ 1; g
< glyph
; g
++)
13798 x
+= g
->pixel_width
;
13800 && INTEGERP ((end
+ 1)->object
)
13801 && (end
+ 1)->charpos
<= 0)
13803 glyph_before
= glyph
+ 1;
13807 else if (row
->reversed_p
)
13809 /* In R2L rows that don't display text, put the cursor on the
13810 rightmost glyph. Case in point: an empty last line that is
13811 part of an R2L paragraph. */
13813 /* Avoid placing the cursor on the last glyph of the row, where
13814 on terminal frames we hold the vertical border between
13815 adjacent windows. */
13816 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13817 && !WINDOW_RIGHTMOST_P (w
)
13818 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13820 x
= -1; /* will be computed below, at label compute_x */
13823 /* Step 1: Try to find the glyph whose character position
13824 corresponds to point. If that's not possible, find 2 glyphs
13825 whose character positions are the closest to point, one before
13826 point, the other after it. */
13827 if (!row
->reversed_p
)
13828 while (/* not marched to end of glyph row */
13830 /* glyph was not inserted by redisplay for internal purposes */
13831 && !INTEGERP (glyph
->object
))
13833 if (BUFFERP (glyph
->object
))
13835 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13837 if (glyph
->charpos
> bpos_max
)
13838 bpos_max
= glyph
->charpos
;
13839 if (glyph
->charpos
< bpos_min
)
13840 bpos_min
= glyph
->charpos
;
13841 if (!glyph
->avoid_cursor_p
)
13843 /* If we hit point, we've found the glyph on which to
13844 display the cursor. */
13847 match_with_avoid_cursor
= 0;
13850 /* See if we've found a better approximation to
13851 POS_BEFORE or to POS_AFTER. Note that we want the
13852 first (leftmost) glyph of all those that are the
13853 closest from below, and the last (rightmost) of all
13854 those from above. */
13855 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13857 pos_before
= glyph
->charpos
;
13858 glyph_before
= glyph
;
13860 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13862 pos_after
= glyph
->charpos
;
13863 glyph_after
= glyph
;
13866 else if (dpos
== 0)
13867 match_with_avoid_cursor
= 1;
13869 else if (STRINGP (glyph
->object
))
13871 Lisp_Object chprop
;
13872 EMACS_INT glyph_pos
= glyph
->charpos
;
13874 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13876 if (!NILP (chprop
))
13878 /* If the string came from a `display' text property,
13879 look up the buffer position of that property and
13880 use that position to update bpos_max, as if we
13881 actually saw such a position in one of the row's
13882 glyphs. This helps with supporting integer values
13883 of `cursor' property on the display string in
13884 situations where most or all of the row's buffer
13885 text is completely covered by display properties,
13886 so that no glyph with valid buffer positions is
13887 ever seen in the row. */
13888 EMACS_INT prop_pos
=
13889 string_buffer_position_lim (glyph
->object
, pos_before
,
13892 if (prop_pos
>= pos_before
)
13893 bpos_max
= prop_pos
- 1;
13895 if (INTEGERP (chprop
))
13897 bpos_covered
= bpos_max
+ XINT (chprop
);
13898 /* If the `cursor' property covers buffer positions up
13899 to and including point, we should display cursor on
13900 this glyph. Note that, if a `cursor' property on one
13901 of the string's characters has an integer value, we
13902 will break out of the loop below _before_ we get to
13903 the position match above. IOW, integer values of
13904 the `cursor' property override the "exact match for
13905 point" strategy of positioning the cursor. */
13906 /* Implementation note: bpos_max == pt_old when, e.g.,
13907 we are in an empty line, where bpos_max is set to
13908 MATRIX_ROW_START_CHARPOS, see above. */
13909 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13918 x
+= glyph
->pixel_width
;
13921 else if (glyph
> end
) /* row is reversed */
13922 while (!INTEGERP (glyph
->object
))
13924 if (BUFFERP (glyph
->object
))
13926 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13928 if (glyph
->charpos
> bpos_max
)
13929 bpos_max
= glyph
->charpos
;
13930 if (glyph
->charpos
< bpos_min
)
13931 bpos_min
= glyph
->charpos
;
13932 if (!glyph
->avoid_cursor_p
)
13936 match_with_avoid_cursor
= 0;
13939 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13941 pos_before
= glyph
->charpos
;
13942 glyph_before
= glyph
;
13944 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13946 pos_after
= glyph
->charpos
;
13947 glyph_after
= glyph
;
13950 else if (dpos
== 0)
13951 match_with_avoid_cursor
= 1;
13953 else if (STRINGP (glyph
->object
))
13955 Lisp_Object chprop
;
13956 EMACS_INT glyph_pos
= glyph
->charpos
;
13958 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13960 if (!NILP (chprop
))
13962 EMACS_INT prop_pos
=
13963 string_buffer_position_lim (glyph
->object
, pos_before
,
13966 if (prop_pos
>= pos_before
)
13967 bpos_max
= prop_pos
- 1;
13969 if (INTEGERP (chprop
))
13971 bpos_covered
= bpos_max
+ XINT (chprop
);
13972 /* If the `cursor' property covers buffer positions up
13973 to and including point, we should display cursor on
13975 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13984 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13986 x
--; /* can't use any pixel_width */
13989 x
-= glyph
->pixel_width
;
13992 /* Step 2: If we didn't find an exact match for point, we need to
13993 look for a proper place to put the cursor among glyphs between
13994 GLYPH_BEFORE and GLYPH_AFTER. */
13995 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13996 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13997 && bpos_covered
< pt_old
)
13999 /* An empty line has a single glyph whose OBJECT is zero and
14000 whose CHARPOS is the position of a newline on that line.
14001 Note that on a TTY, there are more glyphs after that, which
14002 were produced by extend_face_to_end_of_line, but their
14003 CHARPOS is zero or negative. */
14005 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14006 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14008 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14010 EMACS_INT ellipsis_pos
;
14012 /* Scan back over the ellipsis glyphs. */
14013 if (!row
->reversed_p
)
14015 ellipsis_pos
= (glyph
- 1)->charpos
;
14016 while (glyph
> row
->glyphs
[TEXT_AREA
]
14017 && (glyph
- 1)->charpos
== ellipsis_pos
)
14018 glyph
--, x
-= glyph
->pixel_width
;
14019 /* That loop always goes one position too far, including
14020 the glyph before the ellipsis. So scan forward over
14022 x
+= glyph
->pixel_width
;
14025 else /* row is reversed */
14027 ellipsis_pos
= (glyph
+ 1)->charpos
;
14028 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14029 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14030 glyph
++, x
+= glyph
->pixel_width
;
14031 x
-= glyph
->pixel_width
;
14035 else if (match_with_avoid_cursor
)
14037 cursor
= glyph_after
;
14040 else if (string_seen
)
14042 int incr
= row
->reversed_p
? -1 : +1;
14044 /* Need to find the glyph that came out of a string which is
14045 present at point. That glyph is somewhere between
14046 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14047 positioned between POS_BEFORE and POS_AFTER in the
14049 struct glyph
*start
, *stop
;
14050 EMACS_INT pos
= pos_before
;
14054 /* If the row ends in a newline from a display string,
14055 reordering could have moved the glyphs belonging to the
14056 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14057 in this case we extend the search to the last glyph in
14058 the row that was not inserted by redisplay. */
14059 if (row
->ends_in_newline_from_string_p
)
14062 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14065 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14066 correspond to POS_BEFORE and POS_AFTER, respectively. We
14067 need START and STOP in the order that corresponds to the
14068 row's direction as given by its reversed_p flag. If the
14069 directionality of characters between POS_BEFORE and
14070 POS_AFTER is the opposite of the row's base direction,
14071 these characters will have been reordered for display,
14072 and we need to reverse START and STOP. */
14073 if (!row
->reversed_p
)
14075 start
= min (glyph_before
, glyph_after
);
14076 stop
= max (glyph_before
, glyph_after
);
14080 start
= max (glyph_before
, glyph_after
);
14081 stop
= min (glyph_before
, glyph_after
);
14083 for (glyph
= start
+ incr
;
14084 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14087 /* Any glyphs that come from the buffer are here because
14088 of bidi reordering. Skip them, and only pay
14089 attention to glyphs that came from some string. */
14090 if (STRINGP (glyph
->object
))
14094 /* If the display property covers the newline, we
14095 need to search for it one position farther. */
14096 EMACS_INT lim
= pos_after
14097 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14099 string_from_text_prop
= 0;
14100 str
= glyph
->object
;
14101 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14102 if (tem
== 0 /* from overlay */
14105 /* If the string from which this glyph came is
14106 found in the buffer at point, or at position
14107 that is closer to point than pos_after, then
14108 we've found the glyph we've been looking for.
14109 If it comes from an overlay (tem == 0), and
14110 it has the `cursor' property on one of its
14111 glyphs, record that glyph as a candidate for
14112 displaying the cursor. (As in the
14113 unidirectional version, we will display the
14114 cursor on the last candidate we find.) */
14117 || (tem
- pt_old
> 0 && tem
< pos_after
))
14119 /* The glyphs from this string could have
14120 been reordered. Find the one with the
14121 smallest string position. Or there could
14122 be a character in the string with the
14123 `cursor' property, which means display
14124 cursor on that character's glyph. */
14125 EMACS_INT strpos
= glyph
->charpos
;
14130 string_from_text_prop
= 1;
14133 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14134 && EQ (glyph
->object
, str
);
14138 EMACS_INT gpos
= glyph
->charpos
;
14140 cprop
= Fget_char_property (make_number (gpos
),
14148 if (tem
&& glyph
->charpos
< strpos
)
14150 strpos
= glyph
->charpos
;
14156 || (tem
- pt_old
> 0 && tem
< pos_after
))
14160 pos
= tem
+ 1; /* don't find previous instances */
14162 /* This string is not what we want; skip all of the
14163 glyphs that came from it. */
14164 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14165 && EQ (glyph
->object
, str
))
14172 /* If we reached the end of the line, and END was from a string,
14173 the cursor is not on this line. */
14175 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14176 && STRINGP (end
->object
)
14177 && row
->continued_p
)
14180 /* A truncated row may not include PT among its character positions.
14181 Setting the cursor inside the scroll margin will trigger
14182 recalculation of hscroll in hscroll_window_tree. But if a
14183 display string covers point, defer to the string-handling
14184 code below to figure this out. */
14185 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14187 cursor
= glyph_before
;
14190 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14191 /* Zero-width characters produce no glyphs. */
14193 && (row
->reversed_p
14194 ? glyph_after
> glyphs_end
14195 : glyph_after
< glyphs_end
)))
14197 cursor
= glyph_after
;
14203 if (cursor
!= NULL
)
14209 /* Need to compute x that corresponds to GLYPH. */
14210 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14212 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14214 x
+= g
->pixel_width
;
14218 /* ROW could be part of a continued line, which, under bidi
14219 reordering, might have other rows whose start and end charpos
14220 occlude point. Only set w->cursor if we found a better
14221 approximation to the cursor position than we have from previously
14222 examined candidate rows belonging to the same continued line. */
14223 if (/* we already have a candidate row */
14224 w
->cursor
.vpos
>= 0
14225 /* that candidate is not the row we are processing */
14226 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14227 /* Make sure cursor.vpos specifies a row whose start and end
14228 charpos occlude point, and it is valid candidate for being a
14229 cursor-row. This is because some callers of this function
14230 leave cursor.vpos at the row where the cursor was displayed
14231 during the last redisplay cycle. */
14232 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14233 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14234 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14237 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14239 /* Don't consider glyphs that are outside TEXT_AREA. */
14240 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14242 /* Keep the candidate whose buffer position is the closest to
14243 point or has the `cursor' property. */
14244 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14245 w
->cursor
.hpos
>= 0
14246 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14247 && ((BUFFERP (g1
->object
)
14248 && (g1
->charpos
== pt_old
/* an exact match always wins */
14249 || (BUFFERP (glyph
->object
)
14250 && eabs (g1
->charpos
- pt_old
)
14251 < eabs (glyph
->charpos
- pt_old
))))
14252 /* previous candidate is a glyph from a string that has
14253 a non-nil `cursor' property */
14254 || (STRINGP (g1
->object
)
14255 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14256 Qcursor
, g1
->object
))
14257 /* previous candidate is from the same display
14258 string as this one, and the display string
14259 came from a text property */
14260 || (EQ (g1
->object
, glyph
->object
)
14261 && string_from_text_prop
)
14262 /* this candidate is from newline and its
14263 position is not an exact match */
14264 || (INTEGERP (glyph
->object
)
14265 && glyph
->charpos
!= pt_old
)))))
14267 /* If this candidate gives an exact match, use that. */
14268 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14269 /* If this candidate is a glyph created for the
14270 terminating newline of a line, and point is on that
14271 newline, it wins because it's an exact match. */
14272 || (!row
->continued_p
14273 && INTEGERP (glyph
->object
)
14274 && glyph
->charpos
== 0
14275 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14276 /* Otherwise, keep the candidate that comes from a row
14277 spanning less buffer positions. This may win when one or
14278 both candidate positions are on glyphs that came from
14279 display strings, for which we cannot compare buffer
14281 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14282 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14283 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14286 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14288 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14289 w
->cursor
.y
= row
->y
+ dy
;
14291 if (w
== XWINDOW (selected_window
))
14293 if (!row
->continued_p
14294 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14297 this_line_buffer
= XBUFFER (w
->buffer
);
14299 CHARPOS (this_line_start_pos
)
14300 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14301 BYTEPOS (this_line_start_pos
)
14302 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14304 CHARPOS (this_line_end_pos
)
14305 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14306 BYTEPOS (this_line_end_pos
)
14307 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14309 this_line_y
= w
->cursor
.y
;
14310 this_line_pixel_height
= row
->height
;
14311 this_line_vpos
= w
->cursor
.vpos
;
14312 this_line_start_x
= row
->x
;
14315 CHARPOS (this_line_start_pos
) = 0;
14322 /* Run window scroll functions, if any, for WINDOW with new window
14323 start STARTP. Sets the window start of WINDOW to that position.
14325 We assume that the window's buffer is really current. */
14327 static inline struct text_pos
14328 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14330 struct window
*w
= XWINDOW (window
);
14331 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14333 if (current_buffer
!= XBUFFER (w
->buffer
))
14336 if (!NILP (Vwindow_scroll_functions
))
14338 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14339 make_number (CHARPOS (startp
)));
14340 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14341 /* In case the hook functions switch buffers. */
14342 if (current_buffer
!= XBUFFER (w
->buffer
))
14343 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14350 /* Make sure the line containing the cursor is fully visible.
14351 A value of 1 means there is nothing to be done.
14352 (Either the line is fully visible, or it cannot be made so,
14353 or we cannot tell.)
14355 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14356 is higher than window.
14358 A value of 0 means the caller should do scrolling
14359 as if point had gone off the screen. */
14362 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14364 struct glyph_matrix
*matrix
;
14365 struct glyph_row
*row
;
14368 if (!make_cursor_line_fully_visible_p
)
14371 /* It's not always possible to find the cursor, e.g, when a window
14372 is full of overlay strings. Don't do anything in that case. */
14373 if (w
->cursor
.vpos
< 0)
14376 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14377 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14379 /* If the cursor row is not partially visible, there's nothing to do. */
14380 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14383 /* If the row the cursor is in is taller than the window's height,
14384 it's not clear what to do, so do nothing. */
14385 window_height
= window_box_height (w
);
14386 if (row
->height
>= window_height
)
14388 if (!force_p
|| MINI_WINDOW_P (w
)
14389 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14396 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14397 non-zero means only WINDOW is redisplayed in redisplay_internal.
14398 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14399 in redisplay_window to bring a partially visible line into view in
14400 the case that only the cursor has moved.
14402 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14403 last screen line's vertical height extends past the end of the screen.
14407 1 if scrolling succeeded
14409 0 if scrolling didn't find point.
14411 -1 if new fonts have been loaded so that we must interrupt
14412 redisplay, adjust glyph matrices, and try again. */
14418 SCROLLING_NEED_LARGER_MATRICES
14421 /* If scroll-conservatively is more than this, never recenter.
14423 If you change this, don't forget to update the doc string of
14424 `scroll-conservatively' and the Emacs manual. */
14425 #define SCROLL_LIMIT 100
14428 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14429 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14430 int temp_scroll_step
, int last_line_misfit
)
14432 struct window
*w
= XWINDOW (window
);
14433 struct frame
*f
= XFRAME (w
->frame
);
14434 struct text_pos pos
, startp
;
14436 int this_scroll_margin
, scroll_max
, rc
, height
;
14437 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14438 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14439 Lisp_Object aggressive
;
14440 /* We will never try scrolling more than this number of lines. */
14441 int scroll_limit
= SCROLL_LIMIT
;
14444 debug_method_add (w
, "try_scrolling");
14447 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14449 /* Compute scroll margin height in pixels. We scroll when point is
14450 within this distance from the top or bottom of the window. */
14451 if (scroll_margin
> 0)
14452 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14453 * FRAME_LINE_HEIGHT (f
);
14455 this_scroll_margin
= 0;
14457 /* Force arg_scroll_conservatively to have a reasonable value, to
14458 avoid scrolling too far away with slow move_it_* functions. Note
14459 that the user can supply scroll-conservatively equal to
14460 `most-positive-fixnum', which can be larger than INT_MAX. */
14461 if (arg_scroll_conservatively
> scroll_limit
)
14463 arg_scroll_conservatively
= scroll_limit
+ 1;
14464 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14466 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14467 /* Compute how much we should try to scroll maximally to bring
14468 point into view. */
14469 scroll_max
= (max (scroll_step
,
14470 max (arg_scroll_conservatively
, temp_scroll_step
))
14471 * FRAME_LINE_HEIGHT (f
));
14472 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14473 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14474 /* We're trying to scroll because of aggressive scrolling but no
14475 scroll_step is set. Choose an arbitrary one. */
14476 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14482 /* Decide whether to scroll down. */
14483 if (PT
> CHARPOS (startp
))
14485 int scroll_margin_y
;
14487 /* Compute the pixel ypos of the scroll margin, then move IT to
14488 either that ypos or PT, whichever comes first. */
14489 start_display (&it
, w
, startp
);
14490 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14491 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14492 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14493 (MOVE_TO_POS
| MOVE_TO_Y
));
14495 if (PT
> CHARPOS (it
.current
.pos
))
14497 int y0
= line_bottom_y (&it
);
14498 /* Compute how many pixels below window bottom to stop searching
14499 for PT. This avoids costly search for PT that is far away if
14500 the user limited scrolling by a small number of lines, but
14501 always finds PT if scroll_conservatively is set to a large
14502 number, such as most-positive-fixnum. */
14503 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14504 int y_to_move
= it
.last_visible_y
+ slack
;
14506 /* Compute the distance from the scroll margin to PT or to
14507 the scroll limit, whichever comes first. This should
14508 include the height of the cursor line, to make that line
14510 move_it_to (&it
, PT
, -1, y_to_move
,
14511 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14512 dy
= line_bottom_y (&it
) - y0
;
14514 if (dy
> scroll_max
)
14515 return SCROLLING_FAILED
;
14524 /* Point is in or below the bottom scroll margin, so move the
14525 window start down. If scrolling conservatively, move it just
14526 enough down to make point visible. If scroll_step is set,
14527 move it down by scroll_step. */
14528 if (arg_scroll_conservatively
)
14530 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14531 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14532 else if (scroll_step
|| temp_scroll_step
)
14533 amount_to_scroll
= scroll_max
;
14536 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14537 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14538 if (NUMBERP (aggressive
))
14540 double float_amount
= XFLOATINT (aggressive
) * height
;
14541 amount_to_scroll
= float_amount
;
14542 if (amount_to_scroll
== 0 && float_amount
> 0)
14543 amount_to_scroll
= 1;
14544 /* Don't let point enter the scroll margin near top of
14546 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14547 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14551 if (amount_to_scroll
<= 0)
14552 return SCROLLING_FAILED
;
14554 start_display (&it
, w
, startp
);
14555 if (arg_scroll_conservatively
<= scroll_limit
)
14556 move_it_vertically (&it
, amount_to_scroll
);
14559 /* Extra precision for users who set scroll-conservatively
14560 to a large number: make sure the amount we scroll
14561 the window start is never less than amount_to_scroll,
14562 which was computed as distance from window bottom to
14563 point. This matters when lines at window top and lines
14564 below window bottom have different height. */
14566 void *it1data
= NULL
;
14567 /* We use a temporary it1 because line_bottom_y can modify
14568 its argument, if it moves one line down; see there. */
14571 SAVE_IT (it1
, it
, it1data
);
14572 start_y
= line_bottom_y (&it1
);
14574 RESTORE_IT (&it
, &it
, it1data
);
14575 move_it_by_lines (&it
, 1);
14576 SAVE_IT (it1
, it
, it1data
);
14577 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14580 /* If STARTP is unchanged, move it down another screen line. */
14581 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14582 move_it_by_lines (&it
, 1);
14583 startp
= it
.current
.pos
;
14587 struct text_pos scroll_margin_pos
= startp
;
14589 /* See if point is inside the scroll margin at the top of the
14591 if (this_scroll_margin
)
14593 start_display (&it
, w
, startp
);
14594 move_it_vertically (&it
, this_scroll_margin
);
14595 scroll_margin_pos
= it
.current
.pos
;
14598 if (PT
< CHARPOS (scroll_margin_pos
))
14600 /* Point is in the scroll margin at the top of the window or
14601 above what is displayed in the window. */
14604 /* Compute the vertical distance from PT to the scroll
14605 margin position. Move as far as scroll_max allows, or
14606 one screenful, or 10 screen lines, whichever is largest.
14607 Give up if distance is greater than scroll_max. */
14608 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14609 start_display (&it
, w
, pos
);
14611 y_to_move
= max (it
.last_visible_y
,
14612 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14613 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14615 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14616 dy
= it
.current_y
- y0
;
14617 if (dy
> scroll_max
)
14618 return SCROLLING_FAILED
;
14620 /* Compute new window start. */
14621 start_display (&it
, w
, startp
);
14623 if (arg_scroll_conservatively
)
14624 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14625 max (scroll_step
, temp_scroll_step
));
14626 else if (scroll_step
|| temp_scroll_step
)
14627 amount_to_scroll
= scroll_max
;
14630 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14631 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14632 if (NUMBERP (aggressive
))
14634 double float_amount
= XFLOATINT (aggressive
) * height
;
14635 amount_to_scroll
= float_amount
;
14636 if (amount_to_scroll
== 0 && float_amount
> 0)
14637 amount_to_scroll
= 1;
14638 amount_to_scroll
-=
14639 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14640 /* Don't let point enter the scroll margin near
14641 bottom of the window. */
14642 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14643 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14647 if (amount_to_scroll
<= 0)
14648 return SCROLLING_FAILED
;
14650 move_it_vertically_backward (&it
, amount_to_scroll
);
14651 startp
= it
.current
.pos
;
14655 /* Run window scroll functions. */
14656 startp
= run_window_scroll_functions (window
, startp
);
14658 /* Display the window. Give up if new fonts are loaded, or if point
14660 if (!try_window (window
, startp
, 0))
14661 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14662 else if (w
->cursor
.vpos
< 0)
14664 clear_glyph_matrix (w
->desired_matrix
);
14665 rc
= SCROLLING_FAILED
;
14669 /* Maybe forget recorded base line for line number display. */
14670 if (!just_this_one_p
14671 || current_buffer
->clip_changed
14672 || BEG_UNCHANGED
< CHARPOS (startp
))
14673 w
->base_line_number
= Qnil
;
14675 /* If cursor ends up on a partially visible line,
14676 treat that as being off the bottom of the screen. */
14677 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14678 /* It's possible that the cursor is on the first line of the
14679 buffer, which is partially obscured due to a vscroll
14680 (Bug#7537). In that case, avoid looping forever . */
14681 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14683 clear_glyph_matrix (w
->desired_matrix
);
14684 ++extra_scroll_margin_lines
;
14687 rc
= SCROLLING_SUCCESS
;
14694 /* Compute a suitable window start for window W if display of W starts
14695 on a continuation line. Value is non-zero if a new window start
14698 The new window start will be computed, based on W's width, starting
14699 from the start of the continued line. It is the start of the
14700 screen line with the minimum distance from the old start W->start. */
14703 compute_window_start_on_continuation_line (struct window
*w
)
14705 struct text_pos pos
, start_pos
;
14706 int window_start_changed_p
= 0;
14708 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14710 /* If window start is on a continuation line... Window start may be
14711 < BEGV in case there's invisible text at the start of the
14712 buffer (M-x rmail, for example). */
14713 if (CHARPOS (start_pos
) > BEGV
14714 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14717 struct glyph_row
*row
;
14719 /* Handle the case that the window start is out of range. */
14720 if (CHARPOS (start_pos
) < BEGV
)
14721 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14722 else if (CHARPOS (start_pos
) > ZV
)
14723 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14725 /* Find the start of the continued line. This should be fast
14726 because scan_buffer is fast (newline cache). */
14727 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14728 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14729 row
, DEFAULT_FACE_ID
);
14730 reseat_at_previous_visible_line_start (&it
);
14732 /* If the line start is "too far" away from the window start,
14733 say it takes too much time to compute a new window start. */
14734 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14735 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14737 int min_distance
, distance
;
14739 /* Move forward by display lines to find the new window
14740 start. If window width was enlarged, the new start can
14741 be expected to be > the old start. If window width was
14742 decreased, the new window start will be < the old start.
14743 So, we're looking for the display line start with the
14744 minimum distance from the old window start. */
14745 pos
= it
.current
.pos
;
14746 min_distance
= INFINITY
;
14747 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14748 distance
< min_distance
)
14750 min_distance
= distance
;
14751 pos
= it
.current
.pos
;
14752 move_it_by_lines (&it
, 1);
14755 /* Set the window start there. */
14756 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14757 window_start_changed_p
= 1;
14761 return window_start_changed_p
;
14765 /* Try cursor movement in case text has not changed in window WINDOW,
14766 with window start STARTP. Value is
14768 CURSOR_MOVEMENT_SUCCESS if successful
14770 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14772 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14773 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14774 we want to scroll as if scroll-step were set to 1. See the code.
14776 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14777 which case we have to abort this redisplay, and adjust matrices
14782 CURSOR_MOVEMENT_SUCCESS
,
14783 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14784 CURSOR_MOVEMENT_MUST_SCROLL
,
14785 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14789 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14791 struct window
*w
= XWINDOW (window
);
14792 struct frame
*f
= XFRAME (w
->frame
);
14793 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14796 if (inhibit_try_cursor_movement
)
14800 /* Handle case where text has not changed, only point, and it has
14801 not moved off the frame. */
14802 if (/* Point may be in this window. */
14803 PT
>= CHARPOS (startp
)
14804 /* Selective display hasn't changed. */
14805 && !current_buffer
->clip_changed
14806 /* Function force-mode-line-update is used to force a thorough
14807 redisplay. It sets either windows_or_buffers_changed or
14808 update_mode_lines. So don't take a shortcut here for these
14810 && !update_mode_lines
14811 && !windows_or_buffers_changed
14812 && !cursor_type_changed
14813 /* Can't use this case if highlighting a region. When a
14814 region exists, cursor movement has to do more than just
14816 && !(!NILP (Vtransient_mark_mode
)
14817 && !NILP (BVAR (current_buffer
, mark_active
)))
14818 && NILP (w
->region_showing
)
14819 && NILP (Vshow_trailing_whitespace
)
14820 /* Right after splitting windows, last_point may be nil. */
14821 && INTEGERP (w
->last_point
)
14822 /* This code is not used for mini-buffer for the sake of the case
14823 of redisplaying to replace an echo area message; since in
14824 that case the mini-buffer contents per se are usually
14825 unchanged. This code is of no real use in the mini-buffer
14826 since the handling of this_line_start_pos, etc., in redisplay
14827 handles the same cases. */
14828 && !EQ (window
, minibuf_window
)
14829 /* When splitting windows or for new windows, it happens that
14830 redisplay is called with a nil window_end_vpos or one being
14831 larger than the window. This should really be fixed in
14832 window.c. I don't have this on my list, now, so we do
14833 approximately the same as the old redisplay code. --gerd. */
14834 && INTEGERP (w
->window_end_vpos
)
14835 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14836 && (FRAME_WINDOW_P (f
)
14837 || !overlay_arrow_in_current_buffer_p ()))
14839 int this_scroll_margin
, top_scroll_margin
;
14840 struct glyph_row
*row
= NULL
;
14843 debug_method_add (w
, "cursor movement");
14846 /* Scroll if point within this distance from the top or bottom
14847 of the window. This is a pixel value. */
14848 if (scroll_margin
> 0)
14850 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14851 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14854 this_scroll_margin
= 0;
14856 top_scroll_margin
= this_scroll_margin
;
14857 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14858 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14860 /* Start with the row the cursor was displayed during the last
14861 not paused redisplay. Give up if that row is not valid. */
14862 if (w
->last_cursor
.vpos
< 0
14863 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14864 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14867 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14868 if (row
->mode_line_p
)
14870 if (!row
->enabled_p
)
14871 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14874 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14876 int scroll_p
= 0, must_scroll
= 0;
14877 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14879 if (PT
> XFASTINT (w
->last_point
))
14881 /* Point has moved forward. */
14882 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14883 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14885 xassert (row
->enabled_p
);
14889 /* If the end position of a row equals the start
14890 position of the next row, and PT is at that position,
14891 we would rather display cursor in the next line. */
14892 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14893 && MATRIX_ROW_END_CHARPOS (row
) == PT
14894 && row
< w
->current_matrix
->rows
14895 + w
->current_matrix
->nrows
- 1
14896 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14897 && !cursor_row_p (row
))
14900 /* If within the scroll margin, scroll. Note that
14901 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14902 the next line would be drawn, and that
14903 this_scroll_margin can be zero. */
14904 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14905 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14906 /* Line is completely visible last line in window
14907 and PT is to be set in the next line. */
14908 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14909 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14910 && !row
->ends_at_zv_p
14911 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14914 else if (PT
< XFASTINT (w
->last_point
))
14916 /* Cursor has to be moved backward. Note that PT >=
14917 CHARPOS (startp) because of the outer if-statement. */
14918 while (!row
->mode_line_p
14919 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14920 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14921 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14922 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14923 row
> w
->current_matrix
->rows
14924 && (row
-1)->ends_in_newline_from_string_p
))))
14925 && (row
->y
> top_scroll_margin
14926 || CHARPOS (startp
) == BEGV
))
14928 xassert (row
->enabled_p
);
14932 /* Consider the following case: Window starts at BEGV,
14933 there is invisible, intangible text at BEGV, so that
14934 display starts at some point START > BEGV. It can
14935 happen that we are called with PT somewhere between
14936 BEGV and START. Try to handle that case. */
14937 if (row
< w
->current_matrix
->rows
14938 || row
->mode_line_p
)
14940 row
= w
->current_matrix
->rows
;
14941 if (row
->mode_line_p
)
14945 /* Due to newlines in overlay strings, we may have to
14946 skip forward over overlay strings. */
14947 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14948 && MATRIX_ROW_END_CHARPOS (row
) == PT
14949 && !cursor_row_p (row
))
14952 /* If within the scroll margin, scroll. */
14953 if (row
->y
< top_scroll_margin
14954 && CHARPOS (startp
) != BEGV
)
14959 /* Cursor did not move. So don't scroll even if cursor line
14960 is partially visible, as it was so before. */
14961 rc
= CURSOR_MOVEMENT_SUCCESS
;
14964 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14965 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14967 /* if PT is not in the glyph row, give up. */
14968 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14971 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14972 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14974 /* If rows are bidi-reordered and point moved, back up
14975 until we find a row that does not belong to a
14976 continuation line. This is because we must consider
14977 all rows of a continued line as candidates for the
14978 new cursor positioning, since row start and end
14979 positions change non-linearly with vertical position
14981 /* FIXME: Revisit this when glyph ``spilling'' in
14982 continuation lines' rows is implemented for
14983 bidi-reordered rows. */
14984 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14986 /* If we hit the beginning of the displayed portion
14987 without finding the first row of a continued
14989 if (row
<= w
->current_matrix
->rows
)
14991 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14994 xassert (row
->enabled_p
);
15000 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15001 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15002 && make_cursor_line_fully_visible_p
)
15004 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15005 && !row
->ends_at_zv_p
15006 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15007 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15008 else if (row
->height
> window_box_height (w
))
15010 /* If we end up in a partially visible line, let's
15011 make it fully visible, except when it's taller
15012 than the window, in which case we can't do much
15015 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15019 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15020 if (!cursor_row_fully_visible_p (w
, 0, 1))
15021 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15023 rc
= CURSOR_MOVEMENT_SUCCESS
;
15027 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15028 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15029 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15031 /* With bidi-reordered rows, there could be more than
15032 one candidate row whose start and end positions
15033 occlude point. We need to let set_cursor_from_row
15034 find the best candidate. */
15035 /* FIXME: Revisit this when glyph ``spilling'' in
15036 continuation lines' rows is implemented for
15037 bidi-reordered rows. */
15042 int at_zv_p
= 0, exact_match_p
= 0;
15044 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15045 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15046 && cursor_row_p (row
))
15047 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15049 /* As soon as we've found the exact match for point,
15050 or the first suitable row whose ends_at_zv_p flag
15051 is set, we are done. */
15053 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15055 && w
->cursor
.hpos
>= 0
15056 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15059 struct glyph_row
*candidate
=
15060 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15062 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15063 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15066 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15067 || (INTEGERP (g
->object
)
15068 && (g
->charpos
== PT
15069 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15071 if (rv
&& (at_zv_p
|| exact_match_p
))
15073 rc
= CURSOR_MOVEMENT_SUCCESS
;
15076 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15080 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15081 || row
->continued_p
)
15082 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15083 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15084 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15085 /* If we didn't find any candidate rows, or exited the
15086 loop before all the candidates were examined, signal
15087 to the caller that this method failed. */
15088 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15090 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15091 && !row
->continued_p
))
15092 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15094 rc
= CURSOR_MOVEMENT_SUCCESS
;
15100 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15102 rc
= CURSOR_MOVEMENT_SUCCESS
;
15107 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15108 && MATRIX_ROW_START_CHARPOS (row
) == PT
15109 && cursor_row_p (row
));
15117 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15121 set_vertical_scroll_bar (struct window
*w
)
15123 EMACS_INT start
, end
, whole
;
15125 /* Calculate the start and end positions for the current window.
15126 At some point, it would be nice to choose between scrollbars
15127 which reflect the whole buffer size, with special markers
15128 indicating narrowing, and scrollbars which reflect only the
15131 Note that mini-buffers sometimes aren't displaying any text. */
15132 if (!MINI_WINDOW_P (w
)
15133 || (w
== XWINDOW (minibuf_window
)
15134 && NILP (echo_area_buffer
[0])))
15136 struct buffer
*buf
= XBUFFER (w
->buffer
);
15137 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15138 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15139 /* I don't think this is guaranteed to be right. For the
15140 moment, we'll pretend it is. */
15141 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15145 if (whole
< (end
- start
))
15146 whole
= end
- start
;
15149 start
= end
= whole
= 0;
15151 /* Indicate what this scroll bar ought to be displaying now. */
15152 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15153 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15154 (w
, end
- start
, whole
, start
);
15158 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15159 selected_window is redisplayed.
15161 We can return without actually redisplaying the window if
15162 fonts_changed_p is nonzero. In that case, redisplay_internal will
15166 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15168 struct window
*w
= XWINDOW (window
);
15169 struct frame
*f
= XFRAME (w
->frame
);
15170 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15171 struct buffer
*old
= current_buffer
;
15172 struct text_pos lpoint
, opoint
, startp
;
15173 int update_mode_line
;
15176 /* Record it now because it's overwritten. */
15177 int current_matrix_up_to_date_p
= 0;
15178 int used_current_matrix_p
= 0;
15179 /* This is less strict than current_matrix_up_to_date_p.
15180 It indicates that the buffer contents and narrowing are unchanged. */
15181 int buffer_unchanged_p
= 0;
15182 int temp_scroll_step
= 0;
15183 int count
= SPECPDL_INDEX ();
15185 int centering_position
= -1;
15186 int last_line_misfit
= 0;
15187 EMACS_INT beg_unchanged
, end_unchanged
;
15189 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15192 /* W must be a leaf window here. */
15193 xassert (!NILP (w
->buffer
));
15195 *w
->desired_matrix
->method
= 0;
15199 reconsider_clip_changes (w
, buffer
);
15201 /* Has the mode line to be updated? */
15202 update_mode_line
= (!NILP (w
->update_mode_line
)
15203 || update_mode_lines
15204 || buffer
->clip_changed
15205 || buffer
->prevent_redisplay_optimizations_p
);
15207 if (MINI_WINDOW_P (w
))
15209 if (w
== XWINDOW (echo_area_window
)
15210 && !NILP (echo_area_buffer
[0]))
15212 if (update_mode_line
)
15213 /* We may have to update a tty frame's menu bar or a
15214 tool-bar. Example `M-x C-h C-h C-g'. */
15215 goto finish_menu_bars
;
15217 /* We've already displayed the echo area glyphs in this window. */
15218 goto finish_scroll_bars
;
15220 else if ((w
!= XWINDOW (minibuf_window
)
15221 || minibuf_level
== 0)
15222 /* When buffer is nonempty, redisplay window normally. */
15223 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15224 /* Quail displays non-mini buffers in minibuffer window.
15225 In that case, redisplay the window normally. */
15226 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15228 /* W is a mini-buffer window, but it's not active, so clear
15230 int yb
= window_text_bottom_y (w
);
15231 struct glyph_row
*row
;
15234 for (y
= 0, row
= w
->desired_matrix
->rows
;
15236 y
+= row
->height
, ++row
)
15237 blank_row (w
, row
, y
);
15238 goto finish_scroll_bars
;
15241 clear_glyph_matrix (w
->desired_matrix
);
15244 /* Otherwise set up data on this window; select its buffer and point
15246 /* Really select the buffer, for the sake of buffer-local
15248 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15250 current_matrix_up_to_date_p
15251 = (!NILP (w
->window_end_valid
)
15252 && !current_buffer
->clip_changed
15253 && !current_buffer
->prevent_redisplay_optimizations_p
15254 && XFASTINT (w
->last_modified
) >= MODIFF
15255 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15257 /* Run the window-bottom-change-functions
15258 if it is possible that the text on the screen has changed
15259 (either due to modification of the text, or any other reason). */
15260 if (!current_matrix_up_to_date_p
15261 && !NILP (Vwindow_text_change_functions
))
15263 safe_run_hooks (Qwindow_text_change_functions
);
15267 beg_unchanged
= BEG_UNCHANGED
;
15268 end_unchanged
= END_UNCHANGED
;
15270 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15272 specbind (Qinhibit_point_motion_hooks
, Qt
);
15275 = (!NILP (w
->window_end_valid
)
15276 && !current_buffer
->clip_changed
15277 && XFASTINT (w
->last_modified
) >= MODIFF
15278 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15280 /* When windows_or_buffers_changed is non-zero, we can't rely on
15281 the window end being valid, so set it to nil there. */
15282 if (windows_or_buffers_changed
)
15284 /* If window starts on a continuation line, maybe adjust the
15285 window start in case the window's width changed. */
15286 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15287 compute_window_start_on_continuation_line (w
);
15289 w
->window_end_valid
= Qnil
;
15292 /* Some sanity checks. */
15293 CHECK_WINDOW_END (w
);
15294 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15296 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15299 /* If %c is in mode line, update it if needed. */
15300 if (!NILP (w
->column_number_displayed
)
15301 /* This alternative quickly identifies a common case
15302 where no change is needed. */
15303 && !(PT
== XFASTINT (w
->last_point
)
15304 && XFASTINT (w
->last_modified
) >= MODIFF
15305 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15306 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15307 update_mode_line
= 1;
15309 /* Count number of windows showing the selected buffer. An indirect
15310 buffer counts as its base buffer. */
15311 if (!just_this_one_p
)
15313 struct buffer
*current_base
, *window_base
;
15314 current_base
= current_buffer
;
15315 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15316 if (current_base
->base_buffer
)
15317 current_base
= current_base
->base_buffer
;
15318 if (window_base
->base_buffer
)
15319 window_base
= window_base
->base_buffer
;
15320 if (current_base
== window_base
)
15324 /* Point refers normally to the selected window. For any other
15325 window, set up appropriate value. */
15326 if (!EQ (window
, selected_window
))
15328 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15329 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15333 new_pt_byte
= BEGV_BYTE
;
15334 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15336 else if (new_pt
> (ZV
- 1))
15339 new_pt_byte
= ZV_BYTE
;
15340 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15343 /* We don't use SET_PT so that the point-motion hooks don't run. */
15344 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15347 /* If any of the character widths specified in the display table
15348 have changed, invalidate the width run cache. It's true that
15349 this may be a bit late to catch such changes, but the rest of
15350 redisplay goes (non-fatally) haywire when the display table is
15351 changed, so why should we worry about doing any better? */
15352 if (current_buffer
->width_run_cache
)
15354 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15356 if (! disptab_matches_widthtab (disptab
,
15357 XVECTOR (BVAR (current_buffer
, width_table
))))
15359 invalidate_region_cache (current_buffer
,
15360 current_buffer
->width_run_cache
,
15362 recompute_width_table (current_buffer
, disptab
);
15366 /* If window-start is screwed up, choose a new one. */
15367 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15370 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15372 /* If someone specified a new starting point but did not insist,
15373 check whether it can be used. */
15374 if (!NILP (w
->optional_new_start
)
15375 && CHARPOS (startp
) >= BEGV
15376 && CHARPOS (startp
) <= ZV
)
15378 w
->optional_new_start
= Qnil
;
15379 start_display (&it
, w
, startp
);
15380 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15381 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15382 if (IT_CHARPOS (it
) == PT
)
15383 w
->force_start
= Qt
;
15384 /* IT may overshoot PT if text at PT is invisible. */
15385 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15386 w
->force_start
= Qt
;
15391 /* Handle case where place to start displaying has been specified,
15392 unless the specified location is outside the accessible range. */
15393 if (!NILP (w
->force_start
)
15394 || w
->frozen_window_start_p
)
15396 /* We set this later on if we have to adjust point. */
15399 w
->force_start
= Qnil
;
15401 w
->window_end_valid
= Qnil
;
15403 /* Forget any recorded base line for line number display. */
15404 if (!buffer_unchanged_p
)
15405 w
->base_line_number
= Qnil
;
15407 /* Redisplay the mode line. Select the buffer properly for that.
15408 Also, run the hook window-scroll-functions
15409 because we have scrolled. */
15410 /* Note, we do this after clearing force_start because
15411 if there's an error, it is better to forget about force_start
15412 than to get into an infinite loop calling the hook functions
15413 and having them get more errors. */
15414 if (!update_mode_line
15415 || ! NILP (Vwindow_scroll_functions
))
15417 update_mode_line
= 1;
15418 w
->update_mode_line
= Qt
;
15419 startp
= run_window_scroll_functions (window
, startp
);
15422 w
->last_modified
= make_number (0);
15423 w
->last_overlay_modified
= make_number (0);
15424 if (CHARPOS (startp
) < BEGV
)
15425 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15426 else if (CHARPOS (startp
) > ZV
)
15427 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15429 /* Redisplay, then check if cursor has been set during the
15430 redisplay. Give up if new fonts were loaded. */
15431 /* We used to issue a CHECK_MARGINS argument to try_window here,
15432 but this causes scrolling to fail when point begins inside
15433 the scroll margin (bug#148) -- cyd */
15434 if (!try_window (window
, startp
, 0))
15436 w
->force_start
= Qt
;
15437 clear_glyph_matrix (w
->desired_matrix
);
15438 goto need_larger_matrices
;
15441 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15443 /* If point does not appear, try to move point so it does
15444 appear. The desired matrix has been built above, so we
15445 can use it here. */
15446 new_vpos
= window_box_height (w
) / 2;
15449 if (!cursor_row_fully_visible_p (w
, 0, 0))
15451 /* Point does appear, but on a line partly visible at end of window.
15452 Move it back to a fully-visible line. */
15453 new_vpos
= window_box_height (w
);
15456 /* If we need to move point for either of the above reasons,
15457 now actually do it. */
15460 struct glyph_row
*row
;
15462 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15463 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15466 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15467 MATRIX_ROW_START_BYTEPOS (row
));
15469 if (w
!= XWINDOW (selected_window
))
15470 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15471 else if (current_buffer
== old
)
15472 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15474 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15476 /* If we are highlighting the region, then we just changed
15477 the region, so redisplay to show it. */
15478 if (!NILP (Vtransient_mark_mode
)
15479 && !NILP (BVAR (current_buffer
, mark_active
)))
15481 clear_glyph_matrix (w
->desired_matrix
);
15482 if (!try_window (window
, startp
, 0))
15483 goto need_larger_matrices
;
15488 debug_method_add (w
, "forced window start");
15493 /* Handle case where text has not changed, only point, and it has
15494 not moved off the frame, and we are not retrying after hscroll.
15495 (current_matrix_up_to_date_p is nonzero when retrying.) */
15496 if (current_matrix_up_to_date_p
15497 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15498 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15502 case CURSOR_MOVEMENT_SUCCESS
:
15503 used_current_matrix_p
= 1;
15506 case CURSOR_MOVEMENT_MUST_SCROLL
:
15507 goto try_to_scroll
;
15513 /* If current starting point was originally the beginning of a line
15514 but no longer is, find a new starting point. */
15515 else if (!NILP (w
->start_at_line_beg
)
15516 && !(CHARPOS (startp
) <= BEGV
15517 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15520 debug_method_add (w
, "recenter 1");
15525 /* Try scrolling with try_window_id. Value is > 0 if update has
15526 been done, it is -1 if we know that the same window start will
15527 not work. It is 0 if unsuccessful for some other reason. */
15528 else if ((tem
= try_window_id (w
)) != 0)
15531 debug_method_add (w
, "try_window_id %d", tem
);
15534 if (fonts_changed_p
)
15535 goto need_larger_matrices
;
15539 /* Otherwise try_window_id has returned -1 which means that we
15540 don't want the alternative below this comment to execute. */
15542 else if (CHARPOS (startp
) >= BEGV
15543 && CHARPOS (startp
) <= ZV
15544 && PT
>= CHARPOS (startp
)
15545 && (CHARPOS (startp
) < ZV
15546 /* Avoid starting at end of buffer. */
15547 || CHARPOS (startp
) == BEGV
15548 || (XFASTINT (w
->last_modified
) >= MODIFF
15549 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15551 int d1
, d2
, d3
, d4
, d5
, d6
;
15553 /* If first window line is a continuation line, and window start
15554 is inside the modified region, but the first change is before
15555 current window start, we must select a new window start.
15557 However, if this is the result of a down-mouse event (e.g. by
15558 extending the mouse-drag-overlay), we don't want to select a
15559 new window start, since that would change the position under
15560 the mouse, resulting in an unwanted mouse-movement rather
15561 than a simple mouse-click. */
15562 if (NILP (w
->start_at_line_beg
)
15563 && NILP (do_mouse_tracking
)
15564 && CHARPOS (startp
) > BEGV
15565 && CHARPOS (startp
) > BEG
+ beg_unchanged
15566 && CHARPOS (startp
) <= Z
- end_unchanged
15567 /* Even if w->start_at_line_beg is nil, a new window may
15568 start at a line_beg, since that's how set_buffer_window
15569 sets it. So, we need to check the return value of
15570 compute_window_start_on_continuation_line. (See also
15572 && XMARKER (w
->start
)->buffer
== current_buffer
15573 && compute_window_start_on_continuation_line (w
)
15574 /* It doesn't make sense to force the window start like we
15575 do at label force_start if it is already known that point
15576 will not be visible in the resulting window, because
15577 doing so will move point from its correct position
15578 instead of scrolling the window to bring point into view.
15580 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15582 w
->force_start
= Qt
;
15583 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15588 debug_method_add (w
, "same window start");
15591 /* Try to redisplay starting at same place as before.
15592 If point has not moved off frame, accept the results. */
15593 if (!current_matrix_up_to_date_p
15594 /* Don't use try_window_reusing_current_matrix in this case
15595 because a window scroll function can have changed the
15597 || !NILP (Vwindow_scroll_functions
)
15598 || MINI_WINDOW_P (w
)
15599 || !(used_current_matrix_p
15600 = try_window_reusing_current_matrix (w
)))
15602 IF_DEBUG (debug_method_add (w
, "1"));
15603 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15604 /* -1 means we need to scroll.
15605 0 means we need new matrices, but fonts_changed_p
15606 is set in that case, so we will detect it below. */
15607 goto try_to_scroll
;
15610 if (fonts_changed_p
)
15611 goto need_larger_matrices
;
15613 if (w
->cursor
.vpos
>= 0)
15615 if (!just_this_one_p
15616 || current_buffer
->clip_changed
15617 || BEG_UNCHANGED
< CHARPOS (startp
))
15618 /* Forget any recorded base line for line number display. */
15619 w
->base_line_number
= Qnil
;
15621 if (!cursor_row_fully_visible_p (w
, 1, 0))
15623 clear_glyph_matrix (w
->desired_matrix
);
15624 last_line_misfit
= 1;
15626 /* Drop through and scroll. */
15631 clear_glyph_matrix (w
->desired_matrix
);
15636 w
->last_modified
= make_number (0);
15637 w
->last_overlay_modified
= make_number (0);
15639 /* Redisplay the mode line. Select the buffer properly for that. */
15640 if (!update_mode_line
)
15642 update_mode_line
= 1;
15643 w
->update_mode_line
= Qt
;
15646 /* Try to scroll by specified few lines. */
15647 if ((scroll_conservatively
15648 || emacs_scroll_step
15649 || temp_scroll_step
15650 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15651 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15652 && CHARPOS (startp
) >= BEGV
15653 && CHARPOS (startp
) <= ZV
)
15655 /* The function returns -1 if new fonts were loaded, 1 if
15656 successful, 0 if not successful. */
15657 int ss
= try_scrolling (window
, just_this_one_p
,
15658 scroll_conservatively
,
15660 temp_scroll_step
, last_line_misfit
);
15663 case SCROLLING_SUCCESS
:
15666 case SCROLLING_NEED_LARGER_MATRICES
:
15667 goto need_larger_matrices
;
15669 case SCROLLING_FAILED
:
15677 /* Finally, just choose a place to start which positions point
15678 according to user preferences. */
15683 debug_method_add (w
, "recenter");
15686 /* w->vscroll = 0; */
15688 /* Forget any previously recorded base line for line number display. */
15689 if (!buffer_unchanged_p
)
15690 w
->base_line_number
= Qnil
;
15692 /* Determine the window start relative to point. */
15693 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15694 it
.current_y
= it
.last_visible_y
;
15695 if (centering_position
< 0)
15699 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15701 EMACS_INT margin_pos
= CHARPOS (startp
);
15702 Lisp_Object aggressive
;
15705 /* If there is a scroll margin at the top of the window, find
15706 its character position. */
15708 /* Cannot call start_display if startp is not in the
15709 accessible region of the buffer. This can happen when we
15710 have just switched to a different buffer and/or changed
15711 its restriction. In that case, startp is initialized to
15712 the character position 1 (BEGV) because we did not yet
15713 have chance to display the buffer even once. */
15714 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15717 void *it1data
= NULL
;
15719 SAVE_IT (it1
, it
, it1data
);
15720 start_display (&it1
, w
, startp
);
15721 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15722 margin_pos
= IT_CHARPOS (it1
);
15723 RESTORE_IT (&it
, &it
, it1data
);
15725 scrolling_up
= PT
> margin_pos
;
15728 ? BVAR (current_buffer
, scroll_up_aggressively
)
15729 : BVAR (current_buffer
, scroll_down_aggressively
);
15731 if (!MINI_WINDOW_P (w
)
15732 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15736 /* Setting scroll-conservatively overrides
15737 scroll-*-aggressively. */
15738 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15740 double float_amount
= XFLOATINT (aggressive
);
15742 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15743 if (pt_offset
== 0 && float_amount
> 0)
15745 if (pt_offset
&& margin
> 0)
15748 /* Compute how much to move the window start backward from
15749 point so that point will be displayed where the user
15753 centering_position
= it
.last_visible_y
;
15755 centering_position
-= pt_offset
;
15756 centering_position
-=
15757 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15758 + WINDOW_HEADER_LINE_HEIGHT (w
);
15759 /* Don't let point enter the scroll margin near top of
15761 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15762 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15765 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15768 /* Set the window start half the height of the window backward
15770 centering_position
= window_box_height (w
) / 2;
15772 move_it_vertically_backward (&it
, centering_position
);
15774 xassert (IT_CHARPOS (it
) >= BEGV
);
15776 /* The function move_it_vertically_backward may move over more
15777 than the specified y-distance. If it->w is small, e.g. a
15778 mini-buffer window, we may end up in front of the window's
15779 display area. Start displaying at the start of the line
15780 containing PT in this case. */
15781 if (it
.current_y
<= 0)
15783 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15784 move_it_vertically_backward (&it
, 0);
15788 it
.current_x
= it
.hpos
= 0;
15790 /* Set the window start position here explicitly, to avoid an
15791 infinite loop in case the functions in window-scroll-functions
15793 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15795 /* Run scroll hooks. */
15796 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15798 /* Redisplay the window. */
15799 if (!current_matrix_up_to_date_p
15800 || windows_or_buffers_changed
15801 || cursor_type_changed
15802 /* Don't use try_window_reusing_current_matrix in this case
15803 because it can have changed the buffer. */
15804 || !NILP (Vwindow_scroll_functions
)
15805 || !just_this_one_p
15806 || MINI_WINDOW_P (w
)
15807 || !(used_current_matrix_p
15808 = try_window_reusing_current_matrix (w
)))
15809 try_window (window
, startp
, 0);
15811 /* If new fonts have been loaded (due to fontsets), give up. We
15812 have to start a new redisplay since we need to re-adjust glyph
15814 if (fonts_changed_p
)
15815 goto need_larger_matrices
;
15817 /* If cursor did not appear assume that the middle of the window is
15818 in the first line of the window. Do it again with the next line.
15819 (Imagine a window of height 100, displaying two lines of height
15820 60. Moving back 50 from it->last_visible_y will end in the first
15822 if (w
->cursor
.vpos
< 0)
15824 if (!NILP (w
->window_end_valid
)
15825 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15827 clear_glyph_matrix (w
->desired_matrix
);
15828 move_it_by_lines (&it
, 1);
15829 try_window (window
, it
.current
.pos
, 0);
15831 else if (PT
< IT_CHARPOS (it
))
15833 clear_glyph_matrix (w
->desired_matrix
);
15834 move_it_by_lines (&it
, -1);
15835 try_window (window
, it
.current
.pos
, 0);
15839 /* Not much we can do about it. */
15843 /* Consider the following case: Window starts at BEGV, there is
15844 invisible, intangible text at BEGV, so that display starts at
15845 some point START > BEGV. It can happen that we are called with
15846 PT somewhere between BEGV and START. Try to handle that case. */
15847 if (w
->cursor
.vpos
< 0)
15849 struct glyph_row
*row
= w
->current_matrix
->rows
;
15850 if (row
->mode_line_p
)
15852 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15855 if (!cursor_row_fully_visible_p (w
, 0, 0))
15857 /* If vscroll is enabled, disable it and try again. */
15861 clear_glyph_matrix (w
->desired_matrix
);
15865 /* Users who set scroll-conservatively to a large number want
15866 point just above/below the scroll margin. If we ended up
15867 with point's row partially visible, move the window start to
15868 make that row fully visible and out of the margin. */
15869 if (scroll_conservatively
> SCROLL_LIMIT
)
15873 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15875 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15877 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15878 clear_glyph_matrix (w
->desired_matrix
);
15879 if (1 == try_window (window
, it
.current
.pos
,
15880 TRY_WINDOW_CHECK_MARGINS
))
15884 /* If centering point failed to make the whole line visible,
15885 put point at the top instead. That has to make the whole line
15886 visible, if it can be done. */
15887 if (centering_position
== 0)
15890 clear_glyph_matrix (w
->desired_matrix
);
15891 centering_position
= 0;
15897 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15898 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15899 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15902 /* Display the mode line, if we must. */
15903 if ((update_mode_line
15904 /* If window not full width, must redo its mode line
15905 if (a) the window to its side is being redone and
15906 (b) we do a frame-based redisplay. This is a consequence
15907 of how inverted lines are drawn in frame-based redisplay. */
15908 || (!just_this_one_p
15909 && !FRAME_WINDOW_P (f
)
15910 && !WINDOW_FULL_WIDTH_P (w
))
15911 /* Line number to display. */
15912 || INTEGERP (w
->base_line_pos
)
15913 /* Column number is displayed and different from the one displayed. */
15914 || (!NILP (w
->column_number_displayed
)
15915 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15916 /* This means that the window has a mode line. */
15917 && (WINDOW_WANTS_MODELINE_P (w
)
15918 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15920 display_mode_lines (w
);
15922 /* If mode line height has changed, arrange for a thorough
15923 immediate redisplay using the correct mode line height. */
15924 if (WINDOW_WANTS_MODELINE_P (w
)
15925 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15927 fonts_changed_p
= 1;
15928 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15929 = DESIRED_MODE_LINE_HEIGHT (w
);
15932 /* If header line height has changed, arrange for a thorough
15933 immediate redisplay using the correct header line height. */
15934 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15935 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15937 fonts_changed_p
= 1;
15938 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15939 = DESIRED_HEADER_LINE_HEIGHT (w
);
15942 if (fonts_changed_p
)
15943 goto need_larger_matrices
;
15946 if (!line_number_displayed
15947 && !BUFFERP (w
->base_line_pos
))
15949 w
->base_line_pos
= Qnil
;
15950 w
->base_line_number
= Qnil
;
15955 /* When we reach a frame's selected window, redo the frame's menu bar. */
15956 if (update_mode_line
15957 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15959 int redisplay_menu_p
= 0;
15961 if (FRAME_WINDOW_P (f
))
15963 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15964 || defined (HAVE_NS) || defined (USE_GTK)
15965 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15967 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15971 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15973 if (redisplay_menu_p
)
15974 display_menu_bar (w
);
15976 #ifdef HAVE_WINDOW_SYSTEM
15977 if (FRAME_WINDOW_P (f
))
15979 #if defined (USE_GTK) || defined (HAVE_NS)
15980 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15981 redisplay_tool_bar (f
);
15983 if (WINDOWP (f
->tool_bar_window
)
15984 && (FRAME_TOOL_BAR_LINES (f
) > 0
15985 || !NILP (Vauto_resize_tool_bars
))
15986 && redisplay_tool_bar (f
))
15987 ignore_mouse_drag_p
= 1;
15993 #ifdef HAVE_WINDOW_SYSTEM
15994 if (FRAME_WINDOW_P (f
)
15995 && update_window_fringes (w
, (just_this_one_p
15996 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15997 || w
->pseudo_window_p
)))
16001 if (draw_window_fringes (w
, 1))
16002 x_draw_vertical_border (w
);
16006 #endif /* HAVE_WINDOW_SYSTEM */
16008 /* We go to this label, with fonts_changed_p nonzero,
16009 if it is necessary to try again using larger glyph matrices.
16010 We have to redeem the scroll bar even in this case,
16011 because the loop in redisplay_internal expects that. */
16012 need_larger_matrices
:
16014 finish_scroll_bars
:
16016 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16018 /* Set the thumb's position and size. */
16019 set_vertical_scroll_bar (w
);
16021 /* Note that we actually used the scroll bar attached to this
16022 window, so it shouldn't be deleted at the end of redisplay. */
16023 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16024 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16027 /* Restore current_buffer and value of point in it. The window
16028 update may have changed the buffer, so first make sure `opoint'
16029 is still valid (Bug#6177). */
16030 if (CHARPOS (opoint
) < BEGV
)
16031 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16032 else if (CHARPOS (opoint
) > ZV
)
16033 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16035 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16037 set_buffer_internal_1 (old
);
16038 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16039 shorter. This can be caused by log truncation in *Messages*. */
16040 if (CHARPOS (lpoint
) <= ZV
)
16041 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16043 unbind_to (count
, Qnil
);
16047 /* Build the complete desired matrix of WINDOW with a window start
16048 buffer position POS.
16050 Value is 1 if successful. It is zero if fonts were loaded during
16051 redisplay which makes re-adjusting glyph matrices necessary, and -1
16052 if point would appear in the scroll margins.
16053 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16054 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16058 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16060 struct window
*w
= XWINDOW (window
);
16062 struct glyph_row
*last_text_row
= NULL
;
16063 struct frame
*f
= XFRAME (w
->frame
);
16065 /* Make POS the new window start. */
16066 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16068 /* Mark cursor position as unknown. No overlay arrow seen. */
16069 w
->cursor
.vpos
= -1;
16070 overlay_arrow_seen
= 0;
16072 /* Initialize iterator and info to start at POS. */
16073 start_display (&it
, w
, pos
);
16077 /* Display all lines of W. */
16078 while (it
.current_y
< it
.last_visible_y
)
16080 if (display_line (&it
))
16081 last_text_row
= it
.glyph_row
- 1;
16082 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16085 #ifdef HAVE_XWIDGETS_xxx
16086 //currently this is needed to detect xwidget movement reliably. or probably not.
16087 printf("try_window\n");
16091 /* Don't let the cursor end in the scroll margins. */
16092 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16093 && !MINI_WINDOW_P (w
))
16095 int this_scroll_margin
;
16097 if (scroll_margin
> 0)
16099 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16100 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16103 this_scroll_margin
= 0;
16105 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16106 && w
->cursor
.y
< this_scroll_margin
16107 && CHARPOS (pos
) > BEGV
16108 && IT_CHARPOS (it
) < ZV
)
16109 /* rms: considering make_cursor_line_fully_visible_p here
16110 seems to give wrong results. We don't want to recenter
16111 when the last line is partly visible, we want to allow
16112 that case to be handled in the usual way. */
16113 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16115 w
->cursor
.vpos
= -1;
16116 clear_glyph_matrix (w
->desired_matrix
);
16121 /* If bottom moved off end of frame, change mode line percentage. */
16122 if (XFASTINT (w
->window_end_pos
) <= 0
16123 && Z
!= IT_CHARPOS (it
))
16124 w
->update_mode_line
= Qt
;
16126 /* Set window_end_pos to the offset of the last character displayed
16127 on the window from the end of current_buffer. Set
16128 window_end_vpos to its row number. */
16131 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16132 w
->window_end_bytepos
16133 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16135 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16137 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16138 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16139 ->displays_text_p
);
16143 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16144 w
->window_end_pos
= make_number (Z
- ZV
);
16145 w
->window_end_vpos
= make_number (0);
16148 /* But that is not valid info until redisplay finishes. */
16149 w
->window_end_valid
= Qnil
;
16155 /************************************************************************
16156 Window redisplay reusing current matrix when buffer has not changed
16157 ************************************************************************/
16159 /* Try redisplay of window W showing an unchanged buffer with a
16160 different window start than the last time it was displayed by
16161 reusing its current matrix. Value is non-zero if successful.
16162 W->start is the new window start. */
16165 try_window_reusing_current_matrix (struct window
*w
)
16167 struct frame
*f
= XFRAME (w
->frame
);
16168 struct glyph_row
*bottom_row
;
16171 struct text_pos start
, new_start
;
16172 int nrows_scrolled
, i
;
16173 struct glyph_row
*last_text_row
;
16174 struct glyph_row
*last_reused_text_row
;
16175 struct glyph_row
*start_row
;
16176 int start_vpos
, min_y
, max_y
;
16179 if (inhibit_try_window_reusing
)
16183 #ifdef HAVE_XWIDGETS_xxx
16184 //currently this is needed to detect xwidget movement reliably. or probably not.
16185 printf("try_window_reusing_current_matrix\n");
16190 if (/* This function doesn't handle terminal frames. */
16191 !FRAME_WINDOW_P (f
)
16192 /* Don't try to reuse the display if windows have been split
16194 || windows_or_buffers_changed
16195 || cursor_type_changed
)
16198 /* Can't do this if region may have changed. */
16199 if ((!NILP (Vtransient_mark_mode
)
16200 && !NILP (BVAR (current_buffer
, mark_active
)))
16201 || !NILP (w
->region_showing
)
16202 || !NILP (Vshow_trailing_whitespace
))
16205 /* If top-line visibility has changed, give up. */
16206 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16207 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16210 /* Give up if old or new display is scrolled vertically. We could
16211 make this function handle this, but right now it doesn't. */
16212 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16213 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16216 /* The variable new_start now holds the new window start. The old
16217 start `start' can be determined from the current matrix. */
16218 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16219 start
= start_row
->minpos
;
16220 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16222 /* Clear the desired matrix for the display below. */
16223 clear_glyph_matrix (w
->desired_matrix
);
16225 if (CHARPOS (new_start
) <= CHARPOS (start
))
16227 /* Don't use this method if the display starts with an ellipsis
16228 displayed for invisible text. It's not easy to handle that case
16229 below, and it's certainly not worth the effort since this is
16230 not a frequent case. */
16231 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16234 IF_DEBUG (debug_method_add (w
, "twu1"));
16236 /* Display up to a row that can be reused. The variable
16237 last_text_row is set to the last row displayed that displays
16238 text. Note that it.vpos == 0 if or if not there is a
16239 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16240 start_display (&it
, w
, new_start
);
16241 w
->cursor
.vpos
= -1;
16242 last_text_row
= last_reused_text_row
= NULL
;
16244 while (it
.current_y
< it
.last_visible_y
16245 && !fonts_changed_p
)
16247 /* If we have reached into the characters in the START row,
16248 that means the line boundaries have changed. So we
16249 can't start copying with the row START. Maybe it will
16250 work to start copying with the following row. */
16251 while (IT_CHARPOS (it
) > CHARPOS (start
))
16253 /* Advance to the next row as the "start". */
16255 start
= start_row
->minpos
;
16256 /* If there are no more rows to try, or just one, give up. */
16257 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16258 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16259 || CHARPOS (start
) == ZV
)
16261 clear_glyph_matrix (w
->desired_matrix
);
16265 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16267 /* If we have reached alignment, we can copy the rest of the
16269 if (IT_CHARPOS (it
) == CHARPOS (start
)
16270 /* Don't accept "alignment" inside a display vector,
16271 since start_row could have started in the middle of
16272 that same display vector (thus their character
16273 positions match), and we have no way of telling if
16274 that is the case. */
16275 && it
.current
.dpvec_index
< 0)
16278 if (display_line (&it
))
16279 last_text_row
= it
.glyph_row
- 1;
16283 /* A value of current_y < last_visible_y means that we stopped
16284 at the previous window start, which in turn means that we
16285 have at least one reusable row. */
16286 if (it
.current_y
< it
.last_visible_y
)
16288 struct glyph_row
*row
;
16290 /* IT.vpos always starts from 0; it counts text lines. */
16291 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16293 /* Find PT if not already found in the lines displayed. */
16294 if (w
->cursor
.vpos
< 0)
16296 int dy
= it
.current_y
- start_row
->y
;
16298 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16299 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16301 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16302 dy
, nrows_scrolled
);
16305 clear_glyph_matrix (w
->desired_matrix
);
16310 /* Scroll the display. Do it before the current matrix is
16311 changed. The problem here is that update has not yet
16312 run, i.e. part of the current matrix is not up to date.
16313 scroll_run_hook will clear the cursor, and use the
16314 current matrix to get the height of the row the cursor is
16316 run
.current_y
= start_row
->y
;
16317 run
.desired_y
= it
.current_y
;
16318 run
.height
= it
.last_visible_y
- it
.current_y
;
16320 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16323 FRAME_RIF (f
)->update_window_begin_hook (w
);
16324 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16325 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16326 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16330 /* Shift current matrix down by nrows_scrolled lines. */
16331 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16332 rotate_matrix (w
->current_matrix
,
16334 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16337 /* Disable lines that must be updated. */
16338 for (i
= 0; i
< nrows_scrolled
; ++i
)
16339 (start_row
+ i
)->enabled_p
= 0;
16341 /* Re-compute Y positions. */
16342 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16343 max_y
= it
.last_visible_y
;
16344 for (row
= start_row
+ nrows_scrolled
;
16348 row
->y
= it
.current_y
;
16349 row
->visible_height
= row
->height
;
16351 if (row
->y
< min_y
)
16352 row
->visible_height
-= min_y
- row
->y
;
16353 if (row
->y
+ row
->height
> max_y
)
16354 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16355 if (row
->fringe_bitmap_periodic_p
)
16356 row
->redraw_fringe_bitmaps_p
= 1;
16358 it
.current_y
+= row
->height
;
16360 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16361 last_reused_text_row
= row
;
16362 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16366 /* Disable lines in the current matrix which are now
16367 below the window. */
16368 for (++row
; row
< bottom_row
; ++row
)
16369 row
->enabled_p
= row
->mode_line_p
= 0;
16372 /* Update window_end_pos etc.; last_reused_text_row is the last
16373 reused row from the current matrix containing text, if any.
16374 The value of last_text_row is the last displayed line
16375 containing text. */
16376 if (last_reused_text_row
)
16378 w
->window_end_bytepos
16379 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16381 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16383 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16384 w
->current_matrix
));
16386 else if (last_text_row
)
16388 w
->window_end_bytepos
16389 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16391 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16393 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16397 /* This window must be completely empty. */
16398 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16399 w
->window_end_pos
= make_number (Z
- ZV
);
16400 w
->window_end_vpos
= make_number (0);
16402 w
->window_end_valid
= Qnil
;
16404 /* Update hint: don't try scrolling again in update_window. */
16405 w
->desired_matrix
->no_scrolling_p
= 1;
16408 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16412 else if (CHARPOS (new_start
) > CHARPOS (start
))
16414 struct glyph_row
*pt_row
, *row
;
16415 struct glyph_row
*first_reusable_row
;
16416 struct glyph_row
*first_row_to_display
;
16418 int yb
= window_text_bottom_y (w
);
16420 /* Find the row starting at new_start, if there is one. Don't
16421 reuse a partially visible line at the end. */
16422 first_reusable_row
= start_row
;
16423 while (first_reusable_row
->enabled_p
16424 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16425 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16426 < CHARPOS (new_start
)))
16427 ++first_reusable_row
;
16429 /* Give up if there is no row to reuse. */
16430 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16431 || !first_reusable_row
->enabled_p
16432 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16433 != CHARPOS (new_start
)))
16436 /* We can reuse fully visible rows beginning with
16437 first_reusable_row to the end of the window. Set
16438 first_row_to_display to the first row that cannot be reused.
16439 Set pt_row to the row containing point, if there is any. */
16441 for (first_row_to_display
= first_reusable_row
;
16442 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16443 ++first_row_to_display
)
16445 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16446 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16447 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16448 && first_row_to_display
->ends_at_zv_p
16449 && pt_row
== NULL
)))
16450 pt_row
= first_row_to_display
;
16453 /* Start displaying at the start of first_row_to_display. */
16454 xassert (first_row_to_display
->y
< yb
);
16455 init_to_row_start (&it
, w
, first_row_to_display
);
16457 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16459 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16461 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16462 + WINDOW_HEADER_LINE_HEIGHT (w
));
16464 /* Display lines beginning with first_row_to_display in the
16465 desired matrix. Set last_text_row to the last row displayed
16466 that displays text. */
16467 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16468 if (pt_row
== NULL
)
16469 w
->cursor
.vpos
= -1;
16470 last_text_row
= NULL
;
16471 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16472 if (display_line (&it
))
16473 last_text_row
= it
.glyph_row
- 1;
16475 /* If point is in a reused row, adjust y and vpos of the cursor
16479 w
->cursor
.vpos
-= nrows_scrolled
;
16480 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16483 /* Give up if point isn't in a row displayed or reused. (This
16484 also handles the case where w->cursor.vpos < nrows_scrolled
16485 after the calls to display_line, which can happen with scroll
16486 margins. See bug#1295.) */
16487 if (w
->cursor
.vpos
< 0)
16489 clear_glyph_matrix (w
->desired_matrix
);
16493 /* Scroll the display. */
16494 run
.current_y
= first_reusable_row
->y
;
16495 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16496 run
.height
= it
.last_visible_y
- run
.current_y
;
16497 dy
= run
.current_y
- run
.desired_y
;
16502 FRAME_RIF (f
)->update_window_begin_hook (w
);
16503 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16504 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16505 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16509 /* Adjust Y positions of reused rows. */
16510 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16511 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16512 max_y
= it
.last_visible_y
;
16513 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16516 row
->visible_height
= row
->height
;
16517 if (row
->y
< min_y
)
16518 row
->visible_height
-= min_y
- row
->y
;
16519 if (row
->y
+ row
->height
> max_y
)
16520 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16521 if (row
->fringe_bitmap_periodic_p
)
16522 row
->redraw_fringe_bitmaps_p
= 1;
16525 /* Scroll the current matrix. */
16526 xassert (nrows_scrolled
> 0);
16527 rotate_matrix (w
->current_matrix
,
16529 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16532 /* Disable rows not reused. */
16533 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16534 row
->enabled_p
= 0;
16536 /* Point may have moved to a different line, so we cannot assume that
16537 the previous cursor position is valid; locate the correct row. */
16540 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16542 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16543 && !row
->ends_at_zv_p
;
16547 w
->cursor
.y
= row
->y
;
16549 if (row
< bottom_row
)
16551 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16552 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16554 /* Can't use this optimization with bidi-reordered glyph
16555 rows, unless cursor is already at point. */
16556 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16558 if (!(w
->cursor
.hpos
>= 0
16559 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16560 && BUFFERP (glyph
->object
)
16561 && glyph
->charpos
== PT
))
16566 && (!BUFFERP (glyph
->object
)
16567 || glyph
->charpos
< PT
);
16571 w
->cursor
.x
+= glyph
->pixel_width
;
16576 /* Adjust window end. A null value of last_text_row means that
16577 the window end is in reused rows which in turn means that
16578 only its vpos can have changed. */
16581 w
->window_end_bytepos
16582 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16584 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16586 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16591 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16594 w
->window_end_valid
= Qnil
;
16595 w
->desired_matrix
->no_scrolling_p
= 1;
16598 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16608 /************************************************************************
16609 Window redisplay reusing current matrix when buffer has changed
16610 ************************************************************************/
16612 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16613 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16614 EMACS_INT
*, EMACS_INT
*);
16615 static struct glyph_row
*
16616 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16617 struct glyph_row
*);
16620 /* Return the last row in MATRIX displaying text. If row START is
16621 non-null, start searching with that row. IT gives the dimensions
16622 of the display. Value is null if matrix is empty; otherwise it is
16623 a pointer to the row found. */
16625 static struct glyph_row
*
16626 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16627 struct glyph_row
*start
)
16629 struct glyph_row
*row
, *row_found
;
16631 /* Set row_found to the last row in IT->w's current matrix
16632 displaying text. The loop looks funny but think of partially
16635 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16636 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16638 xassert (row
->enabled_p
);
16640 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16649 /* Return the last row in the current matrix of W that is not affected
16650 by changes at the start of current_buffer that occurred since W's
16651 current matrix was built. Value is null if no such row exists.
16653 BEG_UNCHANGED us the number of characters unchanged at the start of
16654 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16655 first changed character in current_buffer. Characters at positions <
16656 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16657 when the current matrix was built. */
16659 static struct glyph_row
*
16660 find_last_unchanged_at_beg_row (struct window
*w
)
16662 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16663 struct glyph_row
*row
;
16664 struct glyph_row
*row_found
= NULL
;
16665 int yb
= window_text_bottom_y (w
);
16667 /* Find the last row displaying unchanged text. */
16668 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16669 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16670 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16673 if (/* If row ends before first_changed_pos, it is unchanged,
16674 except in some case. */
16675 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16676 /* When row ends in ZV and we write at ZV it is not
16678 && !row
->ends_at_zv_p
16679 /* When first_changed_pos is the end of a continued line,
16680 row is not unchanged because it may be no longer
16682 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16683 && (row
->continued_p
16684 || row
->exact_window_width_line_p
)))
16687 /* Stop if last visible row. */
16688 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16696 /* Find the first glyph row in the current matrix of W that is not
16697 affected by changes at the end of current_buffer since the
16698 time W's current matrix was built.
16700 Return in *DELTA the number of chars by which buffer positions in
16701 unchanged text at the end of current_buffer must be adjusted.
16703 Return in *DELTA_BYTES the corresponding number of bytes.
16705 Value is null if no such row exists, i.e. all rows are affected by
16708 static struct glyph_row
*
16709 find_first_unchanged_at_end_row (struct window
*w
,
16710 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16712 struct glyph_row
*row
;
16713 struct glyph_row
*row_found
= NULL
;
16715 *delta
= *delta_bytes
= 0;
16717 /* Display must not have been paused, otherwise the current matrix
16718 is not up to date. */
16719 eassert (!NILP (w
->window_end_valid
));
16721 /* A value of window_end_pos >= END_UNCHANGED means that the window
16722 end is in the range of changed text. If so, there is no
16723 unchanged row at the end of W's current matrix. */
16724 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16727 /* Set row to the last row in W's current matrix displaying text. */
16728 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16730 /* If matrix is entirely empty, no unchanged row exists. */
16731 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16733 /* The value of row is the last glyph row in the matrix having a
16734 meaningful buffer position in it. The end position of row
16735 corresponds to window_end_pos. This allows us to translate
16736 buffer positions in the current matrix to current buffer
16737 positions for characters not in changed text. */
16739 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16740 EMACS_INT Z_BYTE_old
=
16741 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16742 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16743 struct glyph_row
*first_text_row
16744 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16746 *delta
= Z
- Z_old
;
16747 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16749 /* Set last_unchanged_pos to the buffer position of the last
16750 character in the buffer that has not been changed. Z is the
16751 index + 1 of the last character in current_buffer, i.e. by
16752 subtracting END_UNCHANGED we get the index of the last
16753 unchanged character, and we have to add BEG to get its buffer
16755 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16756 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16758 /* Search backward from ROW for a row displaying a line that
16759 starts at a minimum position >= last_unchanged_pos_old. */
16760 for (; row
> first_text_row
; --row
)
16762 /* This used to abort, but it can happen.
16763 It is ok to just stop the search instead here. KFS. */
16764 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16767 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16772 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16778 /* Make sure that glyph rows in the current matrix of window W
16779 reference the same glyph memory as corresponding rows in the
16780 frame's frame matrix. This function is called after scrolling W's
16781 current matrix on a terminal frame in try_window_id and
16782 try_window_reusing_current_matrix. */
16785 sync_frame_with_window_matrix_rows (struct window
*w
)
16787 struct frame
*f
= XFRAME (w
->frame
);
16788 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16790 /* Preconditions: W must be a leaf window and full-width. Its frame
16791 must have a frame matrix. */
16792 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16793 xassert (WINDOW_FULL_WIDTH_P (w
));
16794 xassert (!FRAME_WINDOW_P (f
));
16796 /* If W is a full-width window, glyph pointers in W's current matrix
16797 have, by definition, to be the same as glyph pointers in the
16798 corresponding frame matrix. Note that frame matrices have no
16799 marginal areas (see build_frame_matrix). */
16800 window_row
= w
->current_matrix
->rows
;
16801 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16802 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16803 while (window_row
< window_row_end
)
16805 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16806 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16808 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16809 frame_row
->glyphs
[TEXT_AREA
] = start
;
16810 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16811 frame_row
->glyphs
[LAST_AREA
] = end
;
16813 /* Disable frame rows whose corresponding window rows have
16814 been disabled in try_window_id. */
16815 if (!window_row
->enabled_p
)
16816 frame_row
->enabled_p
= 0;
16818 ++window_row
, ++frame_row
;
16823 /* Find the glyph row in window W containing CHARPOS. Consider all
16824 rows between START and END (not inclusive). END null means search
16825 all rows to the end of the display area of W. Value is the row
16826 containing CHARPOS or null. */
16829 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16830 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16832 struct glyph_row
*row
= start
;
16833 struct glyph_row
*best_row
= NULL
;
16834 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16837 /* If we happen to start on a header-line, skip that. */
16838 if (row
->mode_line_p
)
16841 if ((end
&& row
>= end
) || !row
->enabled_p
)
16844 last_y
= window_text_bottom_y (w
) - dy
;
16848 /* Give up if we have gone too far. */
16849 if (end
&& row
>= end
)
16851 /* This formerly returned if they were equal.
16852 I think that both quantities are of a "last plus one" type;
16853 if so, when they are equal, the row is within the screen. -- rms. */
16854 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16857 /* If it is in this row, return this row. */
16858 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16859 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16860 /* The end position of a row equals the start
16861 position of the next row. If CHARPOS is there, we
16862 would rather display it in the next line, except
16863 when this line ends in ZV. */
16864 && !row
->ends_at_zv_p
16865 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16866 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16870 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16871 || (!best_row
&& !row
->continued_p
))
16873 /* In bidi-reordered rows, there could be several rows
16874 occluding point, all of them belonging to the same
16875 continued line. We need to find the row which fits
16876 CHARPOS the best. */
16877 for (g
= row
->glyphs
[TEXT_AREA
];
16878 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16881 if (!STRINGP (g
->object
))
16883 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16885 mindif
= eabs (g
->charpos
- charpos
);
16887 /* Exact match always wins. */
16894 else if (best_row
&& !row
->continued_p
)
16901 /* Try to redisplay window W by reusing its existing display. W's
16902 current matrix must be up to date when this function is called,
16903 i.e. window_end_valid must not be nil.
16907 1 if display has been updated
16908 0 if otherwise unsuccessful
16909 -1 if redisplay with same window start is known not to succeed
16911 The following steps are performed:
16913 1. Find the last row in the current matrix of W that is not
16914 affected by changes at the start of current_buffer. If no such row
16917 2. Find the first row in W's current matrix that is not affected by
16918 changes at the end of current_buffer. Maybe there is no such row.
16920 3. Display lines beginning with the row + 1 found in step 1 to the
16921 row found in step 2 or, if step 2 didn't find a row, to the end of
16924 4. If cursor is not known to appear on the window, give up.
16926 5. If display stopped at the row found in step 2, scroll the
16927 display and current matrix as needed.
16929 6. Maybe display some lines at the end of W, if we must. This can
16930 happen under various circumstances, like a partially visible line
16931 becoming fully visible, or because newly displayed lines are displayed
16932 in smaller font sizes.
16934 7. Update W's window end information. */
16937 try_window_id (struct window
*w
)
16939 struct frame
*f
= XFRAME (w
->frame
);
16940 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16941 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16942 struct glyph_row
*last_unchanged_at_beg_row
;
16943 struct glyph_row
*first_unchanged_at_end_row
;
16944 struct glyph_row
*row
;
16945 struct glyph_row
*bottom_row
;
16948 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16950 struct text_pos start_pos
;
16952 int first_unchanged_at_end_vpos
= 0;
16953 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16954 struct text_pos start
;
16955 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16958 if (inhibit_try_window_id
)
16962 #ifdef HAVE_XWIDGETS_xxx
16963 //maybe needed for proper xwidget movement
16964 printf("try_window_id\n");
16969 /* This is handy for debugging. */
16971 #define GIVE_UP(X) \
16973 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16977 #define GIVE_UP(X) return 0
16980 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16982 /* Don't use this for mini-windows because these can show
16983 messages and mini-buffers, and we don't handle that here. */
16984 if (MINI_WINDOW_P (w
))
16987 /* This flag is used to prevent redisplay optimizations. */
16988 if (windows_or_buffers_changed
|| cursor_type_changed
)
16991 /* Verify that narrowing has not changed.
16992 Also verify that we were not told to prevent redisplay optimizations.
16993 It would be nice to further
16994 reduce the number of cases where this prevents try_window_id. */
16995 if (current_buffer
->clip_changed
16996 || current_buffer
->prevent_redisplay_optimizations_p
)
16999 /* Window must either use window-based redisplay or be full width. */
17000 if (!FRAME_WINDOW_P (f
)
17001 && (!FRAME_LINE_INS_DEL_OK (f
)
17002 || !WINDOW_FULL_WIDTH_P (w
)))
17005 /* Give up if point is known NOT to appear in W. */
17006 if (PT
< CHARPOS (start
))
17009 /* Another way to prevent redisplay optimizations. */
17010 if (XFASTINT (w
->last_modified
) == 0)
17013 /* Verify that window is not hscrolled. */
17014 if (XFASTINT (w
->hscroll
) != 0)
17017 /* Verify that display wasn't paused. */
17018 if (NILP (w
->window_end_valid
))
17021 /* Can't use this if highlighting a region because a cursor movement
17022 will do more than just set the cursor. */
17023 if (!NILP (Vtransient_mark_mode
)
17024 && !NILP (BVAR (current_buffer
, mark_active
)))
17027 /* Likewise if highlighting trailing whitespace. */
17028 if (!NILP (Vshow_trailing_whitespace
))
17031 /* Likewise if showing a region. */
17032 if (!NILP (w
->region_showing
))
17035 /* Can't use this if overlay arrow position and/or string have
17037 if (overlay_arrows_changed_p ())
17040 /* When word-wrap is on, adding a space to the first word of a
17041 wrapped line can change the wrap position, altering the line
17042 above it. It might be worthwhile to handle this more
17043 intelligently, but for now just redisplay from scratch. */
17044 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17047 /* Under bidi reordering, adding or deleting a character in the
17048 beginning of a paragraph, before the first strong directional
17049 character, can change the base direction of the paragraph (unless
17050 the buffer specifies a fixed paragraph direction), which will
17051 require to redisplay the whole paragraph. It might be worthwhile
17052 to find the paragraph limits and widen the range of redisplayed
17053 lines to that, but for now just give up this optimization and
17054 redisplay from scratch. */
17055 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17056 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17059 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17060 only if buffer has really changed. The reason is that the gap is
17061 initially at Z for freshly visited files. The code below would
17062 set end_unchanged to 0 in that case. */
17063 if (MODIFF
> SAVE_MODIFF
17064 /* This seems to happen sometimes after saving a buffer. */
17065 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17067 if (GPT
- BEG
< BEG_UNCHANGED
)
17068 BEG_UNCHANGED
= GPT
- BEG
;
17069 if (Z
- GPT
< END_UNCHANGED
)
17070 END_UNCHANGED
= Z
- GPT
;
17073 /* The position of the first and last character that has been changed. */
17074 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17075 last_changed_charpos
= Z
- END_UNCHANGED
;
17077 /* If window starts after a line end, and the last change is in
17078 front of that newline, then changes don't affect the display.
17079 This case happens with stealth-fontification. Note that although
17080 the display is unchanged, glyph positions in the matrix have to
17081 be adjusted, of course. */
17082 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17083 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17084 && ((last_changed_charpos
< CHARPOS (start
)
17085 && CHARPOS (start
) == BEGV
)
17086 || (last_changed_charpos
< CHARPOS (start
) - 1
17087 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17089 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17090 struct glyph_row
*r0
;
17092 /* Compute how many chars/bytes have been added to or removed
17093 from the buffer. */
17094 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17095 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17096 Z_delta
= Z
- Z_old
;
17097 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17099 /* Give up if PT is not in the window. Note that it already has
17100 been checked at the start of try_window_id that PT is not in
17101 front of the window start. */
17102 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17105 /* If window start is unchanged, we can reuse the whole matrix
17106 as is, after adjusting glyph positions. No need to compute
17107 the window end again, since its offset from Z hasn't changed. */
17108 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17109 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17110 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17111 /* PT must not be in a partially visible line. */
17112 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17113 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17115 /* Adjust positions in the glyph matrix. */
17116 if (Z_delta
|| Z_delta_bytes
)
17118 struct glyph_row
*r1
17119 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17120 increment_matrix_positions (w
->current_matrix
,
17121 MATRIX_ROW_VPOS (r0
, current_matrix
),
17122 MATRIX_ROW_VPOS (r1
, current_matrix
),
17123 Z_delta
, Z_delta_bytes
);
17126 /* Set the cursor. */
17127 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17129 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17136 /* Handle the case that changes are all below what is displayed in
17137 the window, and that PT is in the window. This shortcut cannot
17138 be taken if ZV is visible in the window, and text has been added
17139 there that is visible in the window. */
17140 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17141 /* ZV is not visible in the window, or there are no
17142 changes at ZV, actually. */
17143 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17144 || first_changed_charpos
== last_changed_charpos
))
17146 struct glyph_row
*r0
;
17148 /* Give up if PT is not in the window. Note that it already has
17149 been checked at the start of try_window_id that PT is not in
17150 front of the window start. */
17151 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17154 /* If window start is unchanged, we can reuse the whole matrix
17155 as is, without changing glyph positions since no text has
17156 been added/removed in front of the window end. */
17157 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17158 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17159 /* PT must not be in a partially visible line. */
17160 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17161 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17163 /* We have to compute the window end anew since text
17164 could have been added/removed after it. */
17166 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17167 w
->window_end_bytepos
17168 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17170 /* Set the cursor. */
17171 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17173 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17180 /* Give up if window start is in the changed area.
17182 The condition used to read
17184 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17186 but why that was tested escapes me at the moment. */
17187 if (CHARPOS (start
) >= first_changed_charpos
17188 && CHARPOS (start
) <= last_changed_charpos
)
17191 /* Check that window start agrees with the start of the first glyph
17192 row in its current matrix. Check this after we know the window
17193 start is not in changed text, otherwise positions would not be
17195 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17196 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17199 /* Give up if the window ends in strings. Overlay strings
17200 at the end are difficult to handle, so don't try. */
17201 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17202 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17205 /* Compute the position at which we have to start displaying new
17206 lines. Some of the lines at the top of the window might be
17207 reusable because they are not displaying changed text. Find the
17208 last row in W's current matrix not affected by changes at the
17209 start of current_buffer. Value is null if changes start in the
17210 first line of window. */
17211 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17212 if (last_unchanged_at_beg_row
)
17214 /* Avoid starting to display in the middle of a character, a TAB
17215 for instance. This is easier than to set up the iterator
17216 exactly, and it's not a frequent case, so the additional
17217 effort wouldn't really pay off. */
17218 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17219 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17220 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17221 --last_unchanged_at_beg_row
;
17223 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17226 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17228 start_pos
= it
.current
.pos
;
17230 /* Start displaying new lines in the desired matrix at the same
17231 vpos we would use in the current matrix, i.e. below
17232 last_unchanged_at_beg_row. */
17233 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17235 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17236 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17238 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17242 /* There are no reusable lines at the start of the window.
17243 Start displaying in the first text line. */
17244 start_display (&it
, w
, start
);
17245 it
.vpos
= it
.first_vpos
;
17246 start_pos
= it
.current
.pos
;
17249 /* Find the first row that is not affected by changes at the end of
17250 the buffer. Value will be null if there is no unchanged row, in
17251 which case we must redisplay to the end of the window. delta
17252 will be set to the value by which buffer positions beginning with
17253 first_unchanged_at_end_row have to be adjusted due to text
17255 first_unchanged_at_end_row
17256 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17257 IF_DEBUG (debug_delta
= delta
);
17258 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17260 /* Set stop_pos to the buffer position up to which we will have to
17261 display new lines. If first_unchanged_at_end_row != NULL, this
17262 is the buffer position of the start of the line displayed in that
17263 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17264 that we don't stop at a buffer position. */
17266 if (first_unchanged_at_end_row
)
17268 xassert (last_unchanged_at_beg_row
== NULL
17269 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17271 /* If this is a continuation line, move forward to the next one
17272 that isn't. Changes in lines above affect this line.
17273 Caution: this may move first_unchanged_at_end_row to a row
17274 not displaying text. */
17275 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17276 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17277 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17278 < it
.last_visible_y
))
17279 ++first_unchanged_at_end_row
;
17281 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17282 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17283 >= it
.last_visible_y
))
17284 first_unchanged_at_end_row
= NULL
;
17287 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17289 first_unchanged_at_end_vpos
17290 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17291 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17294 else if (last_unchanged_at_beg_row
== NULL
)
17300 /* Either there is no unchanged row at the end, or the one we have
17301 now displays text. This is a necessary condition for the window
17302 end pos calculation at the end of this function. */
17303 xassert (first_unchanged_at_end_row
== NULL
17304 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17306 debug_last_unchanged_at_beg_vpos
17307 = (last_unchanged_at_beg_row
17308 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17310 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17312 #endif /* GLYPH_DEBUG != 0 */
17315 /* Display new lines. Set last_text_row to the last new line
17316 displayed which has text on it, i.e. might end up as being the
17317 line where the window_end_vpos is. */
17318 w
->cursor
.vpos
= -1;
17319 last_text_row
= NULL
;
17320 overlay_arrow_seen
= 0;
17321 while (it
.current_y
< it
.last_visible_y
17322 && !fonts_changed_p
17323 && (first_unchanged_at_end_row
== NULL
17324 || IT_CHARPOS (it
) < stop_pos
))
17326 if (display_line (&it
))
17327 last_text_row
= it
.glyph_row
- 1;
17330 if (fonts_changed_p
)
17334 /* Compute differences in buffer positions, y-positions etc. for
17335 lines reused at the bottom of the window. Compute what we can
17337 if (first_unchanged_at_end_row
17338 /* No lines reused because we displayed everything up to the
17339 bottom of the window. */
17340 && it
.current_y
< it
.last_visible_y
)
17343 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17345 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17346 run
.current_y
= first_unchanged_at_end_row
->y
;
17347 run
.desired_y
= run
.current_y
+ dy
;
17348 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17352 delta
= delta_bytes
= dvpos
= dy
17353 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17354 first_unchanged_at_end_row
= NULL
;
17356 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17359 /* Find the cursor if not already found. We have to decide whether
17360 PT will appear on this window (it sometimes doesn't, but this is
17361 not a very frequent case.) This decision has to be made before
17362 the current matrix is altered. A value of cursor.vpos < 0 means
17363 that PT is either in one of the lines beginning at
17364 first_unchanged_at_end_row or below the window. Don't care for
17365 lines that might be displayed later at the window end; as
17366 mentioned, this is not a frequent case. */
17367 if (w
->cursor
.vpos
< 0)
17369 /* Cursor in unchanged rows at the top? */
17370 if (PT
< CHARPOS (start_pos
)
17371 && last_unchanged_at_beg_row
)
17373 row
= row_containing_pos (w
, PT
,
17374 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17375 last_unchanged_at_beg_row
+ 1, 0);
17377 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17380 /* Start from first_unchanged_at_end_row looking for PT. */
17381 else if (first_unchanged_at_end_row
)
17383 row
= row_containing_pos (w
, PT
- delta
,
17384 first_unchanged_at_end_row
, NULL
, 0);
17386 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17387 delta_bytes
, dy
, dvpos
);
17390 /* Give up if cursor was not found. */
17391 if (w
->cursor
.vpos
< 0)
17393 clear_glyph_matrix (w
->desired_matrix
);
17398 /* Don't let the cursor end in the scroll margins. */
17400 int this_scroll_margin
, cursor_height
;
17402 this_scroll_margin
=
17403 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17404 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17405 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17407 if ((w
->cursor
.y
< this_scroll_margin
17408 && CHARPOS (start
) > BEGV
)
17409 /* Old redisplay didn't take scroll margin into account at the bottom,
17410 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17411 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17412 ? cursor_height
+ this_scroll_margin
17413 : 1)) > it
.last_visible_y
)
17415 w
->cursor
.vpos
= -1;
17416 clear_glyph_matrix (w
->desired_matrix
);
17421 /* Scroll the display. Do it before changing the current matrix so
17422 that xterm.c doesn't get confused about where the cursor glyph is
17424 if (dy
&& run
.height
)
17428 if (FRAME_WINDOW_P (f
))
17430 FRAME_RIF (f
)->update_window_begin_hook (w
);
17431 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17432 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17433 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17437 /* Terminal frame. In this case, dvpos gives the number of
17438 lines to scroll by; dvpos < 0 means scroll up. */
17440 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17441 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17442 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17443 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17444 + window_internal_height (w
));
17446 #if defined (HAVE_GPM) || defined (MSDOS)
17447 x_clear_window_mouse_face (w
);
17449 /* Perform the operation on the screen. */
17452 /* Scroll last_unchanged_at_beg_row to the end of the
17453 window down dvpos lines. */
17454 set_terminal_window (f
, end
);
17456 /* On dumb terminals delete dvpos lines at the end
17457 before inserting dvpos empty lines. */
17458 if (!FRAME_SCROLL_REGION_OK (f
))
17459 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17461 /* Insert dvpos empty lines in front of
17462 last_unchanged_at_beg_row. */
17463 ins_del_lines (f
, from
, dvpos
);
17465 else if (dvpos
< 0)
17467 /* Scroll up last_unchanged_at_beg_vpos to the end of
17468 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17469 set_terminal_window (f
, end
);
17471 /* Delete dvpos lines in front of
17472 last_unchanged_at_beg_vpos. ins_del_lines will set
17473 the cursor to the given vpos and emit |dvpos| delete
17475 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17477 /* On a dumb terminal insert dvpos empty lines at the
17479 if (!FRAME_SCROLL_REGION_OK (f
))
17480 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17483 set_terminal_window (f
, 0);
17489 /* Shift reused rows of the current matrix to the right position.
17490 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17492 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17493 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17496 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17497 bottom_vpos
, dvpos
);
17498 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17501 else if (dvpos
> 0)
17503 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17504 bottom_vpos
, dvpos
);
17505 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17506 first_unchanged_at_end_vpos
+ dvpos
, 0);
17509 /* For frame-based redisplay, make sure that current frame and window
17510 matrix are in sync with respect to glyph memory. */
17511 if (!FRAME_WINDOW_P (f
))
17512 sync_frame_with_window_matrix_rows (w
);
17514 /* Adjust buffer positions in reused rows. */
17515 if (delta
|| delta_bytes
)
17516 increment_matrix_positions (current_matrix
,
17517 first_unchanged_at_end_vpos
+ dvpos
,
17518 bottom_vpos
, delta
, delta_bytes
);
17520 /* Adjust Y positions. */
17522 shift_glyph_matrix (w
, current_matrix
,
17523 first_unchanged_at_end_vpos
+ dvpos
,
17526 if (first_unchanged_at_end_row
)
17528 first_unchanged_at_end_row
+= dvpos
;
17529 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17530 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17531 first_unchanged_at_end_row
= NULL
;
17534 /* If scrolling up, there may be some lines to display at the end of
17536 last_text_row_at_end
= NULL
;
17539 /* Scrolling up can leave for example a partially visible line
17540 at the end of the window to be redisplayed. */
17541 /* Set last_row to the glyph row in the current matrix where the
17542 window end line is found. It has been moved up or down in
17543 the matrix by dvpos. */
17544 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17545 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17547 /* If last_row is the window end line, it should display text. */
17548 xassert (last_row
->displays_text_p
);
17550 /* If window end line was partially visible before, begin
17551 displaying at that line. Otherwise begin displaying with the
17552 line following it. */
17553 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17555 init_to_row_start (&it
, w
, last_row
);
17556 it
.vpos
= last_vpos
;
17557 it
.current_y
= last_row
->y
;
17561 init_to_row_end (&it
, w
, last_row
);
17562 it
.vpos
= 1 + last_vpos
;
17563 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17567 /* We may start in a continuation line. If so, we have to
17568 get the right continuation_lines_width and current_x. */
17569 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17570 it
.hpos
= it
.current_x
= 0;
17572 /* Display the rest of the lines at the window end. */
17573 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17574 while (it
.current_y
< it
.last_visible_y
17575 && !fonts_changed_p
)
17577 /* Is it always sure that the display agrees with lines in
17578 the current matrix? I don't think so, so we mark rows
17579 displayed invalid in the current matrix by setting their
17580 enabled_p flag to zero. */
17581 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17582 if (display_line (&it
))
17583 last_text_row_at_end
= it
.glyph_row
- 1;
17587 /* Update window_end_pos and window_end_vpos. */
17588 if (first_unchanged_at_end_row
17589 && !last_text_row_at_end
)
17591 /* Window end line if one of the preserved rows from the current
17592 matrix. Set row to the last row displaying text in current
17593 matrix starting at first_unchanged_at_end_row, after
17595 xassert (first_unchanged_at_end_row
->displays_text_p
);
17596 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17597 first_unchanged_at_end_row
);
17598 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17600 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17601 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17603 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17604 xassert (w
->window_end_bytepos
>= 0);
17605 IF_DEBUG (debug_method_add (w
, "A"));
17607 else if (last_text_row_at_end
)
17610 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17611 w
->window_end_bytepos
17612 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17614 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17615 xassert (w
->window_end_bytepos
>= 0);
17616 IF_DEBUG (debug_method_add (w
, "B"));
17618 else if (last_text_row
)
17620 /* We have displayed either to the end of the window or at the
17621 end of the window, i.e. the last row with text is to be found
17622 in the desired matrix. */
17624 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17625 w
->window_end_bytepos
17626 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17628 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17629 xassert (w
->window_end_bytepos
>= 0);
17631 else if (first_unchanged_at_end_row
== NULL
17632 && last_text_row
== NULL
17633 && last_text_row_at_end
== NULL
)
17635 /* Displayed to end of window, but no line containing text was
17636 displayed. Lines were deleted at the end of the window. */
17637 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17638 int vpos
= XFASTINT (w
->window_end_vpos
);
17639 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17640 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17643 row
== NULL
&& vpos
>= first_vpos
;
17644 --vpos
, --current_row
, --desired_row
)
17646 if (desired_row
->enabled_p
)
17648 if (desired_row
->displays_text_p
)
17651 else if (current_row
->displays_text_p
)
17655 xassert (row
!= NULL
);
17656 w
->window_end_vpos
= make_number (vpos
+ 1);
17657 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17658 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17659 xassert (w
->window_end_bytepos
>= 0);
17660 IF_DEBUG (debug_method_add (w
, "C"));
17665 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17666 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17668 /* Record that display has not been completed. */
17669 w
->window_end_valid
= Qnil
;
17670 w
->desired_matrix
->no_scrolling_p
= 1;
17678 /***********************************************************************
17679 More debugging support
17680 ***********************************************************************/
17684 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17685 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17686 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17689 /* Dump the contents of glyph matrix MATRIX on stderr.
17691 GLYPHS 0 means don't show glyph contents.
17692 GLYPHS 1 means show glyphs in short form
17693 GLYPHS > 1 means show glyphs in long form. */
17696 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17699 for (i
= 0; i
< matrix
->nrows
; ++i
)
17700 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17704 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17705 the glyph row and area where the glyph comes from. */
17708 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17710 if (glyph
->type
== CHAR_GLYPH
)
17713 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17714 glyph
- row
->glyphs
[TEXT_AREA
],
17717 (BUFFERP (glyph
->object
)
17719 : (STRINGP (glyph
->object
)
17722 glyph
->pixel_width
,
17724 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17728 glyph
->left_box_line_p
,
17729 glyph
->right_box_line_p
);
17731 else if (glyph
->type
== STRETCH_GLYPH
)
17734 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17735 glyph
- row
->glyphs
[TEXT_AREA
],
17738 (BUFFERP (glyph
->object
)
17740 : (STRINGP (glyph
->object
)
17743 glyph
->pixel_width
,
17747 glyph
->left_box_line_p
,
17748 glyph
->right_box_line_p
);
17750 else if (glyph
->type
== IMAGE_GLYPH
)
17753 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17754 glyph
- row
->glyphs
[TEXT_AREA
],
17757 (BUFFERP (glyph
->object
)
17759 : (STRINGP (glyph
->object
)
17762 glyph
->pixel_width
,
17766 glyph
->left_box_line_p
,
17767 glyph
->right_box_line_p
);
17769 else if (glyph
->type
== COMPOSITE_GLYPH
)
17772 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17773 glyph
- row
->glyphs
[TEXT_AREA
],
17776 (BUFFERP (glyph
->object
)
17778 : (STRINGP (glyph
->object
)
17781 glyph
->pixel_width
,
17783 if (glyph
->u
.cmp
.automatic
)
17786 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17787 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17789 glyph
->left_box_line_p
,
17790 glyph
->right_box_line_p
);
17792 #ifdef HAVE_XWIDGETS
17793 else if (glyph
->type
== XWIDGET_GLYPH
)
17796 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17797 glyph
- row
->glyphs
[TEXT_AREA
],
17800 (BUFFERP (glyph
->object
)
17802 : (STRINGP (glyph
->object
)
17805 glyph
->pixel_width
,
17809 glyph
->left_box_line_p
,
17810 glyph
->right_box_line_p
);
17812 // printf("dump xwidget glyph\n");
17818 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17819 GLYPHS 0 means don't show glyph contents.
17820 GLYPHS 1 means show glyphs in short form
17821 GLYPHS > 1 means show glyphs in long form. */
17824 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17828 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17829 fprintf (stderr
, "======================================================================\n");
17831 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17832 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17834 MATRIX_ROW_START_CHARPOS (row
),
17835 MATRIX_ROW_END_CHARPOS (row
),
17836 row
->used
[TEXT_AREA
],
17837 row
->contains_overlapping_glyphs_p
,
17839 row
->truncated_on_left_p
,
17840 row
->truncated_on_right_p
,
17842 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17843 row
->displays_text_p
,
17846 row
->ends_in_middle_of_char_p
,
17847 row
->starts_in_middle_of_char_p
,
17853 row
->visible_height
,
17856 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17857 row
->end
.overlay_string_index
,
17858 row
->continuation_lines_width
);
17859 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17860 CHARPOS (row
->start
.string_pos
),
17861 CHARPOS (row
->end
.string_pos
));
17862 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17863 row
->end
.dpvec_index
);
17870 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17872 struct glyph
*glyph
= row
->glyphs
[area
];
17873 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17875 /* Glyph for a line end in text. */
17876 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17879 if (glyph
< glyph_end
)
17880 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17882 for (; glyph
< glyph_end
; ++glyph
)
17883 dump_glyph (row
, glyph
, area
);
17886 else if (glyphs
== 1)
17890 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17892 char *s
= (char *) alloca (row
->used
[area
] + 1);
17895 for (i
= 0; i
< row
->used
[area
]; ++i
)
17897 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17898 if (glyph
->type
== CHAR_GLYPH
17899 && glyph
->u
.ch
< 0x80
17900 && glyph
->u
.ch
>= ' ')
17901 s
[i
] = glyph
->u
.ch
;
17907 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17913 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17914 Sdump_glyph_matrix
, 0, 1, "p",
17915 doc
: /* Dump the current matrix of the selected window to stderr.
17916 Shows contents of glyph row structures. With non-nil
17917 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17918 glyphs in short form, otherwise show glyphs in long form. */)
17919 (Lisp_Object glyphs
)
17921 struct window
*w
= XWINDOW (selected_window
);
17922 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17924 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17925 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17926 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17927 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17928 fprintf (stderr
, "=============================================\n");
17929 dump_glyph_matrix (w
->current_matrix
,
17930 NILP (glyphs
) ? 0 : XINT (glyphs
));
17935 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17936 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17939 struct frame
*f
= XFRAME (selected_frame
);
17940 dump_glyph_matrix (f
->current_matrix
, 1);
17945 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17946 doc
: /* Dump glyph row ROW to stderr.
17947 GLYPH 0 means don't dump glyphs.
17948 GLYPH 1 means dump glyphs in short form.
17949 GLYPH > 1 or omitted means dump glyphs in long form. */)
17950 (Lisp_Object row
, Lisp_Object glyphs
)
17952 struct glyph_matrix
*matrix
;
17955 CHECK_NUMBER (row
);
17956 matrix
= XWINDOW (selected_window
)->current_matrix
;
17958 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17959 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17961 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17966 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17967 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17968 GLYPH 0 means don't dump glyphs.
17969 GLYPH 1 means dump glyphs in short form.
17970 GLYPH > 1 or omitted means dump glyphs in long form. */)
17971 (Lisp_Object row
, Lisp_Object glyphs
)
17973 struct frame
*sf
= SELECTED_FRAME ();
17974 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17977 CHECK_NUMBER (row
);
17979 if (vpos
>= 0 && vpos
< m
->nrows
)
17980 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17981 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17986 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17987 doc
: /* Toggle tracing of redisplay.
17988 With ARG, turn tracing on if and only if ARG is positive. */)
17992 trace_redisplay_p
= !trace_redisplay_p
;
17995 arg
= Fprefix_numeric_value (arg
);
17996 trace_redisplay_p
= XINT (arg
) > 0;
18003 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18004 doc
: /* Like `format', but print result to stderr.
18005 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18006 (ptrdiff_t nargs
, Lisp_Object
*args
)
18008 Lisp_Object s
= Fformat (nargs
, args
);
18009 fprintf (stderr
, "%s", SDATA (s
));
18013 #endif /* GLYPH_DEBUG */
18017 /***********************************************************************
18018 Building Desired Matrix Rows
18019 ***********************************************************************/
18021 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18022 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18024 static struct glyph_row
*
18025 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18027 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18028 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18029 struct buffer
*old
= current_buffer
;
18030 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18031 int arrow_len
= SCHARS (overlay_arrow_string
);
18032 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18033 const unsigned char *p
;
18036 int n_glyphs_before
;
18038 set_buffer_temp (buffer
);
18039 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18040 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18041 SET_TEXT_POS (it
.position
, 0, 0);
18043 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18045 while (p
< arrow_end
)
18047 Lisp_Object face
, ilisp
;
18049 /* Get the next character. */
18051 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18054 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18055 if (! ASCII_CHAR_P (it
.c
))
18056 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18060 /* Get its face. */
18061 ilisp
= make_number (p
- arrow_string
);
18062 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18063 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18065 /* Compute its width, get its glyphs. */
18066 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18067 SET_TEXT_POS (it
.position
, -1, -1);
18068 PRODUCE_GLYPHS (&it
);
18070 /* If this character doesn't fit any more in the line, we have
18071 to remove some glyphs. */
18072 if (it
.current_x
> it
.last_visible_x
)
18074 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18079 set_buffer_temp (old
);
18080 return it
.glyph_row
;
18084 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
18085 glyphs are only inserted for terminal frames since we can't really
18086 win with truncation glyphs when partially visible glyphs are
18087 involved. Which glyphs to insert is determined by
18088 produce_special_glyphs. */
18091 insert_left_trunc_glyphs (struct it
*it
)
18093 struct it truncate_it
;
18094 struct glyph
*from
, *end
, *to
, *toend
;
18096 xassert (!FRAME_WINDOW_P (it
->f
));
18098 /* Get the truncation glyphs. */
18100 truncate_it
.current_x
= 0;
18101 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18102 truncate_it
.glyph_row
= &scratch_glyph_row
;
18103 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18104 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18105 truncate_it
.object
= make_number (0);
18106 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18108 /* Overwrite glyphs from IT with truncation glyphs. */
18109 if (!it
->glyph_row
->reversed_p
)
18111 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18112 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
18113 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18114 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18119 /* There may be padding glyphs left over. Overwrite them too. */
18120 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18122 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18128 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18132 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18133 that back to front. */
18134 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18135 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18136 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18137 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18139 while (from
>= end
&& to
>= toend
)
18141 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18144 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18145 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18146 while (from
>= end
&& to
>= toend
)
18151 /* Need to free some room before prepending additional
18153 int move_by
= from
- end
+ 1;
18154 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18155 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18157 for ( ; g
>= g0
; g
--)
18159 while (from
>= end
)
18161 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18166 /* Compute the hash code for ROW. */
18168 row_hash (struct glyph_row
*row
)
18171 unsigned hashval
= 0;
18173 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18174 for (k
= 0; k
< row
->used
[area
]; ++k
)
18175 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18176 + row
->glyphs
[area
][k
].u
.val
18177 + row
->glyphs
[area
][k
].face_id
18178 + row
->glyphs
[area
][k
].padding_p
18179 + (row
->glyphs
[area
][k
].type
<< 2));
18184 /* Compute the pixel height and width of IT->glyph_row.
18186 Most of the time, ascent and height of a display line will be equal
18187 to the max_ascent and max_height values of the display iterator
18188 structure. This is not the case if
18190 1. We hit ZV without displaying anything. In this case, max_ascent
18191 and max_height will be zero.
18193 2. We have some glyphs that don't contribute to the line height.
18194 (The glyph row flag contributes_to_line_height_p is for future
18195 pixmap extensions).
18197 The first case is easily covered by using default values because in
18198 these cases, the line height does not really matter, except that it
18199 must not be zero. */
18202 compute_line_metrics (struct it
*it
)
18204 struct glyph_row
*row
= it
->glyph_row
;
18206 if (FRAME_WINDOW_P (it
->f
))
18208 int i
, min_y
, max_y
;
18210 /* The line may consist of one space only, that was added to
18211 place the cursor on it. If so, the row's height hasn't been
18213 if (row
->height
== 0)
18215 if (it
->max_ascent
+ it
->max_descent
== 0)
18216 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18217 row
->ascent
= it
->max_ascent
;
18218 row
->height
= it
->max_ascent
+ it
->max_descent
;
18219 row
->phys_ascent
= it
->max_phys_ascent
;
18220 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18221 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18224 /* Compute the width of this line. */
18225 row
->pixel_width
= row
->x
;
18226 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18227 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18229 xassert (row
->pixel_width
>= 0);
18230 xassert (row
->ascent
>= 0 && row
->height
> 0);
18232 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18233 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18235 /* If first line's physical ascent is larger than its logical
18236 ascent, use the physical ascent, and make the row taller.
18237 This makes accented characters fully visible. */
18238 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18239 && row
->phys_ascent
> row
->ascent
)
18241 row
->height
+= row
->phys_ascent
- row
->ascent
;
18242 row
->ascent
= row
->phys_ascent
;
18245 /* Compute how much of the line is visible. */
18246 row
->visible_height
= row
->height
;
18248 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18249 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18251 if (row
->y
< min_y
)
18252 row
->visible_height
-= min_y
- row
->y
;
18253 if (row
->y
+ row
->height
> max_y
)
18254 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18258 row
->pixel_width
= row
->used
[TEXT_AREA
];
18259 if (row
->continued_p
)
18260 row
->pixel_width
-= it
->continuation_pixel_width
;
18261 else if (row
->truncated_on_right_p
)
18262 row
->pixel_width
-= it
->truncation_pixel_width
;
18263 row
->ascent
= row
->phys_ascent
= 0;
18264 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18265 row
->extra_line_spacing
= 0;
18268 /* Compute a hash code for this row. */
18269 row
->hash
= row_hash (row
);
18271 it
->max_ascent
= it
->max_descent
= 0;
18272 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18276 /* Append one space to the glyph row of iterator IT if doing a
18277 window-based redisplay. The space has the same face as
18278 IT->face_id. Value is non-zero if a space was added.
18280 This function is called to make sure that there is always one glyph
18281 at the end of a glyph row that the cursor can be set on under
18282 window-systems. (If there weren't such a glyph we would not know
18283 how wide and tall a box cursor should be displayed).
18285 At the same time this space let's a nicely handle clearing to the
18286 end of the line if the row ends in italic text. */
18289 append_space_for_newline (struct it
*it
, int default_face_p
)
18291 if (FRAME_WINDOW_P (it
->f
))
18293 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18295 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18296 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18298 /* Save some values that must not be changed.
18299 Must save IT->c and IT->len because otherwise
18300 ITERATOR_AT_END_P wouldn't work anymore after
18301 append_space_for_newline has been called. */
18302 enum display_element_type saved_what
= it
->what
;
18303 int saved_c
= it
->c
, saved_len
= it
->len
;
18304 int saved_char_to_display
= it
->char_to_display
;
18305 int saved_x
= it
->current_x
;
18306 int saved_face_id
= it
->face_id
;
18307 struct text_pos saved_pos
;
18308 Lisp_Object saved_object
;
18311 saved_object
= it
->object
;
18312 saved_pos
= it
->position
;
18314 it
->what
= IT_CHARACTER
;
18315 memset (&it
->position
, 0, sizeof it
->position
);
18316 it
->object
= make_number (0);
18317 it
->c
= it
->char_to_display
= ' ';
18320 /* If the default face was remapped, be sure to use the
18321 remapped face for the appended newline. */
18322 if (default_face_p
)
18323 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18324 else if (it
->face_before_selective_p
)
18325 it
->face_id
= it
->saved_face_id
;
18326 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18327 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18329 PRODUCE_GLYPHS (it
);
18331 it
->override_ascent
= -1;
18332 it
->constrain_row_ascent_descent_p
= 0;
18333 it
->current_x
= saved_x
;
18334 it
->object
= saved_object
;
18335 it
->position
= saved_pos
;
18336 it
->what
= saved_what
;
18337 it
->face_id
= saved_face_id
;
18338 it
->len
= saved_len
;
18340 it
->char_to_display
= saved_char_to_display
;
18349 /* Extend the face of the last glyph in the text area of IT->glyph_row
18350 to the end of the display line. Called from display_line. If the
18351 glyph row is empty, add a space glyph to it so that we know the
18352 face to draw. Set the glyph row flag fill_line_p. If the glyph
18353 row is R2L, prepend a stretch glyph to cover the empty space to the
18354 left of the leftmost glyph. */
18357 extend_face_to_end_of_line (struct it
*it
)
18359 struct face
*face
, *default_face
;
18360 struct frame
*f
= it
->f
;
18362 /* If line is already filled, do nothing. Non window-system frames
18363 get a grace of one more ``pixel'' because their characters are
18364 1-``pixel'' wide, so they hit the equality too early. This grace
18365 is needed only for R2L rows that are not continued, to produce
18366 one extra blank where we could display the cursor. */
18367 if (it
->current_x
>= it
->last_visible_x
18368 + (!FRAME_WINDOW_P (f
)
18369 && it
->glyph_row
->reversed_p
18370 && !it
->glyph_row
->continued_p
))
18373 /* The default face, possibly remapped. */
18374 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18376 /* Face extension extends the background and box of IT->face_id
18377 to the end of the line. If the background equals the background
18378 of the frame, we don't have to do anything. */
18379 if (it
->face_before_selective_p
)
18380 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18382 face
= FACE_FROM_ID (f
, it
->face_id
);
18384 if (FRAME_WINDOW_P (f
)
18385 && it
->glyph_row
->displays_text_p
18386 && face
->box
== FACE_NO_BOX
18387 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18389 && !it
->glyph_row
->reversed_p
)
18392 /* Set the glyph row flag indicating that the face of the last glyph
18393 in the text area has to be drawn to the end of the text area. */
18394 it
->glyph_row
->fill_line_p
= 1;
18396 /* If current character of IT is not ASCII, make sure we have the
18397 ASCII face. This will be automatically undone the next time
18398 get_next_display_element returns a multibyte character. Note
18399 that the character will always be single byte in unibyte
18401 if (!ASCII_CHAR_P (it
->c
))
18403 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18406 if (FRAME_WINDOW_P (f
))
18408 /* If the row is empty, add a space with the current face of IT,
18409 so that we know which face to draw. */
18410 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18412 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18413 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18414 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18416 #ifdef HAVE_WINDOW_SYSTEM
18417 if (it
->glyph_row
->reversed_p
)
18419 /* Prepend a stretch glyph to the row, such that the
18420 rightmost glyph will be drawn flushed all the way to the
18421 right margin of the window. The stretch glyph that will
18422 occupy the empty space, if any, to the left of the
18424 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18425 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18426 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18428 int row_width
, stretch_ascent
, stretch_width
;
18429 struct text_pos saved_pos
;
18430 int saved_face_id
, saved_avoid_cursor
;
18432 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18433 row_width
+= g
->pixel_width
;
18434 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18435 if (stretch_width
> 0)
18438 (((it
->ascent
+ it
->descent
)
18439 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18440 saved_pos
= it
->position
;
18441 memset (&it
->position
, 0, sizeof it
->position
);
18442 saved_avoid_cursor
= it
->avoid_cursor_p
;
18443 it
->avoid_cursor_p
= 1;
18444 saved_face_id
= it
->face_id
;
18445 /* The last row's stretch glyph should get the default
18446 face, to avoid painting the rest of the window with
18447 the region face, if the region ends at ZV. */
18448 if (it
->glyph_row
->ends_at_zv_p
)
18449 it
->face_id
= default_face
->id
;
18451 it
->face_id
= face
->id
;
18452 append_stretch_glyph (it
, make_number (0), stretch_width
,
18453 it
->ascent
+ it
->descent
, stretch_ascent
);
18454 it
->position
= saved_pos
;
18455 it
->avoid_cursor_p
= saved_avoid_cursor
;
18456 it
->face_id
= saved_face_id
;
18459 #endif /* HAVE_WINDOW_SYSTEM */
18463 /* Save some values that must not be changed. */
18464 int saved_x
= it
->current_x
;
18465 struct text_pos saved_pos
;
18466 Lisp_Object saved_object
;
18467 enum display_element_type saved_what
= it
->what
;
18468 int saved_face_id
= it
->face_id
;
18470 saved_object
= it
->object
;
18471 saved_pos
= it
->position
;
18473 it
->what
= IT_CHARACTER
;
18474 memset (&it
->position
, 0, sizeof it
->position
);
18475 it
->object
= make_number (0);
18476 it
->c
= it
->char_to_display
= ' ';
18478 /* The last row's blank glyphs should get the default face, to
18479 avoid painting the rest of the window with the region face,
18480 if the region ends at ZV. */
18481 if (it
->glyph_row
->ends_at_zv_p
)
18482 it
->face_id
= default_face
->id
;
18484 it
->face_id
= face
->id
;
18486 PRODUCE_GLYPHS (it
);
18488 while (it
->current_x
<= it
->last_visible_x
)
18489 PRODUCE_GLYPHS (it
);
18491 /* Don't count these blanks really. It would let us insert a left
18492 truncation glyph below and make us set the cursor on them, maybe. */
18493 it
->current_x
= saved_x
;
18494 it
->object
= saved_object
;
18495 it
->position
= saved_pos
;
18496 it
->what
= saved_what
;
18497 it
->face_id
= saved_face_id
;
18502 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18503 trailing whitespace. */
18506 trailing_whitespace_p (EMACS_INT charpos
)
18508 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18511 while (bytepos
< ZV_BYTE
18512 && (c
= FETCH_CHAR (bytepos
),
18513 c
== ' ' || c
== '\t'))
18516 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18518 if (bytepos
!= PT_BYTE
)
18525 /* Highlight trailing whitespace, if any, in ROW. */
18528 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18530 int used
= row
->used
[TEXT_AREA
];
18534 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18535 struct glyph
*glyph
= start
+ used
- 1;
18537 if (row
->reversed_p
)
18539 /* Right-to-left rows need to be processed in the opposite
18540 direction, so swap the edge pointers. */
18542 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18545 /* Skip over glyphs inserted to display the cursor at the
18546 end of a line, for extending the face of the last glyph
18547 to the end of the line on terminals, and for truncation
18548 and continuation glyphs. */
18549 if (!row
->reversed_p
)
18551 while (glyph
>= start
18552 && glyph
->type
== CHAR_GLYPH
18553 && INTEGERP (glyph
->object
))
18558 while (glyph
<= start
18559 && glyph
->type
== CHAR_GLYPH
18560 && INTEGERP (glyph
->object
))
18564 /* If last glyph is a space or stretch, and it's trailing
18565 whitespace, set the face of all trailing whitespace glyphs in
18566 IT->glyph_row to `trailing-whitespace'. */
18567 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18568 && BUFFERP (glyph
->object
)
18569 && (glyph
->type
== STRETCH_GLYPH
18570 || (glyph
->type
== CHAR_GLYPH
18571 && glyph
->u
.ch
== ' '))
18572 && trailing_whitespace_p (glyph
->charpos
))
18574 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18578 if (!row
->reversed_p
)
18580 while (glyph
>= start
18581 && BUFFERP (glyph
->object
)
18582 && (glyph
->type
== STRETCH_GLYPH
18583 || (glyph
->type
== CHAR_GLYPH
18584 && glyph
->u
.ch
== ' ')))
18585 (glyph
--)->face_id
= face_id
;
18589 while (glyph
<= start
18590 && BUFFERP (glyph
->object
)
18591 && (glyph
->type
== STRETCH_GLYPH
18592 || (glyph
->type
== CHAR_GLYPH
18593 && glyph
->u
.ch
== ' ')))
18594 (glyph
++)->face_id
= face_id
;
18601 /* Value is non-zero if glyph row ROW should be
18602 used to hold the cursor. */
18605 cursor_row_p (struct glyph_row
*row
)
18609 if (PT
== CHARPOS (row
->end
.pos
)
18610 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18612 /* Suppose the row ends on a string.
18613 Unless the row is continued, that means it ends on a newline
18614 in the string. If it's anything other than a display string
18615 (e.g., a before-string from an overlay), we don't want the
18616 cursor there. (This heuristic seems to give the optimal
18617 behavior for the various types of multi-line strings.)
18618 One exception: if the string has `cursor' property on one of
18619 its characters, we _do_ want the cursor there. */
18620 if (CHARPOS (row
->end
.string_pos
) >= 0)
18622 if (row
->continued_p
)
18626 /* Check for `display' property. */
18627 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18628 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18629 struct glyph
*glyph
;
18632 for (glyph
= end
; glyph
>= beg
; --glyph
)
18633 if (STRINGP (glyph
->object
))
18636 = Fget_char_property (make_number (PT
),
18640 && display_prop_string_p (prop
, glyph
->object
));
18641 /* If there's a `cursor' property on one of the
18642 string's characters, this row is a cursor row,
18643 even though this is not a display string. */
18646 Lisp_Object s
= glyph
->object
;
18648 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18650 EMACS_INT gpos
= glyph
->charpos
;
18652 if (!NILP (Fget_char_property (make_number (gpos
),
18664 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18666 /* If the row ends in middle of a real character,
18667 and the line is continued, we want the cursor here.
18668 That's because CHARPOS (ROW->end.pos) would equal
18669 PT if PT is before the character. */
18670 if (!row
->ends_in_ellipsis_p
)
18671 result
= row
->continued_p
;
18673 /* If the row ends in an ellipsis, then
18674 CHARPOS (ROW->end.pos) will equal point after the
18675 invisible text. We want that position to be displayed
18676 after the ellipsis. */
18679 /* If the row ends at ZV, display the cursor at the end of that
18680 row instead of at the start of the row below. */
18681 else if (row
->ends_at_zv_p
)
18692 /* Push the property PROP so that it will be rendered at the current
18693 position in IT. Return 1 if PROP was successfully pushed, 0
18694 otherwise. Called from handle_line_prefix to handle the
18695 `line-prefix' and `wrap-prefix' properties. */
18698 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18700 struct text_pos pos
=
18701 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18703 xassert (it
->method
== GET_FROM_BUFFER
18704 || it
->method
== GET_FROM_DISPLAY_VECTOR
18705 || it
->method
== GET_FROM_STRING
);
18707 /* We need to save the current buffer/string position, so it will be
18708 restored by pop_it, because iterate_out_of_display_property
18709 depends on that being set correctly, but some situations leave
18710 it->position not yet set when this function is called. */
18711 push_it (it
, &pos
);
18713 if (STRINGP (prop
))
18715 if (SCHARS (prop
) == 0)
18722 it
->string_from_prefix_prop_p
= 1;
18723 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18724 it
->current
.overlay_string_index
= -1;
18725 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18726 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18727 it
->method
= GET_FROM_STRING
;
18728 it
->stop_charpos
= 0;
18730 it
->base_level_stop
= 0;
18732 /* Force paragraph direction to be that of the parent
18734 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18735 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18737 it
->paragraph_embedding
= L2R
;
18739 /* Set up the bidi iterator for this display string. */
18742 it
->bidi_it
.string
.lstring
= it
->string
;
18743 it
->bidi_it
.string
.s
= NULL
;
18744 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18745 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18746 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18747 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18748 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18751 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18753 it
->method
= GET_FROM_STRETCH
;
18756 #ifdef HAVE_WINDOW_SYSTEM
18757 else if (IMAGEP (prop
))
18759 it
->what
= IT_IMAGE
;
18760 it
->image_id
= lookup_image (it
->f
, prop
);
18761 it
->method
= GET_FROM_IMAGE
;
18763 #endif /* HAVE_WINDOW_SYSTEM */
18766 pop_it (it
); /* bogus display property, give up */
18773 /* Return the character-property PROP at the current position in IT. */
18776 get_it_property (struct it
*it
, Lisp_Object prop
)
18778 Lisp_Object position
;
18780 if (STRINGP (it
->object
))
18781 position
= make_number (IT_STRING_CHARPOS (*it
));
18782 else if (BUFFERP (it
->object
))
18783 position
= make_number (IT_CHARPOS (*it
));
18787 return Fget_char_property (position
, prop
, it
->object
);
18790 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18793 handle_line_prefix (struct it
*it
)
18795 Lisp_Object prefix
;
18797 if (it
->continuation_lines_width
> 0)
18799 prefix
= get_it_property (it
, Qwrap_prefix
);
18801 prefix
= Vwrap_prefix
;
18805 prefix
= get_it_property (it
, Qline_prefix
);
18807 prefix
= Vline_prefix
;
18809 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18811 /* If the prefix is wider than the window, and we try to wrap
18812 it, it would acquire its own wrap prefix, and so on till the
18813 iterator stack overflows. So, don't wrap the prefix. */
18814 it
->line_wrap
= TRUNCATE
;
18815 it
->avoid_cursor_p
= 1;
18821 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18822 only for R2L lines from display_line and display_string, when they
18823 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18824 the line/string needs to be continued on the next glyph row. */
18826 unproduce_glyphs (struct it
*it
, int n
)
18828 struct glyph
*glyph
, *end
;
18830 xassert (it
->glyph_row
);
18831 xassert (it
->glyph_row
->reversed_p
);
18832 xassert (it
->area
== TEXT_AREA
);
18833 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18835 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18836 n
= it
->glyph_row
->used
[TEXT_AREA
];
18837 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18838 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18839 for ( ; glyph
< end
; glyph
++)
18840 glyph
[-n
] = *glyph
;
18843 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18844 and ROW->maxpos. */
18846 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18847 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18848 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18850 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18851 lines' rows is implemented for bidi-reordered rows. */
18853 /* ROW->minpos is the value of min_pos, the minimal buffer position
18854 we have in ROW, or ROW->start.pos if that is smaller. */
18855 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18856 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18858 /* We didn't find buffer positions smaller than ROW->start, or
18859 didn't find _any_ valid buffer positions in any of the glyphs,
18860 so we must trust the iterator's computed positions. */
18861 row
->minpos
= row
->start
.pos
;
18864 max_pos
= CHARPOS (it
->current
.pos
);
18865 max_bpos
= BYTEPOS (it
->current
.pos
);
18868 /* Here are the various use-cases for ending the row, and the
18869 corresponding values for ROW->maxpos:
18871 Line ends in a newline from buffer eol_pos + 1
18872 Line is continued from buffer max_pos + 1
18873 Line is truncated on right it->current.pos
18874 Line ends in a newline from string max_pos + 1(*)
18875 (*) + 1 only when line ends in a forward scan
18876 Line is continued from string max_pos
18877 Line is continued from display vector max_pos
18878 Line is entirely from a string min_pos == max_pos
18879 Line is entirely from a display vector min_pos == max_pos
18880 Line that ends at ZV ZV
18882 If you discover other use-cases, please add them here as
18884 if (row
->ends_at_zv_p
)
18885 row
->maxpos
= it
->current
.pos
;
18886 else if (row
->used
[TEXT_AREA
])
18888 int seen_this_string
= 0;
18889 struct glyph_row
*r1
= row
- 1;
18891 /* Did we see the same display string on the previous row? */
18892 if (STRINGP (it
->object
)
18893 /* this is not the first row */
18894 && row
> it
->w
->desired_matrix
->rows
18895 /* previous row is not the header line */
18896 && !r1
->mode_line_p
18897 /* previous row also ends in a newline from a string */
18898 && r1
->ends_in_newline_from_string_p
)
18900 struct glyph
*start
, *end
;
18902 /* Search for the last glyph of the previous row that came
18903 from buffer or string. Depending on whether the row is
18904 L2R or R2L, we need to process it front to back or the
18905 other way round. */
18906 if (!r1
->reversed_p
)
18908 start
= r1
->glyphs
[TEXT_AREA
];
18909 end
= start
+ r1
->used
[TEXT_AREA
];
18910 /* Glyphs inserted by redisplay have an integer (zero)
18911 as their object. */
18913 && INTEGERP ((end
- 1)->object
)
18914 && (end
- 1)->charpos
<= 0)
18918 if (EQ ((end
- 1)->object
, it
->object
))
18919 seen_this_string
= 1;
18922 /* If all the glyphs of the previous row were inserted
18923 by redisplay, it means the previous row was
18924 produced from a single newline, which is only
18925 possible if that newline came from the same string
18926 as the one which produced this ROW. */
18927 seen_this_string
= 1;
18931 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18932 start
= end
+ r1
->used
[TEXT_AREA
];
18934 && INTEGERP ((end
+ 1)->object
)
18935 && (end
+ 1)->charpos
<= 0)
18939 if (EQ ((end
+ 1)->object
, it
->object
))
18940 seen_this_string
= 1;
18943 seen_this_string
= 1;
18946 /* Take note of each display string that covers a newline only
18947 once, the first time we see it. This is for when a display
18948 string includes more than one newline in it. */
18949 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18951 /* If we were scanning the buffer forward when we displayed
18952 the string, we want to account for at least one buffer
18953 position that belongs to this row (position covered by
18954 the display string), so that cursor positioning will
18955 consider this row as a candidate when point is at the end
18956 of the visual line represented by this row. This is not
18957 required when scanning back, because max_pos will already
18958 have a much larger value. */
18959 if (CHARPOS (row
->end
.pos
) > max_pos
)
18960 INC_BOTH (max_pos
, max_bpos
);
18961 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18963 else if (CHARPOS (it
->eol_pos
) > 0)
18964 SET_TEXT_POS (row
->maxpos
,
18965 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18966 else if (row
->continued_p
)
18968 /* If max_pos is different from IT's current position, it
18969 means IT->method does not belong to the display element
18970 at max_pos. However, it also means that the display
18971 element at max_pos was displayed in its entirety on this
18972 line, which is equivalent to saying that the next line
18973 starts at the next buffer position. */
18974 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18975 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18978 INC_BOTH (max_pos
, max_bpos
);
18979 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18982 else if (row
->truncated_on_right_p
)
18983 /* display_line already called reseat_at_next_visible_line_start,
18984 which puts the iterator at the beginning of the next line, in
18985 the logical order. */
18986 row
->maxpos
= it
->current
.pos
;
18987 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18988 /* A line that is entirely from a string/image/stretch... */
18989 row
->maxpos
= row
->minpos
;
18994 row
->maxpos
= it
->current
.pos
;
18997 /* Construct the glyph row IT->glyph_row in the desired matrix of
18998 IT->w from text at the current position of IT. See dispextern.h
18999 for an overview of struct it. Value is non-zero if
19000 IT->glyph_row displays text, as opposed to a line displaying ZV
19004 display_line (struct it
*it
)
19006 struct glyph_row
*row
= it
->glyph_row
;
19007 Lisp_Object overlay_arrow_string
;
19009 void *wrap_data
= NULL
;
19010 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19011 int wrap_row_used
= -1;
19012 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19013 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19014 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19015 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19016 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19018 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
19019 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19021 /* We always start displaying at hpos zero even if hscrolled. */
19022 xassert (it
->hpos
== 0 && it
->current_x
== 0);
19024 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19025 >= it
->w
->desired_matrix
->nrows
)
19027 it
->w
->nrows_scale_factor
++;
19028 fonts_changed_p
= 1;
19032 /* Is IT->w showing the region? */
19033 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
19035 /* Clear the result glyph row and enable it. */
19036 prepare_desired_row (row
);
19038 row
->y
= it
->current_y
;
19039 row
->start
= it
->start
;
19040 row
->continuation_lines_width
= it
->continuation_lines_width
;
19041 row
->displays_text_p
= 1;
19042 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19043 it
->starts_in_middle_of_char_p
= 0;
19045 /* Arrange the overlays nicely for our purposes. Usually, we call
19046 display_line on only one line at a time, in which case this
19047 can't really hurt too much, or we call it on lines which appear
19048 one after another in the buffer, in which case all calls to
19049 recenter_overlay_lists but the first will be pretty cheap. */
19050 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19052 /* Move over display elements that are not visible because we are
19053 hscrolled. This may stop at an x-position < IT->first_visible_x
19054 if the first glyph is partially visible or if we hit a line end. */
19055 if (it
->current_x
< it
->first_visible_x
)
19057 this_line_min_pos
= row
->start
.pos
;
19058 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19059 MOVE_TO_POS
| MOVE_TO_X
);
19060 /* Record the smallest positions seen while we moved over
19061 display elements that are not visible. This is needed by
19062 redisplay_internal for optimizing the case where the cursor
19063 stays inside the same line. The rest of this function only
19064 considers positions that are actually displayed, so
19065 RECORD_MAX_MIN_POS will not otherwise record positions that
19066 are hscrolled to the left of the left edge of the window. */
19067 min_pos
= CHARPOS (this_line_min_pos
);
19068 min_bpos
= BYTEPOS (this_line_min_pos
);
19072 /* We only do this when not calling `move_it_in_display_line_to'
19073 above, because move_it_in_display_line_to calls
19074 handle_line_prefix itself. */
19075 handle_line_prefix (it
);
19078 /* Get the initial row height. This is either the height of the
19079 text hscrolled, if there is any, or zero. */
19080 row
->ascent
= it
->max_ascent
;
19081 row
->height
= it
->max_ascent
+ it
->max_descent
;
19082 row
->phys_ascent
= it
->max_phys_ascent
;
19083 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19084 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19086 /* Utility macro to record max and min buffer positions seen until now. */
19087 #define RECORD_MAX_MIN_POS(IT) \
19090 int composition_p = !STRINGP ((IT)->string) \
19091 && ((IT)->what == IT_COMPOSITION); \
19092 EMACS_INT current_pos = \
19093 composition_p ? (IT)->cmp_it.charpos \
19094 : IT_CHARPOS (*(IT)); \
19095 EMACS_INT current_bpos = \
19096 composition_p ? CHAR_TO_BYTE (current_pos) \
19097 : IT_BYTEPOS (*(IT)); \
19098 if (current_pos < min_pos) \
19100 min_pos = current_pos; \
19101 min_bpos = current_bpos; \
19103 if (IT_CHARPOS (*it) > max_pos) \
19105 max_pos = IT_CHARPOS (*it); \
19106 max_bpos = IT_BYTEPOS (*it); \
19111 /* Loop generating characters. The loop is left with IT on the next
19112 character to display. */
19115 int n_glyphs_before
, hpos_before
, x_before
;
19117 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19119 /* Retrieve the next thing to display. Value is zero if end of
19121 if (!get_next_display_element (it
))
19123 /* Maybe add a space at the end of this line that is used to
19124 display the cursor there under X. Set the charpos of the
19125 first glyph of blank lines not corresponding to any text
19127 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19128 row
->exact_window_width_line_p
= 1;
19129 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19130 || row
->used
[TEXT_AREA
] == 0)
19132 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19133 row
->displays_text_p
= 0;
19135 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19136 && (!MINI_WINDOW_P (it
->w
)
19137 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19138 row
->indicate_empty_line_p
= 1;
19141 it
->continuation_lines_width
= 0;
19142 row
->ends_at_zv_p
= 1;
19143 /* A row that displays right-to-left text must always have
19144 its last face extended all the way to the end of line,
19145 even if this row ends in ZV, because we still write to
19146 the screen left to right. We also need to extend the
19147 last face if the default face is remapped to some
19148 different face, otherwise the functions that clear
19149 portions of the screen will clear with the default face's
19150 background color. */
19151 if (row
->reversed_p
19152 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19153 extend_face_to_end_of_line (it
);
19157 /* Now, get the metrics of what we want to display. This also
19158 generates glyphs in `row' (which is IT->glyph_row). */
19159 n_glyphs_before
= row
->used
[TEXT_AREA
];
19162 /* Remember the line height so far in case the next element doesn't
19163 fit on the line. */
19164 if (it
->line_wrap
!= TRUNCATE
)
19166 ascent
= it
->max_ascent
;
19167 descent
= it
->max_descent
;
19168 phys_ascent
= it
->max_phys_ascent
;
19169 phys_descent
= it
->max_phys_descent
;
19171 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19173 if (IT_DISPLAYING_WHITESPACE (it
))
19177 SAVE_IT (wrap_it
, *it
, wrap_data
);
19179 wrap_row_used
= row
->used
[TEXT_AREA
];
19180 wrap_row_ascent
= row
->ascent
;
19181 wrap_row_height
= row
->height
;
19182 wrap_row_phys_ascent
= row
->phys_ascent
;
19183 wrap_row_phys_height
= row
->phys_height
;
19184 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19185 wrap_row_min_pos
= min_pos
;
19186 wrap_row_min_bpos
= min_bpos
;
19187 wrap_row_max_pos
= max_pos
;
19188 wrap_row_max_bpos
= max_bpos
;
19194 PRODUCE_GLYPHS (it
);
19196 /* If this display element was in marginal areas, continue with
19198 if (it
->area
!= TEXT_AREA
)
19200 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19201 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19202 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19203 row
->phys_height
= max (row
->phys_height
,
19204 it
->max_phys_ascent
+ it
->max_phys_descent
);
19205 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19206 it
->max_extra_line_spacing
);
19207 set_iterator_to_next (it
, 1);
19211 /* Does the display element fit on the line? If we truncate
19212 lines, we should draw past the right edge of the window. If
19213 we don't truncate, we want to stop so that we can display the
19214 continuation glyph before the right margin. If lines are
19215 continued, there are two possible strategies for characters
19216 resulting in more than 1 glyph (e.g. tabs): Display as many
19217 glyphs as possible in this line and leave the rest for the
19218 continuation line, or display the whole element in the next
19219 line. Original redisplay did the former, so we do it also. */
19220 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19221 hpos_before
= it
->hpos
;
19224 if (/* Not a newline. */
19226 /* Glyphs produced fit entirely in the line. */
19227 && it
->current_x
< it
->last_visible_x
)
19229 it
->hpos
+= nglyphs
;
19230 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19231 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19232 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19233 row
->phys_height
= max (row
->phys_height
,
19234 it
->max_phys_ascent
+ it
->max_phys_descent
);
19235 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19236 it
->max_extra_line_spacing
);
19237 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19238 row
->x
= x
- it
->first_visible_x
;
19239 /* Record the maximum and minimum buffer positions seen so
19240 far in glyphs that will be displayed by this row. */
19242 RECORD_MAX_MIN_POS (it
);
19247 struct glyph
*glyph
;
19249 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19251 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19252 new_x
= x
+ glyph
->pixel_width
;
19254 if (/* Lines are continued. */
19255 it
->line_wrap
!= TRUNCATE
19256 && (/* Glyph doesn't fit on the line. */
19257 new_x
> it
->last_visible_x
19258 /* Or it fits exactly on a window system frame. */
19259 || (new_x
== it
->last_visible_x
19260 && FRAME_WINDOW_P (it
->f
))))
19262 /* End of a continued line. */
19265 || (new_x
== it
->last_visible_x
19266 && FRAME_WINDOW_P (it
->f
)))
19268 /* Current glyph is the only one on the line or
19269 fits exactly on the line. We must continue
19270 the line because we can't draw the cursor
19271 after the glyph. */
19272 row
->continued_p
= 1;
19273 it
->current_x
= new_x
;
19274 it
->continuation_lines_width
+= new_x
;
19276 if (i
== nglyphs
- 1)
19278 /* If line-wrap is on, check if a previous
19279 wrap point was found. */
19280 if (wrap_row_used
> 0
19281 /* Even if there is a previous wrap
19282 point, continue the line here as
19283 usual, if (i) the previous character
19284 was a space or tab AND (ii) the
19285 current character is not. */
19287 || IT_DISPLAYING_WHITESPACE (it
)))
19290 /* Record the maximum and minimum buffer
19291 positions seen so far in glyphs that will be
19292 displayed by this row. */
19294 RECORD_MAX_MIN_POS (it
);
19295 set_iterator_to_next (it
, 1);
19296 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19298 if (!get_next_display_element (it
))
19300 row
->exact_window_width_line_p
= 1;
19301 it
->continuation_lines_width
= 0;
19302 row
->continued_p
= 0;
19303 row
->ends_at_zv_p
= 1;
19305 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19307 row
->continued_p
= 0;
19308 row
->exact_window_width_line_p
= 1;
19312 else if (it
->bidi_p
)
19313 RECORD_MAX_MIN_POS (it
);
19315 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19316 && !FRAME_WINDOW_P (it
->f
))
19318 /* A padding glyph that doesn't fit on this line.
19319 This means the whole character doesn't fit
19321 if (row
->reversed_p
)
19322 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19323 - n_glyphs_before
);
19324 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19326 /* Fill the rest of the row with continuation
19327 glyphs like in 20.x. */
19328 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19329 < row
->glyphs
[1 + TEXT_AREA
])
19330 produce_special_glyphs (it
, IT_CONTINUATION
);
19332 row
->continued_p
= 1;
19333 it
->current_x
= x_before
;
19334 it
->continuation_lines_width
+= x_before
;
19336 /* Restore the height to what it was before the
19337 element not fitting on the line. */
19338 it
->max_ascent
= ascent
;
19339 it
->max_descent
= descent
;
19340 it
->max_phys_ascent
= phys_ascent
;
19341 it
->max_phys_descent
= phys_descent
;
19343 else if (wrap_row_used
> 0)
19346 if (row
->reversed_p
)
19347 unproduce_glyphs (it
,
19348 row
->used
[TEXT_AREA
] - wrap_row_used
);
19349 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19350 it
->continuation_lines_width
+= wrap_x
;
19351 row
->used
[TEXT_AREA
] = wrap_row_used
;
19352 row
->ascent
= wrap_row_ascent
;
19353 row
->height
= wrap_row_height
;
19354 row
->phys_ascent
= wrap_row_phys_ascent
;
19355 row
->phys_height
= wrap_row_phys_height
;
19356 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19357 min_pos
= wrap_row_min_pos
;
19358 min_bpos
= wrap_row_min_bpos
;
19359 max_pos
= wrap_row_max_pos
;
19360 max_bpos
= wrap_row_max_bpos
;
19361 row
->continued_p
= 1;
19362 row
->ends_at_zv_p
= 0;
19363 row
->exact_window_width_line_p
= 0;
19364 it
->continuation_lines_width
+= x
;
19366 /* Make sure that a non-default face is extended
19367 up to the right margin of the window. */
19368 extend_face_to_end_of_line (it
);
19370 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19372 /* A TAB that extends past the right edge of the
19373 window. This produces a single glyph on
19374 window system frames. We leave the glyph in
19375 this row and let it fill the row, but don't
19376 consume the TAB. */
19377 it
->continuation_lines_width
+= it
->last_visible_x
;
19378 row
->ends_in_middle_of_char_p
= 1;
19379 row
->continued_p
= 1;
19380 glyph
->pixel_width
= it
->last_visible_x
- x
;
19381 it
->starts_in_middle_of_char_p
= 1;
19385 /* Something other than a TAB that draws past
19386 the right edge of the window. Restore
19387 positions to values before the element. */
19388 if (row
->reversed_p
)
19389 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19390 - (n_glyphs_before
+ i
));
19391 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19393 /* Display continuation glyphs. */
19394 if (!FRAME_WINDOW_P (it
->f
))
19395 produce_special_glyphs (it
, IT_CONTINUATION
);
19396 row
->continued_p
= 1;
19398 it
->current_x
= x_before
;
19399 it
->continuation_lines_width
+= x
;
19400 extend_face_to_end_of_line (it
);
19402 if (nglyphs
> 1 && i
> 0)
19404 row
->ends_in_middle_of_char_p
= 1;
19405 it
->starts_in_middle_of_char_p
= 1;
19408 /* Restore the height to what it was before the
19409 element not fitting on the line. */
19410 it
->max_ascent
= ascent
;
19411 it
->max_descent
= descent
;
19412 it
->max_phys_ascent
= phys_ascent
;
19413 it
->max_phys_descent
= phys_descent
;
19418 else if (new_x
> it
->first_visible_x
)
19420 /* Increment number of glyphs actually displayed. */
19423 /* Record the maximum and minimum buffer positions
19424 seen so far in glyphs that will be displayed by
19427 RECORD_MAX_MIN_POS (it
);
19429 if (x
< it
->first_visible_x
)
19430 /* Glyph is partially visible, i.e. row starts at
19431 negative X position. */
19432 row
->x
= x
- it
->first_visible_x
;
19436 /* Glyph is completely off the left margin of the
19437 window. This should not happen because of the
19438 move_it_in_display_line at the start of this
19439 function, unless the text display area of the
19440 window is empty. */
19441 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19444 /* Even if this display element produced no glyphs at all,
19445 we want to record its position. */
19446 if (it
->bidi_p
&& nglyphs
== 0)
19447 RECORD_MAX_MIN_POS (it
);
19449 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19450 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19451 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19452 row
->phys_height
= max (row
->phys_height
,
19453 it
->max_phys_ascent
+ it
->max_phys_descent
);
19454 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19455 it
->max_extra_line_spacing
);
19457 /* End of this display line if row is continued. */
19458 if (row
->continued_p
|| row
->ends_at_zv_p
)
19463 /* Is this a line end? If yes, we're also done, after making
19464 sure that a non-default face is extended up to the right
19465 margin of the window. */
19466 if (ITERATOR_AT_END_OF_LINE_P (it
))
19468 int used_before
= row
->used
[TEXT_AREA
];
19470 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19472 /* Add a space at the end of the line that is used to
19473 display the cursor there. */
19474 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19475 append_space_for_newline (it
, 0);
19477 /* Extend the face to the end of the line. */
19478 extend_face_to_end_of_line (it
);
19480 /* Make sure we have the position. */
19481 if (used_before
== 0)
19482 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19484 /* Record the position of the newline, for use in
19486 it
->eol_pos
= it
->current
.pos
;
19488 /* Consume the line end. This skips over invisible lines. */
19489 set_iterator_to_next (it
, 1);
19490 it
->continuation_lines_width
= 0;
19494 /* Proceed with next display element. Note that this skips
19495 over lines invisible because of selective display. */
19496 set_iterator_to_next (it
, 1);
19498 /* If we truncate lines, we are done when the last displayed
19499 glyphs reach past the right margin of the window. */
19500 if (it
->line_wrap
== TRUNCATE
19501 && (FRAME_WINDOW_P (it
->f
)
19502 ? (it
->current_x
>= it
->last_visible_x
)
19503 : (it
->current_x
> it
->last_visible_x
)))
19505 /* Maybe add truncation glyphs. */
19506 if (!FRAME_WINDOW_P (it
->f
))
19510 if (!row
->reversed_p
)
19512 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19513 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19518 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19519 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19521 /* Remove any padding glyphs at the front of ROW, to
19522 make room for the truncation glyphs we will be
19523 adding below. The loop below always inserts at
19524 least one truncation glyph, so also remove the
19525 last glyph added to ROW. */
19526 unproduce_glyphs (it
, i
+ 1);
19527 /* Adjust i for the loop below. */
19528 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19531 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19533 row
->used
[TEXT_AREA
] = i
;
19534 produce_special_glyphs (it
, IT_TRUNCATION
);
19537 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19539 /* Don't truncate if we can overflow newline into fringe. */
19540 if (!get_next_display_element (it
))
19542 it
->continuation_lines_width
= 0;
19543 row
->ends_at_zv_p
= 1;
19544 row
->exact_window_width_line_p
= 1;
19547 if (ITERATOR_AT_END_OF_LINE_P (it
))
19549 row
->exact_window_width_line_p
= 1;
19550 goto at_end_of_line
;
19554 row
->truncated_on_right_p
= 1;
19555 it
->continuation_lines_width
= 0;
19556 reseat_at_next_visible_line_start (it
, 0);
19557 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19558 it
->hpos
= hpos_before
;
19559 it
->current_x
= x_before
;
19565 bidi_unshelve_cache (wrap_data
, 1);
19567 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19568 at the left window margin. */
19569 if (it
->first_visible_x
19570 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19572 if (!FRAME_WINDOW_P (it
->f
))
19573 insert_left_trunc_glyphs (it
);
19574 row
->truncated_on_left_p
= 1;
19577 /* Remember the position at which this line ends.
19579 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19580 cannot be before the call to find_row_edges below, since that is
19581 where these positions are determined. */
19582 row
->end
= it
->current
;
19585 row
->minpos
= row
->start
.pos
;
19586 row
->maxpos
= row
->end
.pos
;
19590 /* ROW->minpos and ROW->maxpos must be the smallest and
19591 `1 + the largest' buffer positions in ROW. But if ROW was
19592 bidi-reordered, these two positions can be anywhere in the
19593 row, so we must determine them now. */
19594 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19597 /* If the start of this line is the overlay arrow-position, then
19598 mark this glyph row as the one containing the overlay arrow.
19599 This is clearly a mess with variable size fonts. It would be
19600 better to let it be displayed like cursors under X. */
19601 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19602 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19603 !NILP (overlay_arrow_string
)))
19605 /* Overlay arrow in window redisplay is a fringe bitmap. */
19606 if (STRINGP (overlay_arrow_string
))
19608 struct glyph_row
*arrow_row
19609 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19610 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19611 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19612 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19613 struct glyph
*p2
, *end
;
19615 /* Copy the arrow glyphs. */
19616 while (glyph
< arrow_end
)
19619 /* Throw away padding glyphs. */
19621 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19622 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19628 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19633 xassert (INTEGERP (overlay_arrow_string
));
19634 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19636 overlay_arrow_seen
= 1;
19639 /* Highlight trailing whitespace. */
19640 if (!NILP (Vshow_trailing_whitespace
))
19641 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19643 /* Compute pixel dimensions of this line. */
19644 compute_line_metrics (it
);
19646 /* Implementation note: No changes in the glyphs of ROW or in their
19647 faces can be done past this point, because compute_line_metrics
19648 computes ROW's hash value and stores it within the glyph_row
19651 /* Record whether this row ends inside an ellipsis. */
19652 row
->ends_in_ellipsis_p
19653 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19654 && it
->ellipsis_p
);
19656 /* Save fringe bitmaps in this row. */
19657 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19658 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19659 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19660 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19662 it
->left_user_fringe_bitmap
= 0;
19663 it
->left_user_fringe_face_id
= 0;
19664 it
->right_user_fringe_bitmap
= 0;
19665 it
->right_user_fringe_face_id
= 0;
19667 /* Maybe set the cursor. */
19668 cvpos
= it
->w
->cursor
.vpos
;
19670 /* In bidi-reordered rows, keep checking for proper cursor
19671 position even if one has been found already, because buffer
19672 positions in such rows change non-linearly with ROW->VPOS,
19673 when a line is continued. One exception: when we are at ZV,
19674 display cursor on the first suitable glyph row, since all
19675 the empty rows after that also have their position set to ZV. */
19676 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19677 lines' rows is implemented for bidi-reordered rows. */
19679 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19680 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19681 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19682 && cursor_row_p (row
))
19683 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19685 /* Prepare for the next line. This line starts horizontally at (X
19686 HPOS) = (0 0). Vertical positions are incremented. As a
19687 convenience for the caller, IT->glyph_row is set to the next
19689 it
->current_x
= it
->hpos
= 0;
19690 it
->current_y
+= row
->height
;
19691 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19694 /* The next row should by default use the same value of the
19695 reversed_p flag as this one. set_iterator_to_next decides when
19696 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19697 the flag accordingly. */
19698 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19699 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19700 it
->start
= row
->end
;
19701 return row
->displays_text_p
;
19703 #undef RECORD_MAX_MIN_POS
19706 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19707 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19708 doc
: /* Return paragraph direction at point in BUFFER.
19709 Value is either `left-to-right' or `right-to-left'.
19710 If BUFFER is omitted or nil, it defaults to the current buffer.
19712 Paragraph direction determines how the text in the paragraph is displayed.
19713 In left-to-right paragraphs, text begins at the left margin of the window
19714 and the reading direction is generally left to right. In right-to-left
19715 paragraphs, text begins at the right margin and is read from right to left.
19717 See also `bidi-paragraph-direction'. */)
19718 (Lisp_Object buffer
)
19720 struct buffer
*buf
= current_buffer
;
19721 struct buffer
*old
= buf
;
19723 if (! NILP (buffer
))
19725 CHECK_BUFFER (buffer
);
19726 buf
= XBUFFER (buffer
);
19729 if (NILP (BVAR (buf
, bidi_display_reordering
))
19730 || NILP (BVAR (buf
, enable_multibyte_characters
))
19731 /* When we are loading loadup.el, the character property tables
19732 needed for bidi iteration are not yet available. */
19733 || !NILP (Vpurify_flag
))
19734 return Qleft_to_right
;
19735 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19736 return BVAR (buf
, bidi_paragraph_direction
);
19739 /* Determine the direction from buffer text. We could try to
19740 use current_matrix if it is up to date, but this seems fast
19741 enough as it is. */
19742 struct bidi_it itb
;
19743 EMACS_INT pos
= BUF_PT (buf
);
19744 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19746 void *itb_data
= bidi_shelve_cache ();
19748 set_buffer_temp (buf
);
19749 /* bidi_paragraph_init finds the base direction of the paragraph
19750 by searching forward from paragraph start. We need the base
19751 direction of the current or _previous_ paragraph, so we need
19752 to make sure we are within that paragraph. To that end, find
19753 the previous non-empty line. */
19754 if (pos
>= ZV
&& pos
> BEGV
)
19757 bytepos
= CHAR_TO_BYTE (pos
);
19759 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19760 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19762 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19763 || c
== ' ' || c
== '\t' || c
== '\f')
19765 if (bytepos
<= BEGV_BYTE
)
19770 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19773 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19774 itb
.paragraph_dir
= NEUTRAL_DIR
;
19775 itb
.string
.s
= NULL
;
19776 itb
.string
.lstring
= Qnil
;
19777 itb
.string
.bufpos
= 0;
19778 itb
.string
.unibyte
= 0;
19779 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19780 bidi_unshelve_cache (itb_data
, 0);
19781 set_buffer_temp (old
);
19782 switch (itb
.paragraph_dir
)
19785 return Qleft_to_right
;
19788 return Qright_to_left
;
19798 /***********************************************************************
19800 ***********************************************************************/
19802 /* Redisplay the menu bar in the frame for window W.
19804 The menu bar of X frames that don't have X toolkit support is
19805 displayed in a special window W->frame->menu_bar_window.
19807 The menu bar of terminal frames is treated specially as far as
19808 glyph matrices are concerned. Menu bar lines are not part of
19809 windows, so the update is done directly on the frame matrix rows
19810 for the menu bar. */
19813 display_menu_bar (struct window
*w
)
19815 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19820 /* Don't do all this for graphical frames. */
19822 if (FRAME_W32_P (f
))
19825 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19831 if (FRAME_NS_P (f
))
19833 #endif /* HAVE_NS */
19835 #ifdef USE_X_TOOLKIT
19836 xassert (!FRAME_WINDOW_P (f
));
19837 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19838 it
.first_visible_x
= 0;
19839 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19840 #else /* not USE_X_TOOLKIT */
19841 if (FRAME_WINDOW_P (f
))
19843 /* Menu bar lines are displayed in the desired matrix of the
19844 dummy window menu_bar_window. */
19845 struct window
*menu_w
;
19846 xassert (WINDOWP (f
->menu_bar_window
));
19847 menu_w
= XWINDOW (f
->menu_bar_window
);
19848 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19850 it
.first_visible_x
= 0;
19851 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19855 /* This is a TTY frame, i.e. character hpos/vpos are used as
19857 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19859 it
.first_visible_x
= 0;
19860 it
.last_visible_x
= FRAME_COLS (f
);
19862 #endif /* not USE_X_TOOLKIT */
19864 /* FIXME: This should be controlled by a user option. See the
19865 comments in redisplay_tool_bar and display_mode_line about
19867 it
.paragraph_embedding
= L2R
;
19869 if (! mode_line_inverse_video
)
19870 /* Force the menu-bar to be displayed in the default face. */
19871 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19873 /* Clear all rows of the menu bar. */
19874 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19876 struct glyph_row
*row
= it
.glyph_row
+ i
;
19877 clear_glyph_row (row
);
19878 row
->enabled_p
= 1;
19879 row
->full_width_p
= 1;
19882 /* Display all items of the menu bar. */
19883 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19884 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19886 Lisp_Object string
;
19888 /* Stop at nil string. */
19889 string
= AREF (items
, i
+ 1);
19893 /* Remember where item was displayed. */
19894 ASET (items
, i
+ 3, make_number (it
.hpos
));
19896 /* Display the item, pad with one space. */
19897 if (it
.current_x
< it
.last_visible_x
)
19898 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19899 SCHARS (string
) + 1, 0, 0, -1);
19902 /* Fill out the line with spaces. */
19903 if (it
.current_x
< it
.last_visible_x
)
19904 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19906 /* Compute the total height of the lines. */
19907 compute_line_metrics (&it
);
19912 /***********************************************************************
19914 ***********************************************************************/
19916 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19917 FORCE is non-zero, redisplay mode lines unconditionally.
19918 Otherwise, redisplay only mode lines that are garbaged. Value is
19919 the number of windows whose mode lines were redisplayed. */
19922 redisplay_mode_lines (Lisp_Object window
, int force
)
19926 while (!NILP (window
))
19928 struct window
*w
= XWINDOW (window
);
19930 if (WINDOWP (w
->hchild
))
19931 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19932 else if (WINDOWP (w
->vchild
))
19933 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19935 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19936 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19938 struct text_pos lpoint
;
19939 struct buffer
*old
= current_buffer
;
19941 /* Set the window's buffer for the mode line display. */
19942 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19943 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19945 /* Point refers normally to the selected window. For any
19946 other window, set up appropriate value. */
19947 if (!EQ (window
, selected_window
))
19949 struct text_pos pt
;
19951 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19952 if (CHARPOS (pt
) < BEGV
)
19953 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19954 else if (CHARPOS (pt
) > (ZV
- 1))
19955 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19957 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19960 /* Display mode lines. */
19961 clear_glyph_matrix (w
->desired_matrix
);
19962 if (display_mode_lines (w
))
19965 w
->must_be_updated_p
= 1;
19968 /* Restore old settings. */
19969 set_buffer_internal_1 (old
);
19970 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19980 /* Display the mode and/or header line of window W. Value is the
19981 sum number of mode lines and header lines displayed. */
19984 display_mode_lines (struct window
*w
)
19986 Lisp_Object old_selected_window
, old_selected_frame
;
19989 old_selected_frame
= selected_frame
;
19990 selected_frame
= w
->frame
;
19991 old_selected_window
= selected_window
;
19992 XSETWINDOW (selected_window
, w
);
19994 /* These will be set while the mode line specs are processed. */
19995 line_number_displayed
= 0;
19996 w
->column_number_displayed
= Qnil
;
19998 if (WINDOW_WANTS_MODELINE_P (w
))
20000 struct window
*sel_w
= XWINDOW (old_selected_window
);
20002 /* Select mode line face based on the real selected window. */
20003 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20004 BVAR (current_buffer
, mode_line_format
));
20008 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20010 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20011 BVAR (current_buffer
, header_line_format
));
20015 selected_frame
= old_selected_frame
;
20016 selected_window
= old_selected_window
;
20021 /* Display mode or header line of window W. FACE_ID specifies which
20022 line to display; it is either MODE_LINE_FACE_ID or
20023 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20024 display. Value is the pixel height of the mode/header line
20028 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20032 int count
= SPECPDL_INDEX ();
20034 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20035 /* Don't extend on a previously drawn mode-line.
20036 This may happen if called from pos_visible_p. */
20037 it
.glyph_row
->enabled_p
= 0;
20038 prepare_desired_row (it
.glyph_row
);
20040 it
.glyph_row
->mode_line_p
= 1;
20042 if (! mode_line_inverse_video
)
20043 /* Force the mode-line to be displayed in the default face. */
20044 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20046 /* FIXME: This should be controlled by a user option. But
20047 supporting such an option is not trivial, since the mode line is
20048 made up of many separate strings. */
20049 it
.paragraph_embedding
= L2R
;
20051 record_unwind_protect (unwind_format_mode_line
,
20052 format_mode_line_unwind_data (NULL
, Qnil
, 0));
20054 mode_line_target
= MODE_LINE_DISPLAY
;
20056 /* Temporarily make frame's keyboard the current kboard so that
20057 kboard-local variables in the mode_line_format will get the right
20059 push_kboard (FRAME_KBOARD (it
.f
));
20060 record_unwind_save_match_data ();
20061 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20064 unbind_to (count
, Qnil
);
20066 /* Fill up with spaces. */
20067 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20069 compute_line_metrics (&it
);
20070 it
.glyph_row
->full_width_p
= 1;
20071 it
.glyph_row
->continued_p
= 0;
20072 it
.glyph_row
->truncated_on_left_p
= 0;
20073 it
.glyph_row
->truncated_on_right_p
= 0;
20075 /* Make a 3D mode-line have a shadow at its right end. */
20076 face
= FACE_FROM_ID (it
.f
, face_id
);
20077 extend_face_to_end_of_line (&it
);
20078 if (face
->box
!= FACE_NO_BOX
)
20080 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20081 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20082 last
->right_box_line_p
= 1;
20085 return it
.glyph_row
->height
;
20088 /* Move element ELT in LIST to the front of LIST.
20089 Return the updated list. */
20092 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20094 register Lisp_Object tail
, prev
;
20095 register Lisp_Object tem
;
20099 while (CONSP (tail
))
20105 /* Splice out the link TAIL. */
20107 list
= XCDR (tail
);
20109 Fsetcdr (prev
, XCDR (tail
));
20111 /* Now make it the first. */
20112 Fsetcdr (tail
, list
);
20117 tail
= XCDR (tail
);
20121 /* Not found--return unchanged LIST. */
20125 /* Contribute ELT to the mode line for window IT->w. How it
20126 translates into text depends on its data type.
20128 IT describes the display environment in which we display, as usual.
20130 DEPTH is the depth in recursion. It is used to prevent
20131 infinite recursion here.
20133 FIELD_WIDTH is the number of characters the display of ELT should
20134 occupy in the mode line, and PRECISION is the maximum number of
20135 characters to display from ELT's representation. See
20136 display_string for details.
20138 Returns the hpos of the end of the text generated by ELT.
20140 PROPS is a property list to add to any string we encounter.
20142 If RISKY is nonzero, remove (disregard) any properties in any string
20143 we encounter, and ignore :eval and :propertize.
20145 The global variable `mode_line_target' determines whether the
20146 output is passed to `store_mode_line_noprop',
20147 `store_mode_line_string', or `display_string'. */
20150 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20151 Lisp_Object elt
, Lisp_Object props
, int risky
)
20153 int n
= 0, field
, prec
;
20158 elt
= build_string ("*too-deep*");
20162 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20166 /* A string: output it and check for %-constructs within it. */
20168 EMACS_INT offset
= 0;
20170 if (SCHARS (elt
) > 0
20171 && (!NILP (props
) || risky
))
20173 Lisp_Object oprops
, aelt
;
20174 oprops
= Ftext_properties_at (make_number (0), elt
);
20176 /* If the starting string's properties are not what
20177 we want, translate the string. Also, if the string
20178 is risky, do that anyway. */
20180 if (NILP (Fequal (props
, oprops
)) || risky
)
20182 /* If the starting string has properties,
20183 merge the specified ones onto the existing ones. */
20184 if (! NILP (oprops
) && !risky
)
20188 oprops
= Fcopy_sequence (oprops
);
20190 while (CONSP (tem
))
20192 oprops
= Fplist_put (oprops
, XCAR (tem
),
20193 XCAR (XCDR (tem
)));
20194 tem
= XCDR (XCDR (tem
));
20199 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20200 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20202 /* AELT is what we want. Move it to the front
20203 without consing. */
20205 mode_line_proptrans_alist
20206 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20212 /* If AELT has the wrong props, it is useless.
20213 so get rid of it. */
20215 mode_line_proptrans_alist
20216 = Fdelq (aelt
, mode_line_proptrans_alist
);
20218 elt
= Fcopy_sequence (elt
);
20219 Fset_text_properties (make_number (0), Flength (elt
),
20221 /* Add this item to mode_line_proptrans_alist. */
20222 mode_line_proptrans_alist
20223 = Fcons (Fcons (elt
, props
),
20224 mode_line_proptrans_alist
);
20225 /* Truncate mode_line_proptrans_alist
20226 to at most 50 elements. */
20227 tem
= Fnthcdr (make_number (50),
20228 mode_line_proptrans_alist
);
20230 XSETCDR (tem
, Qnil
);
20239 prec
= precision
- n
;
20240 switch (mode_line_target
)
20242 case MODE_LINE_NOPROP
:
20243 case MODE_LINE_TITLE
:
20244 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20246 case MODE_LINE_STRING
:
20247 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20249 case MODE_LINE_DISPLAY
:
20250 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20251 0, prec
, 0, STRING_MULTIBYTE (elt
));
20258 /* Handle the non-literal case. */
20260 while ((precision
<= 0 || n
< precision
)
20261 && SREF (elt
, offset
) != 0
20262 && (mode_line_target
!= MODE_LINE_DISPLAY
20263 || it
->current_x
< it
->last_visible_x
))
20265 EMACS_INT last_offset
= offset
;
20267 /* Advance to end of string or next format specifier. */
20268 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20271 if (offset
- 1 != last_offset
)
20273 EMACS_INT nchars
, nbytes
;
20275 /* Output to end of string or up to '%'. Field width
20276 is length of string. Don't output more than
20277 PRECISION allows us. */
20280 prec
= c_string_width (SDATA (elt
) + last_offset
,
20281 offset
- last_offset
, precision
- n
,
20284 switch (mode_line_target
)
20286 case MODE_LINE_NOPROP
:
20287 case MODE_LINE_TITLE
:
20288 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20290 case MODE_LINE_STRING
:
20292 EMACS_INT bytepos
= last_offset
;
20293 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20294 EMACS_INT endpos
= (precision
<= 0
20295 ? string_byte_to_char (elt
, offset
)
20296 : charpos
+ nchars
);
20298 n
+= store_mode_line_string (NULL
,
20299 Fsubstring (elt
, make_number (charpos
),
20300 make_number (endpos
)),
20304 case MODE_LINE_DISPLAY
:
20306 EMACS_INT bytepos
= last_offset
;
20307 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20309 if (precision
<= 0)
20310 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20311 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20313 STRING_MULTIBYTE (elt
));
20318 else /* c == '%' */
20320 EMACS_INT percent_position
= offset
;
20322 /* Get the specified minimum width. Zero means
20325 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20326 field
= field
* 10 + c
- '0';
20328 /* Don't pad beyond the total padding allowed. */
20329 if (field_width
- n
> 0 && field
> field_width
- n
)
20330 field
= field_width
- n
;
20332 /* Note that either PRECISION <= 0 or N < PRECISION. */
20333 prec
= precision
- n
;
20336 n
+= display_mode_element (it
, depth
, field
, prec
,
20337 Vglobal_mode_string
, props
,
20342 EMACS_INT bytepos
, charpos
;
20344 Lisp_Object string
;
20346 bytepos
= percent_position
;
20347 charpos
= (STRING_MULTIBYTE (elt
)
20348 ? string_byte_to_char (elt
, bytepos
)
20350 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20351 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20353 switch (mode_line_target
)
20355 case MODE_LINE_NOPROP
:
20356 case MODE_LINE_TITLE
:
20357 n
+= store_mode_line_noprop (spec
, field
, prec
);
20359 case MODE_LINE_STRING
:
20361 Lisp_Object tem
= build_string (spec
);
20362 props
= Ftext_properties_at (make_number (charpos
), elt
);
20363 /* Should only keep face property in props */
20364 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20367 case MODE_LINE_DISPLAY
:
20369 int nglyphs_before
, nwritten
;
20371 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20372 nwritten
= display_string (spec
, string
, elt
,
20377 /* Assign to the glyphs written above the
20378 string where the `%x' came from, position
20382 struct glyph
*glyph
20383 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20387 for (i
= 0; i
< nwritten
; ++i
)
20389 glyph
[i
].object
= elt
;
20390 glyph
[i
].charpos
= charpos
;
20407 /* A symbol: process the value of the symbol recursively
20408 as if it appeared here directly. Avoid error if symbol void.
20409 Special case: if value of symbol is a string, output the string
20412 register Lisp_Object tem
;
20414 /* If the variable is not marked as risky to set
20415 then its contents are risky to use. */
20416 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20419 tem
= Fboundp (elt
);
20422 tem
= Fsymbol_value (elt
);
20423 /* If value is a string, output that string literally:
20424 don't check for % within it. */
20428 if (!EQ (tem
, elt
))
20430 /* Give up right away for nil or t. */
20440 register Lisp_Object car
, tem
;
20442 /* A cons cell: five distinct cases.
20443 If first element is :eval or :propertize, do something special.
20444 If first element is a string or a cons, process all the elements
20445 and effectively concatenate them.
20446 If first element is a negative number, truncate displaying cdr to
20447 at most that many characters. If positive, pad (with spaces)
20448 to at least that many characters.
20449 If first element is a symbol, process the cadr or caddr recursively
20450 according to whether the symbol's value is non-nil or nil. */
20452 if (EQ (car
, QCeval
))
20454 /* An element of the form (:eval FORM) means evaluate FORM
20455 and use the result as mode line elements. */
20460 if (CONSP (XCDR (elt
)))
20463 spec
= safe_eval (XCAR (XCDR (elt
)));
20464 n
+= display_mode_element (it
, depth
, field_width
- n
,
20465 precision
- n
, spec
, props
,
20469 else if (EQ (car
, QCpropertize
))
20471 /* An element of the form (:propertize ELT PROPS...)
20472 means display ELT but applying properties PROPS. */
20477 if (CONSP (XCDR (elt
)))
20478 n
+= display_mode_element (it
, depth
, field_width
- n
,
20479 precision
- n
, XCAR (XCDR (elt
)),
20480 XCDR (XCDR (elt
)), risky
);
20482 else if (SYMBOLP (car
))
20484 tem
= Fboundp (car
);
20488 /* elt is now the cdr, and we know it is a cons cell.
20489 Use its car if CAR has a non-nil value. */
20492 tem
= Fsymbol_value (car
);
20499 /* Symbol's value is nil (or symbol is unbound)
20500 Get the cddr of the original list
20501 and if possible find the caddr and use that. */
20505 else if (!CONSP (elt
))
20510 else if (INTEGERP (car
))
20512 register int lim
= XINT (car
);
20516 /* Negative int means reduce maximum width. */
20517 if (precision
<= 0)
20520 precision
= min (precision
, -lim
);
20524 /* Padding specified. Don't let it be more than
20525 current maximum. */
20527 lim
= min (precision
, lim
);
20529 /* If that's more padding than already wanted, queue it.
20530 But don't reduce padding already specified even if
20531 that is beyond the current truncation point. */
20532 field_width
= max (lim
, field_width
);
20536 else if (STRINGP (car
) || CONSP (car
))
20538 Lisp_Object halftail
= elt
;
20542 && (precision
<= 0 || n
< precision
))
20544 n
+= display_mode_element (it
, depth
,
20545 /* Do padding only after the last
20546 element in the list. */
20547 (! CONSP (XCDR (elt
))
20550 precision
- n
, XCAR (elt
),
20554 if ((len
& 1) == 0)
20555 halftail
= XCDR (halftail
);
20556 /* Check for cycle. */
20557 if (EQ (halftail
, elt
))
20566 elt
= build_string ("*invalid*");
20570 /* Pad to FIELD_WIDTH. */
20571 if (field_width
> 0 && n
< field_width
)
20573 switch (mode_line_target
)
20575 case MODE_LINE_NOPROP
:
20576 case MODE_LINE_TITLE
:
20577 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20579 case MODE_LINE_STRING
:
20580 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20582 case MODE_LINE_DISPLAY
:
20583 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20592 /* Store a mode-line string element in mode_line_string_list.
20594 If STRING is non-null, display that C string. Otherwise, the Lisp
20595 string LISP_STRING is displayed.
20597 FIELD_WIDTH is the minimum number of output glyphs to produce.
20598 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20599 with spaces. FIELD_WIDTH <= 0 means don't pad.
20601 PRECISION is the maximum number of characters to output from
20602 STRING. PRECISION <= 0 means don't truncate the string.
20604 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20605 properties to the string.
20607 PROPS are the properties to add to the string.
20608 The mode_line_string_face face property is always added to the string.
20612 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20613 int field_width
, int precision
, Lisp_Object props
)
20618 if (string
!= NULL
)
20620 len
= strlen (string
);
20621 if (precision
> 0 && len
> precision
)
20623 lisp_string
= make_string (string
, len
);
20625 props
= mode_line_string_face_prop
;
20626 else if (!NILP (mode_line_string_face
))
20628 Lisp_Object face
= Fplist_get (props
, Qface
);
20629 props
= Fcopy_sequence (props
);
20631 face
= mode_line_string_face
;
20633 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20634 props
= Fplist_put (props
, Qface
, face
);
20636 Fadd_text_properties (make_number (0), make_number (len
),
20637 props
, lisp_string
);
20641 len
= XFASTINT (Flength (lisp_string
));
20642 if (precision
> 0 && len
> precision
)
20645 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20648 if (!NILP (mode_line_string_face
))
20652 props
= Ftext_properties_at (make_number (0), lisp_string
);
20653 face
= Fplist_get (props
, Qface
);
20655 face
= mode_line_string_face
;
20657 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20658 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20660 lisp_string
= Fcopy_sequence (lisp_string
);
20663 Fadd_text_properties (make_number (0), make_number (len
),
20664 props
, lisp_string
);
20669 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20673 if (field_width
> len
)
20675 field_width
-= len
;
20676 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20678 Fadd_text_properties (make_number (0), make_number (field_width
),
20679 props
, lisp_string
);
20680 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20688 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20690 doc
: /* Format a string out of a mode line format specification.
20691 First arg FORMAT specifies the mode line format (see `mode-line-format'
20692 for details) to use.
20694 By default, the format is evaluated for the currently selected window.
20696 Optional second arg FACE specifies the face property to put on all
20697 characters for which no face is specified. The value nil means the
20698 default face. The value t means whatever face the window's mode line
20699 currently uses (either `mode-line' or `mode-line-inactive',
20700 depending on whether the window is the selected window or not).
20701 An integer value means the value string has no text
20704 Optional third and fourth args WINDOW and BUFFER specify the window
20705 and buffer to use as the context for the formatting (defaults
20706 are the selected window and the WINDOW's buffer). */)
20707 (Lisp_Object format
, Lisp_Object face
,
20708 Lisp_Object window
, Lisp_Object buffer
)
20713 struct buffer
*old_buffer
= NULL
;
20715 int no_props
= INTEGERP (face
);
20716 int count
= SPECPDL_INDEX ();
20718 int string_start
= 0;
20721 window
= selected_window
;
20722 CHECK_WINDOW (window
);
20723 w
= XWINDOW (window
);
20726 buffer
= w
->buffer
;
20727 CHECK_BUFFER (buffer
);
20729 /* Make formatting the modeline a non-op when noninteractive, otherwise
20730 there will be problems later caused by a partially initialized frame. */
20731 if (NILP (format
) || noninteractive
)
20732 return empty_unibyte_string
;
20737 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20738 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20739 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20740 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20741 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20742 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20743 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20746 if (XBUFFER (buffer
) != current_buffer
)
20747 old_buffer
= current_buffer
;
20749 /* Save things including mode_line_proptrans_alist,
20750 and set that to nil so that we don't alter the outer value. */
20751 record_unwind_protect (unwind_format_mode_line
,
20752 format_mode_line_unwind_data
20753 (old_buffer
, selected_window
, 1));
20754 mode_line_proptrans_alist
= Qnil
;
20756 Fselect_window (window
, Qt
);
20758 set_buffer_internal_1 (XBUFFER (buffer
));
20760 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20764 mode_line_target
= MODE_LINE_NOPROP
;
20765 mode_line_string_face_prop
= Qnil
;
20766 mode_line_string_list
= Qnil
;
20767 string_start
= MODE_LINE_NOPROP_LEN (0);
20771 mode_line_target
= MODE_LINE_STRING
;
20772 mode_line_string_list
= Qnil
;
20773 mode_line_string_face
= face
;
20774 mode_line_string_face_prop
20775 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20778 push_kboard (FRAME_KBOARD (it
.f
));
20779 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20784 len
= MODE_LINE_NOPROP_LEN (string_start
);
20785 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20789 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20790 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20791 empty_unibyte_string
);
20794 unbind_to (count
, Qnil
);
20798 /* Write a null-terminated, right justified decimal representation of
20799 the positive integer D to BUF using a minimal field width WIDTH. */
20802 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20804 register char *p
= buf
;
20812 *p
++ = d
% 10 + '0';
20817 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20828 /* Write a null-terminated, right justified decimal and "human
20829 readable" representation of the nonnegative integer D to BUF using
20830 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20832 static const char power_letter
[] =
20846 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20848 /* We aim to represent the nonnegative integer D as
20849 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20850 EMACS_INT quotient
= d
;
20852 /* -1 means: do not use TENTHS. */
20856 /* Length of QUOTIENT.TENTHS as a string. */
20862 if (1000 <= quotient
)
20864 /* Scale to the appropriate EXPONENT. */
20867 remainder
= quotient
% 1000;
20871 while (1000 <= quotient
);
20873 /* Round to nearest and decide whether to use TENTHS or not. */
20876 tenths
= remainder
/ 100;
20877 if (50 <= remainder
% 100)
20884 if (quotient
== 10)
20892 if (500 <= remainder
)
20894 if (quotient
< 999)
20905 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20906 if (tenths
== -1 && quotient
<= 99)
20913 p
= psuffix
= buf
+ max (width
, length
);
20915 /* Print EXPONENT. */
20916 *psuffix
++ = power_letter
[exponent
];
20919 /* Print TENTHS. */
20922 *--p
= '0' + tenths
;
20926 /* Print QUOTIENT. */
20929 int digit
= quotient
% 10;
20930 *--p
= '0' + digit
;
20932 while ((quotient
/= 10) != 0);
20934 /* Print leading spaces. */
20939 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20940 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20941 type of CODING_SYSTEM. Return updated pointer into BUF. */
20943 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20946 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20949 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20950 const unsigned char *eol_str
;
20952 /* The EOL conversion we are using. */
20953 Lisp_Object eoltype
;
20955 val
= CODING_SYSTEM_SPEC (coding_system
);
20958 if (!VECTORP (val
)) /* Not yet decided. */
20963 eoltype
= eol_mnemonic_undecided
;
20964 /* Don't mention EOL conversion if it isn't decided. */
20969 Lisp_Object eolvalue
;
20971 attrs
= AREF (val
, 0);
20972 eolvalue
= AREF (val
, 2);
20975 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20979 /* The EOL conversion that is normal on this system. */
20981 if (NILP (eolvalue
)) /* Not yet decided. */
20982 eoltype
= eol_mnemonic_undecided
;
20983 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20984 eoltype
= eol_mnemonic_undecided
;
20985 else /* eolvalue is Qunix, Qdos, or Qmac. */
20986 eoltype
= (EQ (eolvalue
, Qunix
)
20987 ? eol_mnemonic_unix
20988 : (EQ (eolvalue
, Qdos
) == 1
20989 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20995 /* Mention the EOL conversion if it is not the usual one. */
20996 if (STRINGP (eoltype
))
20998 eol_str
= SDATA (eoltype
);
20999 eol_str_len
= SBYTES (eoltype
);
21001 else if (CHARACTERP (eoltype
))
21003 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
21004 int c
= XFASTINT (eoltype
);
21005 eol_str_len
= CHAR_STRING (c
, tmp
);
21010 eol_str
= invalid_eol_type
;
21011 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21013 memcpy (buf
, eol_str
, eol_str_len
);
21014 buf
+= eol_str_len
;
21020 /* Return a string for the output of a mode line %-spec for window W,
21021 generated by character C. FIELD_WIDTH > 0 means pad the string
21022 returned with spaces to that value. Return a Lisp string in
21023 *STRING if the resulting string is taken from that Lisp string.
21025 Note we operate on the current buffer for most purposes,
21026 the exception being w->base_line_pos. */
21028 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21030 static const char *
21031 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21032 Lisp_Object
*string
)
21035 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21036 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21037 struct buffer
*b
= current_buffer
;
21045 if (!NILP (BVAR (b
, read_only
)))
21047 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21052 /* This differs from %* only for a modified read-only buffer. */
21053 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21055 if (!NILP (BVAR (b
, read_only
)))
21060 /* This differs from %* in ignoring read-only-ness. */
21061 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21073 if (command_loop_level
> 5)
21075 p
= decode_mode_spec_buf
;
21076 for (i
= 0; i
< command_loop_level
; i
++)
21079 return decode_mode_spec_buf
;
21087 if (command_loop_level
> 5)
21089 p
= decode_mode_spec_buf
;
21090 for (i
= 0; i
< command_loop_level
; i
++)
21093 return decode_mode_spec_buf
;
21100 /* Let lots_of_dashes be a string of infinite length. */
21101 if (mode_line_target
== MODE_LINE_NOPROP
||
21102 mode_line_target
== MODE_LINE_STRING
)
21104 if (field_width
<= 0
21105 || field_width
> sizeof (lots_of_dashes
))
21107 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21108 decode_mode_spec_buf
[i
] = '-';
21109 decode_mode_spec_buf
[i
] = '\0';
21110 return decode_mode_spec_buf
;
21113 return lots_of_dashes
;
21117 obj
= BVAR (b
, name
);
21121 /* %c and %l are ignored in `frame-title-format'.
21122 (In redisplay_internal, the frame title is drawn _before_ the
21123 windows are updated, so the stuff which depends on actual
21124 window contents (such as %l) may fail to render properly, or
21125 even crash emacs.) */
21126 if (mode_line_target
== MODE_LINE_TITLE
)
21130 EMACS_INT col
= current_column ();
21131 w
->column_number_displayed
= make_number (col
);
21132 pint2str (decode_mode_spec_buf
, field_width
, col
);
21133 return decode_mode_spec_buf
;
21137 #ifndef SYSTEM_MALLOC
21139 if (NILP (Vmemory_full
))
21142 return "!MEM FULL! ";
21149 /* %F displays the frame name. */
21150 if (!NILP (f
->title
))
21151 return SSDATA (f
->title
);
21152 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21153 return SSDATA (f
->name
);
21157 obj
= BVAR (b
, filename
);
21162 EMACS_INT size
= ZV
- BEGV
;
21163 pint2str (decode_mode_spec_buf
, field_width
, size
);
21164 return decode_mode_spec_buf
;
21169 EMACS_INT size
= ZV
- BEGV
;
21170 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21171 return decode_mode_spec_buf
;
21176 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21177 EMACS_INT topline
, nlines
, height
;
21180 /* %c and %l are ignored in `frame-title-format'. */
21181 if (mode_line_target
== MODE_LINE_TITLE
)
21184 startpos
= XMARKER (w
->start
)->charpos
;
21185 startpos_byte
= marker_byte_position (w
->start
);
21186 height
= WINDOW_TOTAL_LINES (w
);
21188 /* If we decided that this buffer isn't suitable for line numbers,
21189 don't forget that too fast. */
21190 if (EQ (w
->base_line_pos
, w
->buffer
))
21192 /* But do forget it, if the window shows a different buffer now. */
21193 else if (BUFFERP (w
->base_line_pos
))
21194 w
->base_line_pos
= Qnil
;
21196 /* If the buffer is very big, don't waste time. */
21197 if (INTEGERP (Vline_number_display_limit
)
21198 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21200 w
->base_line_pos
= Qnil
;
21201 w
->base_line_number
= Qnil
;
21205 if (INTEGERP (w
->base_line_number
)
21206 && INTEGERP (w
->base_line_pos
)
21207 && XFASTINT (w
->base_line_pos
) <= startpos
)
21209 line
= XFASTINT (w
->base_line_number
);
21210 linepos
= XFASTINT (w
->base_line_pos
);
21211 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21216 linepos
= BUF_BEGV (b
);
21217 linepos_byte
= BUF_BEGV_BYTE (b
);
21220 /* Count lines from base line to window start position. */
21221 nlines
= display_count_lines (linepos_byte
,
21225 topline
= nlines
+ line
;
21227 /* Determine a new base line, if the old one is too close
21228 or too far away, or if we did not have one.
21229 "Too close" means it's plausible a scroll-down would
21230 go back past it. */
21231 if (startpos
== BUF_BEGV (b
))
21233 w
->base_line_number
= make_number (topline
);
21234 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21236 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21237 || linepos
== BUF_BEGV (b
))
21239 EMACS_INT limit
= BUF_BEGV (b
);
21240 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21241 EMACS_INT position
;
21242 EMACS_INT distance
=
21243 (height
* 2 + 30) * line_number_display_limit_width
;
21245 if (startpos
- distance
> limit
)
21247 limit
= startpos
- distance
;
21248 limit_byte
= CHAR_TO_BYTE (limit
);
21251 nlines
= display_count_lines (startpos_byte
,
21253 - (height
* 2 + 30),
21255 /* If we couldn't find the lines we wanted within
21256 line_number_display_limit_width chars per line,
21257 give up on line numbers for this window. */
21258 if (position
== limit_byte
&& limit
== startpos
- distance
)
21260 w
->base_line_pos
= w
->buffer
;
21261 w
->base_line_number
= Qnil
;
21265 w
->base_line_number
= make_number (topline
- nlines
);
21266 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21269 /* Now count lines from the start pos to point. */
21270 nlines
= display_count_lines (startpos_byte
,
21271 PT_BYTE
, PT
, &junk
);
21273 /* Record that we did display the line number. */
21274 line_number_displayed
= 1;
21276 /* Make the string to show. */
21277 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21278 return decode_mode_spec_buf
;
21281 char* p
= decode_mode_spec_buf
;
21282 int pad
= field_width
- 2;
21288 return decode_mode_spec_buf
;
21294 obj
= BVAR (b
, mode_name
);
21298 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21304 EMACS_INT pos
= marker_position (w
->start
);
21305 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21307 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21309 if (pos
<= BUF_BEGV (b
))
21314 else if (pos
<= BUF_BEGV (b
))
21318 if (total
> 1000000)
21319 /* Do it differently for a large value, to avoid overflow. */
21320 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21322 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21323 /* We can't normally display a 3-digit number,
21324 so get us a 2-digit number that is close. */
21327 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21328 return decode_mode_spec_buf
;
21332 /* Display percentage of size above the bottom of the screen. */
21335 EMACS_INT toppos
= marker_position (w
->start
);
21336 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21337 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21339 if (botpos
>= BUF_ZV (b
))
21341 if (toppos
<= BUF_BEGV (b
))
21348 if (total
> 1000000)
21349 /* Do it differently for a large value, to avoid overflow. */
21350 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21352 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21353 /* We can't normally display a 3-digit number,
21354 so get us a 2-digit number that is close. */
21357 if (toppos
<= BUF_BEGV (b
))
21358 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21360 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21361 return decode_mode_spec_buf
;
21366 /* status of process */
21367 obj
= Fget_buffer_process (Fcurrent_buffer ());
21369 return "no process";
21371 obj
= Fsymbol_name (Fprocess_status (obj
));
21377 int count
= inhibit_garbage_collection ();
21378 Lisp_Object val
= call1 (intern ("file-remote-p"),
21379 BVAR (current_buffer
, directory
));
21380 unbind_to (count
, Qnil
);
21388 case 't': /* indicate TEXT or BINARY */
21392 /* coding-system (not including end-of-line format) */
21394 /* coding-system (including end-of-line type) */
21396 int eol_flag
= (c
== 'Z');
21397 char *p
= decode_mode_spec_buf
;
21399 if (! FRAME_WINDOW_P (f
))
21401 /* No need to mention EOL here--the terminal never needs
21402 to do EOL conversion. */
21403 p
= decode_mode_spec_coding (CODING_ID_NAME
21404 (FRAME_KEYBOARD_CODING (f
)->id
),
21406 p
= decode_mode_spec_coding (CODING_ID_NAME
21407 (FRAME_TERMINAL_CODING (f
)->id
),
21410 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21413 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21414 #ifdef subprocesses
21415 obj
= Fget_buffer_process (Fcurrent_buffer ());
21416 if (PROCESSP (obj
))
21418 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21420 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21423 #endif /* subprocesses */
21426 return decode_mode_spec_buf
;
21433 return SSDATA (obj
);
21440 /* Count up to COUNT lines starting from START_BYTE.
21441 But don't go beyond LIMIT_BYTE.
21442 Return the number of lines thus found (always nonnegative).
21444 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21447 display_count_lines (EMACS_INT start_byte
,
21448 EMACS_INT limit_byte
, EMACS_INT count
,
21449 EMACS_INT
*byte_pos_ptr
)
21451 register unsigned char *cursor
;
21452 unsigned char *base
;
21454 register EMACS_INT ceiling
;
21455 register unsigned char *ceiling_addr
;
21456 EMACS_INT orig_count
= count
;
21458 /* If we are not in selective display mode,
21459 check only for newlines. */
21460 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21461 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21465 while (start_byte
< limit_byte
)
21467 ceiling
= BUFFER_CEILING_OF (start_byte
);
21468 ceiling
= min (limit_byte
- 1, ceiling
);
21469 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21470 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21473 if (selective_display
)
21474 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21477 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21480 if (cursor
!= ceiling_addr
)
21484 start_byte
+= cursor
- base
+ 1;
21485 *byte_pos_ptr
= start_byte
;
21489 if (++cursor
== ceiling_addr
)
21495 start_byte
+= cursor
- base
;
21500 while (start_byte
> limit_byte
)
21502 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21503 ceiling
= max (limit_byte
, ceiling
);
21504 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21505 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21508 if (selective_display
)
21509 while (--cursor
!= ceiling_addr
21510 && *cursor
!= '\n' && *cursor
!= 015)
21513 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21516 if (cursor
!= ceiling_addr
)
21520 start_byte
+= cursor
- base
+ 1;
21521 *byte_pos_ptr
= start_byte
;
21522 /* When scanning backwards, we should
21523 not count the newline posterior to which we stop. */
21524 return - orig_count
- 1;
21530 /* Here we add 1 to compensate for the last decrement
21531 of CURSOR, which took it past the valid range. */
21532 start_byte
+= cursor
- base
+ 1;
21536 *byte_pos_ptr
= limit_byte
;
21539 return - orig_count
+ count
;
21540 return orig_count
- count
;
21546 /***********************************************************************
21548 ***********************************************************************/
21550 /* Display a NUL-terminated string, starting with index START.
21552 If STRING is non-null, display that C string. Otherwise, the Lisp
21553 string LISP_STRING is displayed. There's a case that STRING is
21554 non-null and LISP_STRING is not nil. It means STRING is a string
21555 data of LISP_STRING. In that case, we display LISP_STRING while
21556 ignoring its text properties.
21558 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21559 FACE_STRING. Display STRING or LISP_STRING with the face at
21560 FACE_STRING_POS in FACE_STRING:
21562 Display the string in the environment given by IT, but use the
21563 standard display table, temporarily.
21565 FIELD_WIDTH is the minimum number of output glyphs to produce.
21566 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21567 with spaces. If STRING has more characters, more than FIELD_WIDTH
21568 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21570 PRECISION is the maximum number of characters to output from
21571 STRING. PRECISION < 0 means don't truncate the string.
21573 This is roughly equivalent to printf format specifiers:
21575 FIELD_WIDTH PRECISION PRINTF
21576 ----------------------------------------
21582 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21583 display them, and < 0 means obey the current buffer's value of
21584 enable_multibyte_characters.
21586 Value is the number of columns displayed. */
21589 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21590 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21591 int field_width
, int precision
, int max_x
, int multibyte
)
21593 int hpos_at_start
= it
->hpos
;
21594 int saved_face_id
= it
->face_id
;
21595 struct glyph_row
*row
= it
->glyph_row
;
21596 EMACS_INT it_charpos
;
21598 /* Initialize the iterator IT for iteration over STRING beginning
21599 with index START. */
21600 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21601 precision
, field_width
, multibyte
);
21602 if (string
&& STRINGP (lisp_string
))
21603 /* LISP_STRING is the one returned by decode_mode_spec. We should
21604 ignore its text properties. */
21605 it
->stop_charpos
= it
->end_charpos
;
21607 /* If displaying STRING, set up the face of the iterator from
21608 FACE_STRING, if that's given. */
21609 if (STRINGP (face_string
))
21615 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21616 0, it
->region_beg_charpos
,
21617 it
->region_end_charpos
,
21618 &endptr
, it
->base_face_id
, 0);
21619 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21620 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21623 /* Set max_x to the maximum allowed X position. Don't let it go
21624 beyond the right edge of the window. */
21626 max_x
= it
->last_visible_x
;
21628 max_x
= min (max_x
, it
->last_visible_x
);
21630 /* Skip over display elements that are not visible. because IT->w is
21632 if (it
->current_x
< it
->first_visible_x
)
21633 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21634 MOVE_TO_POS
| MOVE_TO_X
);
21636 row
->ascent
= it
->max_ascent
;
21637 row
->height
= it
->max_ascent
+ it
->max_descent
;
21638 row
->phys_ascent
= it
->max_phys_ascent
;
21639 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21640 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21642 if (STRINGP (it
->string
))
21643 it_charpos
= IT_STRING_CHARPOS (*it
);
21645 it_charpos
= IT_CHARPOS (*it
);
21647 /* This condition is for the case that we are called with current_x
21648 past last_visible_x. */
21649 while (it
->current_x
< max_x
)
21651 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21653 /* Get the next display element. */
21654 if (!get_next_display_element (it
))
21657 /* Produce glyphs. */
21658 x_before
= it
->current_x
;
21659 n_glyphs_before
= row
->used
[TEXT_AREA
];
21660 PRODUCE_GLYPHS (it
);
21662 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21665 while (i
< nglyphs
)
21667 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21669 if (it
->line_wrap
!= TRUNCATE
21670 && x
+ glyph
->pixel_width
> max_x
)
21672 /* End of continued line or max_x reached. */
21673 if (CHAR_GLYPH_PADDING_P (*glyph
))
21675 /* A wide character is unbreakable. */
21676 if (row
->reversed_p
)
21677 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21678 - n_glyphs_before
);
21679 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21680 it
->current_x
= x_before
;
21684 if (row
->reversed_p
)
21685 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21686 - (n_glyphs_before
+ i
));
21687 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21692 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21694 /* Glyph is at least partially visible. */
21696 if (x
< it
->first_visible_x
)
21697 row
->x
= x
- it
->first_visible_x
;
21701 /* Glyph is off the left margin of the display area.
21702 Should not happen. */
21706 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21707 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21708 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21709 row
->phys_height
= max (row
->phys_height
,
21710 it
->max_phys_ascent
+ it
->max_phys_descent
);
21711 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21712 it
->max_extra_line_spacing
);
21713 x
+= glyph
->pixel_width
;
21717 /* Stop if max_x reached. */
21721 /* Stop at line ends. */
21722 if (ITERATOR_AT_END_OF_LINE_P (it
))
21724 it
->continuation_lines_width
= 0;
21728 set_iterator_to_next (it
, 1);
21729 if (STRINGP (it
->string
))
21730 it_charpos
= IT_STRING_CHARPOS (*it
);
21732 it_charpos
= IT_CHARPOS (*it
);
21734 /* Stop if truncating at the right edge. */
21735 if (it
->line_wrap
== TRUNCATE
21736 && it
->current_x
>= it
->last_visible_x
)
21738 /* Add truncation mark, but don't do it if the line is
21739 truncated at a padding space. */
21740 if (it_charpos
< it
->string_nchars
)
21742 if (!FRAME_WINDOW_P (it
->f
))
21746 if (it
->current_x
> it
->last_visible_x
)
21748 if (!row
->reversed_p
)
21750 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21751 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21756 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21757 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21759 unproduce_glyphs (it
, ii
+ 1);
21760 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21762 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21764 row
->used
[TEXT_AREA
] = ii
;
21765 produce_special_glyphs (it
, IT_TRUNCATION
);
21768 produce_special_glyphs (it
, IT_TRUNCATION
);
21770 row
->truncated_on_right_p
= 1;
21776 /* Maybe insert a truncation at the left. */
21777 if (it
->first_visible_x
21780 if (!FRAME_WINDOW_P (it
->f
))
21781 insert_left_trunc_glyphs (it
);
21782 row
->truncated_on_left_p
= 1;
21785 it
->face_id
= saved_face_id
;
21787 /* Value is number of columns displayed. */
21788 return it
->hpos
- hpos_at_start
;
21793 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21794 appears as an element of LIST or as the car of an element of LIST.
21795 If PROPVAL is a list, compare each element against LIST in that
21796 way, and return 1/2 if any element of PROPVAL is found in LIST.
21797 Otherwise return 0. This function cannot quit.
21798 The return value is 2 if the text is invisible but with an ellipsis
21799 and 1 if it's invisible and without an ellipsis. */
21802 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21804 register Lisp_Object tail
, proptail
;
21806 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21808 register Lisp_Object tem
;
21810 if (EQ (propval
, tem
))
21812 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21813 return NILP (XCDR (tem
)) ? 1 : 2;
21816 if (CONSP (propval
))
21818 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21820 Lisp_Object propelt
;
21821 propelt
= XCAR (proptail
);
21822 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21824 register Lisp_Object tem
;
21826 if (EQ (propelt
, tem
))
21828 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21829 return NILP (XCDR (tem
)) ? 1 : 2;
21837 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21838 doc
: /* Non-nil if the property makes the text invisible.
21839 POS-OR-PROP can be a marker or number, in which case it is taken to be
21840 a position in the current buffer and the value of the `invisible' property
21841 is checked; or it can be some other value, which is then presumed to be the
21842 value of the `invisible' property of the text of interest.
21843 The non-nil value returned can be t for truly invisible text or something
21844 else if the text is replaced by an ellipsis. */)
21845 (Lisp_Object pos_or_prop
)
21848 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21849 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21851 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21852 return (invis
== 0 ? Qnil
21854 : make_number (invis
));
21857 /* Calculate a width or height in pixels from a specification using
21858 the following elements:
21861 NUM - a (fractional) multiple of the default font width/height
21862 (NUM) - specifies exactly NUM pixels
21863 UNIT - a fixed number of pixels, see below.
21864 ELEMENT - size of a display element in pixels, see below.
21865 (NUM . SPEC) - equals NUM * SPEC
21866 (+ SPEC SPEC ...) - add pixel values
21867 (- SPEC SPEC ...) - subtract pixel values
21868 (- SPEC) - negate pixel value
21871 INT or FLOAT - a number constant
21872 SYMBOL - use symbol's (buffer local) variable binding.
21875 in - pixels per inch *)
21876 mm - pixels per 1/1000 meter *)
21877 cm - pixels per 1/100 meter *)
21878 width - width of current font in pixels.
21879 height - height of current font in pixels.
21881 *) using the ratio(s) defined in display-pixels-per-inch.
21885 left-fringe - left fringe width in pixels
21886 right-fringe - right fringe width in pixels
21888 left-margin - left margin width in pixels
21889 right-margin - right margin width in pixels
21891 scroll-bar - scroll-bar area width in pixels
21895 Pixels corresponding to 5 inches:
21898 Total width of non-text areas on left side of window (if scroll-bar is on left):
21899 '(space :width (+ left-fringe left-margin scroll-bar))
21901 Align to first text column (in header line):
21902 '(space :align-to 0)
21904 Align to middle of text area minus half the width of variable `my-image'
21905 containing a loaded image:
21906 '(space :align-to (0.5 . (- text my-image)))
21908 Width of left margin minus width of 1 character in the default font:
21909 '(space :width (- left-margin 1))
21911 Width of left margin minus width of 2 characters in the current font:
21912 '(space :width (- left-margin (2 . width)))
21914 Center 1 character over left-margin (in header line):
21915 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21917 Different ways to express width of left fringe plus left margin minus one pixel:
21918 '(space :width (- (+ left-fringe left-margin) (1)))
21919 '(space :width (+ left-fringe left-margin (- (1))))
21920 '(space :width (+ left-fringe left-margin (-1)))
21924 #define NUMVAL(X) \
21925 ((INTEGERP (X) || FLOATP (X)) \
21930 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21931 struct font
*font
, int width_p
, int *align_to
)
21935 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21936 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21939 return OK_PIXELS (0);
21941 xassert (FRAME_LIVE_P (it
->f
));
21943 if (SYMBOLP (prop
))
21945 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21947 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21949 if (unit
[0] == 'i' && unit
[1] == 'n')
21951 else if (unit
[0] == 'm' && unit
[1] == 'm')
21953 else if (unit
[0] == 'c' && unit
[1] == 'm')
21960 #ifdef HAVE_WINDOW_SYSTEM
21961 if (FRAME_WINDOW_P (it
->f
)
21963 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21964 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21966 return OK_PIXELS (ppi
/ pixels
);
21969 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21970 || (CONSP (Vdisplay_pixels_per_inch
)
21972 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21973 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21975 return OK_PIXELS (ppi
/ pixels
);
21981 #ifdef HAVE_WINDOW_SYSTEM
21982 if (EQ (prop
, Qheight
))
21983 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21984 if (EQ (prop
, Qwidth
))
21985 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21987 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21988 return OK_PIXELS (1);
21991 if (EQ (prop
, Qtext
))
21992 return OK_PIXELS (width_p
21993 ? window_box_width (it
->w
, TEXT_AREA
)
21994 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21996 if (align_to
&& *align_to
< 0)
21999 if (EQ (prop
, Qleft
))
22000 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22001 if (EQ (prop
, Qright
))
22002 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22003 if (EQ (prop
, Qcenter
))
22004 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22005 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22006 if (EQ (prop
, Qleft_fringe
))
22007 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22008 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22009 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22010 if (EQ (prop
, Qright_fringe
))
22011 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22012 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22013 : window_box_right_offset (it
->w
, TEXT_AREA
));
22014 if (EQ (prop
, Qleft_margin
))
22015 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22016 if (EQ (prop
, Qright_margin
))
22017 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22018 if (EQ (prop
, Qscroll_bar
))
22019 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22021 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22022 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22023 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22028 if (EQ (prop
, Qleft_fringe
))
22029 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22030 if (EQ (prop
, Qright_fringe
))
22031 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22032 if (EQ (prop
, Qleft_margin
))
22033 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22034 if (EQ (prop
, Qright_margin
))
22035 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22036 if (EQ (prop
, Qscroll_bar
))
22037 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22040 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
22043 if (INTEGERP (prop
) || FLOATP (prop
))
22045 int base_unit
= (width_p
22046 ? FRAME_COLUMN_WIDTH (it
->f
)
22047 : FRAME_LINE_HEIGHT (it
->f
));
22048 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22053 Lisp_Object car
= XCAR (prop
);
22054 Lisp_Object cdr
= XCDR (prop
);
22058 #ifdef HAVE_WINDOW_SYSTEM
22059 if (FRAME_WINDOW_P (it
->f
)
22060 && valid_image_p (prop
))
22062 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22063 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22065 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22067 #ifdef HAVE_XWIDGETS
22068 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_p (prop
))
22070 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
22071 return OK_PIXELS (width_p
? 100 : 100);
22075 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22081 while (CONSP (cdr
))
22083 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22084 font
, width_p
, align_to
))
22087 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22092 if (EQ (car
, Qminus
))
22094 return OK_PIXELS (pixels
);
22097 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
22100 if (INTEGERP (car
) || FLOATP (car
))
22103 pixels
= XFLOATINT (car
);
22105 return OK_PIXELS (pixels
);
22106 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22107 font
, width_p
, align_to
))
22108 return OK_PIXELS (pixels
* fact
);
22119 /***********************************************************************
22121 ***********************************************************************/
22123 #ifdef HAVE_WINDOW_SYSTEM
22128 dump_glyph_string (struct glyph_string
*s
)
22130 fprintf (stderr
, "glyph string\n");
22131 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22132 s
->x
, s
->y
, s
->width
, s
->height
);
22133 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22134 fprintf (stderr
, " hl = %d\n", s
->hl
);
22135 fprintf (stderr
, " left overhang = %d, right = %d\n",
22136 s
->left_overhang
, s
->right_overhang
);
22137 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22138 fprintf (stderr
, " extends to end of line = %d\n",
22139 s
->extends_to_end_of_line_p
);
22140 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22141 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22144 #endif /* GLYPH_DEBUG */
22146 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22147 of XChar2b structures for S; it can't be allocated in
22148 init_glyph_string because it must be allocated via `alloca'. W
22149 is the window on which S is drawn. ROW and AREA are the glyph row
22150 and area within the row from which S is constructed. START is the
22151 index of the first glyph structure covered by S. HL is a
22152 face-override for drawing S. */
22155 #define OPTIONAL_HDC(hdc) HDC hdc,
22156 #define DECLARE_HDC(hdc) HDC hdc;
22157 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22158 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22161 #ifndef OPTIONAL_HDC
22162 #define OPTIONAL_HDC(hdc)
22163 #define DECLARE_HDC(hdc)
22164 #define ALLOCATE_HDC(hdc, f)
22165 #define RELEASE_HDC(hdc, f)
22169 init_glyph_string (struct glyph_string
*s
,
22171 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22172 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22174 memset (s
, 0, sizeof *s
);
22176 s
->f
= XFRAME (w
->frame
);
22180 s
->display
= FRAME_X_DISPLAY (s
->f
);
22181 s
->window
= FRAME_X_WINDOW (s
->f
);
22182 s
->char2b
= char2b
;
22186 s
->first_glyph
= row
->glyphs
[area
] + start
;
22187 s
->height
= row
->height
;
22188 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22189 s
->ybase
= s
->y
+ row
->ascent
;
22193 /* Append the list of glyph strings with head H and tail T to the list
22194 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22197 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22198 struct glyph_string
*h
, struct glyph_string
*t
)
22212 /* Prepend the list of glyph strings with head H and tail T to the
22213 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22217 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22218 struct glyph_string
*h
, struct glyph_string
*t
)
22232 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22233 Set *HEAD and *TAIL to the resulting list. */
22236 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22237 struct glyph_string
*s
)
22239 s
->next
= s
->prev
= NULL
;
22240 append_glyph_string_lists (head
, tail
, s
, s
);
22244 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22245 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22246 make sure that X resources for the face returned are allocated.
22247 Value is a pointer to a realized face that is ready for display if
22248 DISPLAY_P is non-zero. */
22250 static inline struct face
*
22251 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22252 XChar2b
*char2b
, int display_p
)
22254 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22258 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22260 if (code
!= FONT_INVALID_CODE
)
22261 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22263 STORE_XCHAR2B (char2b
, 0, 0);
22266 /* Make sure X resources of the face are allocated. */
22267 #ifdef HAVE_X_WINDOWS
22271 xassert (face
!= NULL
);
22272 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22279 /* Get face and two-byte form of character glyph GLYPH on frame F.
22280 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22281 a pointer to a realized face that is ready for display. */
22283 static inline struct face
*
22284 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22285 XChar2b
*char2b
, int *two_byte_p
)
22289 xassert (glyph
->type
== CHAR_GLYPH
);
22290 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22299 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22300 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22302 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22304 if (code
!= FONT_INVALID_CODE
)
22305 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22307 STORE_XCHAR2B (char2b
, 0, 0);
22310 /* Make sure X resources of the face are allocated. */
22311 xassert (face
!= NULL
);
22312 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22317 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22318 Return 1 if FONT has a glyph for C, otherwise return 0. */
22321 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22325 if (CHAR_BYTE8_P (c
))
22326 code
= CHAR_TO_BYTE8 (c
);
22328 code
= font
->driver
->encode_char (font
, c
);
22330 if (code
== FONT_INVALID_CODE
)
22332 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22337 /* Fill glyph string S with composition components specified by S->cmp.
22339 BASE_FACE is the base face of the composition.
22340 S->cmp_from is the index of the first component for S.
22342 OVERLAPS non-zero means S should draw the foreground only, and use
22343 its physical height for clipping. See also draw_glyphs.
22345 Value is the index of a component not in S. */
22348 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22352 /* For all glyphs of this composition, starting at the offset
22353 S->cmp_from, until we reach the end of the definition or encounter a
22354 glyph that requires the different face, add it to S. */
22359 s
->for_overlaps
= overlaps
;
22362 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22364 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22366 /* TAB in a composition means display glyphs with padding space
22367 on the left or right. */
22370 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22373 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22380 s
->font
= s
->face
->font
;
22382 else if (s
->face
!= face
)
22390 if (s
->face
== NULL
)
22392 s
->face
= base_face
->ascii_face
;
22393 s
->font
= s
->face
->font
;
22396 /* All glyph strings for the same composition has the same width,
22397 i.e. the width set for the first component of the composition. */
22398 s
->width
= s
->first_glyph
->pixel_width
;
22400 /* If the specified font could not be loaded, use the frame's
22401 default font, but record the fact that we couldn't load it in
22402 the glyph string so that we can draw rectangles for the
22403 characters of the glyph string. */
22404 if (s
->font
== NULL
)
22406 s
->font_not_found_p
= 1;
22407 s
->font
= FRAME_FONT (s
->f
);
22410 /* Adjust base line for subscript/superscript text. */
22411 s
->ybase
+= s
->first_glyph
->voffset
;
22413 /* This glyph string must always be drawn with 16-bit functions. */
22420 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22421 int start
, int end
, int overlaps
)
22423 struct glyph
*glyph
, *last
;
22424 Lisp_Object lgstring
;
22427 s
->for_overlaps
= overlaps
;
22428 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22429 last
= s
->row
->glyphs
[s
->area
] + end
;
22430 s
->cmp_id
= glyph
->u
.cmp
.id
;
22431 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22432 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22433 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22434 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22435 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22437 while (glyph
< last
22438 && glyph
->u
.cmp
.automatic
22439 && glyph
->u
.cmp
.id
== s
->cmp_id
22440 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22441 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22443 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22445 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22446 unsigned code
= LGLYPH_CODE (lglyph
);
22448 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22450 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22451 return glyph
- s
->row
->glyphs
[s
->area
];
22455 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22456 See the comment of fill_glyph_string for arguments.
22457 Value is the index of the first glyph not in S. */
22461 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22462 int start
, int end
, int overlaps
)
22464 struct glyph
*glyph
, *last
;
22467 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22468 s
->for_overlaps
= overlaps
;
22469 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22470 last
= s
->row
->glyphs
[s
->area
] + end
;
22471 voffset
= glyph
->voffset
;
22472 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22473 s
->font
= s
->face
->font
;
22475 s
->width
= glyph
->pixel_width
;
22477 while (glyph
< last
22478 && glyph
->type
== GLYPHLESS_GLYPH
22479 && glyph
->voffset
== voffset
22480 && glyph
->face_id
== face_id
)
22483 s
->width
+= glyph
->pixel_width
;
22486 s
->ybase
+= voffset
;
22487 return glyph
- s
->row
->glyphs
[s
->area
];
22491 /* Fill glyph string S from a sequence of character glyphs.
22493 FACE_ID is the face id of the string. START is the index of the
22494 first glyph to consider, END is the index of the last + 1.
22495 OVERLAPS non-zero means S should draw the foreground only, and use
22496 its physical height for clipping. See also draw_glyphs.
22498 Value is the index of the first glyph not in S. */
22501 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22502 int start
, int end
, int overlaps
)
22504 struct glyph
*glyph
, *last
;
22506 int glyph_not_available_p
;
22508 xassert (s
->f
== XFRAME (s
->w
->frame
));
22509 xassert (s
->nchars
== 0);
22510 xassert (start
>= 0 && end
> start
);
22512 s
->for_overlaps
= overlaps
;
22513 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22514 last
= s
->row
->glyphs
[s
->area
] + end
;
22515 voffset
= glyph
->voffset
;
22516 s
->padding_p
= glyph
->padding_p
;
22517 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22519 while (glyph
< last
22520 && glyph
->type
== CHAR_GLYPH
22521 && glyph
->voffset
== voffset
22522 /* Same face id implies same font, nowadays. */
22523 && glyph
->face_id
== face_id
22524 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22528 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22529 s
->char2b
+ s
->nchars
,
22531 s
->two_byte_p
= two_byte_p
;
22533 xassert (s
->nchars
<= end
- start
);
22534 s
->width
+= glyph
->pixel_width
;
22535 if (glyph
++->padding_p
!= s
->padding_p
)
22539 s
->font
= s
->face
->font
;
22541 /* If the specified font could not be loaded, use the frame's font,
22542 but record the fact that we couldn't load it in
22543 S->font_not_found_p so that we can draw rectangles for the
22544 characters of the glyph string. */
22545 if (s
->font
== NULL
|| glyph_not_available_p
)
22547 s
->font_not_found_p
= 1;
22548 s
->font
= FRAME_FONT (s
->f
);
22551 /* Adjust base line for subscript/superscript text. */
22552 s
->ybase
+= voffset
;
22554 xassert (s
->face
&& s
->face
->gc
);
22555 return glyph
- s
->row
->glyphs
[s
->area
];
22559 /* Fill glyph string S from image glyph S->first_glyph. */
22562 fill_image_glyph_string (struct glyph_string
*s
)
22564 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22565 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22567 s
->slice
= s
->first_glyph
->slice
.img
;
22568 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22569 s
->font
= s
->face
->font
;
22570 s
->width
= s
->first_glyph
->pixel_width
;
22572 /* Adjust base line for subscript/superscript text. */
22573 s
->ybase
+= s
->first_glyph
->voffset
;
22576 #ifdef HAVE_XWIDGETS
22578 fill_xwidget_glyph_string (struct glyph_string
*s
)
22580 xassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
22581 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
22582 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22583 s
->font
= s
->face
->font
;
22584 s
->width
= s
->first_glyph
->pixel_width
;
22585 s
->ybase
+= s
->first_glyph
->voffset
;
22586 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
22587 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
22590 /* Fill glyph string S from a sequence of stretch glyphs.
22592 START is the index of the first glyph to consider,
22593 END is the index of the last + 1.
22595 Value is the index of the first glyph not in S. */
22598 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22600 struct glyph
*glyph
, *last
;
22601 int voffset
, face_id
;
22603 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22605 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22606 last
= s
->row
->glyphs
[s
->area
] + end
;
22607 face_id
= glyph
->face_id
;
22608 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22609 s
->font
= s
->face
->font
;
22610 s
->width
= glyph
->pixel_width
;
22612 voffset
= glyph
->voffset
;
22616 && glyph
->type
== STRETCH_GLYPH
22617 && glyph
->voffset
== voffset
22618 && glyph
->face_id
== face_id
);
22620 s
->width
+= glyph
->pixel_width
;
22622 /* Adjust base line for subscript/superscript text. */
22623 s
->ybase
+= voffset
;
22625 /* The case that face->gc == 0 is handled when drawing the glyph
22626 string by calling PREPARE_FACE_FOR_DISPLAY. */
22628 return glyph
- s
->row
->glyphs
[s
->area
];
22631 static struct font_metrics
*
22632 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22634 static struct font_metrics metrics
;
22635 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22637 if (! font
|| code
== FONT_INVALID_CODE
)
22639 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22644 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22645 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22646 assumed to be zero. */
22649 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22651 *left
= *right
= 0;
22653 if (glyph
->type
== CHAR_GLYPH
)
22657 struct font_metrics
*pcm
;
22659 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22660 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22662 if (pcm
->rbearing
> pcm
->width
)
22663 *right
= pcm
->rbearing
- pcm
->width
;
22664 if (pcm
->lbearing
< 0)
22665 *left
= -pcm
->lbearing
;
22668 else if (glyph
->type
== COMPOSITE_GLYPH
)
22670 if (! glyph
->u
.cmp
.automatic
)
22672 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22674 if (cmp
->rbearing
> cmp
->pixel_width
)
22675 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22676 if (cmp
->lbearing
< 0)
22677 *left
= - cmp
->lbearing
;
22681 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22682 struct font_metrics metrics
;
22684 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22685 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22686 if (metrics
.rbearing
> metrics
.width
)
22687 *right
= metrics
.rbearing
- metrics
.width
;
22688 if (metrics
.lbearing
< 0)
22689 *left
= - metrics
.lbearing
;
22695 /* Return the index of the first glyph preceding glyph string S that
22696 is overwritten by S because of S's left overhang. Value is -1
22697 if no glyphs are overwritten. */
22700 left_overwritten (struct glyph_string
*s
)
22704 if (s
->left_overhang
)
22707 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22708 int first
= s
->first_glyph
- glyphs
;
22710 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22711 x
-= glyphs
[i
].pixel_width
;
22722 /* Return the index of the first glyph preceding glyph string S that
22723 is overwriting S because of its right overhang. Value is -1 if no
22724 glyph in front of S overwrites S. */
22727 left_overwriting (struct glyph_string
*s
)
22730 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22731 int first
= s
->first_glyph
- glyphs
;
22735 for (i
= first
- 1; i
>= 0; --i
)
22738 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22741 x
-= glyphs
[i
].pixel_width
;
22748 /* Return the index of the last glyph following glyph string S that is
22749 overwritten by S because of S's right overhang. Value is -1 if
22750 no such glyph is found. */
22753 right_overwritten (struct glyph_string
*s
)
22757 if (s
->right_overhang
)
22760 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22761 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22762 int end
= s
->row
->used
[s
->area
];
22764 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22765 x
+= glyphs
[i
].pixel_width
;
22774 /* Return the index of the last glyph following glyph string S that
22775 overwrites S because of its left overhang. Value is negative
22776 if no such glyph is found. */
22779 right_overwriting (struct glyph_string
*s
)
22782 int end
= s
->row
->used
[s
->area
];
22783 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22784 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22788 for (i
= first
; i
< end
; ++i
)
22791 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22794 x
+= glyphs
[i
].pixel_width
;
22801 /* Set background width of glyph string S. START is the index of the
22802 first glyph following S. LAST_X is the right-most x-position + 1
22803 in the drawing area. */
22806 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22808 /* If the face of this glyph string has to be drawn to the end of
22809 the drawing area, set S->extends_to_end_of_line_p. */
22811 if (start
== s
->row
->used
[s
->area
]
22812 && s
->area
== TEXT_AREA
22813 && ((s
->row
->fill_line_p
22814 && (s
->hl
== DRAW_NORMAL_TEXT
22815 || s
->hl
== DRAW_IMAGE_RAISED
22816 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22817 || s
->hl
== DRAW_MOUSE_FACE
))
22818 s
->extends_to_end_of_line_p
= 1;
22820 /* If S extends its face to the end of the line, set its
22821 background_width to the distance to the right edge of the drawing
22823 if (s
->extends_to_end_of_line_p
)
22824 s
->background_width
= last_x
- s
->x
+ 1;
22826 s
->background_width
= s
->width
;
22830 /* Compute overhangs and x-positions for glyph string S and its
22831 predecessors, or successors. X is the starting x-position for S.
22832 BACKWARD_P non-zero means process predecessors. */
22835 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22841 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22842 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22852 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22853 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22863 /* The following macros are only called from draw_glyphs below.
22864 They reference the following parameters of that function directly:
22865 `w', `row', `area', and `overlap_p'
22866 as well as the following local variables:
22867 `s', `f', and `hdc' (in W32) */
22870 /* On W32, silently add local `hdc' variable to argument list of
22871 init_glyph_string. */
22872 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22873 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22875 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22876 init_glyph_string (s, char2b, w, row, area, start, hl)
22879 /* Add a glyph string for a stretch glyph to the list of strings
22880 between HEAD and TAIL. START is the index of the stretch glyph in
22881 row area AREA of glyph row ROW. END is the index of the last glyph
22882 in that glyph row area. X is the current output position assigned
22883 to the new glyph string constructed. HL overrides that face of the
22884 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22885 is the right-most x-position of the drawing area. */
22887 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22888 and below -- keep them on one line. */
22889 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22892 s = (struct glyph_string *) alloca (sizeof *s); \
22893 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22894 START = fill_stretch_glyph_string (s, START, END); \
22895 append_glyph_string (&HEAD, &TAIL, s); \
22901 /* Add a glyph string for an image glyph to the list of strings
22902 between HEAD and TAIL. START is the index of the image glyph in
22903 row area AREA of glyph row ROW. END is the index of the last glyph
22904 in that glyph row area. X is the current output position assigned
22905 to the new glyph string constructed. HL overrides that face of the
22906 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22907 is the right-most x-position of the drawing area. */
22909 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22912 s = (struct glyph_string *) alloca (sizeof *s); \
22913 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22914 fill_image_glyph_string (s); \
22915 append_glyph_string (&HEAD, &TAIL, s); \
22921 #ifdef HAVE_XWIDGETS
22922 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22925 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
22926 s = (struct glyph_string *) alloca (sizeof *s); \
22927 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22928 fill_xwidget_glyph_string (s); \
22929 append_glyph_string (&HEAD, &TAIL, s); \
22937 /* Add a glyph string for a sequence of character glyphs to the list
22938 of strings between HEAD and TAIL. START is the index of the first
22939 glyph in row area AREA of glyph row ROW that is part of the new
22940 glyph string. END is the index of the last glyph in that glyph row
22941 area. X is the current output position assigned to the new glyph
22942 string constructed. HL overrides that face of the glyph; e.g. it
22943 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22944 right-most x-position of the drawing area. */
22946 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22952 face_id = (row)->glyphs[area][START].face_id; \
22954 s = (struct glyph_string *) alloca (sizeof *s); \
22955 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22956 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22957 append_glyph_string (&HEAD, &TAIL, s); \
22959 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22964 /* Add a glyph string for a composite sequence to the list of strings
22965 between HEAD and TAIL. START is the index of the first glyph in
22966 row area AREA of glyph row ROW that is part of the new glyph
22967 string. END is the index of the last glyph in that glyph row area.
22968 X is the current output position assigned to the new glyph string
22969 constructed. HL overrides that face of the glyph; e.g. it is
22970 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22971 x-position of the drawing area. */
22973 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22975 int face_id = (row)->glyphs[area][START].face_id; \
22976 struct face *base_face = FACE_FROM_ID (f, face_id); \
22977 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22978 struct composition *cmp = composition_table[cmp_id]; \
22980 struct glyph_string *first_s = NULL; \
22983 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22985 /* Make glyph_strings for each glyph sequence that is drawable by \
22986 the same face, and append them to HEAD/TAIL. */ \
22987 for (n = 0; n < cmp->glyph_len;) \
22989 s = (struct glyph_string *) alloca (sizeof *s); \
22990 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22991 append_glyph_string (&(HEAD), &(TAIL), s); \
22997 n = fill_composite_glyph_string (s, base_face, overlaps); \
23005 /* Add a glyph string for a glyph-string sequence to the list of strings
23006 between HEAD and TAIL. */
23008 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23012 Lisp_Object gstring; \
23014 face_id = (row)->glyphs[area][START].face_id; \
23015 gstring = (composition_gstring_from_id \
23016 ((row)->glyphs[area][START].u.cmp.id)); \
23017 s = (struct glyph_string *) alloca (sizeof *s); \
23018 char2b = (XChar2b *) alloca ((sizeof *char2b) \
23019 * LGSTRING_GLYPH_LEN (gstring)); \
23020 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23021 append_glyph_string (&(HEAD), &(TAIL), s); \
23023 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23027 /* Add a glyph string for a sequence of glyphless character's glyphs
23028 to the list of strings between HEAD and TAIL. The meanings of
23029 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23031 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23036 face_id = (row)->glyphs[area][START].face_id; \
23038 s = (struct glyph_string *) alloca (sizeof *s); \
23039 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23040 append_glyph_string (&HEAD, &TAIL, s); \
23042 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23048 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23049 of AREA of glyph row ROW on window W between indices START and END.
23050 HL overrides the face for drawing glyph strings, e.g. it is
23051 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23052 x-positions of the drawing area.
23054 This is an ugly monster macro construct because we must use alloca
23055 to allocate glyph strings (because draw_glyphs can be called
23056 asynchronously). */
23058 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23061 HEAD = TAIL = NULL; \
23062 while (START < END) \
23064 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23065 switch (first_glyph->type) \
23068 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23072 case COMPOSITE_GLYPH: \
23073 if (first_glyph->u.cmp.automatic) \
23074 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23077 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23081 case STRETCH_GLYPH: \
23082 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23086 case IMAGE_GLYPH: \
23087 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23090 case XWIDGET_GLYPH: \
23091 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
23096 case GLYPHLESS_GLYPH: \
23097 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23107 set_glyph_string_background_width (s, START, LAST_X); \
23114 /* Draw glyphs between START and END in AREA of ROW on window W,
23115 starting at x-position X. X is relative to AREA in W. HL is a
23116 face-override with the following meaning:
23118 DRAW_NORMAL_TEXT draw normally
23119 DRAW_CURSOR draw in cursor face
23120 DRAW_MOUSE_FACE draw in mouse face.
23121 DRAW_INVERSE_VIDEO draw in mode line face
23122 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23123 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23125 If OVERLAPS is non-zero, draw only the foreground of characters and
23126 clip to the physical height of ROW. Non-zero value also defines
23127 the overlapping part to be drawn:
23129 OVERLAPS_PRED overlap with preceding rows
23130 OVERLAPS_SUCC overlap with succeeding rows
23131 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23132 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23134 Value is the x-position reached, relative to AREA of W. */
23137 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23138 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
23139 enum draw_glyphs_face hl
, int overlaps
)
23141 struct glyph_string
*head
, *tail
;
23142 struct glyph_string
*s
;
23143 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23144 int i
, j
, x_reached
, last_x
, area_left
= 0;
23145 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23148 ALLOCATE_HDC (hdc
, f
);
23150 /* Let's rather be paranoid than getting a SEGV. */
23151 end
= min (end
, row
->used
[area
]);
23152 start
= max (0, start
);
23153 start
= min (end
, start
);
23155 /* Translate X to frame coordinates. Set last_x to the right
23156 end of the drawing area. */
23157 if (row
->full_width_p
)
23159 /* X is relative to the left edge of W, without scroll bars
23161 area_left
= WINDOW_LEFT_EDGE_X (w
);
23162 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23166 area_left
= window_box_left (w
, area
);
23167 last_x
= area_left
+ window_box_width (w
, area
);
23171 /* Build a doubly-linked list of glyph_string structures between
23172 head and tail from what we have to draw. Note that the macro
23173 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23174 the reason we use a separate variable `i'. */
23176 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23178 x_reached
= tail
->x
+ tail
->background_width
;
23182 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23183 the row, redraw some glyphs in front or following the glyph
23184 strings built above. */
23185 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23187 struct glyph_string
*h
, *t
;
23188 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23189 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23190 int check_mouse_face
= 0;
23193 /* If mouse highlighting is on, we may need to draw adjacent
23194 glyphs using mouse-face highlighting. */
23195 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23197 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23199 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23200 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23202 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23204 check_mouse_face
= 1;
23205 mouse_beg_col
= (row
== mouse_beg_row
)
23206 ? hlinfo
->mouse_face_beg_col
: 0;
23207 mouse_end_col
= (row
== mouse_end_row
)
23208 ? hlinfo
->mouse_face_end_col
23209 : row
->used
[TEXT_AREA
];
23213 /* Compute overhangs for all glyph strings. */
23214 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23215 for (s
= head
; s
; s
= s
->next
)
23216 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23218 /* Prepend glyph strings for glyphs in front of the first glyph
23219 string that are overwritten because of the first glyph
23220 string's left overhang. The background of all strings
23221 prepended must be drawn because the first glyph string
23223 i
= left_overwritten (head
);
23226 enum draw_glyphs_face overlap_hl
;
23228 /* If this row contains mouse highlighting, attempt to draw
23229 the overlapped glyphs with the correct highlight. This
23230 code fails if the overlap encompasses more than one glyph
23231 and mouse-highlight spans only some of these glyphs.
23232 However, making it work perfectly involves a lot more
23233 code, and I don't know if the pathological case occurs in
23234 practice, so we'll stick to this for now. --- cyd */
23235 if (check_mouse_face
23236 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23237 overlap_hl
= DRAW_MOUSE_FACE
;
23239 overlap_hl
= DRAW_NORMAL_TEXT
;
23242 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23243 overlap_hl
, dummy_x
, last_x
);
23245 compute_overhangs_and_x (t
, head
->x
, 1);
23246 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23250 /* Prepend glyph strings for glyphs in front of the first glyph
23251 string that overwrite that glyph string because of their
23252 right overhang. For these strings, only the foreground must
23253 be drawn, because it draws over the glyph string at `head'.
23254 The background must not be drawn because this would overwrite
23255 right overhangs of preceding glyphs for which no glyph
23257 i
= left_overwriting (head
);
23260 enum draw_glyphs_face overlap_hl
;
23262 if (check_mouse_face
23263 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23264 overlap_hl
= DRAW_MOUSE_FACE
;
23266 overlap_hl
= DRAW_NORMAL_TEXT
;
23269 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23270 overlap_hl
, dummy_x
, last_x
);
23271 for (s
= h
; s
; s
= s
->next
)
23272 s
->background_filled_p
= 1;
23273 compute_overhangs_and_x (t
, head
->x
, 1);
23274 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23277 /* Append glyphs strings for glyphs following the last glyph
23278 string tail that are overwritten by tail. The background of
23279 these strings has to be drawn because tail's foreground draws
23281 i
= right_overwritten (tail
);
23284 enum draw_glyphs_face overlap_hl
;
23286 if (check_mouse_face
23287 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23288 overlap_hl
= DRAW_MOUSE_FACE
;
23290 overlap_hl
= DRAW_NORMAL_TEXT
;
23292 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23293 overlap_hl
, x
, last_x
);
23294 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23295 we don't have `end = i;' here. */
23296 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23297 append_glyph_string_lists (&head
, &tail
, h
, t
);
23301 /* Append glyph strings for glyphs following the last glyph
23302 string tail that overwrite tail. The foreground of such
23303 glyphs has to be drawn because it writes into the background
23304 of tail. The background must not be drawn because it could
23305 paint over the foreground of following glyphs. */
23306 i
= right_overwriting (tail
);
23309 enum draw_glyphs_face overlap_hl
;
23310 if (check_mouse_face
23311 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23312 overlap_hl
= DRAW_MOUSE_FACE
;
23314 overlap_hl
= DRAW_NORMAL_TEXT
;
23317 i
++; /* We must include the Ith glyph. */
23318 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23319 overlap_hl
, x
, last_x
);
23320 for (s
= h
; s
; s
= s
->next
)
23321 s
->background_filled_p
= 1;
23322 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23323 append_glyph_string_lists (&head
, &tail
, h
, t
);
23325 if (clip_head
|| clip_tail
)
23326 for (s
= head
; s
; s
= s
->next
)
23328 s
->clip_head
= clip_head
;
23329 s
->clip_tail
= clip_tail
;
23333 /* Draw all strings. */
23334 for (s
= head
; s
; s
= s
->next
)
23335 FRAME_RIF (f
)->draw_glyph_string (s
);
23338 /* When focus a sole frame and move horizontally, this sets on_p to 0
23339 causing a failure to erase prev cursor position. */
23340 if (area
== TEXT_AREA
23341 && !row
->full_width_p
23342 /* When drawing overlapping rows, only the glyph strings'
23343 foreground is drawn, which doesn't erase a cursor
23347 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23348 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23349 : (tail
? tail
->x
+ tail
->background_width
: x
));
23353 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23354 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23358 /* Value is the x-position up to which drawn, relative to AREA of W.
23359 This doesn't include parts drawn because of overhangs. */
23360 if (row
->full_width_p
)
23361 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23363 x_reached
-= area_left
;
23365 RELEASE_HDC (hdc
, f
);
23370 /* Expand row matrix if too narrow. Don't expand if area
23373 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23375 if (!fonts_changed_p \
23376 && (it->glyph_row->glyphs[area] \
23377 < it->glyph_row->glyphs[area + 1])) \
23379 it->w->ncols_scale_factor++; \
23380 fonts_changed_p = 1; \
23384 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23385 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23388 append_glyph (struct it
*it
)
23390 struct glyph
*glyph
;
23391 enum glyph_row_area area
= it
->area
;
23393 xassert (it
->glyph_row
);
23394 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23396 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23397 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23399 /* If the glyph row is reversed, we need to prepend the glyph
23400 rather than append it. */
23401 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23405 /* Make room for the additional glyph. */
23406 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23408 glyph
= it
->glyph_row
->glyphs
[area
];
23410 glyph
->charpos
= CHARPOS (it
->position
);
23411 glyph
->object
= it
->object
;
23412 if (it
->pixel_width
> 0)
23414 glyph
->pixel_width
= it
->pixel_width
;
23415 glyph
->padding_p
= 0;
23419 /* Assure at least 1-pixel width. Otherwise, cursor can't
23420 be displayed correctly. */
23421 glyph
->pixel_width
= 1;
23422 glyph
->padding_p
= 1;
23424 glyph
->ascent
= it
->ascent
;
23425 glyph
->descent
= it
->descent
;
23426 glyph
->voffset
= it
->voffset
;
23427 glyph
->type
= CHAR_GLYPH
;
23428 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23429 glyph
->multibyte_p
= it
->multibyte_p
;
23430 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23431 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23432 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23433 || it
->phys_descent
> it
->descent
);
23434 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23435 glyph
->face_id
= it
->face_id
;
23436 glyph
->u
.ch
= it
->char_to_display
;
23437 glyph
->slice
.img
= null_glyph_slice
;
23438 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23441 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23442 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23444 glyph
->bidi_type
= it
->bidi_it
.type
;
23448 glyph
->resolved_level
= 0;
23449 glyph
->bidi_type
= UNKNOWN_BT
;
23451 ++it
->glyph_row
->used
[area
];
23454 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23457 /* Store one glyph for the composition IT->cmp_it.id in
23458 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23462 append_composite_glyph (struct it
*it
)
23464 struct glyph
*glyph
;
23465 enum glyph_row_area area
= it
->area
;
23467 xassert (it
->glyph_row
);
23469 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23470 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23472 /* If the glyph row is reversed, we need to prepend the glyph
23473 rather than append it. */
23474 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23478 /* Make room for the new glyph. */
23479 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23481 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23483 glyph
->charpos
= it
->cmp_it
.charpos
;
23484 glyph
->object
= it
->object
;
23485 glyph
->pixel_width
= it
->pixel_width
;
23486 glyph
->ascent
= it
->ascent
;
23487 glyph
->descent
= it
->descent
;
23488 glyph
->voffset
= it
->voffset
;
23489 glyph
->type
= COMPOSITE_GLYPH
;
23490 if (it
->cmp_it
.ch
< 0)
23492 glyph
->u
.cmp
.automatic
= 0;
23493 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23494 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23498 glyph
->u
.cmp
.automatic
= 1;
23499 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23500 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23501 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23503 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23504 glyph
->multibyte_p
= it
->multibyte_p
;
23505 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23506 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23507 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23508 || it
->phys_descent
> it
->descent
);
23509 glyph
->padding_p
= 0;
23510 glyph
->glyph_not_available_p
= 0;
23511 glyph
->face_id
= it
->face_id
;
23512 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23515 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23516 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23518 glyph
->bidi_type
= it
->bidi_it
.type
;
23520 ++it
->glyph_row
->used
[area
];
23523 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23527 /* Change IT->ascent and IT->height according to the setting of
23531 take_vertical_position_into_account (struct it
*it
)
23535 if (it
->voffset
< 0)
23536 /* Increase the ascent so that we can display the text higher
23538 it
->ascent
-= it
->voffset
;
23540 /* Increase the descent so that we can display the text lower
23542 it
->descent
+= it
->voffset
;
23547 /* Produce glyphs/get display metrics for the image IT is loaded with.
23548 See the description of struct display_iterator in dispextern.h for
23549 an overview of struct display_iterator. */
23552 produce_image_glyph (struct it
*it
)
23556 int glyph_ascent
, crop
;
23557 struct glyph_slice slice
;
23559 xassert (it
->what
== IT_IMAGE
);
23561 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23563 /* Make sure X resources of the face is loaded. */
23564 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23566 if (it
->image_id
< 0)
23568 /* Fringe bitmap. */
23569 it
->ascent
= it
->phys_ascent
= 0;
23570 it
->descent
= it
->phys_descent
= 0;
23571 it
->pixel_width
= 0;
23576 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23578 /* Make sure X resources of the image is loaded. */
23579 prepare_image_for_display (it
->f
, img
);
23581 slice
.x
= slice
.y
= 0;
23582 slice
.width
= img
->width
;
23583 slice
.height
= img
->height
;
23585 if (INTEGERP (it
->slice
.x
))
23586 slice
.x
= XINT (it
->slice
.x
);
23587 else if (FLOATP (it
->slice
.x
))
23588 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23590 if (INTEGERP (it
->slice
.y
))
23591 slice
.y
= XINT (it
->slice
.y
);
23592 else if (FLOATP (it
->slice
.y
))
23593 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23595 if (INTEGERP (it
->slice
.width
))
23596 slice
.width
= XINT (it
->slice
.width
);
23597 else if (FLOATP (it
->slice
.width
))
23598 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23600 if (INTEGERP (it
->slice
.height
))
23601 slice
.height
= XINT (it
->slice
.height
);
23602 else if (FLOATP (it
->slice
.height
))
23603 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23605 if (slice
.x
>= img
->width
)
23606 slice
.x
= img
->width
;
23607 if (slice
.y
>= img
->height
)
23608 slice
.y
= img
->height
;
23609 if (slice
.x
+ slice
.width
>= img
->width
)
23610 slice
.width
= img
->width
- slice
.x
;
23611 if (slice
.y
+ slice
.height
> img
->height
)
23612 slice
.height
= img
->height
- slice
.y
;
23614 if (slice
.width
== 0 || slice
.height
== 0)
23617 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23619 it
->descent
= slice
.height
- glyph_ascent
;
23621 it
->descent
+= img
->vmargin
;
23622 if (slice
.y
+ slice
.height
== img
->height
)
23623 it
->descent
+= img
->vmargin
;
23624 it
->phys_descent
= it
->descent
;
23626 it
->pixel_width
= slice
.width
;
23628 it
->pixel_width
+= img
->hmargin
;
23629 if (slice
.x
+ slice
.width
== img
->width
)
23630 it
->pixel_width
+= img
->hmargin
;
23632 /* It's quite possible for images to have an ascent greater than
23633 their height, so don't get confused in that case. */
23634 if (it
->descent
< 0)
23639 if (face
->box
!= FACE_NO_BOX
)
23641 if (face
->box_line_width
> 0)
23644 it
->ascent
+= face
->box_line_width
;
23645 if (slice
.y
+ slice
.height
== img
->height
)
23646 it
->descent
+= face
->box_line_width
;
23649 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23650 it
->pixel_width
+= eabs (face
->box_line_width
);
23651 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23652 it
->pixel_width
+= eabs (face
->box_line_width
);
23655 take_vertical_position_into_account (it
);
23657 /* Automatically crop wide image glyphs at right edge so we can
23658 draw the cursor on same display row. */
23659 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23660 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23662 it
->pixel_width
-= crop
;
23663 slice
.width
-= crop
;
23668 struct glyph
*glyph
;
23669 enum glyph_row_area area
= it
->area
;
23671 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23672 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23674 glyph
->charpos
= CHARPOS (it
->position
);
23675 glyph
->object
= it
->object
;
23676 glyph
->pixel_width
= it
->pixel_width
;
23677 glyph
->ascent
= glyph_ascent
;
23678 glyph
->descent
= it
->descent
;
23679 glyph
->voffset
= it
->voffset
;
23680 glyph
->type
= IMAGE_GLYPH
;
23681 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23682 glyph
->multibyte_p
= it
->multibyte_p
;
23683 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23684 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23685 glyph
->overlaps_vertically_p
= 0;
23686 glyph
->padding_p
= 0;
23687 glyph
->glyph_not_available_p
= 0;
23688 glyph
->face_id
= it
->face_id
;
23689 glyph
->u
.img_id
= img
->id
;
23690 glyph
->slice
.img
= slice
;
23691 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23694 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23695 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23697 glyph
->bidi_type
= it
->bidi_it
.type
;
23699 ++it
->glyph_row
->used
[area
];
23702 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23706 #ifdef HAVE_XWIDGETS
23708 produce_xwidget_glyph (struct it
*it
)
23710 struct xwidget
* xw
;
23712 int glyph_ascent
, crop
;
23713 printf("produce_xwidget_glyph:\n");
23714 xassert (it
->what
== IT_XWIDGET
);
23716 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23718 /* Make sure X resources of the face is loaded. */
23719 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23722 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
23723 it
->descent
= xw
->height
/2;
23724 it
->phys_descent
= it
->descent
;
23725 it
->pixel_width
= xw
->width
;
23726 /* It's quite possible for images to have an ascent greater than
23727 their height, so don't get confused in that case. */
23728 if (it
->descent
< 0)
23733 if (face
->box
!= FACE_NO_BOX
)
23735 if (face
->box_line_width
> 0)
23737 it
->ascent
+= face
->box_line_width
;
23738 it
->descent
+= face
->box_line_width
;
23741 if (it
->start_of_box_run_p
)
23742 it
->pixel_width
+= eabs (face
->box_line_width
);
23743 it
->pixel_width
+= eabs (face
->box_line_width
);
23746 take_vertical_position_into_account (it
);
23748 /* Automatically crop wide image glyphs at right edge so we can
23749 draw the cursor on same display row. */
23750 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23751 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23753 it
->pixel_width
-= crop
;
23758 struct glyph
*glyph
;
23759 enum glyph_row_area area
= it
->area
;
23761 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23762 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23764 glyph
->charpos
= CHARPOS (it
->position
);
23765 glyph
->object
= it
->object
;
23766 glyph
->pixel_width
= it
->pixel_width
;
23767 glyph
->ascent
= glyph_ascent
;
23768 glyph
->descent
= it
->descent
;
23769 glyph
->voffset
= it
->voffset
;
23770 glyph
->type
= XWIDGET_GLYPH
;
23772 glyph
->multibyte_p
= it
->multibyte_p
;
23773 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23774 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23775 glyph
->overlaps_vertically_p
= 0;
23776 glyph
->padding_p
= 0;
23777 glyph
->glyph_not_available_p
= 0;
23778 glyph
->face_id
= it
->face_id
;
23779 glyph
->u
.xwidget
= it
->xwidget
;
23780 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
23781 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23782 ++it
->glyph_row
->used
[area
];
23785 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23790 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23791 of the glyph, WIDTH and HEIGHT are the width and height of the
23792 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23795 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23796 int width
, int height
, int ascent
)
23798 struct glyph
*glyph
;
23799 enum glyph_row_area area
= it
->area
;
23801 xassert (ascent
>= 0 && ascent
<= height
);
23803 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23804 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23806 /* If the glyph row is reversed, we need to prepend the glyph
23807 rather than append it. */
23808 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23812 /* Make room for the additional glyph. */
23813 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23815 glyph
= it
->glyph_row
->glyphs
[area
];
23817 glyph
->charpos
= CHARPOS (it
->position
);
23818 glyph
->object
= object
;
23819 glyph
->pixel_width
= width
;
23820 glyph
->ascent
= ascent
;
23821 glyph
->descent
= height
- ascent
;
23822 glyph
->voffset
= it
->voffset
;
23823 glyph
->type
= STRETCH_GLYPH
;
23824 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23825 glyph
->multibyte_p
= it
->multibyte_p
;
23826 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23827 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23828 glyph
->overlaps_vertically_p
= 0;
23829 glyph
->padding_p
= 0;
23830 glyph
->glyph_not_available_p
= 0;
23831 glyph
->face_id
= it
->face_id
;
23832 glyph
->u
.stretch
.ascent
= ascent
;
23833 glyph
->u
.stretch
.height
= height
;
23834 glyph
->slice
.img
= null_glyph_slice
;
23835 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23838 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23839 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23841 glyph
->bidi_type
= it
->bidi_it
.type
;
23845 glyph
->resolved_level
= 0;
23846 glyph
->bidi_type
= UNKNOWN_BT
;
23848 ++it
->glyph_row
->used
[area
];
23851 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23854 #endif /* HAVE_WINDOW_SYSTEM */
23856 /* Produce a stretch glyph for iterator IT. IT->object is the value
23857 of the glyph property displayed. The value must be a list
23858 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23861 1. `:width WIDTH' specifies that the space should be WIDTH *
23862 canonical char width wide. WIDTH may be an integer or floating
23865 2. `:relative-width FACTOR' specifies that the width of the stretch
23866 should be computed from the width of the first character having the
23867 `glyph' property, and should be FACTOR times that width.
23869 3. `:align-to HPOS' specifies that the space should be wide enough
23870 to reach HPOS, a value in canonical character units.
23872 Exactly one of the above pairs must be present.
23874 4. `:height HEIGHT' specifies that the height of the stretch produced
23875 should be HEIGHT, measured in canonical character units.
23877 5. `:relative-height FACTOR' specifies that the height of the
23878 stretch should be FACTOR times the height of the characters having
23879 the glyph property.
23881 Either none or exactly one of 4 or 5 must be present.
23883 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23884 of the stretch should be used for the ascent of the stretch.
23885 ASCENT must be in the range 0 <= ASCENT <= 100. */
23888 produce_stretch_glyph (struct it
*it
)
23890 /* (space :width WIDTH :height HEIGHT ...) */
23891 Lisp_Object prop
, plist
;
23892 int width
= 0, height
= 0, align_to
= -1;
23893 int zero_width_ok_p
= 0;
23896 struct face
*face
= NULL
;
23897 struct font
*font
= NULL
;
23899 #ifdef HAVE_WINDOW_SYSTEM
23900 int zero_height_ok_p
= 0;
23902 if (FRAME_WINDOW_P (it
->f
))
23904 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23905 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23906 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23910 /* List should start with `space'. */
23911 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23912 plist
= XCDR (it
->object
);
23914 /* Compute the width of the stretch. */
23915 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23916 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23918 /* Absolute width `:width WIDTH' specified and valid. */
23919 zero_width_ok_p
= 1;
23922 #ifdef HAVE_WINDOW_SYSTEM
23923 else if (FRAME_WINDOW_P (it
->f
)
23924 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23926 /* Relative width `:relative-width FACTOR' specified and valid.
23927 Compute the width of the characters having the `glyph'
23930 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23933 if (it
->multibyte_p
)
23934 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23937 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23938 if (! ASCII_CHAR_P (it2
.c
))
23939 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23942 it2
.glyph_row
= NULL
;
23943 it2
.what
= IT_CHARACTER
;
23944 x_produce_glyphs (&it2
);
23945 width
= NUMVAL (prop
) * it2
.pixel_width
;
23947 #endif /* HAVE_WINDOW_SYSTEM */
23948 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23949 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23951 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23952 align_to
= (align_to
< 0
23954 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23955 else if (align_to
< 0)
23956 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23957 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23958 zero_width_ok_p
= 1;
23961 /* Nothing specified -> width defaults to canonical char width. */
23962 width
= FRAME_COLUMN_WIDTH (it
->f
);
23964 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23967 #ifdef HAVE_WINDOW_SYSTEM
23968 /* Compute height. */
23969 if (FRAME_WINDOW_P (it
->f
))
23971 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23972 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23975 zero_height_ok_p
= 1;
23977 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23979 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23981 height
= FONT_HEIGHT (font
);
23983 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23986 /* Compute percentage of height used for ascent. If
23987 `:ascent ASCENT' is present and valid, use that. Otherwise,
23988 derive the ascent from the font in use. */
23989 if (prop
= Fplist_get (plist
, QCascent
),
23990 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23991 ascent
= height
* NUMVAL (prop
) / 100.0;
23992 else if (!NILP (prop
)
23993 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23994 ascent
= min (max (0, (int)tem
), height
);
23996 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23999 #endif /* HAVE_WINDOW_SYSTEM */
24002 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24003 && it
->current_x
+ width
> it
->last_visible_x
)
24005 width
= it
->last_visible_x
- it
->current_x
;
24006 #ifdef HAVE_WINDOW_SYSTEM
24007 /* Subtract one more pixel from the stretch width, but only on
24008 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24009 width
-= FRAME_WINDOW_P (it
->f
);
24013 if (width
> 0 && height
> 0 && it
->glyph_row
)
24015 Lisp_Object o_object
= it
->object
;
24016 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24019 if (!STRINGP (object
))
24020 object
= it
->w
->buffer
;
24021 #ifdef HAVE_WINDOW_SYSTEM
24022 if (FRAME_WINDOW_P (it
->f
))
24023 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24027 it
->object
= object
;
24028 it
->char_to_display
= ' ';
24029 it
->pixel_width
= it
->len
= 1;
24031 tty_append_glyph (it
);
24032 it
->object
= o_object
;
24036 it
->pixel_width
= width
;
24037 #ifdef HAVE_WINDOW_SYSTEM
24038 if (FRAME_WINDOW_P (it
->f
))
24040 it
->ascent
= it
->phys_ascent
= ascent
;
24041 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24042 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24043 take_vertical_position_into_account (it
);
24047 it
->nglyphs
= width
;
24050 #ifdef HAVE_WINDOW_SYSTEM
24052 /* Calculate line-height and line-spacing properties.
24053 An integer value specifies explicit pixel value.
24054 A float value specifies relative value to current face height.
24055 A cons (float . face-name) specifies relative value to
24056 height of specified face font.
24058 Returns height in pixels, or nil. */
24062 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24063 int boff
, int override
)
24065 Lisp_Object face_name
= Qnil
;
24066 int ascent
, descent
, height
;
24068 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24073 face_name
= XCAR (val
);
24075 if (!NUMBERP (val
))
24076 val
= make_number (1);
24077 if (NILP (face_name
))
24079 height
= it
->ascent
+ it
->descent
;
24084 if (NILP (face_name
))
24086 font
= FRAME_FONT (it
->f
);
24087 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24089 else if (EQ (face_name
, Qt
))
24098 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24100 return make_number (-1);
24102 face
= FACE_FROM_ID (it
->f
, face_id
);
24105 return make_number (-1);
24106 boff
= font
->baseline_offset
;
24107 if (font
->vertical_centering
)
24108 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24111 ascent
= FONT_BASE (font
) + boff
;
24112 descent
= FONT_DESCENT (font
) - boff
;
24116 it
->override_ascent
= ascent
;
24117 it
->override_descent
= descent
;
24118 it
->override_boff
= boff
;
24121 height
= ascent
+ descent
;
24125 height
= (int)(XFLOAT_DATA (val
) * height
);
24126 else if (INTEGERP (val
))
24127 height
*= XINT (val
);
24129 return make_number (height
);
24133 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24134 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24135 and only if this is for a character for which no font was found.
24137 If the display method (it->glyphless_method) is
24138 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24139 length of the acronym or the hexadecimal string, UPPER_XOFF and
24140 UPPER_YOFF are pixel offsets for the upper part of the string,
24141 LOWER_XOFF and LOWER_YOFF are for the lower part.
24143 For the other display methods, LEN through LOWER_YOFF are zero. */
24146 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24147 short upper_xoff
, short upper_yoff
,
24148 short lower_xoff
, short lower_yoff
)
24150 struct glyph
*glyph
;
24151 enum glyph_row_area area
= it
->area
;
24153 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24154 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24156 /* If the glyph row is reversed, we need to prepend the glyph
24157 rather than append it. */
24158 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24162 /* Make room for the additional glyph. */
24163 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24165 glyph
= it
->glyph_row
->glyphs
[area
];
24167 glyph
->charpos
= CHARPOS (it
->position
);
24168 glyph
->object
= it
->object
;
24169 glyph
->pixel_width
= it
->pixel_width
;
24170 glyph
->ascent
= it
->ascent
;
24171 glyph
->descent
= it
->descent
;
24172 glyph
->voffset
= it
->voffset
;
24173 glyph
->type
= GLYPHLESS_GLYPH
;
24174 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24175 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24176 glyph
->u
.glyphless
.len
= len
;
24177 glyph
->u
.glyphless
.ch
= it
->c
;
24178 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24179 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24180 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24181 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24182 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24183 glyph
->multibyte_p
= it
->multibyte_p
;
24184 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24185 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24186 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24187 || it
->phys_descent
> it
->descent
);
24188 glyph
->padding_p
= 0;
24189 glyph
->glyph_not_available_p
= 0;
24190 glyph
->face_id
= face_id
;
24191 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24194 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24195 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24197 glyph
->bidi_type
= it
->bidi_it
.type
;
24199 ++it
->glyph_row
->used
[area
];
24202 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24206 /* Produce a glyph for a glyphless character for iterator IT.
24207 IT->glyphless_method specifies which method to use for displaying
24208 the character. See the description of enum
24209 glyphless_display_method in dispextern.h for the detail.
24211 FOR_NO_FONT is nonzero if and only if this is for a character for
24212 which no font was found. ACRONYM, if non-nil, is an acronym string
24213 for the character. */
24216 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24221 int base_width
, base_height
, width
, height
;
24222 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24225 /* Get the metrics of the base font. We always refer to the current
24227 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24228 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24229 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24230 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24231 base_height
= it
->ascent
+ it
->descent
;
24232 base_width
= font
->average_width
;
24234 /* Get a face ID for the glyph by utilizing a cache (the same way as
24235 done for `escape-glyph' in get_next_display_element). */
24236 if (it
->f
== last_glyphless_glyph_frame
24237 && it
->face_id
== last_glyphless_glyph_face_id
)
24239 face_id
= last_glyphless_glyph_merged_face_id
;
24243 /* Merge the `glyphless-char' face into the current face. */
24244 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24245 last_glyphless_glyph_frame
= it
->f
;
24246 last_glyphless_glyph_face_id
= it
->face_id
;
24247 last_glyphless_glyph_merged_face_id
= face_id
;
24250 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24252 it
->pixel_width
= THIN_SPACE_WIDTH
;
24254 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24256 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24258 width
= CHAR_WIDTH (it
->c
);
24261 else if (width
> 4)
24263 it
->pixel_width
= base_width
* width
;
24265 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24271 unsigned int code
[6];
24273 int ascent
, descent
;
24274 struct font_metrics metrics_upper
, metrics_lower
;
24276 face
= FACE_FROM_ID (it
->f
, face_id
);
24277 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24278 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24280 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24282 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24283 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24284 if (CONSP (acronym
))
24285 acronym
= XCAR (acronym
);
24286 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24290 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24291 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24294 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24295 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24296 upper_len
= (len
+ 1) / 2;
24297 font
->driver
->text_extents (font
, code
, upper_len
,
24299 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24304 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24305 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24306 upper_xoff
= upper_yoff
= 2; /* the typical case */
24307 if (base_width
>= width
)
24309 /* Align the upper to the left, the lower to the right. */
24310 it
->pixel_width
= base_width
;
24311 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24315 /* Center the shorter one. */
24316 it
->pixel_width
= width
;
24317 if (metrics_upper
.width
>= metrics_lower
.width
)
24318 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24321 /* FIXME: This code doesn't look right. It formerly was
24322 missing the "lower_xoff = 0;", which couldn't have
24323 been right since it left lower_xoff uninitialized. */
24325 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24329 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24330 top, bottom, and between upper and lower strings. */
24331 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24332 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24333 /* Center vertically.
24334 H:base_height, D:base_descent
24335 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24337 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24338 descent = D - H/2 + h/2;
24339 lower_yoff = descent - 2 - ld;
24340 upper_yoff = lower_yoff - la - 1 - ud; */
24341 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24342 descent
= it
->descent
- (base_height
- height
) / 2;
24343 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24344 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24345 - metrics_upper
.descent
);
24346 /* Don't make the height shorter than the base height. */
24347 if (height
> base_height
)
24349 it
->ascent
= ascent
;
24350 it
->descent
= descent
;
24354 it
->phys_ascent
= it
->ascent
;
24355 it
->phys_descent
= it
->descent
;
24357 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24358 upper_xoff
, upper_yoff
,
24359 lower_xoff
, lower_yoff
);
24361 take_vertical_position_into_account (it
);
24366 Produce glyphs/get display metrics for the display element IT is
24367 loaded with. See the description of struct it in dispextern.h
24368 for an overview of struct it. */
24371 x_produce_glyphs (struct it
*it
)
24373 int extra_line_spacing
= it
->extra_line_spacing
;
24375 it
->glyph_not_available_p
= 0;
24377 if (it
->what
== IT_CHARACTER
)
24380 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24381 struct font
*font
= face
->font
;
24382 struct font_metrics
*pcm
= NULL
;
24383 int boff
; /* baseline offset */
24387 /* When no suitable font is found, display this character by
24388 the method specified in the first extra slot of
24389 Vglyphless_char_display. */
24390 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24392 xassert (it
->what
== IT_GLYPHLESS
);
24393 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24397 boff
= font
->baseline_offset
;
24398 if (font
->vertical_centering
)
24399 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24401 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24407 if (it
->override_ascent
>= 0)
24409 it
->ascent
= it
->override_ascent
;
24410 it
->descent
= it
->override_descent
;
24411 boff
= it
->override_boff
;
24415 it
->ascent
= FONT_BASE (font
) + boff
;
24416 it
->descent
= FONT_DESCENT (font
) - boff
;
24419 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24421 pcm
= get_per_char_metric (font
, &char2b
);
24422 if (pcm
->width
== 0
24423 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24429 it
->phys_ascent
= pcm
->ascent
+ boff
;
24430 it
->phys_descent
= pcm
->descent
- boff
;
24431 it
->pixel_width
= pcm
->width
;
24435 it
->glyph_not_available_p
= 1;
24436 it
->phys_ascent
= it
->ascent
;
24437 it
->phys_descent
= it
->descent
;
24438 it
->pixel_width
= font
->space_width
;
24441 if (it
->constrain_row_ascent_descent_p
)
24443 if (it
->descent
> it
->max_descent
)
24445 it
->ascent
+= it
->descent
- it
->max_descent
;
24446 it
->descent
= it
->max_descent
;
24448 if (it
->ascent
> it
->max_ascent
)
24450 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24451 it
->ascent
= it
->max_ascent
;
24453 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24454 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24455 extra_line_spacing
= 0;
24458 /* If this is a space inside a region of text with
24459 `space-width' property, change its width. */
24460 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24462 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24464 /* If face has a box, add the box thickness to the character
24465 height. If character has a box line to the left and/or
24466 right, add the box line width to the character's width. */
24467 if (face
->box
!= FACE_NO_BOX
)
24469 int thick
= face
->box_line_width
;
24473 it
->ascent
+= thick
;
24474 it
->descent
+= thick
;
24479 if (it
->start_of_box_run_p
)
24480 it
->pixel_width
+= thick
;
24481 if (it
->end_of_box_run_p
)
24482 it
->pixel_width
+= thick
;
24485 /* If face has an overline, add the height of the overline
24486 (1 pixel) and a 1 pixel margin to the character height. */
24487 if (face
->overline_p
)
24488 it
->ascent
+= overline_margin
;
24490 if (it
->constrain_row_ascent_descent_p
)
24492 if (it
->ascent
> it
->max_ascent
)
24493 it
->ascent
= it
->max_ascent
;
24494 if (it
->descent
> it
->max_descent
)
24495 it
->descent
= it
->max_descent
;
24498 take_vertical_position_into_account (it
);
24500 /* If we have to actually produce glyphs, do it. */
24505 /* Translate a space with a `space-width' property
24506 into a stretch glyph. */
24507 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24508 / FONT_HEIGHT (font
));
24509 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24510 it
->ascent
+ it
->descent
, ascent
);
24515 /* If characters with lbearing or rbearing are displayed
24516 in this line, record that fact in a flag of the
24517 glyph row. This is used to optimize X output code. */
24518 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24519 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24521 if (! stretched_p
&& it
->pixel_width
== 0)
24522 /* We assure that all visible glyphs have at least 1-pixel
24524 it
->pixel_width
= 1;
24526 else if (it
->char_to_display
== '\n')
24528 /* A newline has no width, but we need the height of the
24529 line. But if previous part of the line sets a height,
24530 don't increase that height */
24532 Lisp_Object height
;
24533 Lisp_Object total_height
= Qnil
;
24535 it
->override_ascent
= -1;
24536 it
->pixel_width
= 0;
24539 height
= get_it_property (it
, Qline_height
);
24540 /* Split (line-height total-height) list */
24542 && CONSP (XCDR (height
))
24543 && NILP (XCDR (XCDR (height
))))
24545 total_height
= XCAR (XCDR (height
));
24546 height
= XCAR (height
);
24548 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24550 if (it
->override_ascent
>= 0)
24552 it
->ascent
= it
->override_ascent
;
24553 it
->descent
= it
->override_descent
;
24554 boff
= it
->override_boff
;
24558 it
->ascent
= FONT_BASE (font
) + boff
;
24559 it
->descent
= FONT_DESCENT (font
) - boff
;
24562 if (EQ (height
, Qt
))
24564 if (it
->descent
> it
->max_descent
)
24566 it
->ascent
+= it
->descent
- it
->max_descent
;
24567 it
->descent
= it
->max_descent
;
24569 if (it
->ascent
> it
->max_ascent
)
24571 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24572 it
->ascent
= it
->max_ascent
;
24574 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24575 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24576 it
->constrain_row_ascent_descent_p
= 1;
24577 extra_line_spacing
= 0;
24581 Lisp_Object spacing
;
24583 it
->phys_ascent
= it
->ascent
;
24584 it
->phys_descent
= it
->descent
;
24586 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24587 && face
->box
!= FACE_NO_BOX
24588 && face
->box_line_width
> 0)
24590 it
->ascent
+= face
->box_line_width
;
24591 it
->descent
+= face
->box_line_width
;
24594 && XINT (height
) > it
->ascent
+ it
->descent
)
24595 it
->ascent
= XINT (height
) - it
->descent
;
24597 if (!NILP (total_height
))
24598 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24601 spacing
= get_it_property (it
, Qline_spacing
);
24602 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24604 if (INTEGERP (spacing
))
24606 extra_line_spacing
= XINT (spacing
);
24607 if (!NILP (total_height
))
24608 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24612 else /* i.e. (it->char_to_display == '\t') */
24614 if (font
->space_width
> 0)
24616 int tab_width
= it
->tab_width
* font
->space_width
;
24617 int x
= it
->current_x
+ it
->continuation_lines_width
;
24618 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24620 /* If the distance from the current position to the next tab
24621 stop is less than a space character width, use the
24622 tab stop after that. */
24623 if (next_tab_x
- x
< font
->space_width
)
24624 next_tab_x
+= tab_width
;
24626 it
->pixel_width
= next_tab_x
- x
;
24628 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24629 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24633 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24634 it
->ascent
+ it
->descent
, it
->ascent
);
24639 it
->pixel_width
= 0;
24644 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24646 /* A static composition.
24648 Note: A composition is represented as one glyph in the
24649 glyph matrix. There are no padding glyphs.
24651 Important note: pixel_width, ascent, and descent are the
24652 values of what is drawn by draw_glyphs (i.e. the values of
24653 the overall glyphs composed). */
24654 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24655 int boff
; /* baseline offset */
24656 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24657 int glyph_len
= cmp
->glyph_len
;
24658 struct font
*font
= face
->font
;
24662 /* If we have not yet calculated pixel size data of glyphs of
24663 the composition for the current face font, calculate them
24664 now. Theoretically, we have to check all fonts for the
24665 glyphs, but that requires much time and memory space. So,
24666 here we check only the font of the first glyph. This may
24667 lead to incorrect display, but it's very rare, and C-l
24668 (recenter-top-bottom) can correct the display anyway. */
24669 if (! cmp
->font
|| cmp
->font
!= font
)
24671 /* Ascent and descent of the font of the first character
24672 of this composition (adjusted by baseline offset).
24673 Ascent and descent of overall glyphs should not be less
24674 than these, respectively. */
24675 int font_ascent
, font_descent
, font_height
;
24676 /* Bounding box of the overall glyphs. */
24677 int leftmost
, rightmost
, lowest
, highest
;
24678 int lbearing
, rbearing
;
24679 int i
, width
, ascent
, descent
;
24680 int left_padded
= 0, right_padded
= 0;
24681 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24683 struct font_metrics
*pcm
;
24684 int font_not_found_p
;
24687 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24688 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24690 if (glyph_len
< cmp
->glyph_len
)
24692 for (i
= 0; i
< glyph_len
; i
++)
24694 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24696 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24701 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24702 : IT_CHARPOS (*it
));
24703 /* If no suitable font is found, use the default font. */
24704 font_not_found_p
= font
== NULL
;
24705 if (font_not_found_p
)
24707 face
= face
->ascii_face
;
24710 boff
= font
->baseline_offset
;
24711 if (font
->vertical_centering
)
24712 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24713 font_ascent
= FONT_BASE (font
) + boff
;
24714 font_descent
= FONT_DESCENT (font
) - boff
;
24715 font_height
= FONT_HEIGHT (font
);
24717 cmp
->font
= (void *) font
;
24720 if (! font_not_found_p
)
24722 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24724 pcm
= get_per_char_metric (font
, &char2b
);
24727 /* Initialize the bounding box. */
24730 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24731 ascent
= pcm
->ascent
;
24732 descent
= pcm
->descent
;
24733 lbearing
= pcm
->lbearing
;
24734 rbearing
= pcm
->rbearing
;
24738 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24739 ascent
= FONT_BASE (font
);
24740 descent
= FONT_DESCENT (font
);
24747 lowest
= - descent
+ boff
;
24748 highest
= ascent
+ boff
;
24750 if (! font_not_found_p
24751 && font
->default_ascent
24752 && CHAR_TABLE_P (Vuse_default_ascent
)
24753 && !NILP (Faref (Vuse_default_ascent
,
24754 make_number (it
->char_to_display
))))
24755 highest
= font
->default_ascent
+ boff
;
24757 /* Draw the first glyph at the normal position. It may be
24758 shifted to right later if some other glyphs are drawn
24760 cmp
->offsets
[i
* 2] = 0;
24761 cmp
->offsets
[i
* 2 + 1] = boff
;
24762 cmp
->lbearing
= lbearing
;
24763 cmp
->rbearing
= rbearing
;
24765 /* Set cmp->offsets for the remaining glyphs. */
24766 for (i
++; i
< glyph_len
; i
++)
24768 int left
, right
, btm
, top
;
24769 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24771 struct face
*this_face
;
24775 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24776 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24777 font
= this_face
->font
;
24783 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24785 pcm
= get_per_char_metric (font
, &char2b
);
24788 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24791 width
= pcm
->width
;
24792 ascent
= pcm
->ascent
;
24793 descent
= pcm
->descent
;
24794 lbearing
= pcm
->lbearing
;
24795 rbearing
= pcm
->rbearing
;
24796 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24798 /* Relative composition with or without
24799 alternate chars. */
24800 left
= (leftmost
+ rightmost
- width
) / 2;
24801 btm
= - descent
+ boff
;
24802 if (font
->relative_compose
24803 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24804 || NILP (Faref (Vignore_relative_composition
,
24805 make_number (ch
)))))
24808 if (- descent
>= font
->relative_compose
)
24809 /* One extra pixel between two glyphs. */
24811 else if (ascent
<= 0)
24812 /* One extra pixel between two glyphs. */
24813 btm
= lowest
- 1 - ascent
- descent
;
24818 /* A composition rule is specified by an integer
24819 value that encodes global and new reference
24820 points (GREF and NREF). GREF and NREF are
24821 specified by numbers as below:
24823 0---1---2 -- ascent
24827 9--10--11 -- center
24829 ---3---4---5--- baseline
24831 6---7---8 -- descent
24833 int rule
= COMPOSITION_RULE (cmp
, i
);
24834 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24836 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24837 grefx
= gref
% 3, nrefx
= nref
% 3;
24838 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24840 xoff
= font_height
* (xoff
- 128) / 256;
24842 yoff
= font_height
* (yoff
- 128) / 256;
24845 + grefx
* (rightmost
- leftmost
) / 2
24846 - nrefx
* width
/ 2
24849 btm
= ((grefy
== 0 ? highest
24851 : grefy
== 2 ? lowest
24852 : (highest
+ lowest
) / 2)
24853 - (nrefy
== 0 ? ascent
+ descent
24854 : nrefy
== 1 ? descent
- boff
24856 : (ascent
+ descent
) / 2)
24860 cmp
->offsets
[i
* 2] = left
;
24861 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24863 /* Update the bounding box of the overall glyphs. */
24866 right
= left
+ width
;
24867 if (left
< leftmost
)
24869 if (right
> rightmost
)
24872 top
= btm
+ descent
+ ascent
;
24878 if (cmp
->lbearing
> left
+ lbearing
)
24879 cmp
->lbearing
= left
+ lbearing
;
24880 if (cmp
->rbearing
< left
+ rbearing
)
24881 cmp
->rbearing
= left
+ rbearing
;
24885 /* If there are glyphs whose x-offsets are negative,
24886 shift all glyphs to the right and make all x-offsets
24890 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24891 cmp
->offsets
[i
* 2] -= leftmost
;
24892 rightmost
-= leftmost
;
24893 cmp
->lbearing
-= leftmost
;
24894 cmp
->rbearing
-= leftmost
;
24897 if (left_padded
&& cmp
->lbearing
< 0)
24899 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24900 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24901 rightmost
-= cmp
->lbearing
;
24902 cmp
->rbearing
-= cmp
->lbearing
;
24905 if (right_padded
&& rightmost
< cmp
->rbearing
)
24907 rightmost
= cmp
->rbearing
;
24910 cmp
->pixel_width
= rightmost
;
24911 cmp
->ascent
= highest
;
24912 cmp
->descent
= - lowest
;
24913 if (cmp
->ascent
< font_ascent
)
24914 cmp
->ascent
= font_ascent
;
24915 if (cmp
->descent
< font_descent
)
24916 cmp
->descent
= font_descent
;
24920 && (cmp
->lbearing
< 0
24921 || cmp
->rbearing
> cmp
->pixel_width
))
24922 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24924 it
->pixel_width
= cmp
->pixel_width
;
24925 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24926 it
->descent
= it
->phys_descent
= cmp
->descent
;
24927 if (face
->box
!= FACE_NO_BOX
)
24929 int thick
= face
->box_line_width
;
24933 it
->ascent
+= thick
;
24934 it
->descent
+= thick
;
24939 if (it
->start_of_box_run_p
)
24940 it
->pixel_width
+= thick
;
24941 if (it
->end_of_box_run_p
)
24942 it
->pixel_width
+= thick
;
24945 /* If face has an overline, add the height of the overline
24946 (1 pixel) and a 1 pixel margin to the character height. */
24947 if (face
->overline_p
)
24948 it
->ascent
+= overline_margin
;
24950 take_vertical_position_into_account (it
);
24951 if (it
->ascent
< 0)
24953 if (it
->descent
< 0)
24956 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
24957 append_composite_glyph (it
);
24959 else if (it
->what
== IT_COMPOSITION
)
24961 /* A dynamic (automatic) composition. */
24962 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24963 Lisp_Object gstring
;
24964 struct font_metrics metrics
;
24968 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24970 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24973 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24974 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24975 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24976 it
->descent
= it
->phys_descent
= metrics
.descent
;
24977 if (face
->box
!= FACE_NO_BOX
)
24979 int thick
= face
->box_line_width
;
24983 it
->ascent
+= thick
;
24984 it
->descent
+= thick
;
24989 if (it
->start_of_box_run_p
)
24990 it
->pixel_width
+= thick
;
24991 if (it
->end_of_box_run_p
)
24992 it
->pixel_width
+= thick
;
24994 /* If face has an overline, add the height of the overline
24995 (1 pixel) and a 1 pixel margin to the character height. */
24996 if (face
->overline_p
)
24997 it
->ascent
+= overline_margin
;
24998 take_vertical_position_into_account (it
);
24999 if (it
->ascent
< 0)
25001 if (it
->descent
< 0)
25005 append_composite_glyph (it
);
25007 else if (it
->what
== IT_GLYPHLESS
)
25008 produce_glyphless_glyph (it
, 0, Qnil
);
25009 else if (it
->what
== IT_IMAGE
)
25010 produce_image_glyph (it
);
25011 else if (it
->what
== IT_STRETCH
)
25012 produce_stretch_glyph (it
);
25013 #ifdef HAVE_XWIDGETS
25014 else if (it
->what
== IT_XWIDGET
)
25015 produce_xwidget_glyph (it
);
25018 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25019 because this isn't true for images with `:ascent 100'. */
25020 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
25021 if (it
->area
== TEXT_AREA
)
25022 it
->current_x
+= it
->pixel_width
;
25024 if (extra_line_spacing
> 0)
25026 it
->descent
+= extra_line_spacing
;
25027 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25028 it
->max_extra_line_spacing
= extra_line_spacing
;
25031 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25032 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25033 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25034 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25038 Output LEN glyphs starting at START at the nominal cursor position.
25039 Advance the nominal cursor over the text. The global variable
25040 updated_window contains the window being updated, updated_row is
25041 the glyph row being updated, and updated_area is the area of that
25042 row being updated. */
25045 x_write_glyphs (struct glyph
*start
, int len
)
25047 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25049 xassert (updated_window
&& updated_row
);
25050 /* When the window is hscrolled, cursor hpos can legitimately be out
25051 of bounds, but we draw the cursor at the corresponding window
25052 margin in that case. */
25053 if (!updated_row
->reversed_p
&& chpos
< 0)
25055 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25056 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25060 /* Write glyphs. */
25062 hpos
= start
- updated_row
->glyphs
[updated_area
];
25063 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25064 updated_row
, updated_area
,
25066 DRAW_NORMAL_TEXT
, 0);
25068 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25069 if (updated_area
== TEXT_AREA
25070 && updated_window
->phys_cursor_on_p
25071 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25073 && chpos
< hpos
+ len
)
25074 updated_window
->phys_cursor_on_p
= 0;
25078 /* Advance the output cursor. */
25079 output_cursor
.hpos
+= len
;
25080 output_cursor
.x
= x
;
25085 Insert LEN glyphs from START at the nominal cursor position. */
25088 x_insert_glyphs (struct glyph
*start
, int len
)
25092 int line_height
, shift_by_width
, shifted_region_width
;
25093 struct glyph_row
*row
;
25094 struct glyph
*glyph
;
25095 int frame_x
, frame_y
;
25098 xassert (updated_window
&& updated_row
);
25100 w
= updated_window
;
25101 f
= XFRAME (WINDOW_FRAME (w
));
25103 /* Get the height of the line we are in. */
25105 line_height
= row
->height
;
25107 /* Get the width of the glyphs to insert. */
25108 shift_by_width
= 0;
25109 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25110 shift_by_width
+= glyph
->pixel_width
;
25112 /* Get the width of the region to shift right. */
25113 shifted_region_width
= (window_box_width (w
, updated_area
)
25118 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25119 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25121 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25122 line_height
, shift_by_width
);
25124 /* Write the glyphs. */
25125 hpos
= start
- row
->glyphs
[updated_area
];
25126 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25128 DRAW_NORMAL_TEXT
, 0);
25130 /* Advance the output cursor. */
25131 output_cursor
.hpos
+= len
;
25132 output_cursor
.x
+= shift_by_width
;
25138 Erase the current text line from the nominal cursor position
25139 (inclusive) to pixel column TO_X (exclusive). The idea is that
25140 everything from TO_X onward is already erased.
25142 TO_X is a pixel position relative to updated_area of
25143 updated_window. TO_X == -1 means clear to the end of this area. */
25146 x_clear_end_of_line (int to_x
)
25149 struct window
*w
= updated_window
;
25150 int max_x
, min_y
, max_y
;
25151 int from_x
, from_y
, to_y
;
25153 xassert (updated_window
&& updated_row
);
25154 f
= XFRAME (w
->frame
);
25156 if (updated_row
->full_width_p
)
25157 max_x
= WINDOW_TOTAL_WIDTH (w
);
25159 max_x
= window_box_width (w
, updated_area
);
25160 max_y
= window_text_bottom_y (w
);
25162 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25163 of window. For TO_X > 0, truncate to end of drawing area. */
25169 to_x
= min (to_x
, max_x
);
25171 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25173 /* Notice if the cursor will be cleared by this operation. */
25174 if (!updated_row
->full_width_p
)
25175 notice_overwritten_cursor (w
, updated_area
,
25176 output_cursor
.x
, -1,
25178 MATRIX_ROW_BOTTOM_Y (updated_row
));
25180 from_x
= output_cursor
.x
;
25182 /* Translate to frame coordinates. */
25183 if (updated_row
->full_width_p
)
25185 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25186 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25190 int area_left
= window_box_left (w
, updated_area
);
25191 from_x
+= area_left
;
25195 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25196 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25197 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25199 /* Prevent inadvertently clearing to end of the X window. */
25200 if (to_x
> from_x
&& to_y
> from_y
)
25203 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25204 to_x
- from_x
, to_y
- from_y
);
25209 #endif /* HAVE_WINDOW_SYSTEM */
25213 /***********************************************************************
25215 ***********************************************************************/
25217 /* Value is the internal representation of the specified cursor type
25218 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25219 of the bar cursor. */
25221 static enum text_cursor_kinds
25222 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25224 enum text_cursor_kinds type
;
25229 if (EQ (arg
, Qbox
))
25230 return FILLED_BOX_CURSOR
;
25232 if (EQ (arg
, Qhollow
))
25233 return HOLLOW_BOX_CURSOR
;
25235 if (EQ (arg
, Qbar
))
25242 && EQ (XCAR (arg
), Qbar
)
25243 && INTEGERP (XCDR (arg
))
25244 && XINT (XCDR (arg
)) >= 0)
25246 *width
= XINT (XCDR (arg
));
25250 if (EQ (arg
, Qhbar
))
25253 return HBAR_CURSOR
;
25257 && EQ (XCAR (arg
), Qhbar
)
25258 && INTEGERP (XCDR (arg
))
25259 && XINT (XCDR (arg
)) >= 0)
25261 *width
= XINT (XCDR (arg
));
25262 return HBAR_CURSOR
;
25265 /* Treat anything unknown as "hollow box cursor".
25266 It was bad to signal an error; people have trouble fixing
25267 .Xdefaults with Emacs, when it has something bad in it. */
25268 type
= HOLLOW_BOX_CURSOR
;
25273 /* Set the default cursor types for specified frame. */
25275 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25280 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25281 FRAME_CURSOR_WIDTH (f
) = width
;
25283 /* By default, set up the blink-off state depending on the on-state. */
25285 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25288 FRAME_BLINK_OFF_CURSOR (f
)
25289 = get_specified_cursor_type (XCDR (tem
), &width
);
25290 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25293 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25297 #ifdef HAVE_WINDOW_SYSTEM
25299 /* Return the cursor we want to be displayed in window W. Return
25300 width of bar/hbar cursor through WIDTH arg. Return with
25301 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25302 (i.e. if the `system caret' should track this cursor).
25304 In a mini-buffer window, we want the cursor only to appear if we
25305 are reading input from this window. For the selected window, we
25306 want the cursor type given by the frame parameter or buffer local
25307 setting of cursor-type. If explicitly marked off, draw no cursor.
25308 In all other cases, we want a hollow box cursor. */
25310 static enum text_cursor_kinds
25311 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25312 int *active_cursor
)
25314 struct frame
*f
= XFRAME (w
->frame
);
25315 struct buffer
*b
= XBUFFER (w
->buffer
);
25316 int cursor_type
= DEFAULT_CURSOR
;
25317 Lisp_Object alt_cursor
;
25318 int non_selected
= 0;
25320 *active_cursor
= 1;
25323 if (cursor_in_echo_area
25324 && FRAME_HAS_MINIBUF_P (f
)
25325 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25327 if (w
== XWINDOW (echo_area_window
))
25329 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25331 *width
= FRAME_CURSOR_WIDTH (f
);
25332 return FRAME_DESIRED_CURSOR (f
);
25335 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25338 *active_cursor
= 0;
25342 /* Detect a nonselected window or nonselected frame. */
25343 else if (w
!= XWINDOW (f
->selected_window
)
25344 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25346 *active_cursor
= 0;
25348 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25354 /* Never display a cursor in a window in which cursor-type is nil. */
25355 if (NILP (BVAR (b
, cursor_type
)))
25358 /* Get the normal cursor type for this window. */
25359 if (EQ (BVAR (b
, cursor_type
), Qt
))
25361 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25362 *width
= FRAME_CURSOR_WIDTH (f
);
25365 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25367 /* Use cursor-in-non-selected-windows instead
25368 for non-selected window or frame. */
25371 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25372 if (!EQ (Qt
, alt_cursor
))
25373 return get_specified_cursor_type (alt_cursor
, width
);
25374 /* t means modify the normal cursor type. */
25375 if (cursor_type
== FILLED_BOX_CURSOR
)
25376 cursor_type
= HOLLOW_BOX_CURSOR
;
25377 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25379 return cursor_type
;
25382 /* Use normal cursor if not blinked off. */
25383 if (!w
->cursor_off_p
)
25386 #ifdef HAVE_XWIDGETS
25387 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
25388 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
25392 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25394 if (cursor_type
== FILLED_BOX_CURSOR
)
25396 /* Using a block cursor on large images can be very annoying.
25397 So use a hollow cursor for "large" images.
25398 If image is not transparent (no mask), also use hollow cursor. */
25399 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25400 if (img
!= NULL
&& IMAGEP (img
->spec
))
25402 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25403 where N = size of default frame font size.
25404 This should cover most of the "tiny" icons people may use. */
25406 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25407 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25408 cursor_type
= HOLLOW_BOX_CURSOR
;
25411 else if (cursor_type
!= NO_CURSOR
)
25413 /* Display current only supports BOX and HOLLOW cursors for images.
25414 So for now, unconditionally use a HOLLOW cursor when cursor is
25415 not a solid box cursor. */
25416 cursor_type
= HOLLOW_BOX_CURSOR
;
25419 return cursor_type
;
25422 /* Cursor is blinked off, so determine how to "toggle" it. */
25424 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25425 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25426 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25428 /* Then see if frame has specified a specific blink off cursor type. */
25429 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25431 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25432 return FRAME_BLINK_OFF_CURSOR (f
);
25436 /* Some people liked having a permanently visible blinking cursor,
25437 while others had very strong opinions against it. So it was
25438 decided to remove it. KFS 2003-09-03 */
25440 /* Finally perform built-in cursor blinking:
25441 filled box <-> hollow box
25442 wide [h]bar <-> narrow [h]bar
25443 narrow [h]bar <-> no cursor
25444 other type <-> no cursor */
25446 if (cursor_type
== FILLED_BOX_CURSOR
)
25447 return HOLLOW_BOX_CURSOR
;
25449 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25452 return cursor_type
;
25460 /* Notice when the text cursor of window W has been completely
25461 overwritten by a drawing operation that outputs glyphs in AREA
25462 starting at X0 and ending at X1 in the line starting at Y0 and
25463 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25464 the rest of the line after X0 has been written. Y coordinates
25465 are window-relative. */
25468 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25469 int x0
, int x1
, int y0
, int y1
)
25471 int cx0
, cx1
, cy0
, cy1
;
25472 struct glyph_row
*row
;
25474 if (!w
->phys_cursor_on_p
)
25476 if (area
!= TEXT_AREA
)
25479 if (w
->phys_cursor
.vpos
< 0
25480 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25481 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25482 !(row
->enabled_p
&& row
->displays_text_p
)))
25485 if (row
->cursor_in_fringe_p
)
25487 row
->cursor_in_fringe_p
= 0;
25488 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25489 w
->phys_cursor_on_p
= 0;
25493 cx0
= w
->phys_cursor
.x
;
25494 cx1
= cx0
+ w
->phys_cursor_width
;
25495 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25498 /* The cursor image will be completely removed from the
25499 screen if the output area intersects the cursor area in
25500 y-direction. When we draw in [y0 y1[, and some part of
25501 the cursor is at y < y0, that part must have been drawn
25502 before. When scrolling, the cursor is erased before
25503 actually scrolling, so we don't come here. When not
25504 scrolling, the rows above the old cursor row must have
25505 changed, and in this case these rows must have written
25506 over the cursor image.
25508 Likewise if part of the cursor is below y1, with the
25509 exception of the cursor being in the first blank row at
25510 the buffer and window end because update_text_area
25511 doesn't draw that row. (Except when it does, but
25512 that's handled in update_text_area.) */
25514 cy0
= w
->phys_cursor
.y
;
25515 cy1
= cy0
+ w
->phys_cursor_height
;
25516 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25519 w
->phys_cursor_on_p
= 0;
25522 #endif /* HAVE_WINDOW_SYSTEM */
25525 /************************************************************************
25527 ************************************************************************/
25529 #ifdef HAVE_WINDOW_SYSTEM
25532 Fix the display of area AREA of overlapping row ROW in window W
25533 with respect to the overlapping part OVERLAPS. */
25536 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25537 enum glyph_row_area area
, int overlaps
)
25544 for (i
= 0; i
< row
->used
[area
];)
25546 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25548 int start
= i
, start_x
= x
;
25552 x
+= row
->glyphs
[area
][i
].pixel_width
;
25555 while (i
< row
->used
[area
]
25556 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25558 draw_glyphs (w
, start_x
, row
, area
,
25560 DRAW_NORMAL_TEXT
, overlaps
);
25564 x
+= row
->glyphs
[area
][i
].pixel_width
;
25574 Draw the cursor glyph of window W in glyph row ROW. See the
25575 comment of draw_glyphs for the meaning of HL. */
25578 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25579 enum draw_glyphs_face hl
)
25581 /* If cursor hpos is out of bounds, don't draw garbage. This can
25582 happen in mini-buffer windows when switching between echo area
25583 glyphs and mini-buffer. */
25584 if ((row
->reversed_p
25585 ? (w
->phys_cursor
.hpos
>= 0)
25586 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25588 int on_p
= w
->phys_cursor_on_p
;
25590 int hpos
= w
->phys_cursor
.hpos
;
25592 /* When the window is hscrolled, cursor hpos can legitimately be
25593 out of bounds, but we draw the cursor at the corresponding
25594 window margin in that case. */
25595 if (!row
->reversed_p
&& hpos
< 0)
25597 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25598 hpos
= row
->used
[TEXT_AREA
] - 1;
25600 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25602 w
->phys_cursor_on_p
= on_p
;
25604 if (hl
== DRAW_CURSOR
)
25605 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25606 /* When we erase the cursor, and ROW is overlapped by other
25607 rows, make sure that these overlapping parts of other rows
25609 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25611 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25613 if (row
> w
->current_matrix
->rows
25614 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25615 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25616 OVERLAPS_ERASED_CURSOR
);
25618 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25619 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25620 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25621 OVERLAPS_ERASED_CURSOR
);
25628 Erase the image of a cursor of window W from the screen. */
25631 erase_phys_cursor (struct window
*w
)
25633 struct frame
*f
= XFRAME (w
->frame
);
25634 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25635 int hpos
= w
->phys_cursor
.hpos
;
25636 int vpos
= w
->phys_cursor
.vpos
;
25637 int mouse_face_here_p
= 0;
25638 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25639 struct glyph_row
*cursor_row
;
25640 struct glyph
*cursor_glyph
;
25641 enum draw_glyphs_face hl
;
25643 /* No cursor displayed or row invalidated => nothing to do on the
25645 if (w
->phys_cursor_type
== NO_CURSOR
)
25646 goto mark_cursor_off
;
25648 /* VPOS >= active_glyphs->nrows means that window has been resized.
25649 Don't bother to erase the cursor. */
25650 if (vpos
>= active_glyphs
->nrows
)
25651 goto mark_cursor_off
;
25653 /* If row containing cursor is marked invalid, there is nothing we
25655 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25656 if (!cursor_row
->enabled_p
)
25657 goto mark_cursor_off
;
25659 /* If line spacing is > 0, old cursor may only be partially visible in
25660 window after split-window. So adjust visible height. */
25661 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25662 window_text_bottom_y (w
) - cursor_row
->y
);
25664 /* If row is completely invisible, don't attempt to delete a cursor which
25665 isn't there. This can happen if cursor is at top of a window, and
25666 we switch to a buffer with a header line in that window. */
25667 if (cursor_row
->visible_height
<= 0)
25668 goto mark_cursor_off
;
25670 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25671 if (cursor_row
->cursor_in_fringe_p
)
25673 cursor_row
->cursor_in_fringe_p
= 0;
25674 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25675 goto mark_cursor_off
;
25678 /* This can happen when the new row is shorter than the old one.
25679 In this case, either draw_glyphs or clear_end_of_line
25680 should have cleared the cursor. Note that we wouldn't be
25681 able to erase the cursor in this case because we don't have a
25682 cursor glyph at hand. */
25683 if ((cursor_row
->reversed_p
25684 ? (w
->phys_cursor
.hpos
< 0)
25685 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25686 goto mark_cursor_off
;
25688 /* When the window is hscrolled, cursor hpos can legitimately be out
25689 of bounds, but we draw the cursor at the corresponding window
25690 margin in that case. */
25691 if (!cursor_row
->reversed_p
&& hpos
< 0)
25693 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25694 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25696 /* If the cursor is in the mouse face area, redisplay that when
25697 we clear the cursor. */
25698 if (! NILP (hlinfo
->mouse_face_window
)
25699 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25700 /* Don't redraw the cursor's spot in mouse face if it is at the
25701 end of a line (on a newline). The cursor appears there, but
25702 mouse highlighting does not. */
25703 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25704 mouse_face_here_p
= 1;
25706 /* Maybe clear the display under the cursor. */
25707 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25710 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25713 cursor_glyph
= get_phys_cursor_glyph (w
);
25714 if (cursor_glyph
== NULL
)
25715 goto mark_cursor_off
;
25717 width
= cursor_glyph
->pixel_width
;
25718 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25719 x
= w
->phys_cursor
.x
;
25721 width
-= left_x
- x
;
25722 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25723 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25724 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25727 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25730 /* Erase the cursor by redrawing the character underneath it. */
25731 if (mouse_face_here_p
)
25732 hl
= DRAW_MOUSE_FACE
;
25734 hl
= DRAW_NORMAL_TEXT
;
25735 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25738 w
->phys_cursor_on_p
= 0;
25739 w
->phys_cursor_type
= NO_CURSOR
;
25744 Display or clear cursor of window W. If ON is zero, clear the
25745 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25746 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25749 display_and_set_cursor (struct window
*w
, int on
,
25750 int hpos
, int vpos
, int x
, int y
)
25752 struct frame
*f
= XFRAME (w
->frame
);
25753 int new_cursor_type
;
25754 int new_cursor_width
;
25756 struct glyph_row
*glyph_row
;
25757 struct glyph
*glyph
;
25759 /* This is pointless on invisible frames, and dangerous on garbaged
25760 windows and frames; in the latter case, the frame or window may
25761 be in the midst of changing its size, and x and y may be off the
25763 if (! FRAME_VISIBLE_P (f
)
25764 || FRAME_GARBAGED_P (f
)
25765 || vpos
>= w
->current_matrix
->nrows
25766 || hpos
>= w
->current_matrix
->matrix_w
)
25769 /* If cursor is off and we want it off, return quickly. */
25770 if (!on
&& !w
->phys_cursor_on_p
)
25773 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25774 /* If cursor row is not enabled, we don't really know where to
25775 display the cursor. */
25776 if (!glyph_row
->enabled_p
)
25778 w
->phys_cursor_on_p
= 0;
25783 if (!glyph_row
->exact_window_width_line_p
25784 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25785 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25787 xassert (interrupt_input_blocked
);
25789 /* Set new_cursor_type to the cursor we want to be displayed. */
25790 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25791 &new_cursor_width
, &active_cursor
);
25793 /* If cursor is currently being shown and we don't want it to be or
25794 it is in the wrong place, or the cursor type is not what we want,
25796 if (w
->phys_cursor_on_p
25798 || w
->phys_cursor
.x
!= x
25799 || w
->phys_cursor
.y
!= y
25800 || new_cursor_type
!= w
->phys_cursor_type
25801 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25802 && new_cursor_width
!= w
->phys_cursor_width
)))
25803 erase_phys_cursor (w
);
25805 /* Don't check phys_cursor_on_p here because that flag is only set
25806 to zero in some cases where we know that the cursor has been
25807 completely erased, to avoid the extra work of erasing the cursor
25808 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25809 still not be visible, or it has only been partly erased. */
25812 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25813 w
->phys_cursor_height
= glyph_row
->height
;
25815 /* Set phys_cursor_.* before x_draw_.* is called because some
25816 of them may need the information. */
25817 w
->phys_cursor
.x
= x
;
25818 w
->phys_cursor
.y
= glyph_row
->y
;
25819 w
->phys_cursor
.hpos
= hpos
;
25820 w
->phys_cursor
.vpos
= vpos
;
25823 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25824 new_cursor_type
, new_cursor_width
,
25825 on
, active_cursor
);
25829 /* Switch the display of W's cursor on or off, according to the value
25833 update_window_cursor (struct window
*w
, int on
)
25835 /* Don't update cursor in windows whose frame is in the process
25836 of being deleted. */
25837 if (w
->current_matrix
)
25839 int hpos
= w
->phys_cursor
.hpos
;
25840 int vpos
= w
->phys_cursor
.vpos
;
25841 struct glyph_row
*row
;
25843 if (vpos
>= w
->current_matrix
->nrows
25844 || hpos
>= w
->current_matrix
->matrix_w
)
25847 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25849 /* When the window is hscrolled, cursor hpos can legitimately be
25850 out of bounds, but we draw the cursor at the corresponding
25851 window margin in that case. */
25852 if (!row
->reversed_p
&& hpos
< 0)
25854 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25855 hpos
= row
->used
[TEXT_AREA
] - 1;
25858 display_and_set_cursor (w
, on
, hpos
, vpos
,
25859 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25865 /* Call update_window_cursor with parameter ON_P on all leaf windows
25866 in the window tree rooted at W. */
25869 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25873 if (!NILP (w
->hchild
))
25874 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25875 else if (!NILP (w
->vchild
))
25876 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25878 update_window_cursor (w
, on_p
);
25880 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25886 Display the cursor on window W, or clear it, according to ON_P.
25887 Don't change the cursor's position. */
25890 x_update_cursor (struct frame
*f
, int on_p
)
25892 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25897 Clear the cursor of window W to background color, and mark the
25898 cursor as not shown. This is used when the text where the cursor
25899 is about to be rewritten. */
25902 x_clear_cursor (struct window
*w
)
25904 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25905 update_window_cursor (w
, 0);
25908 #endif /* HAVE_WINDOW_SYSTEM */
25910 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25913 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25914 int start_hpos
, int end_hpos
,
25915 enum draw_glyphs_face draw
)
25917 #ifdef HAVE_WINDOW_SYSTEM
25918 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25920 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25924 #if defined (HAVE_GPM) || defined (MSDOS)
25925 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25929 /* Display the active region described by mouse_face_* according to DRAW. */
25932 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25934 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25935 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25937 if (/* If window is in the process of being destroyed, don't bother
25939 w
->current_matrix
!= NULL
25940 /* Don't update mouse highlight if hidden */
25941 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25942 /* Recognize when we are called to operate on rows that don't exist
25943 anymore. This can happen when a window is split. */
25944 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25946 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25947 struct glyph_row
*row
, *first
, *last
;
25949 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25950 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25952 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25954 int start_hpos
, end_hpos
, start_x
;
25956 /* For all but the first row, the highlight starts at column 0. */
25959 /* R2L rows have BEG and END in reversed order, but the
25960 screen drawing geometry is always left to right. So
25961 we need to mirror the beginning and end of the
25962 highlighted area in R2L rows. */
25963 if (!row
->reversed_p
)
25965 start_hpos
= hlinfo
->mouse_face_beg_col
;
25966 start_x
= hlinfo
->mouse_face_beg_x
;
25968 else if (row
== last
)
25970 start_hpos
= hlinfo
->mouse_face_end_col
;
25971 start_x
= hlinfo
->mouse_face_end_x
;
25979 else if (row
->reversed_p
&& row
== last
)
25981 start_hpos
= hlinfo
->mouse_face_end_col
;
25982 start_x
= hlinfo
->mouse_face_end_x
;
25992 if (!row
->reversed_p
)
25993 end_hpos
= hlinfo
->mouse_face_end_col
;
25994 else if (row
== first
)
25995 end_hpos
= hlinfo
->mouse_face_beg_col
;
25998 end_hpos
= row
->used
[TEXT_AREA
];
25999 if (draw
== DRAW_NORMAL_TEXT
)
26000 row
->fill_line_p
= 1; /* Clear to end of line */
26003 else if (row
->reversed_p
&& row
== first
)
26004 end_hpos
= hlinfo
->mouse_face_beg_col
;
26007 end_hpos
= row
->used
[TEXT_AREA
];
26008 if (draw
== DRAW_NORMAL_TEXT
)
26009 row
->fill_line_p
= 1; /* Clear to end of line */
26012 if (end_hpos
> start_hpos
)
26014 draw_row_with_mouse_face (w
, start_x
, row
,
26015 start_hpos
, end_hpos
, draw
);
26018 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26022 #ifdef HAVE_WINDOW_SYSTEM
26023 /* When we've written over the cursor, arrange for it to
26024 be displayed again. */
26025 if (FRAME_WINDOW_P (f
)
26026 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26028 int hpos
= w
->phys_cursor
.hpos
;
26030 /* When the window is hscrolled, cursor hpos can legitimately be
26031 out of bounds, but we draw the cursor at the corresponding
26032 window margin in that case. */
26033 if (!row
->reversed_p
&& hpos
< 0)
26035 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26036 hpos
= row
->used
[TEXT_AREA
] - 1;
26039 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26040 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26043 #endif /* HAVE_WINDOW_SYSTEM */
26046 #ifdef HAVE_WINDOW_SYSTEM
26047 /* Change the mouse cursor. */
26048 if (FRAME_WINDOW_P (f
))
26050 if (draw
== DRAW_NORMAL_TEXT
26051 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26052 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26053 else if (draw
== DRAW_MOUSE_FACE
)
26054 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26056 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26058 #endif /* HAVE_WINDOW_SYSTEM */
26062 Clear out the mouse-highlighted active region.
26063 Redraw it un-highlighted first. Value is non-zero if mouse
26064 face was actually drawn unhighlighted. */
26067 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26071 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26073 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26077 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26078 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26079 hlinfo
->mouse_face_window
= Qnil
;
26080 hlinfo
->mouse_face_overlay
= Qnil
;
26084 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26085 within the mouse face on that window. */
26087 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26089 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26091 /* Quickly resolve the easy cases. */
26092 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26093 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26095 if (vpos
< hlinfo
->mouse_face_beg_row
26096 || vpos
> hlinfo
->mouse_face_end_row
)
26098 if (vpos
> hlinfo
->mouse_face_beg_row
26099 && vpos
< hlinfo
->mouse_face_end_row
)
26102 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26104 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26106 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26109 else if ((vpos
== hlinfo
->mouse_face_beg_row
26110 && hpos
>= hlinfo
->mouse_face_beg_col
)
26111 || (vpos
== hlinfo
->mouse_face_end_row
26112 && hpos
< hlinfo
->mouse_face_end_col
))
26117 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26119 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26122 else if ((vpos
== hlinfo
->mouse_face_beg_row
26123 && hpos
<= hlinfo
->mouse_face_beg_col
)
26124 || (vpos
== hlinfo
->mouse_face_end_row
26125 && hpos
> hlinfo
->mouse_face_end_col
))
26133 Non-zero if physical cursor of window W is within mouse face. */
26136 cursor_in_mouse_face_p (struct window
*w
)
26138 int hpos
= w
->phys_cursor
.hpos
;
26139 int vpos
= w
->phys_cursor
.vpos
;
26140 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26142 /* When the window is hscrolled, cursor hpos can legitimately be out
26143 of bounds, but we draw the cursor at the corresponding window
26144 margin in that case. */
26145 if (!row
->reversed_p
&& hpos
< 0)
26147 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26148 hpos
= row
->used
[TEXT_AREA
] - 1;
26150 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26155 /* Find the glyph rows START_ROW and END_ROW of window W that display
26156 characters between buffer positions START_CHARPOS and END_CHARPOS
26157 (excluding END_CHARPOS). DISP_STRING is a display string that
26158 covers these buffer positions. This is similar to
26159 row_containing_pos, but is more accurate when bidi reordering makes
26160 buffer positions change non-linearly with glyph rows. */
26162 rows_from_pos_range (struct window
*w
,
26163 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
26164 Lisp_Object disp_string
,
26165 struct glyph_row
**start
, struct glyph_row
**end
)
26167 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26168 int last_y
= window_text_bottom_y (w
);
26169 struct glyph_row
*row
;
26174 while (!first
->enabled_p
26175 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26178 /* Find the START row. */
26180 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26183 /* A row can potentially be the START row if the range of the
26184 characters it displays intersects the range
26185 [START_CHARPOS..END_CHARPOS). */
26186 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26187 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26188 /* See the commentary in row_containing_pos, for the
26189 explanation of the complicated way to check whether
26190 some position is beyond the end of the characters
26191 displayed by a row. */
26192 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26193 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26194 && !row
->ends_at_zv_p
26195 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26196 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26197 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26198 && !row
->ends_at_zv_p
26199 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26201 /* Found a candidate row. Now make sure at least one of the
26202 glyphs it displays has a charpos from the range
26203 [START_CHARPOS..END_CHARPOS).
26205 This is not obvious because bidi reordering could make
26206 buffer positions of a row be 1,2,3,102,101,100, and if we
26207 want to highlight characters in [50..60), we don't want
26208 this row, even though [50..60) does intersect [1..103),
26209 the range of character positions given by the row's start
26210 and end positions. */
26211 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26212 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26216 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26217 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26218 /* A glyph that comes from DISP_STRING is by
26219 definition to be highlighted. */
26220 || EQ (g
->object
, disp_string
))
26229 /* Find the END row. */
26231 /* If the last row is partially visible, start looking for END
26232 from that row, instead of starting from FIRST. */
26233 && !(row
->enabled_p
26234 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26236 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26238 struct glyph_row
*next
= row
+ 1;
26239 EMACS_INT next_start
= MATRIX_ROW_START_CHARPOS (next
);
26241 if (!next
->enabled_p
26242 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26243 /* The first row >= START whose range of displayed characters
26244 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26245 is the row END + 1. */
26246 || (start_charpos
< next_start
26247 && end_charpos
< next_start
)
26248 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26249 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26250 && !next
->ends_at_zv_p
26251 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26252 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26253 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26254 && !next
->ends_at_zv_p
26255 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26262 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26263 but none of the characters it displays are in the range, it is
26265 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26266 struct glyph
*s
= g
;
26267 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26271 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26272 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26273 /* If the buffer position of the first glyph in
26274 the row is equal to END_CHARPOS, it means
26275 the last character to be highlighted is the
26276 newline of ROW, and we must consider NEXT as
26278 || (((!next
->reversed_p
&& g
== s
)
26279 || (next
->reversed_p
&& g
== e
- 1))
26280 && (g
->charpos
== end_charpos
26281 /* Special case for when NEXT is an
26282 empty line at ZV. */
26283 || (g
->charpos
== -1
26284 && !row
->ends_at_zv_p
26285 && next_start
== end_charpos
)))))
26286 /* A glyph that comes from DISP_STRING is by
26287 definition to be highlighted. */
26288 || EQ (g
->object
, disp_string
))
26297 /* The first row that ends at ZV must be the last to be
26299 else if (next
->ends_at_zv_p
)
26308 /* This function sets the mouse_face_* elements of HLINFO, assuming
26309 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26310 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26311 for the overlay or run of text properties specifying the mouse
26312 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26313 before-string and after-string that must also be highlighted.
26314 DISP_STRING, if non-nil, is a display string that may cover some
26315 or all of the highlighted text. */
26318 mouse_face_from_buffer_pos (Lisp_Object window
,
26319 Mouse_HLInfo
*hlinfo
,
26320 EMACS_INT mouse_charpos
,
26321 EMACS_INT start_charpos
,
26322 EMACS_INT end_charpos
,
26323 Lisp_Object before_string
,
26324 Lisp_Object after_string
,
26325 Lisp_Object disp_string
)
26327 struct window
*w
= XWINDOW (window
);
26328 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26329 struct glyph_row
*r1
, *r2
;
26330 struct glyph
*glyph
, *end
;
26331 EMACS_INT ignore
, pos
;
26334 xassert (NILP (disp_string
) || STRINGP (disp_string
));
26335 xassert (NILP (before_string
) || STRINGP (before_string
));
26336 xassert (NILP (after_string
) || STRINGP (after_string
));
26338 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26339 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26341 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26342 /* If the before-string or display-string contains newlines,
26343 rows_from_pos_range skips to its last row. Move back. */
26344 if (!NILP (before_string
) || !NILP (disp_string
))
26346 struct glyph_row
*prev
;
26347 while ((prev
= r1
- 1, prev
>= first
)
26348 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26349 && prev
->used
[TEXT_AREA
] > 0)
26351 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26352 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26353 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26355 || !(EQ (glyph
->object
, before_string
)
26356 || EQ (glyph
->object
, disp_string
)))
26363 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26364 hlinfo
->mouse_face_past_end
= 1;
26366 else if (!NILP (after_string
))
26368 /* If the after-string has newlines, advance to its last row. */
26369 struct glyph_row
*next
;
26370 struct glyph_row
*last
26371 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26373 for (next
= r2
+ 1;
26375 && next
->used
[TEXT_AREA
] > 0
26376 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26380 /* The rest of the display engine assumes that mouse_face_beg_row is
26381 either above mouse_face_end_row or identical to it. But with
26382 bidi-reordered continued lines, the row for START_CHARPOS could
26383 be below the row for END_CHARPOS. If so, swap the rows and store
26384 them in correct order. */
26387 struct glyph_row
*tem
= r2
;
26393 hlinfo
->mouse_face_beg_y
= r1
->y
;
26394 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26395 hlinfo
->mouse_face_end_y
= r2
->y
;
26396 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26398 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26399 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26400 could be anywhere in the row and in any order. The strategy
26401 below is to find the leftmost and the rightmost glyph that
26402 belongs to either of these 3 strings, or whose position is
26403 between START_CHARPOS and END_CHARPOS, and highlight all the
26404 glyphs between those two. This may cover more than just the text
26405 between START_CHARPOS and END_CHARPOS if the range of characters
26406 strides the bidi level boundary, e.g. if the beginning is in R2L
26407 text while the end is in L2R text or vice versa. */
26408 if (!r1
->reversed_p
)
26410 /* This row is in a left to right paragraph. Scan it left to
26412 glyph
= r1
->glyphs
[TEXT_AREA
];
26413 end
= glyph
+ r1
->used
[TEXT_AREA
];
26416 /* Skip truncation glyphs at the start of the glyph row. */
26417 if (r1
->displays_text_p
)
26419 && INTEGERP (glyph
->object
)
26420 && glyph
->charpos
< 0;
26422 x
+= glyph
->pixel_width
;
26424 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26425 or DISP_STRING, and the first glyph from buffer whose
26426 position is between START_CHARPOS and END_CHARPOS. */
26428 && !INTEGERP (glyph
->object
)
26429 && !EQ (glyph
->object
, disp_string
)
26430 && !(BUFFERP (glyph
->object
)
26431 && (glyph
->charpos
>= start_charpos
26432 && glyph
->charpos
< end_charpos
));
26435 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26436 are present at buffer positions between START_CHARPOS and
26437 END_CHARPOS, or if they come from an overlay. */
26438 if (EQ (glyph
->object
, before_string
))
26440 pos
= string_buffer_position (before_string
,
26442 /* If pos == 0, it means before_string came from an
26443 overlay, not from a buffer position. */
26444 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26447 else if (EQ (glyph
->object
, after_string
))
26449 pos
= string_buffer_position (after_string
, end_charpos
);
26450 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26453 x
+= glyph
->pixel_width
;
26455 hlinfo
->mouse_face_beg_x
= x
;
26456 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26460 /* This row is in a right to left paragraph. Scan it right to
26464 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26465 glyph
= end
+ r1
->used
[TEXT_AREA
];
26467 /* Skip truncation glyphs at the start of the glyph row. */
26468 if (r1
->displays_text_p
)
26470 && INTEGERP (glyph
->object
)
26471 && glyph
->charpos
< 0;
26475 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26476 or DISP_STRING, and the first glyph from buffer whose
26477 position is between START_CHARPOS and END_CHARPOS. */
26479 && !INTEGERP (glyph
->object
)
26480 && !EQ (glyph
->object
, disp_string
)
26481 && !(BUFFERP (glyph
->object
)
26482 && (glyph
->charpos
>= start_charpos
26483 && glyph
->charpos
< end_charpos
));
26486 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26487 are present at buffer positions between START_CHARPOS and
26488 END_CHARPOS, or if they come from an overlay. */
26489 if (EQ (glyph
->object
, before_string
))
26491 pos
= string_buffer_position (before_string
, start_charpos
);
26492 /* If pos == 0, it means before_string came from an
26493 overlay, not from a buffer position. */
26494 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26497 else if (EQ (glyph
->object
, after_string
))
26499 pos
= string_buffer_position (after_string
, end_charpos
);
26500 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26505 glyph
++; /* first glyph to the right of the highlighted area */
26506 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26507 x
+= g
->pixel_width
;
26508 hlinfo
->mouse_face_beg_x
= x
;
26509 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26512 /* If the highlight ends in a different row, compute GLYPH and END
26513 for the end row. Otherwise, reuse the values computed above for
26514 the row where the highlight begins. */
26517 if (!r2
->reversed_p
)
26519 glyph
= r2
->glyphs
[TEXT_AREA
];
26520 end
= glyph
+ r2
->used
[TEXT_AREA
];
26525 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26526 glyph
= end
+ r2
->used
[TEXT_AREA
];
26530 if (!r2
->reversed_p
)
26532 /* Skip truncation and continuation glyphs near the end of the
26533 row, and also blanks and stretch glyphs inserted by
26534 extend_face_to_end_of_line. */
26536 && INTEGERP ((end
- 1)->object
))
26538 /* Scan the rest of the glyph row from the end, looking for the
26539 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26540 DISP_STRING, or whose position is between START_CHARPOS
26544 && !INTEGERP (end
->object
)
26545 && !EQ (end
->object
, disp_string
)
26546 && !(BUFFERP (end
->object
)
26547 && (end
->charpos
>= start_charpos
26548 && end
->charpos
< end_charpos
));
26551 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26552 are present at buffer positions between START_CHARPOS and
26553 END_CHARPOS, or if they come from an overlay. */
26554 if (EQ (end
->object
, before_string
))
26556 pos
= string_buffer_position (before_string
, start_charpos
);
26557 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26560 else if (EQ (end
->object
, after_string
))
26562 pos
= string_buffer_position (after_string
, end_charpos
);
26563 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26567 /* Find the X coordinate of the last glyph to be highlighted. */
26568 for (; glyph
<= end
; ++glyph
)
26569 x
+= glyph
->pixel_width
;
26571 hlinfo
->mouse_face_end_x
= x
;
26572 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26576 /* Skip truncation and continuation glyphs near the end of the
26577 row, and also blanks and stretch glyphs inserted by
26578 extend_face_to_end_of_line. */
26582 && INTEGERP (end
->object
))
26584 x
+= end
->pixel_width
;
26587 /* Scan the rest of the glyph row from the end, looking for the
26588 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26589 DISP_STRING, or whose position is between START_CHARPOS
26593 && !INTEGERP (end
->object
)
26594 && !EQ (end
->object
, disp_string
)
26595 && !(BUFFERP (end
->object
)
26596 && (end
->charpos
>= start_charpos
26597 && end
->charpos
< end_charpos
));
26600 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26601 are present at buffer positions between START_CHARPOS and
26602 END_CHARPOS, or if they come from an overlay. */
26603 if (EQ (end
->object
, before_string
))
26605 pos
= string_buffer_position (before_string
, start_charpos
);
26606 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26609 else if (EQ (end
->object
, after_string
))
26611 pos
= string_buffer_position (after_string
, end_charpos
);
26612 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26615 x
+= end
->pixel_width
;
26617 /* If we exited the above loop because we arrived at the last
26618 glyph of the row, and its buffer position is still not in
26619 range, it means the last character in range is the preceding
26620 newline. Bump the end column and x values to get past the
26623 && BUFFERP (end
->object
)
26624 && (end
->charpos
< start_charpos
26625 || end
->charpos
>= end_charpos
))
26627 x
+= end
->pixel_width
;
26630 hlinfo
->mouse_face_end_x
= x
;
26631 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26634 hlinfo
->mouse_face_window
= window
;
26635 hlinfo
->mouse_face_face_id
26636 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26638 !hlinfo
->mouse_face_hidden
, -1);
26639 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26642 /* The following function is not used anymore (replaced with
26643 mouse_face_from_string_pos), but I leave it here for the time
26644 being, in case someone would. */
26646 #if 0 /* not used */
26648 /* Find the position of the glyph for position POS in OBJECT in
26649 window W's current matrix, and return in *X, *Y the pixel
26650 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26652 RIGHT_P non-zero means return the position of the right edge of the
26653 glyph, RIGHT_P zero means return the left edge position.
26655 If no glyph for POS exists in the matrix, return the position of
26656 the glyph with the next smaller position that is in the matrix, if
26657 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26658 exists in the matrix, return the position of the glyph with the
26659 next larger position in OBJECT.
26661 Value is non-zero if a glyph was found. */
26664 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26665 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26667 int yb
= window_text_bottom_y (w
);
26668 struct glyph_row
*r
;
26669 struct glyph
*best_glyph
= NULL
;
26670 struct glyph_row
*best_row
= NULL
;
26673 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26674 r
->enabled_p
&& r
->y
< yb
;
26677 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26678 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26681 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26682 if (EQ (g
->object
, object
))
26684 if (g
->charpos
== pos
)
26691 else if (best_glyph
== NULL
26692 || ((eabs (g
->charpos
- pos
)
26693 < eabs (best_glyph
->charpos
- pos
))
26696 : g
->charpos
> pos
)))
26710 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26714 *x
+= best_glyph
->pixel_width
;
26719 *vpos
= best_row
- w
->current_matrix
->rows
;
26722 return best_glyph
!= NULL
;
26724 #endif /* not used */
26726 /* Find the positions of the first and the last glyphs in window W's
26727 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26728 (assumed to be a string), and return in HLINFO's mouse_face_*
26729 members the pixel and column/row coordinates of those glyphs. */
26732 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26733 Lisp_Object object
,
26734 EMACS_INT startpos
, EMACS_INT endpos
)
26736 int yb
= window_text_bottom_y (w
);
26737 struct glyph_row
*r
;
26738 struct glyph
*g
, *e
;
26742 /* Find the glyph row with at least one position in the range
26743 [STARTPOS..ENDPOS], and the first glyph in that row whose
26744 position belongs to that range. */
26745 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26746 r
->enabled_p
&& r
->y
< yb
;
26749 if (!r
->reversed_p
)
26751 g
= r
->glyphs
[TEXT_AREA
];
26752 e
= g
+ r
->used
[TEXT_AREA
];
26753 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26754 if (EQ (g
->object
, object
)
26755 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26757 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26758 hlinfo
->mouse_face_beg_y
= r
->y
;
26759 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26760 hlinfo
->mouse_face_beg_x
= gx
;
26769 e
= r
->glyphs
[TEXT_AREA
];
26770 g
= e
+ r
->used
[TEXT_AREA
];
26771 for ( ; g
> e
; --g
)
26772 if (EQ ((g
-1)->object
, object
)
26773 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26775 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26776 hlinfo
->mouse_face_beg_y
= r
->y
;
26777 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26778 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26779 gx
+= g1
->pixel_width
;
26780 hlinfo
->mouse_face_beg_x
= gx
;
26792 /* Starting with the next row, look for the first row which does NOT
26793 include any glyphs whose positions are in the range. */
26794 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26796 g
= r
->glyphs
[TEXT_AREA
];
26797 e
= g
+ r
->used
[TEXT_AREA
];
26799 for ( ; g
< e
; ++g
)
26800 if (EQ (g
->object
, object
)
26801 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26810 /* The highlighted region ends on the previous row. */
26813 /* Set the end row and its vertical pixel coordinate. */
26814 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26815 hlinfo
->mouse_face_end_y
= r
->y
;
26817 /* Compute and set the end column and the end column's horizontal
26818 pixel coordinate. */
26819 if (!r
->reversed_p
)
26821 g
= r
->glyphs
[TEXT_AREA
];
26822 e
= g
+ r
->used
[TEXT_AREA
];
26823 for ( ; e
> g
; --e
)
26824 if (EQ ((e
-1)->object
, object
)
26825 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26827 hlinfo
->mouse_face_end_col
= e
- g
;
26829 for (gx
= r
->x
; g
< e
; ++g
)
26830 gx
+= g
->pixel_width
;
26831 hlinfo
->mouse_face_end_x
= gx
;
26835 e
= r
->glyphs
[TEXT_AREA
];
26836 g
= e
+ r
->used
[TEXT_AREA
];
26837 for (gx
= r
->x
; e
< g
; ++e
)
26839 if (EQ (e
->object
, object
)
26840 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26842 gx
+= e
->pixel_width
;
26844 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26845 hlinfo
->mouse_face_end_x
= gx
;
26849 #ifdef HAVE_WINDOW_SYSTEM
26851 /* See if position X, Y is within a hot-spot of an image. */
26854 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26856 if (!CONSP (hot_spot
))
26859 if (EQ (XCAR (hot_spot
), Qrect
))
26861 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26862 Lisp_Object rect
= XCDR (hot_spot
);
26866 if (!CONSP (XCAR (rect
)))
26868 if (!CONSP (XCDR (rect
)))
26870 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26872 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26874 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26876 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26880 else if (EQ (XCAR (hot_spot
), Qcircle
))
26882 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26883 Lisp_Object circ
= XCDR (hot_spot
);
26884 Lisp_Object lr
, lx0
, ly0
;
26886 && CONSP (XCAR (circ
))
26887 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26888 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26889 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26891 double r
= XFLOATINT (lr
);
26892 double dx
= XINT (lx0
) - x
;
26893 double dy
= XINT (ly0
) - y
;
26894 return (dx
* dx
+ dy
* dy
<= r
* r
);
26897 else if (EQ (XCAR (hot_spot
), Qpoly
))
26899 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26900 if (VECTORP (XCDR (hot_spot
)))
26902 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26903 Lisp_Object
*poly
= v
->contents
;
26904 int n
= v
->header
.size
;
26907 Lisp_Object lx
, ly
;
26910 /* Need an even number of coordinates, and at least 3 edges. */
26911 if (n
< 6 || n
& 1)
26914 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26915 If count is odd, we are inside polygon. Pixels on edges
26916 may or may not be included depending on actual geometry of the
26918 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26919 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26921 x0
= XINT (lx
), y0
= XINT (ly
);
26922 for (i
= 0; i
< n
; i
+= 2)
26924 int x1
= x0
, y1
= y0
;
26925 if ((lx
= poly
[i
], !INTEGERP (lx
))
26926 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26928 x0
= XINT (lx
), y0
= XINT (ly
);
26930 /* Does this segment cross the X line? */
26938 if (y
> y0
&& y
> y1
)
26940 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26950 find_hot_spot (Lisp_Object map
, int x
, int y
)
26952 while (CONSP (map
))
26954 if (CONSP (XCAR (map
))
26955 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26963 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26965 doc
: /* Lookup in image map MAP coordinates X and Y.
26966 An image map is an alist where each element has the format (AREA ID PLIST).
26967 An AREA is specified as either a rectangle, a circle, or a polygon:
26968 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26969 pixel coordinates of the upper left and bottom right corners.
26970 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26971 and the radius of the circle; r may be a float or integer.
26972 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26973 vector describes one corner in the polygon.
26974 Returns the alist element for the first matching AREA in MAP. */)
26975 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26983 return find_hot_spot (map
, XINT (x
), XINT (y
));
26987 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26989 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26991 /* Do not change cursor shape while dragging mouse. */
26992 if (!NILP (do_mouse_tracking
))
26995 if (!NILP (pointer
))
26997 if (EQ (pointer
, Qarrow
))
26998 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26999 else if (EQ (pointer
, Qhand
))
27000 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27001 else if (EQ (pointer
, Qtext
))
27002 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27003 else if (EQ (pointer
, intern ("hdrag")))
27004 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27005 #ifdef HAVE_X_WINDOWS
27006 else if (EQ (pointer
, intern ("vdrag")))
27007 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27009 else if (EQ (pointer
, intern ("hourglass")))
27010 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27011 else if (EQ (pointer
, Qmodeline
))
27012 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27014 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27017 if (cursor
!= No_Cursor
)
27018 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27021 #endif /* HAVE_WINDOW_SYSTEM */
27023 /* Take proper action when mouse has moved to the mode or header line
27024 or marginal area AREA of window W, x-position X and y-position Y.
27025 X is relative to the start of the text display area of W, so the
27026 width of bitmap areas and scroll bars must be subtracted to get a
27027 position relative to the start of the mode line. */
27030 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27031 enum window_part area
)
27033 struct window
*w
= XWINDOW (window
);
27034 struct frame
*f
= XFRAME (w
->frame
);
27035 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27036 #ifdef HAVE_WINDOW_SYSTEM
27037 Display_Info
*dpyinfo
;
27039 Cursor cursor
= No_Cursor
;
27040 Lisp_Object pointer
= Qnil
;
27041 int dx
, dy
, width
, height
;
27043 Lisp_Object string
, object
= Qnil
;
27044 Lisp_Object pos
, help
;
27046 Lisp_Object mouse_face
;
27047 int original_x_pixel
= x
;
27048 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27049 struct glyph_row
*row
;
27051 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27056 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27057 returns them in row/column units! */
27058 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27059 &object
, &dx
, &dy
, &width
, &height
);
27061 row
= (area
== ON_MODE_LINE
27062 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27063 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27065 /* Find the glyph under the mouse pointer. */
27066 if (row
->mode_line_p
&& row
->enabled_p
)
27068 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27069 end
= glyph
+ row
->used
[TEXT_AREA
];
27071 for (x0
= original_x_pixel
;
27072 glyph
< end
&& x0
>= glyph
->pixel_width
;
27074 x0
-= glyph
->pixel_width
;
27082 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27083 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27084 returns them in row/column units! */
27085 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27086 &object
, &dx
, &dy
, &width
, &height
);
27091 #ifdef HAVE_WINDOW_SYSTEM
27092 if (IMAGEP (object
))
27094 Lisp_Object image_map
, hotspot
;
27095 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27097 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27099 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27103 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27104 If so, we could look for mouse-enter, mouse-leave
27105 properties in PLIST (and do something...). */
27106 hotspot
= XCDR (hotspot
);
27107 if (CONSP (hotspot
)
27108 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27110 pointer
= Fplist_get (plist
, Qpointer
);
27111 if (NILP (pointer
))
27113 help
= Fplist_get (plist
, Qhelp_echo
);
27116 help_echo_string
= help
;
27117 /* Is this correct? ++kfs */
27118 XSETWINDOW (help_echo_window
, w
);
27119 help_echo_object
= w
->buffer
;
27120 help_echo_pos
= charpos
;
27124 if (NILP (pointer
))
27125 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27127 #endif /* HAVE_WINDOW_SYSTEM */
27129 if (STRINGP (string
))
27131 pos
= make_number (charpos
);
27132 /* If we're on a string with `help-echo' text property, arrange
27133 for the help to be displayed. This is done by setting the
27134 global variable help_echo_string to the help string. */
27137 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27140 help_echo_string
= help
;
27141 XSETWINDOW (help_echo_window
, w
);
27142 help_echo_object
= string
;
27143 help_echo_pos
= charpos
;
27147 #ifdef HAVE_WINDOW_SYSTEM
27148 if (FRAME_WINDOW_P (f
))
27150 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27151 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27152 if (NILP (pointer
))
27153 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27155 /* Change the mouse pointer according to what is under X/Y. */
27157 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27160 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27161 if (!KEYMAPP (map
))
27162 map
= Fget_text_property (pos
, Qkeymap
, string
);
27163 if (!KEYMAPP (map
))
27164 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27169 /* Change the mouse face according to what is under X/Y. */
27170 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27171 if (!NILP (mouse_face
)
27172 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27177 struct glyph
* tmp_glyph
;
27181 int total_pixel_width
;
27182 EMACS_INT begpos
, endpos
, ignore
;
27186 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27187 Qmouse_face
, string
, Qnil
);
27193 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27195 endpos
= SCHARS (string
);
27199 /* Calculate the glyph position GPOS of GLYPH in the
27200 displayed string, relative to the beginning of the
27201 highlighted part of the string.
27203 Note: GPOS is different from CHARPOS. CHARPOS is the
27204 position of GLYPH in the internal string object. A mode
27205 line string format has structures which are converted to
27206 a flattened string by the Emacs Lisp interpreter. The
27207 internal string is an element of those structures. The
27208 displayed string is the flattened string. */
27209 tmp_glyph
= row_start_glyph
;
27210 while (tmp_glyph
< glyph
27211 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27212 && begpos
<= tmp_glyph
->charpos
27213 && tmp_glyph
->charpos
< endpos
)))
27215 gpos
= glyph
- tmp_glyph
;
27217 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27218 the highlighted part of the displayed string to which
27219 GLYPH belongs. Note: GSEQ_LENGTH is different from
27220 SCHARS (STRING), because the latter returns the length of
27221 the internal string. */
27222 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27224 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27225 && begpos
<= tmp_glyph
->charpos
27226 && tmp_glyph
->charpos
< endpos
));
27229 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27231 /* Calculate the total pixel width of all the glyphs between
27232 the beginning of the highlighted area and GLYPH. */
27233 total_pixel_width
= 0;
27234 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27235 total_pixel_width
+= tmp_glyph
->pixel_width
;
27237 /* Pre calculation of re-rendering position. Note: X is in
27238 column units here, after the call to mode_line_string or
27239 marginal_area_string. */
27241 vpos
= (area
== ON_MODE_LINE
27242 ? (w
->current_matrix
)->nrows
- 1
27245 /* If GLYPH's position is included in the region that is
27246 already drawn in mouse face, we have nothing to do. */
27247 if ( EQ (window
, hlinfo
->mouse_face_window
)
27248 && (!row
->reversed_p
27249 ? (hlinfo
->mouse_face_beg_col
<= hpos
27250 && hpos
< hlinfo
->mouse_face_end_col
)
27251 /* In R2L rows we swap BEG and END, see below. */
27252 : (hlinfo
->mouse_face_end_col
<= hpos
27253 && hpos
< hlinfo
->mouse_face_beg_col
))
27254 && hlinfo
->mouse_face_beg_row
== vpos
)
27257 if (clear_mouse_face (hlinfo
))
27258 cursor
= No_Cursor
;
27260 if (!row
->reversed_p
)
27262 hlinfo
->mouse_face_beg_col
= hpos
;
27263 hlinfo
->mouse_face_beg_x
= original_x_pixel
27264 - (total_pixel_width
+ dx
);
27265 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27266 hlinfo
->mouse_face_end_x
= 0;
27270 /* In R2L rows, show_mouse_face expects BEG and END
27271 coordinates to be swapped. */
27272 hlinfo
->mouse_face_end_col
= hpos
;
27273 hlinfo
->mouse_face_end_x
= original_x_pixel
27274 - (total_pixel_width
+ dx
);
27275 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27276 hlinfo
->mouse_face_beg_x
= 0;
27279 hlinfo
->mouse_face_beg_row
= vpos
;
27280 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27281 hlinfo
->mouse_face_beg_y
= 0;
27282 hlinfo
->mouse_face_end_y
= 0;
27283 hlinfo
->mouse_face_past_end
= 0;
27284 hlinfo
->mouse_face_window
= window
;
27286 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27292 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27294 if (NILP (pointer
))
27297 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27298 clear_mouse_face (hlinfo
);
27300 #ifdef HAVE_WINDOW_SYSTEM
27301 if (FRAME_WINDOW_P (f
))
27302 define_frame_cursor1 (f
, cursor
, pointer
);
27308 Take proper action when the mouse has moved to position X, Y on
27309 frame F as regards highlighting characters that have mouse-face
27310 properties. Also de-highlighting chars where the mouse was before.
27311 X and Y can be negative or out of range. */
27314 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27316 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27317 enum window_part part
= ON_NOTHING
;
27318 Lisp_Object window
;
27320 Cursor cursor
= No_Cursor
;
27321 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27324 /* When a menu is active, don't highlight because this looks odd. */
27325 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27326 if (popup_activated ())
27330 if (NILP (Vmouse_highlight
)
27331 || !f
->glyphs_initialized_p
27332 || f
->pointer_invisible
)
27335 hlinfo
->mouse_face_mouse_x
= x
;
27336 hlinfo
->mouse_face_mouse_y
= y
;
27337 hlinfo
->mouse_face_mouse_frame
= f
;
27339 if (hlinfo
->mouse_face_defer
)
27342 if (gc_in_progress
)
27344 hlinfo
->mouse_face_deferred_gc
= 1;
27348 /* Which window is that in? */
27349 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27351 /* If displaying active text in another window, clear that. */
27352 if (! EQ (window
, hlinfo
->mouse_face_window
)
27353 /* Also clear if we move out of text area in same window. */
27354 || (!NILP (hlinfo
->mouse_face_window
)
27357 && part
!= ON_MODE_LINE
27358 && part
!= ON_HEADER_LINE
))
27359 clear_mouse_face (hlinfo
);
27361 /* Not on a window -> return. */
27362 if (!WINDOWP (window
))
27365 /* Reset help_echo_string. It will get recomputed below. */
27366 help_echo_string
= Qnil
;
27368 /* Convert to window-relative pixel coordinates. */
27369 w
= XWINDOW (window
);
27370 frame_to_window_pixel_xy (w
, &x
, &y
);
27372 #ifdef HAVE_WINDOW_SYSTEM
27373 /* Handle tool-bar window differently since it doesn't display a
27375 if (EQ (window
, f
->tool_bar_window
))
27377 note_tool_bar_highlight (f
, x
, y
);
27382 /* Mouse is on the mode, header line or margin? */
27383 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27384 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27386 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27390 #ifdef HAVE_WINDOW_SYSTEM
27391 if (part
== ON_VERTICAL_BORDER
)
27393 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27394 help_echo_string
= build_string ("drag-mouse-1: resize");
27396 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27397 || part
== ON_SCROLL_BAR
)
27398 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27400 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27403 /* Are we in a window whose display is up to date?
27404 And verify the buffer's text has not changed. */
27405 b
= XBUFFER (w
->buffer
);
27406 if (part
== ON_TEXT
27407 && EQ (w
->window_end_valid
, w
->buffer
)
27408 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27409 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27411 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27413 struct glyph
*glyph
;
27414 Lisp_Object object
;
27415 Lisp_Object mouse_face
= Qnil
, position
;
27416 Lisp_Object
*overlay_vec
= NULL
;
27417 ptrdiff_t i
, noverlays
;
27418 struct buffer
*obuf
;
27419 EMACS_INT obegv
, ozv
;
27422 /* Find the glyph under X/Y. */
27423 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27425 #ifdef HAVE_WINDOW_SYSTEM
27426 /* Look for :pointer property on image. */
27427 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27429 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27430 if (img
!= NULL
&& IMAGEP (img
->spec
))
27432 Lisp_Object image_map
, hotspot
;
27433 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27435 && (hotspot
= find_hot_spot (image_map
,
27436 glyph
->slice
.img
.x
+ dx
,
27437 glyph
->slice
.img
.y
+ dy
),
27439 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27443 /* Could check XCAR (hotspot) to see if we enter/leave
27445 If so, we could look for mouse-enter, mouse-leave
27446 properties in PLIST (and do something...). */
27447 hotspot
= XCDR (hotspot
);
27448 if (CONSP (hotspot
)
27449 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27451 pointer
= Fplist_get (plist
, Qpointer
);
27452 if (NILP (pointer
))
27454 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27455 if (!NILP (help_echo_string
))
27457 help_echo_window
= window
;
27458 help_echo_object
= glyph
->object
;
27459 help_echo_pos
= glyph
->charpos
;
27463 if (NILP (pointer
))
27464 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27467 #endif /* HAVE_WINDOW_SYSTEM */
27469 /* Clear mouse face if X/Y not over text. */
27471 || area
!= TEXT_AREA
27472 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27473 /* Glyph's OBJECT is an integer for glyphs inserted by the
27474 display engine for its internal purposes, like truncation
27475 and continuation glyphs and blanks beyond the end of
27476 line's text on text terminals. If we are over such a
27477 glyph, we are not over any text. */
27478 || INTEGERP (glyph
->object
)
27479 /* R2L rows have a stretch glyph at their front, which
27480 stands for no text, whereas L2R rows have no glyphs at
27481 all beyond the end of text. Treat such stretch glyphs
27482 like we do with NULL glyphs in L2R rows. */
27483 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27484 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27485 && glyph
->type
== STRETCH_GLYPH
27486 && glyph
->avoid_cursor_p
))
27488 if (clear_mouse_face (hlinfo
))
27489 cursor
= No_Cursor
;
27490 #ifdef HAVE_WINDOW_SYSTEM
27491 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27493 if (area
!= TEXT_AREA
)
27494 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27496 pointer
= Vvoid_text_area_pointer
;
27502 pos
= glyph
->charpos
;
27503 object
= glyph
->object
;
27504 if (!STRINGP (object
) && !BUFFERP (object
))
27507 /* If we get an out-of-range value, return now; avoid an error. */
27508 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27511 /* Make the window's buffer temporarily current for
27512 overlays_at and compute_char_face. */
27513 obuf
= current_buffer
;
27514 current_buffer
= b
;
27520 /* Is this char mouse-active or does it have help-echo? */
27521 position
= make_number (pos
);
27523 if (BUFFERP (object
))
27525 /* Put all the overlays we want in a vector in overlay_vec. */
27526 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27527 /* Sort overlays into increasing priority order. */
27528 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27533 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27536 cursor
= No_Cursor
;
27538 /* Check mouse-face highlighting. */
27540 /* If there exists an overlay with mouse-face overlapping
27541 the one we are currently highlighting, we have to
27542 check if we enter the overlapping overlay, and then
27543 highlight only that. */
27544 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27545 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27547 /* Find the highest priority overlay with a mouse-face. */
27548 Lisp_Object overlay
= Qnil
;
27549 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27551 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27552 if (!NILP (mouse_face
))
27553 overlay
= overlay_vec
[i
];
27556 /* If we're highlighting the same overlay as before, there's
27557 no need to do that again. */
27558 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27559 goto check_help_echo
;
27560 hlinfo
->mouse_face_overlay
= overlay
;
27562 /* Clear the display of the old active region, if any. */
27563 if (clear_mouse_face (hlinfo
))
27564 cursor
= No_Cursor
;
27566 /* If no overlay applies, get a text property. */
27567 if (NILP (overlay
))
27568 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27570 /* Next, compute the bounds of the mouse highlighting and
27572 if (!NILP (mouse_face
) && STRINGP (object
))
27574 /* The mouse-highlighting comes from a display string
27575 with a mouse-face. */
27579 s
= Fprevious_single_property_change
27580 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27581 e
= Fnext_single_property_change
27582 (position
, Qmouse_face
, object
, Qnil
);
27584 s
= make_number (0);
27586 e
= make_number (SCHARS (object
) - 1);
27587 mouse_face_from_string_pos (w
, hlinfo
, object
,
27588 XINT (s
), XINT (e
));
27589 hlinfo
->mouse_face_past_end
= 0;
27590 hlinfo
->mouse_face_window
= window
;
27591 hlinfo
->mouse_face_face_id
27592 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27593 glyph
->face_id
, 1);
27594 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27595 cursor
= No_Cursor
;
27599 /* The mouse-highlighting, if any, comes from an overlay
27600 or text property in the buffer. */
27601 Lisp_Object buffer
IF_LINT (= Qnil
);
27602 Lisp_Object disp_string
IF_LINT (= Qnil
);
27604 if (STRINGP (object
))
27606 /* If we are on a display string with no mouse-face,
27607 check if the text under it has one. */
27608 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27609 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27610 pos
= string_buffer_position (object
, start
);
27613 mouse_face
= get_char_property_and_overlay
27614 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27615 buffer
= w
->buffer
;
27616 disp_string
= object
;
27622 disp_string
= Qnil
;
27625 if (!NILP (mouse_face
))
27627 Lisp_Object before
, after
;
27628 Lisp_Object before_string
, after_string
;
27629 /* To correctly find the limits of mouse highlight
27630 in a bidi-reordered buffer, we must not use the
27631 optimization of limiting the search in
27632 previous-single-property-change and
27633 next-single-property-change, because
27634 rows_from_pos_range needs the real start and end
27635 positions to DTRT in this case. That's because
27636 the first row visible in a window does not
27637 necessarily display the character whose position
27638 is the smallest. */
27640 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27641 ? Fmarker_position (w
->start
)
27644 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27645 ? make_number (BUF_Z (XBUFFER (buffer
))
27646 - XFASTINT (w
->window_end_pos
))
27649 if (NILP (overlay
))
27651 /* Handle the text property case. */
27652 before
= Fprevious_single_property_change
27653 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27654 after
= Fnext_single_property_change
27655 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27656 before_string
= after_string
= Qnil
;
27660 /* Handle the overlay case. */
27661 before
= Foverlay_start (overlay
);
27662 after
= Foverlay_end (overlay
);
27663 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27664 after_string
= Foverlay_get (overlay
, Qafter_string
);
27666 if (!STRINGP (before_string
)) before_string
= Qnil
;
27667 if (!STRINGP (after_string
)) after_string
= Qnil
;
27670 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27673 : XFASTINT (before
),
27675 ? BUF_Z (XBUFFER (buffer
))
27676 : XFASTINT (after
),
27677 before_string
, after_string
,
27679 cursor
= No_Cursor
;
27686 /* Look for a `help-echo' property. */
27687 if (NILP (help_echo_string
)) {
27688 Lisp_Object help
, overlay
;
27690 /* Check overlays first. */
27691 help
= overlay
= Qnil
;
27692 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27694 overlay
= overlay_vec
[i
];
27695 help
= Foverlay_get (overlay
, Qhelp_echo
);
27700 help_echo_string
= help
;
27701 help_echo_window
= window
;
27702 help_echo_object
= overlay
;
27703 help_echo_pos
= pos
;
27707 Lisp_Object obj
= glyph
->object
;
27708 EMACS_INT charpos
= glyph
->charpos
;
27710 /* Try text properties. */
27713 && charpos
< SCHARS (obj
))
27715 help
= Fget_text_property (make_number (charpos
),
27719 /* If the string itself doesn't specify a help-echo,
27720 see if the buffer text ``under'' it does. */
27721 struct glyph_row
*r
27722 = MATRIX_ROW (w
->current_matrix
, vpos
);
27723 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27724 EMACS_INT p
= string_buffer_position (obj
, start
);
27727 help
= Fget_char_property (make_number (p
),
27728 Qhelp_echo
, w
->buffer
);
27737 else if (BUFFERP (obj
)
27740 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27745 help_echo_string
= help
;
27746 help_echo_window
= window
;
27747 help_echo_object
= obj
;
27748 help_echo_pos
= charpos
;
27753 #ifdef HAVE_WINDOW_SYSTEM
27754 /* Look for a `pointer' property. */
27755 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27757 /* Check overlays first. */
27758 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27759 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27761 if (NILP (pointer
))
27763 Lisp_Object obj
= glyph
->object
;
27764 EMACS_INT charpos
= glyph
->charpos
;
27766 /* Try text properties. */
27769 && charpos
< SCHARS (obj
))
27771 pointer
= Fget_text_property (make_number (charpos
),
27773 if (NILP (pointer
))
27775 /* If the string itself doesn't specify a pointer,
27776 see if the buffer text ``under'' it does. */
27777 struct glyph_row
*r
27778 = MATRIX_ROW (w
->current_matrix
, vpos
);
27779 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27780 EMACS_INT p
= string_buffer_position (obj
, start
);
27782 pointer
= Fget_char_property (make_number (p
),
27783 Qpointer
, w
->buffer
);
27786 else if (BUFFERP (obj
)
27789 pointer
= Fget_text_property (make_number (charpos
),
27793 #endif /* HAVE_WINDOW_SYSTEM */
27797 current_buffer
= obuf
;
27802 #ifdef HAVE_WINDOW_SYSTEM
27803 if (FRAME_WINDOW_P (f
))
27804 define_frame_cursor1 (f
, cursor
, pointer
);
27806 /* This is here to prevent a compiler error, about "label at end of
27807 compound statement". */
27814 Clear any mouse-face on window W. This function is part of the
27815 redisplay interface, and is called from try_window_id and similar
27816 functions to ensure the mouse-highlight is off. */
27819 x_clear_window_mouse_face (struct window
*w
)
27821 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27822 Lisp_Object window
;
27825 XSETWINDOW (window
, w
);
27826 if (EQ (window
, hlinfo
->mouse_face_window
))
27827 clear_mouse_face (hlinfo
);
27833 Just discard the mouse face information for frame F, if any.
27834 This is used when the size of F is changed. */
27837 cancel_mouse_face (struct frame
*f
)
27839 Lisp_Object window
;
27840 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27842 window
= hlinfo
->mouse_face_window
;
27843 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27845 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27846 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27847 hlinfo
->mouse_face_window
= Qnil
;
27853 /***********************************************************************
27855 ***********************************************************************/
27857 #ifdef HAVE_WINDOW_SYSTEM
27859 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27860 which intersects rectangle R. R is in window-relative coordinates. */
27863 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27864 enum glyph_row_area area
)
27866 struct glyph
*first
= row
->glyphs
[area
];
27867 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27868 struct glyph
*last
;
27869 int first_x
, start_x
, x
;
27871 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27872 /* If row extends face to end of line write the whole line. */
27873 draw_glyphs (w
, 0, row
, area
,
27874 0, row
->used
[area
],
27875 DRAW_NORMAL_TEXT
, 0);
27878 /* Set START_X to the window-relative start position for drawing glyphs of
27879 AREA. The first glyph of the text area can be partially visible.
27880 The first glyphs of other areas cannot. */
27881 start_x
= window_box_left_offset (w
, area
);
27883 if (area
== TEXT_AREA
)
27886 /* Find the first glyph that must be redrawn. */
27888 && x
+ first
->pixel_width
< r
->x
)
27890 x
+= first
->pixel_width
;
27894 /* Find the last one. */
27898 && x
< r
->x
+ r
->width
)
27900 x
+= last
->pixel_width
;
27906 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27907 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27908 DRAW_NORMAL_TEXT
, 0);
27913 /* Redraw the parts of the glyph row ROW on window W intersecting
27914 rectangle R. R is in window-relative coordinates. Value is
27915 non-zero if mouse-face was overwritten. */
27918 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27920 xassert (row
->enabled_p
);
27922 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27923 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27924 0, row
->used
[TEXT_AREA
],
27925 DRAW_NORMAL_TEXT
, 0);
27928 if (row
->used
[LEFT_MARGIN_AREA
])
27929 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27930 if (row
->used
[TEXT_AREA
])
27931 expose_area (w
, row
, r
, TEXT_AREA
);
27932 if (row
->used
[RIGHT_MARGIN_AREA
])
27933 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27934 draw_row_fringe_bitmaps (w
, row
);
27937 return row
->mouse_face_p
;
27941 /* Redraw those parts of glyphs rows during expose event handling that
27942 overlap other rows. Redrawing of an exposed line writes over parts
27943 of lines overlapping that exposed line; this function fixes that.
27945 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27946 row in W's current matrix that is exposed and overlaps other rows.
27947 LAST_OVERLAPPING_ROW is the last such row. */
27950 expose_overlaps (struct window
*w
,
27951 struct glyph_row
*first_overlapping_row
,
27952 struct glyph_row
*last_overlapping_row
,
27955 struct glyph_row
*row
;
27957 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27958 if (row
->overlapping_p
)
27960 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27963 if (row
->used
[LEFT_MARGIN_AREA
])
27964 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27966 if (row
->used
[TEXT_AREA
])
27967 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27969 if (row
->used
[RIGHT_MARGIN_AREA
])
27970 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27976 /* Return non-zero if W's cursor intersects rectangle R. */
27979 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27981 XRectangle cr
, result
;
27982 struct glyph
*cursor_glyph
;
27983 struct glyph_row
*row
;
27985 if (w
->phys_cursor
.vpos
>= 0
27986 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27987 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27989 && row
->cursor_in_fringe_p
)
27991 /* Cursor is in the fringe. */
27992 cr
.x
= window_box_right_offset (w
,
27993 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27994 ? RIGHT_MARGIN_AREA
27997 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27998 cr
.height
= row
->height
;
27999 return x_intersect_rectangles (&cr
, r
, &result
);
28002 cursor_glyph
= get_phys_cursor_glyph (w
);
28005 /* r is relative to W's box, but w->phys_cursor.x is relative
28006 to left edge of W's TEXT area. Adjust it. */
28007 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28008 cr
.y
= w
->phys_cursor
.y
;
28009 cr
.width
= cursor_glyph
->pixel_width
;
28010 cr
.height
= w
->phys_cursor_height
;
28011 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28012 I assume the effect is the same -- and this is portable. */
28013 return x_intersect_rectangles (&cr
, r
, &result
);
28015 /* If we don't understand the format, pretend we're not in the hot-spot. */
28021 Draw a vertical window border to the right of window W if W doesn't
28022 have vertical scroll bars. */
28025 x_draw_vertical_border (struct window
*w
)
28027 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28029 /* We could do better, if we knew what type of scroll-bar the adjacent
28030 windows (on either side) have... But we don't :-(
28031 However, I think this works ok. ++KFS 2003-04-25 */
28033 /* Redraw borders between horizontally adjacent windows. Don't
28034 do it for frames with vertical scroll bars because either the
28035 right scroll bar of a window, or the left scroll bar of its
28036 neighbor will suffice as a border. */
28037 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28040 if (!WINDOW_RIGHTMOST_P (w
)
28041 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28043 int x0
, x1
, y0
, y1
;
28045 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28048 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28051 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28053 else if (!WINDOW_LEFTMOST_P (w
)
28054 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28056 int x0
, x1
, y0
, y1
;
28058 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28061 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28064 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28069 /* Redraw the part of window W intersection rectangle FR. Pixel
28070 coordinates in FR are frame-relative. Call this function with
28071 input blocked. Value is non-zero if the exposure overwrites
28075 expose_window (struct window
*w
, XRectangle
*fr
)
28077 struct frame
*f
= XFRAME (w
->frame
);
28079 int mouse_face_overwritten_p
= 0;
28081 /* If window is not yet fully initialized, do nothing. This can
28082 happen when toolkit scroll bars are used and a window is split.
28083 Reconfiguring the scroll bar will generate an expose for a newly
28085 if (w
->current_matrix
== NULL
)
28088 /* When we're currently updating the window, display and current
28089 matrix usually don't agree. Arrange for a thorough display
28091 if (w
== updated_window
)
28093 SET_FRAME_GARBAGED (f
);
28097 /* Frame-relative pixel rectangle of W. */
28098 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28099 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28100 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28101 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28103 if (x_intersect_rectangles (fr
, &wr
, &r
))
28105 int yb
= window_text_bottom_y (w
);
28106 struct glyph_row
*row
;
28107 int cursor_cleared_p
, phys_cursor_on_p
;
28108 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28110 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28111 r
.x
, r
.y
, r
.width
, r
.height
));
28113 /* Convert to window coordinates. */
28114 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28115 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28117 /* Turn off the cursor. */
28118 if (!w
->pseudo_window_p
28119 && phys_cursor_in_rect_p (w
, &r
))
28121 x_clear_cursor (w
);
28122 cursor_cleared_p
= 1;
28125 cursor_cleared_p
= 0;
28127 /* If the row containing the cursor extends face to end of line,
28128 then expose_area might overwrite the cursor outside the
28129 rectangle and thus notice_overwritten_cursor might clear
28130 w->phys_cursor_on_p. We remember the original value and
28131 check later if it is changed. */
28132 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28134 /* Update lines intersecting rectangle R. */
28135 first_overlapping_row
= last_overlapping_row
= NULL
;
28136 for (row
= w
->current_matrix
->rows
;
28141 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28143 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28144 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28145 || (r
.y
>= y0
&& r
.y
< y1
)
28146 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28148 /* A header line may be overlapping, but there is no need
28149 to fix overlapping areas for them. KFS 2005-02-12 */
28150 if (row
->overlapping_p
&& !row
->mode_line_p
)
28152 if (first_overlapping_row
== NULL
)
28153 first_overlapping_row
= row
;
28154 last_overlapping_row
= row
;
28158 if (expose_line (w
, row
, &r
))
28159 mouse_face_overwritten_p
= 1;
28162 else if (row
->overlapping_p
)
28164 /* We must redraw a row overlapping the exposed area. */
28166 ? y0
+ row
->phys_height
> r
.y
28167 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28169 if (first_overlapping_row
== NULL
)
28170 first_overlapping_row
= row
;
28171 last_overlapping_row
= row
;
28179 /* Display the mode line if there is one. */
28180 if (WINDOW_WANTS_MODELINE_P (w
)
28181 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28183 && row
->y
< r
.y
+ r
.height
)
28185 if (expose_line (w
, row
, &r
))
28186 mouse_face_overwritten_p
= 1;
28189 if (!w
->pseudo_window_p
)
28191 /* Fix the display of overlapping rows. */
28192 if (first_overlapping_row
)
28193 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28196 /* Draw border between windows. */
28197 x_draw_vertical_border (w
);
28199 /* Turn the cursor on again. */
28200 if (cursor_cleared_p
28201 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28202 update_window_cursor (w
, 1);
28206 return mouse_face_overwritten_p
;
28211 /* Redraw (parts) of all windows in the window tree rooted at W that
28212 intersect R. R contains frame pixel coordinates. Value is
28213 non-zero if the exposure overwrites mouse-face. */
28216 expose_window_tree (struct window
*w
, XRectangle
*r
)
28218 struct frame
*f
= XFRAME (w
->frame
);
28219 int mouse_face_overwritten_p
= 0;
28221 while (w
&& !FRAME_GARBAGED_P (f
))
28223 if (!NILP (w
->hchild
))
28224 mouse_face_overwritten_p
28225 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28226 else if (!NILP (w
->vchild
))
28227 mouse_face_overwritten_p
28228 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28230 mouse_face_overwritten_p
|= expose_window (w
, r
);
28232 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28235 return mouse_face_overwritten_p
;
28240 Redisplay an exposed area of frame F. X and Y are the upper-left
28241 corner of the exposed rectangle. W and H are width and height of
28242 the exposed area. All are pixel values. W or H zero means redraw
28243 the entire frame. */
28246 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28249 int mouse_face_overwritten_p
= 0;
28251 TRACE ((stderr
, "expose_frame "));
28253 /* No need to redraw if frame will be redrawn soon. */
28254 if (FRAME_GARBAGED_P (f
))
28256 TRACE ((stderr
, " garbaged\n"));
28260 /* If basic faces haven't been realized yet, there is no point in
28261 trying to redraw anything. This can happen when we get an expose
28262 event while Emacs is starting, e.g. by moving another window. */
28263 if (FRAME_FACE_CACHE (f
) == NULL
28264 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28266 TRACE ((stderr
, " no faces\n"));
28270 if (w
== 0 || h
== 0)
28273 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28274 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28284 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28285 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28287 if (WINDOWP (f
->tool_bar_window
))
28288 mouse_face_overwritten_p
28289 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28291 #ifdef HAVE_X_WINDOWS
28293 #ifndef USE_X_TOOLKIT
28294 if (WINDOWP (f
->menu_bar_window
))
28295 mouse_face_overwritten_p
28296 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28297 #endif /* not USE_X_TOOLKIT */
28301 /* Some window managers support a focus-follows-mouse style with
28302 delayed raising of frames. Imagine a partially obscured frame,
28303 and moving the mouse into partially obscured mouse-face on that
28304 frame. The visible part of the mouse-face will be highlighted,
28305 then the WM raises the obscured frame. With at least one WM, KDE
28306 2.1, Emacs is not getting any event for the raising of the frame
28307 (even tried with SubstructureRedirectMask), only Expose events.
28308 These expose events will draw text normally, i.e. not
28309 highlighted. Which means we must redo the highlight here.
28310 Subsume it under ``we love X''. --gerd 2001-08-15 */
28311 /* Included in Windows version because Windows most likely does not
28312 do the right thing if any third party tool offers
28313 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28314 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28316 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28317 if (f
== hlinfo
->mouse_face_mouse_frame
)
28319 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28320 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28321 clear_mouse_face (hlinfo
);
28322 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28329 Determine the intersection of two rectangles R1 and R2. Return
28330 the intersection in *RESULT. Value is non-zero if RESULT is not
28334 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28336 XRectangle
*left
, *right
;
28337 XRectangle
*upper
, *lower
;
28338 int intersection_p
= 0;
28340 /* Rearrange so that R1 is the left-most rectangle. */
28342 left
= r1
, right
= r2
;
28344 left
= r2
, right
= r1
;
28346 /* X0 of the intersection is right.x0, if this is inside R1,
28347 otherwise there is no intersection. */
28348 if (right
->x
<= left
->x
+ left
->width
)
28350 result
->x
= right
->x
;
28352 /* The right end of the intersection is the minimum of
28353 the right ends of left and right. */
28354 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28357 /* Same game for Y. */
28359 upper
= r1
, lower
= r2
;
28361 upper
= r2
, lower
= r1
;
28363 /* The upper end of the intersection is lower.y0, if this is inside
28364 of upper. Otherwise, there is no intersection. */
28365 if (lower
->y
<= upper
->y
+ upper
->height
)
28367 result
->y
= lower
->y
;
28369 /* The lower end of the intersection is the minimum of the lower
28370 ends of upper and lower. */
28371 result
->height
= (min (lower
->y
+ lower
->height
,
28372 upper
->y
+ upper
->height
)
28374 intersection_p
= 1;
28378 return intersection_p
;
28381 #endif /* HAVE_WINDOW_SYSTEM */
28384 /***********************************************************************
28386 ***********************************************************************/
28389 syms_of_xdisp (void)
28391 Vwith_echo_area_save_vector
= Qnil
;
28392 staticpro (&Vwith_echo_area_save_vector
);
28394 Vmessage_stack
= Qnil
;
28395 staticpro (&Vmessage_stack
);
28397 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28399 message_dolog_marker1
= Fmake_marker ();
28400 staticpro (&message_dolog_marker1
);
28401 message_dolog_marker2
= Fmake_marker ();
28402 staticpro (&message_dolog_marker2
);
28403 message_dolog_marker3
= Fmake_marker ();
28404 staticpro (&message_dolog_marker3
);
28407 defsubr (&Sdump_frame_glyph_matrix
);
28408 defsubr (&Sdump_glyph_matrix
);
28409 defsubr (&Sdump_glyph_row
);
28410 defsubr (&Sdump_tool_bar_row
);
28411 defsubr (&Strace_redisplay
);
28412 defsubr (&Strace_to_stderr
);
28414 #ifdef HAVE_WINDOW_SYSTEM
28415 defsubr (&Stool_bar_lines_needed
);
28416 defsubr (&Slookup_image_map
);
28418 defsubr (&Sformat_mode_line
);
28419 defsubr (&Sinvisible_p
);
28420 defsubr (&Scurrent_bidi_paragraph_direction
);
28422 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28423 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28424 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28425 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28426 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28427 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28428 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28429 DEFSYM (Qeval
, "eval");
28430 DEFSYM (QCdata
, ":data");
28431 DEFSYM (Qdisplay
, "display");
28432 DEFSYM (Qspace_width
, "space-width");
28433 DEFSYM (Qraise
, "raise");
28434 DEFSYM (Qslice
, "slice");
28435 DEFSYM (Qspace
, "space");
28436 DEFSYM (Qmargin
, "margin");
28437 DEFSYM (Qpointer
, "pointer");
28438 DEFSYM (Qleft_margin
, "left-margin");
28439 DEFSYM (Qright_margin
, "right-margin");
28440 DEFSYM (Qcenter
, "center");
28441 DEFSYM (Qline_height
, "line-height");
28442 DEFSYM (QCalign_to
, ":align-to");
28443 DEFSYM (QCrelative_width
, ":relative-width");
28444 DEFSYM (QCrelative_height
, ":relative-height");
28445 DEFSYM (QCeval
, ":eval");
28446 DEFSYM (QCpropertize
, ":propertize");
28447 DEFSYM (QCfile
, ":file");
28448 DEFSYM (Qfontified
, "fontified");
28449 DEFSYM (Qfontification_functions
, "fontification-functions");
28450 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28451 DEFSYM (Qescape_glyph
, "escape-glyph");
28452 DEFSYM (Qnobreak_space
, "nobreak-space");
28453 DEFSYM (Qimage
, "image");
28454 DEFSYM (Qtext
, "text");
28455 DEFSYM (Qboth
, "both");
28456 DEFSYM (Qboth_horiz
, "both-horiz");
28457 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28458 DEFSYM (QCmap
, ":map");
28459 DEFSYM (QCpointer
, ":pointer");
28460 DEFSYM (Qrect
, "rect");
28461 DEFSYM (Qcircle
, "circle");
28462 DEFSYM (Qpoly
, "poly");
28463 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28464 DEFSYM (Qgrow_only
, "grow-only");
28465 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28466 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28467 DEFSYM (Qposition
, "position");
28468 DEFSYM (Qbuffer_position
, "buffer-position");
28469 DEFSYM (Qobject
, "object");
28470 DEFSYM (Qbar
, "bar");
28471 DEFSYM (Qhbar
, "hbar");
28472 DEFSYM (Qbox
, "box");
28473 DEFSYM (Qhollow
, "hollow");
28474 DEFSYM (Qhand
, "hand");
28475 DEFSYM (Qarrow
, "arrow");
28476 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28478 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28479 Fcons (intern_c_string ("void-variable"), Qnil
)),
28481 staticpro (&list_of_error
);
28483 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28484 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28485 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28486 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28488 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28489 staticpro (&echo_buffer
[0]);
28490 staticpro (&echo_buffer
[1]);
28492 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28493 staticpro (&echo_area_buffer
[0]);
28494 staticpro (&echo_area_buffer
[1]);
28496 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28497 staticpro (&Vmessages_buffer_name
);
28499 mode_line_proptrans_alist
= Qnil
;
28500 staticpro (&mode_line_proptrans_alist
);
28501 mode_line_string_list
= Qnil
;
28502 staticpro (&mode_line_string_list
);
28503 mode_line_string_face
= Qnil
;
28504 staticpro (&mode_line_string_face
);
28505 mode_line_string_face_prop
= Qnil
;
28506 staticpro (&mode_line_string_face_prop
);
28507 Vmode_line_unwind_vector
= Qnil
;
28508 staticpro (&Vmode_line_unwind_vector
);
28510 help_echo_string
= Qnil
;
28511 staticpro (&help_echo_string
);
28512 help_echo_object
= Qnil
;
28513 staticpro (&help_echo_object
);
28514 help_echo_window
= Qnil
;
28515 staticpro (&help_echo_window
);
28516 previous_help_echo_string
= Qnil
;
28517 staticpro (&previous_help_echo_string
);
28518 help_echo_pos
= -1;
28520 DEFSYM (Qright_to_left
, "right-to-left");
28521 DEFSYM (Qleft_to_right
, "left-to-right");
28523 #ifdef HAVE_WINDOW_SYSTEM
28524 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28525 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28526 For example, if a block cursor is over a tab, it will be drawn as
28527 wide as that tab on the display. */);
28528 x_stretch_cursor_p
= 0;
28531 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28532 doc
: /* Non-nil means highlight trailing whitespace.
28533 The face used for trailing whitespace is `trailing-whitespace'. */);
28534 Vshow_trailing_whitespace
= Qnil
;
28536 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28537 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28538 If the value is t, Emacs highlights non-ASCII chars which have the
28539 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28540 or `escape-glyph' face respectively.
28542 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28543 U+2011 (non-breaking hyphen) are affected.
28545 Any other non-nil value means to display these characters as a escape
28546 glyph followed by an ordinary space or hyphen.
28548 A value of nil means no special handling of these characters. */);
28549 Vnobreak_char_display
= Qt
;
28551 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28552 doc
: /* The pointer shape to show in void text areas.
28553 A value of nil means to show the text pointer. Other options are `arrow',
28554 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28555 Vvoid_text_area_pointer
= Qarrow
;
28557 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28558 doc
: /* Non-nil means don't actually do any redisplay.
28559 This is used for internal purposes. */);
28560 Vinhibit_redisplay
= Qnil
;
28562 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28563 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28564 Vglobal_mode_string
= Qnil
;
28566 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28567 doc
: /* Marker for where to display an arrow on top of the buffer text.
28568 This must be the beginning of a line in order to work.
28569 See also `overlay-arrow-string'. */);
28570 Voverlay_arrow_position
= Qnil
;
28572 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28573 doc
: /* String to display as an arrow in non-window frames.
28574 See also `overlay-arrow-position'. */);
28575 Voverlay_arrow_string
= make_pure_c_string ("=>");
28577 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28578 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28579 The symbols on this list are examined during redisplay to determine
28580 where to display overlay arrows. */);
28581 Voverlay_arrow_variable_list
28582 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28584 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28585 doc
: /* The number of lines to try scrolling a window by when point moves out.
28586 If that fails to bring point back on frame, point is centered instead.
28587 If this is zero, point is always centered after it moves off frame.
28588 If you want scrolling to always be a line at a time, you should set
28589 `scroll-conservatively' to a large value rather than set this to 1. */);
28591 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28592 doc
: /* Scroll up to this many lines, to bring point back on screen.
28593 If point moves off-screen, redisplay will scroll by up to
28594 `scroll-conservatively' lines in order to bring point just barely
28595 onto the screen again. If that cannot be done, then redisplay
28596 recenters point as usual.
28598 If the value is greater than 100, redisplay will never recenter point,
28599 but will always scroll just enough text to bring point into view, even
28600 if you move far away.
28602 A value of zero means always recenter point if it moves off screen. */);
28603 scroll_conservatively
= 0;
28605 DEFVAR_INT ("scroll-margin", scroll_margin
,
28606 doc
: /* Number of lines of margin at the top and bottom of a window.
28607 Recenter the window whenever point gets within this many lines
28608 of the top or bottom of the window. */);
28611 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28612 doc
: /* Pixels per inch value for non-window system displays.
28613 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28614 Vdisplay_pixels_per_inch
= make_float (72.0);
28617 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28620 DEFVAR_LISP ("truncate-partial-width-windows",
28621 Vtruncate_partial_width_windows
,
28622 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28623 For an integer value, truncate lines in each window narrower than the
28624 full frame width, provided the window width is less than that integer;
28625 otherwise, respect the value of `truncate-lines'.
28627 For any other non-nil value, truncate lines in all windows that do
28628 not span the full frame width.
28630 A value of nil means to respect the value of `truncate-lines'.
28632 If `word-wrap' is enabled, you might want to reduce this. */);
28633 Vtruncate_partial_width_windows
= make_number (50);
28635 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28636 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28637 Any other value means to use the appropriate face, `mode-line',
28638 `header-line', or `menu' respectively. */);
28639 mode_line_inverse_video
= 1;
28641 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28642 doc
: /* Maximum buffer size for which line number should be displayed.
28643 If the buffer is bigger than this, the line number does not appear
28644 in the mode line. A value of nil means no limit. */);
28645 Vline_number_display_limit
= Qnil
;
28647 DEFVAR_INT ("line-number-display-limit-width",
28648 line_number_display_limit_width
,
28649 doc
: /* Maximum line width (in characters) for line number display.
28650 If the average length of the lines near point is bigger than this, then the
28651 line number may be omitted from the mode line. */);
28652 line_number_display_limit_width
= 200;
28654 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28655 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28656 highlight_nonselected_windows
= 0;
28658 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28659 doc
: /* Non-nil if more than one frame is visible on this display.
28660 Minibuffer-only frames don't count, but iconified frames do.
28661 This variable is not guaranteed to be accurate except while processing
28662 `frame-title-format' and `icon-title-format'. */);
28664 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28665 doc
: /* Template for displaying the title bar of visible frames.
28666 \(Assuming the window manager supports this feature.)
28668 This variable has the same structure as `mode-line-format', except that
28669 the %c and %l constructs are ignored. It is used only on frames for
28670 which no explicit name has been set \(see `modify-frame-parameters'). */);
28672 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28673 doc
: /* Template for displaying the title bar of an iconified frame.
28674 \(Assuming the window manager supports this feature.)
28675 This variable has the same structure as `mode-line-format' (which see),
28676 and is used only on frames for which no explicit name has been set
28677 \(see `modify-frame-parameters'). */);
28679 = Vframe_title_format
28680 = pure_cons (intern_c_string ("multiple-frames"),
28681 pure_cons (make_pure_c_string ("%b"),
28682 pure_cons (pure_cons (empty_unibyte_string
,
28683 pure_cons (intern_c_string ("invocation-name"),
28684 pure_cons (make_pure_c_string ("@"),
28685 pure_cons (intern_c_string ("system-name"),
28689 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28690 doc
: /* Maximum number of lines to keep in the message log buffer.
28691 If nil, disable message logging. If t, log messages but don't truncate
28692 the buffer when it becomes large. */);
28693 Vmessage_log_max
= make_number (100);
28695 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28696 doc
: /* Functions called before redisplay, if window sizes have changed.
28697 The value should be a list of functions that take one argument.
28698 Just before redisplay, for each frame, if any of its windows have changed
28699 size since the last redisplay, or have been split or deleted,
28700 all the functions in the list are called, with the frame as argument. */);
28701 Vwindow_size_change_functions
= Qnil
;
28703 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28704 doc
: /* List of functions to call before redisplaying a window with scrolling.
28705 Each function is called with two arguments, the window and its new
28706 display-start position. Note that these functions are also called by
28707 `set-window-buffer'. Also note that the value of `window-end' is not
28708 valid when these functions are called.
28710 Warning: Do not use this feature to alter the way the window
28711 is scrolled. It is not designed for that, and such use probably won't
28713 Vwindow_scroll_functions
= Qnil
;
28715 DEFVAR_LISP ("window-text-change-functions",
28716 Vwindow_text_change_functions
,
28717 doc
: /* Functions to call in redisplay when text in the window might change. */);
28718 Vwindow_text_change_functions
= Qnil
;
28720 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28721 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28722 Each function is called with two arguments, the window and the end trigger value.
28723 See `set-window-redisplay-end-trigger'. */);
28724 Vredisplay_end_trigger_functions
= Qnil
;
28726 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28727 doc
: /* Non-nil means autoselect window with mouse pointer.
28728 If nil, do not autoselect windows.
28729 A positive number means delay autoselection by that many seconds: a
28730 window is autoselected only after the mouse has remained in that
28731 window for the duration of the delay.
28732 A negative number has a similar effect, but causes windows to be
28733 autoselected only after the mouse has stopped moving. \(Because of
28734 the way Emacs compares mouse events, you will occasionally wait twice
28735 that time before the window gets selected.\)
28736 Any other value means to autoselect window instantaneously when the
28737 mouse pointer enters it.
28739 Autoselection selects the minibuffer only if it is active, and never
28740 unselects the minibuffer if it is active.
28742 When customizing this variable make sure that the actual value of
28743 `focus-follows-mouse' matches the behavior of your window manager. */);
28744 Vmouse_autoselect_window
= Qnil
;
28746 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28747 doc
: /* Non-nil means automatically resize tool-bars.
28748 This dynamically changes the tool-bar's height to the minimum height
28749 that is needed to make all tool-bar items visible.
28750 If value is `grow-only', the tool-bar's height is only increased
28751 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28752 Vauto_resize_tool_bars
= Qt
;
28754 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28755 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28756 auto_raise_tool_bar_buttons_p
= 1;
28758 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28759 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28760 make_cursor_line_fully_visible_p
= 1;
28762 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28763 doc
: /* Border below tool-bar in pixels.
28764 If an integer, use it as the height of the border.
28765 If it is one of `internal-border-width' or `border-width', use the
28766 value of the corresponding frame parameter.
28767 Otherwise, no border is added below the tool-bar. */);
28768 Vtool_bar_border
= Qinternal_border_width
;
28770 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28771 doc
: /* Margin around tool-bar buttons in pixels.
28772 If an integer, use that for both horizontal and vertical margins.
28773 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28774 HORZ specifying the horizontal margin, and VERT specifying the
28775 vertical margin. */);
28776 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28778 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28779 doc
: /* Relief thickness of tool-bar buttons. */);
28780 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28782 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28783 doc
: /* Tool bar style to use.
28785 image - show images only
28786 text - show text only
28787 both - show both, text below image
28788 both-horiz - show text to the right of the image
28789 text-image-horiz - show text to the left of the image
28790 any other - use system default or image if no system default. */);
28791 Vtool_bar_style
= Qnil
;
28793 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28794 doc
: /* Maximum number of characters a label can have to be shown.
28795 The tool bar style must also show labels for this to have any effect, see
28796 `tool-bar-style'. */);
28797 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28799 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28800 doc
: /* List of functions to call to fontify regions of text.
28801 Each function is called with one argument POS. Functions must
28802 fontify a region starting at POS in the current buffer, and give
28803 fontified regions the property `fontified'. */);
28804 Vfontification_functions
= Qnil
;
28805 Fmake_variable_buffer_local (Qfontification_functions
);
28807 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28808 unibyte_display_via_language_environment
,
28809 doc
: /* Non-nil means display unibyte text according to language environment.
28810 Specifically, this means that raw bytes in the range 160-255 decimal
28811 are displayed by converting them to the equivalent multibyte characters
28812 according to the current language environment. As a result, they are
28813 displayed according to the current fontset.
28815 Note that this variable affects only how these bytes are displayed,
28816 but does not change the fact they are interpreted as raw bytes. */);
28817 unibyte_display_via_language_environment
= 0;
28819 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28820 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
28821 If a float, it specifies a fraction of the mini-window frame's height.
28822 If an integer, it specifies a number of lines. */);
28823 Vmax_mini_window_height
= make_float (0.25);
28825 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28826 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28827 A value of nil means don't automatically resize mini-windows.
28828 A value of t means resize them to fit the text displayed in them.
28829 A value of `grow-only', the default, means let mini-windows grow only;
28830 they return to their normal size when the minibuffer is closed, or the
28831 echo area becomes empty. */);
28832 Vresize_mini_windows
= Qgrow_only
;
28834 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28835 doc
: /* Alist specifying how to blink the cursor off.
28836 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28837 `cursor-type' frame-parameter or variable equals ON-STATE,
28838 comparing using `equal', Emacs uses OFF-STATE to specify
28839 how to blink it off. ON-STATE and OFF-STATE are values for
28840 the `cursor-type' frame parameter.
28842 If a frame's ON-STATE has no entry in this list,
28843 the frame's other specifications determine how to blink the cursor off. */);
28844 Vblink_cursor_alist
= Qnil
;
28846 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28847 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28848 If non-nil, windows are automatically scrolled horizontally to make
28849 point visible. */);
28850 automatic_hscrolling_p
= 1;
28851 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28853 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28854 doc
: /* How many columns away from the window edge point is allowed to get
28855 before automatic hscrolling will horizontally scroll the window. */);
28856 hscroll_margin
= 5;
28858 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28859 doc
: /* How many columns to scroll the window when point gets too close to the edge.
28860 When point is less than `hscroll-margin' columns from the window
28861 edge, automatic hscrolling will scroll the window by the amount of columns
28862 determined by this variable. If its value is a positive integer, scroll that
28863 many columns. If it's a positive floating-point number, it specifies the
28864 fraction of the window's width to scroll. If it's nil or zero, point will be
28865 centered horizontally after the scroll. Any other value, including negative
28866 numbers, are treated as if the value were zero.
28868 Automatic hscrolling always moves point outside the scroll margin, so if
28869 point was more than scroll step columns inside the margin, the window will
28870 scroll more than the value given by the scroll step.
28872 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28873 and `scroll-right' overrides this variable's effect. */);
28874 Vhscroll_step
= make_number (0);
28876 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28877 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28878 Bind this around calls to `message' to let it take effect. */);
28879 message_truncate_lines
= 0;
28881 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28882 doc
: /* Normal hook run to update the menu bar definitions.
28883 Redisplay runs this hook before it redisplays the menu bar.
28884 This is used to update submenus such as Buffers,
28885 whose contents depend on various data. */);
28886 Vmenu_bar_update_hook
= Qnil
;
28888 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28889 doc
: /* Frame for which we are updating a menu.
28890 The enable predicate for a menu binding should check this variable. */);
28891 Vmenu_updating_frame
= Qnil
;
28893 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28894 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28895 inhibit_menubar_update
= 0;
28897 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28898 doc
: /* Prefix prepended to all continuation lines at display time.
28899 The value may be a string, an image, or a stretch-glyph; it is
28900 interpreted in the same way as the value of a `display' text property.
28902 This variable is overridden by any `wrap-prefix' text or overlay
28905 To add a prefix to non-continuation lines, use `line-prefix'. */);
28906 Vwrap_prefix
= Qnil
;
28907 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28908 Fmake_variable_buffer_local (Qwrap_prefix
);
28910 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28911 doc
: /* Prefix prepended to all non-continuation lines at display time.
28912 The value may be a string, an image, or a stretch-glyph; it is
28913 interpreted in the same way as the value of a `display' text property.
28915 This variable is overridden by any `line-prefix' text or overlay
28918 To add a prefix to continuation lines, use `wrap-prefix'. */);
28919 Vline_prefix
= Qnil
;
28920 DEFSYM (Qline_prefix
, "line-prefix");
28921 Fmake_variable_buffer_local (Qline_prefix
);
28923 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28924 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28925 inhibit_eval_during_redisplay
= 0;
28927 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28928 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28929 inhibit_free_realized_faces
= 0;
28932 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28933 doc
: /* Inhibit try_window_id display optimization. */);
28934 inhibit_try_window_id
= 0;
28936 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28937 doc
: /* Inhibit try_window_reusing display optimization. */);
28938 inhibit_try_window_reusing
= 0;
28940 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28941 doc
: /* Inhibit try_cursor_movement display optimization. */);
28942 inhibit_try_cursor_movement
= 0;
28943 #endif /* GLYPH_DEBUG */
28945 DEFVAR_INT ("overline-margin", overline_margin
,
28946 doc
: /* Space between overline and text, in pixels.
28947 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28948 margin to the character height. */);
28949 overline_margin
= 2;
28951 DEFVAR_INT ("underline-minimum-offset",
28952 underline_minimum_offset
,
28953 doc
: /* Minimum distance between baseline and underline.
28954 This can improve legibility of underlined text at small font sizes,
28955 particularly when using variable `x-use-underline-position-properties'
28956 with fonts that specify an UNDERLINE_POSITION relatively close to the
28957 baseline. The default value is 1. */);
28958 underline_minimum_offset
= 1;
28960 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28961 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28962 This feature only works when on a window system that can change
28963 cursor shapes. */);
28964 display_hourglass_p
= 1;
28966 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28967 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28968 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28970 hourglass_atimer
= NULL
;
28971 hourglass_shown_p
= 0;
28973 DEFSYM (Qglyphless_char
, "glyphless-char");
28974 DEFSYM (Qhex_code
, "hex-code");
28975 DEFSYM (Qempty_box
, "empty-box");
28976 DEFSYM (Qthin_space
, "thin-space");
28977 DEFSYM (Qzero_width
, "zero-width");
28979 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28980 /* Intern this now in case it isn't already done.
28981 Setting this variable twice is harmless.
28982 But don't staticpro it here--that is done in alloc.c. */
28983 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28984 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28986 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28987 doc
: /* Char-table defining glyphless characters.
28988 Each element, if non-nil, should be one of the following:
28989 an ASCII acronym string: display this string in a box
28990 `hex-code': display the hexadecimal code of a character in a box
28991 `empty-box': display as an empty box
28992 `thin-space': display as 1-pixel width space
28993 `zero-width': don't display
28994 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28995 display method for graphical terminals and text terminals respectively.
28996 GRAPHICAL and TEXT should each have one of the values listed above.
28998 The char-table has one extra slot to control the display of a character for
28999 which no font is found. This slot only takes effect on graphical terminals.
29000 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29001 `thin-space'. The default is `empty-box'. */);
29002 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29003 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29008 /* Initialize this module when Emacs starts. */
29013 current_header_line_height
= current_mode_line_height
= -1;
29015 CHARPOS (this_line_start_pos
) = 0;
29017 if (!noninteractive
)
29019 struct window
*m
= XWINDOW (minibuf_window
);
29020 Lisp_Object frame
= m
->frame
;
29021 struct frame
*f
= XFRAME (frame
);
29022 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29023 struct window
*r
= XWINDOW (root
);
29026 echo_area_window
= minibuf_window
;
29028 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
29029 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
29030 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
29031 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
29032 XSETFASTINT (m
->total_lines
, 1);
29033 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
29035 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29036 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29037 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29039 /* The default ellipsis glyphs `...'. */
29040 for (i
= 0; i
< 3; ++i
)
29041 default_invis_vector
[i
] = make_number ('.');
29045 /* Allocate the buffer for frame titles.
29046 Also used for `format-mode-line'. */
29048 mode_line_noprop_buf
= (char *) xmalloc (size
);
29049 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29050 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29051 mode_line_target
= MODE_LINE_DISPLAY
;
29054 help_echo_showing_p
= 0;
29057 /* Since w32 does not support atimers, it defines its own implementation of
29058 the following three functions in w32fns.c. */
29061 /* Platform-independent portion of hourglass implementation. */
29063 /* Return non-zero if hourglass timer has been started or hourglass is
29066 hourglass_started (void)
29068 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
29071 /* Cancel a currently active hourglass timer, and start a new one. */
29073 start_hourglass (void)
29075 #if defined (HAVE_WINDOW_SYSTEM)
29077 int secs
, usecs
= 0;
29079 cancel_hourglass ();
29081 if (INTEGERP (Vhourglass_delay
)
29082 && XINT (Vhourglass_delay
) > 0)
29083 secs
= XFASTINT (Vhourglass_delay
);
29084 else if (FLOATP (Vhourglass_delay
)
29085 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29088 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
29089 secs
= XFASTINT (tem
);
29090 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
29093 secs
= DEFAULT_HOURGLASS_DELAY
;
29095 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
29096 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29097 show_hourglass
, NULL
);
29102 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29105 cancel_hourglass (void)
29107 #if defined (HAVE_WINDOW_SYSTEM)
29108 if (hourglass_atimer
)
29110 cancel_atimer (hourglass_atimer
);
29111 hourglass_atimer
= NULL
;
29114 if (hourglass_shown_p
)
29118 #endif /* ! WINDOWSNT */