1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code.
37 The following diagram shows how redisplay code is invoked. As you
38 can see, Lisp calls redisplay and vice versa. Under window systems
39 like X, some portions of the redisplay code are also called
40 asynchronously during mouse movement or expose events. It is very
41 important that these code parts do NOT use the C library (malloc,
42 free) because many C libraries under Unix are not reentrant. They
43 may also NOT call functions of the Lisp interpreter which could
44 change the interpreter's state. If you don't follow these rules,
45 you will encounter bugs which are very hard to explain.
47 +--------------+ redisplay +----------------+
48 | Lisp machine |---------------->| Redisplay code |<--+
49 +--------------+ (xdisp.c) +----------------+ |
51 +----------------------------------+ |
52 Don't use this path when called |
55 expose_window (asynchronous) |
57 X expose events -----+
59 What does redisplay do? Obviously, it has to figure out somehow what
60 has been changed since the last time the display has been updated,
61 and to make these changes visible. Preferably it would do that in
62 a moderately intelligent way, i.e. fast.
64 Changes in buffer text can be deduced from window and buffer
65 structures, and from some global variables like `beg_unchanged' and
66 `end_unchanged'. The contents of the display are additionally
67 recorded in a `glyph matrix', a two-dimensional matrix of glyph
68 structures. Each row in such a matrix corresponds to a line on the
69 display, and each glyph in a row corresponds to a column displaying
70 a character, an image, or what else. This matrix is called the
71 `current glyph matrix' or `current matrix' in redisplay
74 For buffer parts that have been changed since the last update, a
75 second glyph matrix is constructed, the so called `desired glyph
76 matrix' or short `desired matrix'. Current and desired matrix are
77 then compared to find a cheap way to update the display, e.g. by
78 reusing part of the display by scrolling lines.
80 You will find a lot of redisplay optimizations when you start
81 looking at the innards of redisplay. The overall goal of all these
82 optimizations is to make redisplay fast because it is done
83 frequently. Some of these optimizations are implemented by the
88 This function tries to update the display if the text in the
89 window did not change and did not scroll, only point moved, and
90 it did not move off the displayed portion of the text.
92 . try_window_reusing_current_matrix
94 This function reuses the current matrix of a window when text
95 has not changed, but the window start changed (e.g., due to
100 This function attempts to redisplay a window by reusing parts of
101 its existing display. It finds and reuses the part that was not
102 changed, and redraws the rest.
106 This function performs the full redisplay of a single window
107 assuming that its fonts were not changed and that the cursor
108 will not end up in the scroll margins. (Loading fonts requires
109 re-adjustment of dimensions of glyph matrices, which makes this
110 method impossible to use.)
112 These optimizations are tried in sequence (some can be skipped if
113 it is known that they are not applicable). If none of the
114 optimizations were successful, redisplay calls redisplay_windows,
115 which performs a full redisplay of all windows.
119 Desired matrices are always built per Emacs window. The function
120 `display_line' is the central function to look at if you are
121 interested. It constructs one row in a desired matrix given an
122 iterator structure containing both a buffer position and a
123 description of the environment in which the text is to be
124 displayed. But this is too early, read on.
126 Characters and pixmaps displayed for a range of buffer text depend
127 on various settings of buffers and windows, on overlays and text
128 properties, on display tables, on selective display. The good news
129 is that all this hairy stuff is hidden behind a small set of
130 interface functions taking an iterator structure (struct it)
133 Iteration over things to be displayed is then simple. It is
134 started by initializing an iterator with a call to init_iterator.
135 Calls to get_next_display_element fill the iterator structure with
136 relevant information about the next thing to display. Calls to
137 set_iterator_to_next move the iterator to the next thing.
139 Besides this, an iterator also contains information about the
140 display environment in which glyphs for display elements are to be
141 produced. It has fields for the width and height of the display,
142 the information whether long lines are truncated or continued, a
143 current X and Y position, and lots of other stuff you can better
146 Glyphs in a desired matrix are normally constructed in a loop
147 calling get_next_display_element and then PRODUCE_GLYPHS. The call
148 to PRODUCE_GLYPHS will fill the iterator structure with pixel
149 information about the element being displayed and at the same time
150 produce glyphs for it. If the display element fits on the line
151 being displayed, set_iterator_to_next is called next, otherwise the
152 glyphs produced are discarded. The function display_line is the
153 workhorse of filling glyph rows in the desired matrix with glyphs.
154 In addition to producing glyphs, it also handles line truncation
155 and continuation, word wrap, and cursor positioning (for the
156 latter, see also set_cursor_from_row).
160 That just couldn't be all, could it? What about terminal types not
161 supporting operations on sub-windows of the screen? To update the
162 display on such a terminal, window-based glyph matrices are not
163 well suited. To be able to reuse part of the display (scrolling
164 lines up and down), we must instead have a view of the whole
165 screen. This is what `frame matrices' are for. They are a trick.
167 Frames on terminals like above have a glyph pool. Windows on such
168 a frame sub-allocate their glyph memory from their frame's glyph
169 pool. The frame itself is given its own glyph matrices. By
170 coincidence---or maybe something else---rows in window glyph
171 matrices are slices of corresponding rows in frame matrices. Thus
172 writing to window matrices implicitly updates a frame matrix which
173 provides us with the view of the whole screen that we originally
174 wanted to have without having to move many bytes around. To be
175 honest, there is a little bit more done, but not much more. If you
176 plan to extend that code, take a look at dispnew.c. The function
177 build_frame_matrix is a good starting point.
179 Bidirectional display.
181 Bidirectional display adds quite some hair to this already complex
182 design. The good news are that a large portion of that hairy stuff
183 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
184 reordering engine which is called by set_iterator_to_next and
185 returns the next character to display in the visual order. See
186 commentary on bidi.c for more details. As far as redisplay is
187 concerned, the effect of calling bidi_move_to_visually_next, the
188 main interface of the reordering engine, is that the iterator gets
189 magically placed on the buffer or string position that is to be
190 displayed next. In other words, a linear iteration through the
191 buffer/string is replaced with a non-linear one. All the rest of
192 the redisplay is oblivious to the bidi reordering.
194 Well, almost oblivious---there are still complications, most of
195 them due to the fact that buffer and string positions no longer
196 change monotonously with glyph indices in a glyph row. Moreover,
197 for continued lines, the buffer positions may not even be
198 monotonously changing with vertical positions. Also, accounting
199 for face changes, overlays, etc. becomes more complex because
200 non-linear iteration could potentially skip many positions with
201 changes, and then cross them again on the way back...
203 One other prominent effect of bidirectional display is that some
204 paragraphs of text need to be displayed starting at the right
205 margin of the window---the so-called right-to-left, or R2L
206 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
207 which have their reversed_p flag set. The bidi reordering engine
208 produces characters in such rows starting from the character which
209 should be the rightmost on display. PRODUCE_GLYPHS then reverses
210 the order, when it fills up the glyph row whose reversed_p flag is
211 set, by prepending each new glyph to what is already there, instead
212 of appending it. When the glyph row is complete, the function
213 extend_face_to_end_of_line fills the empty space to the left of the
214 leftmost character with special glyphs, which will display as,
215 well, empty. On text terminals, these special glyphs are simply
216 blank characters. On graphics terminals, there's a single stretch
217 glyph with suitably computed width. Both the blanks and the
218 stretch glyph are given the face of the background of the line.
219 This way, the terminal-specific back-end can still draw the glyphs
220 left to right, even for R2L lines.
222 Note one important detail mentioned above: that the bidi reordering
223 engine, driven by the iterator, produces characters in R2L rows
224 starting at the character that will be the rightmost on display.
225 As far as the iterator is concerned, the geometry of such rows is
226 still left to right, i.e. the iterator "thinks" the first character
227 is at the leftmost pixel position. The iterator does not know that
228 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
229 delivers. This is important when functions from the the move_it_*
230 family are used to get to certain screen position or to match
231 screen coordinates with buffer coordinates: these functions use the
232 iterator geometry, which is left to right even in R2L paragraphs.
233 This works well with most callers of move_it_*, because they need
234 to get to a specific column, and columns are still numbered in the
235 reading order, i.e. the rightmost character in a R2L paragraph is
236 still column zero. But some callers do not get well with this; a
237 notable example is mouse clicks that need to find the character
238 that corresponds to certain pixel coordinates. See
239 buffer_posn_from_coords in dispnew.c for how this is handled. */
247 #include "keyboard.h"
250 #include "termchar.h"
251 #include "dispextern.h"
253 #include "character.h"
256 #include "commands.h"
260 #include "termhooks.h"
261 #include "termopts.h"
262 #include "intervals.h"
265 #include "region-cache.h"
268 #include "blockinput.h"
270 #ifdef HAVE_X_WINDOWS
285 #ifndef FRAME_X_OUTPUT
286 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
289 #define INFINITY 10000000
291 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
292 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
293 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
294 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
295 Lisp_Object Qinhibit_point_motion_hooks
;
296 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
297 Lisp_Object Qfontified
;
298 Lisp_Object Qgrow_only
;
299 Lisp_Object Qinhibit_eval_during_redisplay
;
300 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
301 Lisp_Object Qright_to_left
, Qleft_to_right
;
304 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
307 Lisp_Object Qarrow
, Qhand
, Qtext
;
309 Lisp_Object Qrisky_local_variable
;
311 /* Holds the list (error). */
312 Lisp_Object list_of_error
;
314 /* Functions called to fontify regions of text. */
316 Lisp_Object Vfontification_functions
;
317 Lisp_Object Qfontification_functions
;
319 /* Non-nil means automatically select any window when the mouse
320 cursor moves into it. */
321 Lisp_Object Vmouse_autoselect_window
;
323 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
324 Lisp_Object Vline_prefix
, Qline_prefix
;
326 /* Non-zero means draw tool bar buttons raised when the mouse moves
329 int auto_raise_tool_bar_buttons_p
;
331 /* Non-zero means to reposition window if cursor line is only partially visible. */
333 int make_cursor_line_fully_visible_p
;
335 /* Margin below tool bar in pixels. 0 or nil means no margin.
336 If value is `internal-border-width' or `border-width',
337 the corresponding frame parameter is used. */
339 Lisp_Object Vtool_bar_border
;
341 /* Margin around tool bar buttons in pixels. */
343 Lisp_Object Vtool_bar_button_margin
;
345 /* Thickness of shadow to draw around tool bar buttons. */
347 EMACS_INT tool_bar_button_relief
;
349 /* Non-nil means automatically resize tool-bars so that all tool-bar
350 items are visible, and no blank lines remain.
352 If value is `grow-only', only make tool-bar bigger. */
354 Lisp_Object Vauto_resize_tool_bars
;
356 /* Type of tool bar. Can be symbols image, text, both or both-hroiz. */
358 Lisp_Object Vtool_bar_style
;
360 /* Maximum number of characters a label can have to be shown. */
362 EMACS_INT tool_bar_max_label_size
;
364 /* Non-zero means draw block and hollow cursor as wide as the glyph
365 under it. For example, if a block cursor is over a tab, it will be
366 drawn as wide as that tab on the display. */
368 int x_stretch_cursor_p
;
370 /* Non-nil means don't actually do any redisplay. */
372 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
374 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
376 int inhibit_eval_during_redisplay
;
378 /* Names of text properties relevant for redisplay. */
380 Lisp_Object Qdisplay
;
382 /* Symbols used in text property values. */
384 Lisp_Object Vdisplay_pixels_per_inch
;
385 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
386 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
389 Lisp_Object Qmargin
, Qpointer
;
390 Lisp_Object Qline_height
;
392 /* Non-nil means highlight trailing whitespace. */
394 Lisp_Object Vshow_trailing_whitespace
;
396 /* Non-nil means escape non-break space and hyphens. */
398 Lisp_Object Vnobreak_char_display
;
400 #ifdef HAVE_WINDOW_SYSTEM
402 /* Test if overflow newline into fringe. Called with iterator IT
403 at or past right window margin, and with IT->current_x set. */
405 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
406 (!NILP (Voverflow_newline_into_fringe) \
407 && FRAME_WINDOW_P ((IT)->f) \
408 && ((IT)->bidi_it.paragraph_dir == R2L \
409 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
410 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
411 && (IT)->current_x == (IT)->last_visible_x \
412 && (IT)->line_wrap != WORD_WRAP)
414 #else /* !HAVE_WINDOW_SYSTEM */
415 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
416 #endif /* HAVE_WINDOW_SYSTEM */
418 /* Test if the display element loaded in IT is a space or tab
419 character. This is used to determine word wrapping. */
421 #define IT_DISPLAYING_WHITESPACE(it) \
422 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
424 /* Non-nil means show the text cursor in void text areas
425 i.e. in blank areas after eol and eob. This used to be
426 the default in 21.3. */
428 Lisp_Object Vvoid_text_area_pointer
;
430 /* Name of the face used to highlight trailing whitespace. */
432 Lisp_Object Qtrailing_whitespace
;
434 /* Name and number of the face used to highlight escape glyphs. */
436 Lisp_Object Qescape_glyph
;
438 /* Name and number of the face used to highlight non-breaking spaces. */
440 Lisp_Object Qnobreak_space
;
442 /* The symbol `image' which is the car of the lists used to represent
443 images in Lisp. Also a tool bar style. */
447 /* The image map types. */
448 Lisp_Object QCmap
, QCpointer
;
449 Lisp_Object Qrect
, Qcircle
, Qpoly
;
451 /* Tool bar styles */
452 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
454 /* Non-zero means print newline to stdout before next mini-buffer
457 int noninteractive_need_newline
;
459 /* Non-zero means print newline to message log before next message. */
461 static int message_log_need_newline
;
463 /* Three markers that message_dolog uses.
464 It could allocate them itself, but that causes trouble
465 in handling memory-full errors. */
466 static Lisp_Object message_dolog_marker1
;
467 static Lisp_Object message_dolog_marker2
;
468 static Lisp_Object message_dolog_marker3
;
470 /* The buffer position of the first character appearing entirely or
471 partially on the line of the selected window which contains the
472 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
473 redisplay optimization in redisplay_internal. */
475 static struct text_pos this_line_start_pos
;
477 /* Number of characters past the end of the line above, including the
478 terminating newline. */
480 static struct text_pos this_line_end_pos
;
482 /* The vertical positions and the height of this line. */
484 static int this_line_vpos
;
485 static int this_line_y
;
486 static int this_line_pixel_height
;
488 /* X position at which this display line starts. Usually zero;
489 negative if first character is partially visible. */
491 static int this_line_start_x
;
493 /* Buffer that this_line_.* variables are referring to. */
495 static struct buffer
*this_line_buffer
;
497 /* Nonzero means truncate lines in all windows less wide than the
500 Lisp_Object Vtruncate_partial_width_windows
;
502 /* A flag to control how to display unibyte 8-bit character. */
504 int unibyte_display_via_language_environment
;
506 /* Nonzero means we have more than one non-mini-buffer-only frame.
507 Not guaranteed to be accurate except while parsing
508 frame-title-format. */
512 Lisp_Object Vglobal_mode_string
;
515 /* List of variables (symbols) which hold markers for overlay arrows.
516 The symbols on this list are examined during redisplay to determine
517 where to display overlay arrows. */
519 Lisp_Object Voverlay_arrow_variable_list
;
521 /* Marker for where to display an arrow on top of the buffer text. */
523 Lisp_Object Voverlay_arrow_position
;
525 /* String to display for the arrow. Only used on terminal frames. */
527 Lisp_Object Voverlay_arrow_string
;
529 /* Values of those variables at last redisplay are stored as
530 properties on `overlay-arrow-position' symbol. However, if
531 Voverlay_arrow_position is a marker, last-arrow-position is its
532 numerical position. */
534 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
536 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
537 properties on a symbol in overlay-arrow-variable-list. */
539 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
541 /* Like mode-line-format, but for the title bar on a visible frame. */
543 Lisp_Object Vframe_title_format
;
545 /* Like mode-line-format, but for the title bar on an iconified frame. */
547 Lisp_Object Vicon_title_format
;
549 /* List of functions to call when a window's size changes. These
550 functions get one arg, a frame on which one or more windows' sizes
553 static Lisp_Object Vwindow_size_change_functions
;
555 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
557 /* Nonzero if an overlay arrow has been displayed in this window. */
559 static int overlay_arrow_seen
;
561 /* Nonzero means highlight the region even in nonselected windows. */
563 int highlight_nonselected_windows
;
565 /* If cursor motion alone moves point off frame, try scrolling this
566 many lines up or down if that will bring it back. */
568 static EMACS_INT scroll_step
;
570 /* Nonzero means scroll just far enough to bring point back on the
571 screen, when appropriate. */
573 static EMACS_INT scroll_conservatively
;
575 /* Recenter the window whenever point gets within this many lines of
576 the top or bottom of the window. This value is translated into a
577 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
578 that there is really a fixed pixel height scroll margin. */
580 EMACS_INT scroll_margin
;
582 /* Number of windows showing the buffer of the selected window (or
583 another buffer with the same base buffer). keyboard.c refers to
588 /* Vector containing glyphs for an ellipsis `...'. */
590 static Lisp_Object default_invis_vector
[3];
592 /* Zero means display the mode-line/header-line/menu-bar in the default face
593 (this slightly odd definition is for compatibility with previous versions
594 of emacs), non-zero means display them using their respective faces.
596 This variable is deprecated. */
598 int mode_line_inverse_video
;
600 /* Prompt to display in front of the mini-buffer contents. */
602 Lisp_Object minibuf_prompt
;
604 /* Width of current mini-buffer prompt. Only set after display_line
605 of the line that contains the prompt. */
607 int minibuf_prompt_width
;
609 /* This is the window where the echo area message was displayed. It
610 is always a mini-buffer window, but it may not be the same window
611 currently active as a mini-buffer. */
613 Lisp_Object echo_area_window
;
615 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
616 pushes the current message and the value of
617 message_enable_multibyte on the stack, the function restore_message
618 pops the stack and displays MESSAGE again. */
620 Lisp_Object Vmessage_stack
;
622 /* Nonzero means multibyte characters were enabled when the echo area
623 message was specified. */
625 int message_enable_multibyte
;
627 /* Nonzero if we should redraw the mode lines on the next redisplay. */
629 int update_mode_lines
;
631 /* Nonzero if window sizes or contents have changed since last
632 redisplay that finished. */
634 int windows_or_buffers_changed
;
636 /* Nonzero means a frame's cursor type has been changed. */
638 int cursor_type_changed
;
640 /* Nonzero after display_mode_line if %l was used and it displayed a
643 int line_number_displayed
;
645 /* Maximum buffer size for which to display line numbers. */
647 Lisp_Object Vline_number_display_limit
;
649 /* Line width to consider when repositioning for line number display. */
651 static EMACS_INT line_number_display_limit_width
;
653 /* Number of lines to keep in the message log buffer. t means
654 infinite. nil means don't log at all. */
656 Lisp_Object Vmessage_log_max
;
658 /* The name of the *Messages* buffer, a string. */
660 static Lisp_Object Vmessages_buffer_name
;
662 /* Current, index 0, and last displayed echo area message. Either
663 buffers from echo_buffers, or nil to indicate no message. */
665 Lisp_Object echo_area_buffer
[2];
667 /* The buffers referenced from echo_area_buffer. */
669 static Lisp_Object echo_buffer
[2];
671 /* A vector saved used in with_area_buffer to reduce consing. */
673 static Lisp_Object Vwith_echo_area_save_vector
;
675 /* Non-zero means display_echo_area should display the last echo area
676 message again. Set by redisplay_preserve_echo_area. */
678 static int display_last_displayed_message_p
;
680 /* Nonzero if echo area is being used by print; zero if being used by
683 int message_buf_print
;
685 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
687 Lisp_Object Qinhibit_menubar_update
;
688 int inhibit_menubar_update
;
690 /* When evaluating expressions from menu bar items (enable conditions,
691 for instance), this is the frame they are being processed for. */
693 Lisp_Object Vmenu_updating_frame
;
695 /* Maximum height for resizing mini-windows. Either a float
696 specifying a fraction of the available height, or an integer
697 specifying a number of lines. */
699 Lisp_Object Vmax_mini_window_height
;
701 /* Non-zero means messages should be displayed with truncated
702 lines instead of being continued. */
704 int message_truncate_lines
;
705 Lisp_Object Qmessage_truncate_lines
;
707 /* Set to 1 in clear_message to make redisplay_internal aware
708 of an emptied echo area. */
710 static int message_cleared_p
;
712 /* How to blink the default frame cursor off. */
713 Lisp_Object Vblink_cursor_alist
;
715 /* A scratch glyph row with contents used for generating truncation
716 glyphs. Also used in direct_output_for_insert. */
718 #define MAX_SCRATCH_GLYPHS 100
719 struct glyph_row scratch_glyph_row
;
720 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
722 /* Ascent and height of the last line processed by move_it_to. */
724 static int last_max_ascent
, last_height
;
726 /* Non-zero if there's a help-echo in the echo area. */
728 int help_echo_showing_p
;
730 /* If >= 0, computed, exact values of mode-line and header-line height
731 to use in the macros CURRENT_MODE_LINE_HEIGHT and
732 CURRENT_HEADER_LINE_HEIGHT. */
734 int current_mode_line_height
, current_header_line_height
;
736 /* The maximum distance to look ahead for text properties. Values
737 that are too small let us call compute_char_face and similar
738 functions too often which is expensive. Values that are too large
739 let us call compute_char_face and alike too often because we
740 might not be interested in text properties that far away. */
742 #define TEXT_PROP_DISTANCE_LIMIT 100
746 /* Variables to turn off display optimizations from Lisp. */
748 int inhibit_try_window_id
, inhibit_try_window_reusing
;
749 int inhibit_try_cursor_movement
;
751 /* Non-zero means print traces of redisplay if compiled with
754 int trace_redisplay_p
;
756 #endif /* GLYPH_DEBUG */
758 #ifdef DEBUG_TRACE_MOVE
759 /* Non-zero means trace with TRACE_MOVE to stderr. */
762 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
764 #define TRACE_MOVE(x) (void) 0
767 /* Non-zero means automatically scroll windows horizontally to make
770 int automatic_hscrolling_p
;
771 Lisp_Object Qauto_hscroll_mode
;
773 /* How close to the margin can point get before the window is scrolled
775 EMACS_INT hscroll_margin
;
777 /* How much to scroll horizontally when point is inside the above margin. */
778 Lisp_Object Vhscroll_step
;
780 /* The variable `resize-mini-windows'. If nil, don't resize
781 mini-windows. If t, always resize them to fit the text they
782 display. If `grow-only', let mini-windows grow only until they
785 Lisp_Object Vresize_mini_windows
;
787 /* Buffer being redisplayed -- for redisplay_window_error. */
789 struct buffer
*displayed_buffer
;
791 /* Space between overline and text. */
793 EMACS_INT overline_margin
;
795 /* Require underline to be at least this many screen pixels below baseline
796 This to avoid underline "merging" with the base of letters at small
797 font sizes, particularly when x_use_underline_position_properties is on. */
799 EMACS_INT underline_minimum_offset
;
801 /* Value returned from text property handlers (see below). */
806 HANDLED_RECOMPUTE_PROPS
,
807 HANDLED_OVERLAY_STRING_CONSUMED
,
811 /* A description of text properties that redisplay is interested
816 /* The name of the property. */
819 /* A unique index for the property. */
822 /* A handler function called to set up iterator IT from the property
823 at IT's current position. Value is used to steer handle_stop. */
824 enum prop_handled (*handler
) (struct it
*it
);
827 static enum prop_handled
handle_face_prop (struct it
*);
828 static enum prop_handled
handle_invisible_prop (struct it
*);
829 static enum prop_handled
handle_display_prop (struct it
*);
830 static enum prop_handled
handle_composition_prop (struct it
*);
831 static enum prop_handled
handle_overlay_change (struct it
*);
832 static enum prop_handled
handle_fontified_prop (struct it
*);
834 /* Properties handled by iterators. */
836 static struct props it_props
[] =
838 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
839 /* Handle `face' before `display' because some sub-properties of
840 `display' need to know the face. */
841 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
842 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
843 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
844 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
848 /* Value is the position described by X. If X is a marker, value is
849 the marker_position of X. Otherwise, value is X. */
851 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
853 /* Enumeration returned by some move_it_.* functions internally. */
857 /* Not used. Undefined value. */
860 /* Move ended at the requested buffer position or ZV. */
861 MOVE_POS_MATCH_OR_ZV
,
863 /* Move ended at the requested X pixel position. */
866 /* Move within a line ended at the end of a line that must be
870 /* Move within a line ended at the end of a line that would
871 be displayed truncated. */
874 /* Move within a line ended at a line end. */
878 /* This counter is used to clear the face cache every once in a while
879 in redisplay_internal. It is incremented for each redisplay.
880 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
883 #define CLEAR_FACE_CACHE_COUNT 500
884 static int clear_face_cache_count
;
886 /* Similarly for the image cache. */
888 #ifdef HAVE_WINDOW_SYSTEM
889 #define CLEAR_IMAGE_CACHE_COUNT 101
890 static int clear_image_cache_count
;
893 /* Non-zero while redisplay_internal is in progress. */
897 /* Non-zero means don't free realized faces. Bound while freeing
898 realized faces is dangerous because glyph matrices might still
901 int inhibit_free_realized_faces
;
902 Lisp_Object Qinhibit_free_realized_faces
;
904 /* If a string, XTread_socket generates an event to display that string.
905 (The display is done in read_char.) */
907 Lisp_Object help_echo_string
;
908 Lisp_Object help_echo_window
;
909 Lisp_Object help_echo_object
;
912 /* Temporary variable for XTread_socket. */
914 Lisp_Object previous_help_echo_string
;
916 /* Null glyph slice */
918 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
920 /* Platform-independent portion of hourglass implementation. */
922 /* Non-zero means we're allowed to display a hourglass pointer. */
923 int display_hourglass_p
;
925 /* Non-zero means an hourglass cursor is currently shown. */
926 int hourglass_shown_p
;
928 /* If non-null, an asynchronous timer that, when it expires, displays
929 an hourglass cursor on all frames. */
930 struct atimer
*hourglass_atimer
;
932 /* Number of seconds to wait before displaying an hourglass cursor. */
933 Lisp_Object Vhourglass_delay
;
935 /* Default number of seconds to wait before displaying an hourglass
937 #define DEFAULT_HOURGLASS_DELAY 1
940 /* Function prototypes. */
942 static void setup_for_ellipsis (struct it
*, int);
943 static void mark_window_display_accurate_1 (struct window
*, int);
944 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
945 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
946 static int cursor_row_p (struct window
*, struct glyph_row
*);
947 static int redisplay_mode_lines (Lisp_Object
, int);
948 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
950 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
952 static void handle_line_prefix (struct it
*);
954 static void pint2str (char *, int, int);
955 static void pint2hrstr (char *, int, int);
956 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
958 static void reconsider_clip_changes (struct window
*, struct buffer
*);
959 static int text_outside_line_unchanged_p (struct window
*, int, int);
960 static void store_mode_line_noprop_char (char);
961 static int store_mode_line_noprop (const unsigned char *, int, int);
962 static void x_consider_frame_title (Lisp_Object
);
963 static void handle_stop (struct it
*);
964 static void handle_stop_backwards (struct it
*, EMACS_INT
);
965 static int tool_bar_lines_needed (struct frame
*, int *);
966 static int single_display_spec_intangible_p (Lisp_Object
);
967 static void ensure_echo_area_buffers (void);
968 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
969 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
970 static int with_echo_area_buffer (struct window
*, int,
971 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
972 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
973 static void clear_garbaged_frames (void);
974 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
975 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
976 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
977 static int display_echo_area (struct window
*);
978 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
979 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
980 static Lisp_Object
unwind_redisplay (Lisp_Object
);
981 static int string_char_and_length (const unsigned char *, int *);
982 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
984 static int compute_window_start_on_continuation_line (struct window
*);
985 static Lisp_Object
safe_eval_handler (Lisp_Object
);
986 static void insert_left_trunc_glyphs (struct it
*);
987 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
989 static void extend_face_to_end_of_line (struct it
*);
990 static int append_space_for_newline (struct it
*, int);
991 static int cursor_row_fully_visible_p (struct window
*, int, int);
992 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
993 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
994 static int trailing_whitespace_p (int);
995 static int message_log_check_duplicate (int, int, int, int);
996 static void push_it (struct it
*);
997 static void pop_it (struct it
*);
998 static void sync_frame_with_window_matrix_rows (struct window
*);
999 static void select_frame_for_redisplay (Lisp_Object
);
1000 static void redisplay_internal (int);
1001 static int echo_area_display (int);
1002 static void redisplay_windows (Lisp_Object
);
1003 static void redisplay_window (Lisp_Object
, int);
1004 static Lisp_Object
redisplay_window_error (Lisp_Object
);
1005 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
1006 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
1007 static int update_menu_bar (struct frame
*, int, int);
1008 static int try_window_reusing_current_matrix (struct window
*);
1009 static int try_window_id (struct window
*);
1010 static int display_line (struct it
*);
1011 static int display_mode_lines (struct window
*);
1012 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
1013 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
1014 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
1015 static const char *decode_mode_spec (struct window
*, int, int, int,
1017 static void display_menu_bar (struct window
*);
1018 static int display_count_lines (int, int, int, int, int *);
1019 static int display_string (const unsigned char *, Lisp_Object
, Lisp_Object
,
1020 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
1021 static void compute_line_metrics (struct it
*);
1022 static void run_redisplay_end_trigger_hook (struct it
*);
1023 static int get_overlay_strings (struct it
*, int);
1024 static int get_overlay_strings_1 (struct it
*, int, int);
1025 static void next_overlay_string (struct it
*);
1026 static void reseat (struct it
*, struct text_pos
, int);
1027 static void reseat_1 (struct it
*, struct text_pos
, int);
1028 static void back_to_previous_visible_line_start (struct it
*);
1029 void reseat_at_previous_visible_line_start (struct it
*);
1030 static void reseat_at_next_visible_line_start (struct it
*, int);
1031 static int next_element_from_ellipsis (struct it
*);
1032 static int next_element_from_display_vector (struct it
*);
1033 static int next_element_from_string (struct it
*);
1034 static int next_element_from_c_string (struct it
*);
1035 static int next_element_from_buffer (struct it
*);
1036 static int next_element_from_composition (struct it
*);
1037 static int next_element_from_image (struct it
*);
1038 static int next_element_from_stretch (struct it
*);
1039 static void load_overlay_strings (struct it
*, int);
1040 static int init_from_display_pos (struct it
*, struct window
*,
1041 struct display_pos
*);
1042 static void reseat_to_string (struct it
*, const unsigned char *,
1043 Lisp_Object
, int, int, int, int);
1044 static enum move_it_result
1045 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
1046 enum move_operation_enum
);
1047 void move_it_vertically_backward (struct it
*, int);
1048 static void init_to_row_start (struct it
*, struct window
*,
1049 struct glyph_row
*);
1050 static int init_to_row_end (struct it
*, struct window
*,
1051 struct glyph_row
*);
1052 static void back_to_previous_line_start (struct it
*);
1053 static int forward_to_next_line_start (struct it
*, int *);
1054 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
1056 static struct text_pos
string_pos (int, Lisp_Object
);
1057 static struct text_pos
c_string_pos (int, const unsigned char *, int);
1058 static int number_of_chars (const unsigned char *, int);
1059 static void compute_stop_pos (struct it
*);
1060 static void compute_string_pos (struct text_pos
*, struct text_pos
,
1062 static int face_before_or_after_it_pos (struct it
*, int);
1063 static EMACS_INT
next_overlay_change (EMACS_INT
);
1064 static int handle_single_display_spec (struct it
*, Lisp_Object
,
1065 Lisp_Object
, Lisp_Object
,
1066 struct text_pos
*, int);
1067 static int underlying_face_id (struct it
*);
1068 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
1071 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1072 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1074 #ifdef HAVE_WINDOW_SYSTEM
1076 static void update_tool_bar (struct frame
*, int);
1077 static void build_desired_tool_bar_string (struct frame
*f
);
1078 static int redisplay_tool_bar (struct frame
*);
1079 static void display_tool_bar_line (struct it
*, int);
1080 static void notice_overwritten_cursor (struct window
*,
1081 enum glyph_row_area
,
1082 int, int, int, int);
1083 static void append_stretch_glyph (struct it
*, Lisp_Object
,
1088 #endif /* HAVE_WINDOW_SYSTEM */
1091 /***********************************************************************
1092 Window display dimensions
1093 ***********************************************************************/
1095 /* Return the bottom boundary y-position for text lines in window W.
1096 This is the first y position at which a line cannot start.
1097 It is relative to the top of the window.
1099 This is the height of W minus the height of a mode line, if any. */
1102 window_text_bottom_y (struct window
*w
)
1104 int height
= WINDOW_TOTAL_HEIGHT (w
);
1106 if (WINDOW_WANTS_MODELINE_P (w
))
1107 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1111 /* Return the pixel width of display area AREA of window W. AREA < 0
1112 means return the total width of W, not including fringes to
1113 the left and right of the window. */
1116 window_box_width (struct window
*w
, int area
)
1118 int cols
= XFASTINT (w
->total_cols
);
1121 if (!w
->pseudo_window_p
)
1123 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1125 if (area
== TEXT_AREA
)
1127 if (INTEGERP (w
->left_margin_cols
))
1128 cols
-= XFASTINT (w
->left_margin_cols
);
1129 if (INTEGERP (w
->right_margin_cols
))
1130 cols
-= XFASTINT (w
->right_margin_cols
);
1131 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1133 else if (area
== LEFT_MARGIN_AREA
)
1135 cols
= (INTEGERP (w
->left_margin_cols
)
1136 ? XFASTINT (w
->left_margin_cols
) : 0);
1139 else if (area
== RIGHT_MARGIN_AREA
)
1141 cols
= (INTEGERP (w
->right_margin_cols
)
1142 ? XFASTINT (w
->right_margin_cols
) : 0);
1147 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1151 /* Return the pixel height of the display area of window W, not
1152 including mode lines of W, if any. */
1155 window_box_height (struct window
*w
)
1157 struct frame
*f
= XFRAME (w
->frame
);
1158 int height
= WINDOW_TOTAL_HEIGHT (w
);
1160 xassert (height
>= 0);
1162 /* Note: the code below that determines the mode-line/header-line
1163 height is essentially the same as that contained in the macro
1164 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1165 the appropriate glyph row has its `mode_line_p' flag set,
1166 and if it doesn't, uses estimate_mode_line_height instead. */
1168 if (WINDOW_WANTS_MODELINE_P (w
))
1170 struct glyph_row
*ml_row
1171 = (w
->current_matrix
&& w
->current_matrix
->rows
1172 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1174 if (ml_row
&& ml_row
->mode_line_p
)
1175 height
-= ml_row
->height
;
1177 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1180 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1182 struct glyph_row
*hl_row
1183 = (w
->current_matrix
&& w
->current_matrix
->rows
1184 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1186 if (hl_row
&& hl_row
->mode_line_p
)
1187 height
-= hl_row
->height
;
1189 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1192 /* With a very small font and a mode-line that's taller than
1193 default, we might end up with a negative height. */
1194 return max (0, height
);
1197 /* Return the window-relative coordinate of the left edge of display
1198 area AREA of window W. AREA < 0 means return the left edge of the
1199 whole window, to the right of the left fringe of W. */
1202 window_box_left_offset (struct window
*w
, int area
)
1206 if (w
->pseudo_window_p
)
1209 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1211 if (area
== TEXT_AREA
)
1212 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1213 + window_box_width (w
, LEFT_MARGIN_AREA
));
1214 else if (area
== RIGHT_MARGIN_AREA
)
1215 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1216 + window_box_width (w
, LEFT_MARGIN_AREA
)
1217 + window_box_width (w
, TEXT_AREA
)
1218 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1220 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1221 else if (area
== LEFT_MARGIN_AREA
1222 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1223 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1229 /* Return the window-relative coordinate of the right edge of display
1230 area AREA of window W. AREA < 0 means return the right edge of the
1231 whole window, to the left of the right fringe of W. */
1234 window_box_right_offset (struct window
*w
, int area
)
1236 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1239 /* Return the frame-relative coordinate of the left edge of display
1240 area AREA of window W. AREA < 0 means return the left edge of the
1241 whole window, to the right of the left fringe of W. */
1244 window_box_left (struct window
*w
, int area
)
1246 struct frame
*f
= XFRAME (w
->frame
);
1249 if (w
->pseudo_window_p
)
1250 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1252 x
= (WINDOW_LEFT_EDGE_X (w
)
1253 + window_box_left_offset (w
, area
));
1259 /* Return the frame-relative coordinate of the right edge of display
1260 area AREA of window W. AREA < 0 means return the right edge of the
1261 whole window, to the left of the right fringe of W. */
1264 window_box_right (struct window
*w
, int area
)
1266 return window_box_left (w
, area
) + window_box_width (w
, area
);
1269 /* Get the bounding box of the display area AREA of window W, without
1270 mode lines, in frame-relative coordinates. AREA < 0 means the
1271 whole window, not including the left and right fringes of
1272 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1273 coordinates of the upper-left corner of the box. Return in
1274 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1277 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1278 int *box_width
, int *box_height
)
1281 *box_width
= window_box_width (w
, area
);
1283 *box_height
= window_box_height (w
);
1285 *box_x
= window_box_left (w
, area
);
1288 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1289 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1290 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1295 /* Get the bounding box of the display area AREA of window W, without
1296 mode lines. AREA < 0 means the whole window, not including the
1297 left and right fringe of the window. Return in *TOP_LEFT_X
1298 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1299 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1300 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1304 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1305 int *bottom_right_x
, int *bottom_right_y
)
1307 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1309 *bottom_right_x
+= *top_left_x
;
1310 *bottom_right_y
+= *top_left_y
;
1315 /***********************************************************************
1317 ***********************************************************************/
1319 /* Return the bottom y-position of the line the iterator IT is in.
1320 This can modify IT's settings. */
1323 line_bottom_y (struct it
*it
)
1325 int line_height
= it
->max_ascent
+ it
->max_descent
;
1326 int line_top_y
= it
->current_y
;
1328 if (line_height
== 0)
1331 line_height
= last_height
;
1332 else if (IT_CHARPOS (*it
) < ZV
)
1334 move_it_by_lines (it
, 1, 1);
1335 line_height
= (it
->max_ascent
|| it
->max_descent
1336 ? it
->max_ascent
+ it
->max_descent
1341 struct glyph_row
*row
= it
->glyph_row
;
1343 /* Use the default character height. */
1344 it
->glyph_row
= NULL
;
1345 it
->what
= IT_CHARACTER
;
1348 PRODUCE_GLYPHS (it
);
1349 line_height
= it
->ascent
+ it
->descent
;
1350 it
->glyph_row
= row
;
1354 return line_top_y
+ line_height
;
1358 /* Return 1 if position CHARPOS is visible in window W.
1359 CHARPOS < 0 means return info about WINDOW_END position.
1360 If visible, set *X and *Y to pixel coordinates of top left corner.
1361 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1362 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1365 pos_visible_p (struct window
*w
, int charpos
, int *x
, int *y
,
1366 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1369 struct text_pos top
;
1371 struct buffer
*old_buffer
= NULL
;
1373 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1376 if (XBUFFER (w
->buffer
) != current_buffer
)
1378 old_buffer
= current_buffer
;
1379 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1382 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1384 /* Compute exact mode line heights. */
1385 if (WINDOW_WANTS_MODELINE_P (w
))
1386 current_mode_line_height
1387 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1388 current_buffer
->mode_line_format
);
1390 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1391 current_header_line_height
1392 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1393 current_buffer
->header_line_format
);
1395 start_display (&it
, w
, top
);
1396 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1397 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1399 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1401 /* We have reached CHARPOS, or passed it. How the call to
1402 move_it_to can overshoot: (i) If CHARPOS is on invisible
1403 text, move_it_to stops at the end of the invisible text,
1404 after CHARPOS. (ii) If CHARPOS is in a display vector,
1405 move_it_to stops on its last glyph. */
1406 int top_x
= it
.current_x
;
1407 int top_y
= it
.current_y
;
1408 enum it_method it_method
= it
.method
;
1409 /* Calling line_bottom_y may change it.method, it.position, etc. */
1410 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1411 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1413 if (top_y
< window_top_y
)
1414 visible_p
= bottom_y
> window_top_y
;
1415 else if (top_y
< it
.last_visible_y
)
1419 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1421 /* We stopped on the last glyph of a display vector.
1422 Try and recompute. Hack alert! */
1423 if (charpos
< 2 || top
.charpos
>= charpos
)
1424 top_x
= it
.glyph_row
->x
;
1428 start_display (&it2
, w
, top
);
1429 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1430 get_next_display_element (&it2
);
1431 PRODUCE_GLYPHS (&it2
);
1432 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1433 || it2
.current_x
> it2
.last_visible_x
)
1434 top_x
= it
.glyph_row
->x
;
1437 top_x
= it2
.current_x
;
1438 top_y
= it2
.current_y
;
1444 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1445 *rtop
= max (0, window_top_y
- top_y
);
1446 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1447 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1448 - max (top_y
, window_top_y
)));
1457 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1458 move_it_by_lines (&it
, 1, 0);
1459 if (charpos
< IT_CHARPOS (it
)
1460 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1463 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1465 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1466 *rtop
= max (0, -it2
.current_y
);
1467 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1468 - it
.last_visible_y
));
1469 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1471 - max (it2
.current_y
,
1472 WINDOW_HEADER_LINE_HEIGHT (w
))));
1478 set_buffer_internal_1 (old_buffer
);
1480 current_header_line_height
= current_mode_line_height
= -1;
1482 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1483 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1486 /* Debugging code. */
1488 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1489 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1491 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1498 /* Return the next character from STR which is MAXLEN bytes long.
1499 Return in *LEN the length of the character. This is like
1500 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1501 we find one, we return a `?', but with the length of the invalid
1505 string_char_and_length (const unsigned char *str
, int *len
)
1509 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1510 if (!CHAR_VALID_P (c
, 1))
1511 /* We may not change the length here because other places in Emacs
1512 don't use this function, i.e. they silently accept invalid
1521 /* Given a position POS containing a valid character and byte position
1522 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1524 static struct text_pos
1525 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, int nchars
)
1527 xassert (STRINGP (string
) && nchars
>= 0);
1529 if (STRING_MULTIBYTE (string
))
1531 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1532 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1537 string_char_and_length (p
, &len
);
1538 p
+= len
, rest
-= len
;
1539 xassert (rest
>= 0);
1541 BYTEPOS (pos
) += len
;
1545 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1551 /* Value is the text position, i.e. character and byte position,
1552 for character position CHARPOS in STRING. */
1554 static INLINE
struct text_pos
1555 string_pos (int charpos
, Lisp_Object string
)
1557 struct text_pos pos
;
1558 xassert (STRINGP (string
));
1559 xassert (charpos
>= 0);
1560 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1565 /* Value is a text position, i.e. character and byte position, for
1566 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1567 means recognize multibyte characters. */
1569 static struct text_pos
1570 c_string_pos (int charpos
, const unsigned char *s
, int multibyte_p
)
1572 struct text_pos pos
;
1574 xassert (s
!= NULL
);
1575 xassert (charpos
>= 0);
1579 int rest
= strlen (s
), len
;
1581 SET_TEXT_POS (pos
, 0, 0);
1584 string_char_and_length (s
, &len
);
1585 s
+= len
, rest
-= len
;
1586 xassert (rest
>= 0);
1588 BYTEPOS (pos
) += len
;
1592 SET_TEXT_POS (pos
, charpos
, charpos
);
1598 /* Value is the number of characters in C string S. MULTIBYTE_P
1599 non-zero means recognize multibyte characters. */
1602 number_of_chars (const unsigned char *s
, int multibyte_p
)
1608 int rest
= strlen (s
), len
;
1609 unsigned char *p
= (unsigned char *) s
;
1611 for (nchars
= 0; rest
> 0; ++nchars
)
1613 string_char_and_length (p
, &len
);
1614 rest
-= len
, p
+= len
;
1618 nchars
= strlen (s
);
1624 /* Compute byte position NEWPOS->bytepos corresponding to
1625 NEWPOS->charpos. POS is a known position in string STRING.
1626 NEWPOS->charpos must be >= POS.charpos. */
1629 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1631 xassert (STRINGP (string
));
1632 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1634 if (STRING_MULTIBYTE (string
))
1635 *newpos
= string_pos_nchars_ahead (pos
, string
,
1636 CHARPOS (*newpos
) - CHARPOS (pos
));
1638 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1642 Return an estimation of the pixel height of mode or header lines on
1643 frame F. FACE_ID specifies what line's height to estimate. */
1646 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1648 #ifdef HAVE_WINDOW_SYSTEM
1649 if (FRAME_WINDOW_P (f
))
1651 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1653 /* This function is called so early when Emacs starts that the face
1654 cache and mode line face are not yet initialized. */
1655 if (FRAME_FACE_CACHE (f
))
1657 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1661 height
= FONT_HEIGHT (face
->font
);
1662 if (face
->box_line_width
> 0)
1663 height
+= 2 * face
->box_line_width
;
1674 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1675 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1676 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1677 not force the value into range. */
1680 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1681 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1684 #ifdef HAVE_WINDOW_SYSTEM
1685 if (FRAME_WINDOW_P (f
))
1687 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1688 even for negative values. */
1690 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1692 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1694 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1695 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1698 STORE_NATIVE_RECT (*bounds
,
1699 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1700 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1701 FRAME_COLUMN_WIDTH (f
) - 1,
1702 FRAME_LINE_HEIGHT (f
) - 1);
1708 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1709 pix_x
= FRAME_TOTAL_COLS (f
);
1713 else if (pix_y
> FRAME_LINES (f
))
1714 pix_y
= FRAME_LINES (f
);
1724 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1725 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1726 can't tell the positions because W's display is not up to date,
1730 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1731 int *frame_x
, int *frame_y
)
1733 #ifdef HAVE_WINDOW_SYSTEM
1734 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1738 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1739 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1741 if (display_completed
)
1743 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1744 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1745 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1751 hpos
+= glyph
->pixel_width
;
1755 /* If first glyph is partially visible, its first visible position is still 0. */
1767 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1768 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1779 #ifdef HAVE_WINDOW_SYSTEM
1781 /* Find the glyph under window-relative coordinates X/Y in window W.
1782 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1783 strings. Return in *HPOS and *VPOS the row and column number of
1784 the glyph found. Return in *AREA the glyph area containing X.
1785 Value is a pointer to the glyph found or null if X/Y is not on
1786 text, or we can't tell because W's current matrix is not up to
1791 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1792 int *dx
, int *dy
, int *area
)
1794 struct glyph
*glyph
, *end
;
1795 struct glyph_row
*row
= NULL
;
1798 /* Find row containing Y. Give up if some row is not enabled. */
1799 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1801 row
= MATRIX_ROW (w
->current_matrix
, i
);
1802 if (!row
->enabled_p
)
1804 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1811 /* Give up if Y is not in the window. */
1812 if (i
== w
->current_matrix
->nrows
)
1815 /* Get the glyph area containing X. */
1816 if (w
->pseudo_window_p
)
1823 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1825 *area
= LEFT_MARGIN_AREA
;
1826 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1828 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1831 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1835 *area
= RIGHT_MARGIN_AREA
;
1836 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1840 /* Find glyph containing X. */
1841 glyph
= row
->glyphs
[*area
];
1842 end
= glyph
+ row
->used
[*area
];
1844 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1846 x
-= glyph
->pixel_width
;
1856 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1859 *hpos
= glyph
- row
->glyphs
[*area
];
1865 Convert frame-relative x/y to coordinates relative to window W.
1866 Takes pseudo-windows into account. */
1869 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1871 if (w
->pseudo_window_p
)
1873 /* A pseudo-window is always full-width, and starts at the
1874 left edge of the frame, plus a frame border. */
1875 struct frame
*f
= XFRAME (w
->frame
);
1876 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1877 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1881 *x
-= WINDOW_LEFT_EDGE_X (w
);
1882 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1887 Return in RECTS[] at most N clipping rectangles for glyph string S.
1888 Return the number of stored rectangles. */
1891 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1898 if (s
->row
->full_width_p
)
1900 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1901 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1902 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1904 /* Unless displaying a mode or menu bar line, which are always
1905 fully visible, clip to the visible part of the row. */
1906 if (s
->w
->pseudo_window_p
)
1907 r
.height
= s
->row
->visible_height
;
1909 r
.height
= s
->height
;
1913 /* This is a text line that may be partially visible. */
1914 r
.x
= window_box_left (s
->w
, s
->area
);
1915 r
.width
= window_box_width (s
->w
, s
->area
);
1916 r
.height
= s
->row
->visible_height
;
1920 if (r
.x
< s
->clip_head
->x
)
1922 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1923 r
.width
-= s
->clip_head
->x
- r
.x
;
1926 r
.x
= s
->clip_head
->x
;
1929 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1931 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1932 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1937 /* If S draws overlapping rows, it's sufficient to use the top and
1938 bottom of the window for clipping because this glyph string
1939 intentionally draws over other lines. */
1940 if (s
->for_overlaps
)
1942 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1943 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1945 /* Alas, the above simple strategy does not work for the
1946 environments with anti-aliased text: if the same text is
1947 drawn onto the same place multiple times, it gets thicker.
1948 If the overlap we are processing is for the erased cursor, we
1949 take the intersection with the rectagle of the cursor. */
1950 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1952 XRectangle rc
, r_save
= r
;
1954 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1955 rc
.y
= s
->w
->phys_cursor
.y
;
1956 rc
.width
= s
->w
->phys_cursor_width
;
1957 rc
.height
= s
->w
->phys_cursor_height
;
1959 x_intersect_rectangles (&r_save
, &rc
, &r
);
1964 /* Don't use S->y for clipping because it doesn't take partially
1965 visible lines into account. For example, it can be negative for
1966 partially visible lines at the top of a window. */
1967 if (!s
->row
->full_width_p
1968 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1969 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1971 r
.y
= max (0, s
->row
->y
);
1974 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1976 /* If drawing the cursor, don't let glyph draw outside its
1977 advertised boundaries. Cleartype does this under some circumstances. */
1978 if (s
->hl
== DRAW_CURSOR
)
1980 struct glyph
*glyph
= s
->first_glyph
;
1985 r
.width
-= s
->x
- r
.x
;
1988 r
.width
= min (r
.width
, glyph
->pixel_width
);
1990 /* If r.y is below window bottom, ensure that we still see a cursor. */
1991 height
= min (glyph
->ascent
+ glyph
->descent
,
1992 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1993 max_y
= window_text_bottom_y (s
->w
) - height
;
1994 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1995 if (s
->ybase
- glyph
->ascent
> max_y
)
2002 /* Don't draw cursor glyph taller than our actual glyph. */
2003 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2004 if (height
< r
.height
)
2006 max_y
= r
.y
+ r
.height
;
2007 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2008 r
.height
= min (max_y
- r
.y
, height
);
2015 XRectangle r_save
= r
;
2017 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2021 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2022 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2024 #ifdef CONVERT_FROM_XRECT
2025 CONVERT_FROM_XRECT (r
, *rects
);
2033 /* If we are processing overlapping and allowed to return
2034 multiple clipping rectangles, we exclude the row of the glyph
2035 string from the clipping rectangle. This is to avoid drawing
2036 the same text on the environment with anti-aliasing. */
2037 #ifdef CONVERT_FROM_XRECT
2040 XRectangle
*rs
= rects
;
2042 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2044 if (s
->for_overlaps
& OVERLAPS_PRED
)
2047 if (r
.y
+ r
.height
> row_y
)
2050 rs
[i
].height
= row_y
- r
.y
;
2056 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2059 if (r
.y
< row_y
+ s
->row
->visible_height
)
2061 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2063 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2064 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2073 #ifdef CONVERT_FROM_XRECT
2074 for (i
= 0; i
< n
; i
++)
2075 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2082 Return in *NR the clipping rectangle for glyph string S. */
2085 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2087 get_glyph_string_clip_rects (s
, nr
, 1);
2092 Return the position and height of the phys cursor in window W.
2093 Set w->phys_cursor_width to width of phys cursor.
2097 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2098 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2100 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2101 int x
, y
, wd
, h
, h0
, y0
;
2103 /* Compute the width of the rectangle to draw. If on a stretch
2104 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2105 rectangle as wide as the glyph, but use a canonical character
2107 wd
= glyph
->pixel_width
- 1;
2108 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2112 x
= w
->phys_cursor
.x
;
2119 if (glyph
->type
== STRETCH_GLYPH
2120 && !x_stretch_cursor_p
)
2121 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2122 w
->phys_cursor_width
= wd
;
2124 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2126 /* If y is below window bottom, ensure that we still see a cursor. */
2127 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2129 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2130 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2132 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2135 h
= max (h
- (y0
- y
) + 1, h0
);
2140 y0
= window_text_bottom_y (w
) - h0
;
2148 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2149 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2154 * Remember which glyph the mouse is over.
2158 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2162 struct glyph_row
*r
, *gr
, *end_row
;
2163 enum window_part part
;
2164 enum glyph_row_area area
;
2165 int x
, y
, width
, height
;
2167 /* Try to determine frame pixel position and size of the glyph under
2168 frame pixel coordinates X/Y on frame F. */
2170 if (!f
->glyphs_initialized_p
2171 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2174 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2175 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2179 w
= XWINDOW (window
);
2180 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2181 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2183 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2184 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2186 if (w
->pseudo_window_p
)
2189 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2195 case ON_LEFT_MARGIN
:
2196 area
= LEFT_MARGIN_AREA
;
2199 case ON_RIGHT_MARGIN
:
2200 area
= RIGHT_MARGIN_AREA
;
2203 case ON_HEADER_LINE
:
2205 gr
= (part
== ON_HEADER_LINE
2206 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2207 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2210 goto text_glyph_row_found
;
2217 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2218 if (r
->y
+ r
->height
> y
)
2224 text_glyph_row_found
:
2227 struct glyph
*g
= gr
->glyphs
[area
];
2228 struct glyph
*end
= g
+ gr
->used
[area
];
2230 height
= gr
->height
;
2231 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2232 if (gx
+ g
->pixel_width
> x
)
2237 if (g
->type
== IMAGE_GLYPH
)
2239 /* Don't remember when mouse is over image, as
2240 image may have hot-spots. */
2241 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2244 width
= g
->pixel_width
;
2248 /* Use nominal char spacing at end of line. */
2250 gx
+= (x
/ width
) * width
;
2253 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2254 gx
+= window_box_left_offset (w
, area
);
2258 /* Use nominal line height at end of window. */
2259 gx
= (x
/ width
) * width
;
2261 gy
+= (y
/ height
) * height
;
2265 case ON_LEFT_FRINGE
:
2266 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2267 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2268 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2269 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2272 case ON_RIGHT_FRINGE
:
2273 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2274 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2275 : window_box_right_offset (w
, TEXT_AREA
));
2276 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2280 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2282 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2283 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2284 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2286 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2290 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2291 if (r
->y
+ r
->height
> y
)
2298 height
= gr
->height
;
2301 /* Use nominal line height at end of window. */
2303 gy
+= (y
/ height
) * height
;
2310 /* If there is no glyph under the mouse, then we divide the screen
2311 into a grid of the smallest glyph in the frame, and use that
2314 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2315 round down even for negative values. */
2321 gx
= (gx
/ width
) * width
;
2322 gy
= (gy
/ height
) * height
;
2327 gx
+= WINDOW_LEFT_EDGE_X (w
);
2328 gy
+= WINDOW_TOP_EDGE_Y (w
);
2331 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2333 /* Visible feedback for debugging. */
2336 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2337 f
->output_data
.x
->normal_gc
,
2338 gx
, gy
, width
, height
);
2344 #endif /* HAVE_WINDOW_SYSTEM */
2347 /***********************************************************************
2348 Lisp form evaluation
2349 ***********************************************************************/
2351 /* Error handler for safe_eval and safe_call. */
2354 safe_eval_handler (Lisp_Object arg
)
2356 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2361 /* Evaluate SEXPR and return the result, or nil if something went
2362 wrong. Prevent redisplay during the evaluation. */
2364 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2365 Return the result, or nil if something went wrong. Prevent
2366 redisplay during the evaluation. */
2369 safe_call (int nargs
, Lisp_Object
*args
)
2373 if (inhibit_eval_during_redisplay
)
2377 int count
= SPECPDL_INDEX ();
2378 struct gcpro gcpro1
;
2381 gcpro1
.nvars
= nargs
;
2382 specbind (Qinhibit_redisplay
, Qt
);
2383 /* Use Qt to ensure debugger does not run,
2384 so there is no possibility of wanting to redisplay. */
2385 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2388 val
= unbind_to (count
, val
);
2395 /* Call function FN with one argument ARG.
2396 Return the result, or nil if something went wrong. */
2399 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2401 Lisp_Object args
[2];
2404 return safe_call (2, args
);
2407 static Lisp_Object Qeval
;
2410 safe_eval (Lisp_Object sexpr
)
2412 return safe_call1 (Qeval
, sexpr
);
2415 /* Call function FN with one argument ARG.
2416 Return the result, or nil if something went wrong. */
2419 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2421 Lisp_Object args
[3];
2425 return safe_call (3, args
);
2430 /***********************************************************************
2432 ***********************************************************************/
2436 /* Define CHECK_IT to perform sanity checks on iterators.
2437 This is for debugging. It is too slow to do unconditionally. */
2443 if (it
->method
== GET_FROM_STRING
)
2445 xassert (STRINGP (it
->string
));
2446 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2450 xassert (IT_STRING_CHARPOS (*it
) < 0);
2451 if (it
->method
== GET_FROM_BUFFER
)
2453 /* Check that character and byte positions agree. */
2454 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2459 xassert (it
->current
.dpvec_index
>= 0);
2461 xassert (it
->current
.dpvec_index
< 0);
2464 #define CHECK_IT(IT) check_it ((IT))
2468 #define CHECK_IT(IT) (void) 0
2475 /* Check that the window end of window W is what we expect it
2476 to be---the last row in the current matrix displaying text. */
2479 check_window_end (w
)
2482 if (!MINI_WINDOW_P (w
)
2483 && !NILP (w
->window_end_valid
))
2485 struct glyph_row
*row
;
2486 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2487 XFASTINT (w
->window_end_vpos
)),
2489 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2490 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2494 #define CHECK_WINDOW_END(W) check_window_end ((W))
2496 #else /* not GLYPH_DEBUG */
2498 #define CHECK_WINDOW_END(W) (void) 0
2500 #endif /* not GLYPH_DEBUG */
2504 /***********************************************************************
2505 Iterator initialization
2506 ***********************************************************************/
2508 /* Initialize IT for displaying current_buffer in window W, starting
2509 at character position CHARPOS. CHARPOS < 0 means that no buffer
2510 position is specified which is useful when the iterator is assigned
2511 a position later. BYTEPOS is the byte position corresponding to
2512 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2514 If ROW is not null, calls to produce_glyphs with IT as parameter
2515 will produce glyphs in that row.
2517 BASE_FACE_ID is the id of a base face to use. It must be one of
2518 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2519 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2520 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2522 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2523 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2524 will be initialized to use the corresponding mode line glyph row of
2525 the desired matrix of W. */
2528 init_iterator (struct it
*it
, struct window
*w
,
2529 EMACS_INT charpos
, EMACS_INT bytepos
,
2530 struct glyph_row
*row
, enum face_id base_face_id
)
2532 int highlight_region_p
;
2533 enum face_id remapped_base_face_id
= base_face_id
;
2535 /* Some precondition checks. */
2536 xassert (w
!= NULL
&& it
!= NULL
);
2537 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2540 /* If face attributes have been changed since the last redisplay,
2541 free realized faces now because they depend on face definitions
2542 that might have changed. Don't free faces while there might be
2543 desired matrices pending which reference these faces. */
2544 if (face_change_count
&& !inhibit_free_realized_faces
)
2546 face_change_count
= 0;
2547 free_all_realized_faces (Qnil
);
2550 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2551 if (! NILP (Vface_remapping_alist
))
2552 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2554 /* Use one of the mode line rows of W's desired matrix if
2558 if (base_face_id
== MODE_LINE_FACE_ID
2559 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2560 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2561 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2562 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2566 memset (it
, 0, sizeof *it
);
2567 it
->current
.overlay_string_index
= -1;
2568 it
->current
.dpvec_index
= -1;
2569 it
->base_face_id
= remapped_base_face_id
;
2571 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2573 /* The window in which we iterate over current_buffer: */
2574 XSETWINDOW (it
->window
, w
);
2576 it
->f
= XFRAME (w
->frame
);
2580 /* Extra space between lines (on window systems only). */
2581 if (base_face_id
== DEFAULT_FACE_ID
2582 && FRAME_WINDOW_P (it
->f
))
2584 if (NATNUMP (current_buffer
->extra_line_spacing
))
2585 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2586 else if (FLOATP (current_buffer
->extra_line_spacing
))
2587 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2588 * FRAME_LINE_HEIGHT (it
->f
));
2589 else if (it
->f
->extra_line_spacing
> 0)
2590 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2591 it
->max_extra_line_spacing
= 0;
2594 /* If realized faces have been removed, e.g. because of face
2595 attribute changes of named faces, recompute them. When running
2596 in batch mode, the face cache of the initial frame is null. If
2597 we happen to get called, make a dummy face cache. */
2598 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2599 init_frame_faces (it
->f
);
2600 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2601 recompute_basic_faces (it
->f
);
2603 /* Current value of the `slice', `space-width', and 'height' properties. */
2604 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2605 it
->space_width
= Qnil
;
2606 it
->font_height
= Qnil
;
2607 it
->override_ascent
= -1;
2609 /* Are control characters displayed as `^C'? */
2610 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2612 /* -1 means everything between a CR and the following line end
2613 is invisible. >0 means lines indented more than this value are
2615 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2616 ? XFASTINT (current_buffer
->selective_display
)
2617 : (!NILP (current_buffer
->selective_display
)
2619 it
->selective_display_ellipsis_p
2620 = !NILP (current_buffer
->selective_display_ellipses
);
2622 /* Display table to use. */
2623 it
->dp
= window_display_table (w
);
2625 /* Are multibyte characters enabled in current_buffer? */
2626 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2628 /* Do we need to reorder bidirectional text? Not if this is a
2629 unibyte buffer: by definition, none of the single-byte characters
2630 are strong R2L, so no reordering is needed. And bidi.c doesn't
2631 support unibyte buffers anyway. */
2633 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2635 /* Non-zero if we should highlight the region. */
2637 = (!NILP (Vtransient_mark_mode
)
2638 && !NILP (current_buffer
->mark_active
)
2639 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2641 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2642 start and end of a visible region in window IT->w. Set both to
2643 -1 to indicate no region. */
2644 if (highlight_region_p
2645 /* Maybe highlight only in selected window. */
2646 && (/* Either show region everywhere. */
2647 highlight_nonselected_windows
2648 /* Or show region in the selected window. */
2649 || w
== XWINDOW (selected_window
)
2650 /* Or show the region if we are in the mini-buffer and W is
2651 the window the mini-buffer refers to. */
2652 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2653 && WINDOWP (minibuf_selected_window
)
2654 && w
== XWINDOW (minibuf_selected_window
))))
2656 int charpos
= marker_position (current_buffer
->mark
);
2657 it
->region_beg_charpos
= min (PT
, charpos
);
2658 it
->region_end_charpos
= max (PT
, charpos
);
2661 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2663 /* Get the position at which the redisplay_end_trigger hook should
2664 be run, if it is to be run at all. */
2665 if (MARKERP (w
->redisplay_end_trigger
)
2666 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2667 it
->redisplay_end_trigger_charpos
2668 = marker_position (w
->redisplay_end_trigger
);
2669 else if (INTEGERP (w
->redisplay_end_trigger
))
2670 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2672 /* Correct bogus values of tab_width. */
2673 it
->tab_width
= XINT (current_buffer
->tab_width
);
2674 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2677 /* Are lines in the display truncated? */
2678 if (base_face_id
!= DEFAULT_FACE_ID
2679 || XINT (it
->w
->hscroll
)
2680 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2681 && ((!NILP (Vtruncate_partial_width_windows
)
2682 && !INTEGERP (Vtruncate_partial_width_windows
))
2683 || (INTEGERP (Vtruncate_partial_width_windows
)
2684 && (WINDOW_TOTAL_COLS (it
->w
)
2685 < XINT (Vtruncate_partial_width_windows
))))))
2686 it
->line_wrap
= TRUNCATE
;
2687 else if (NILP (current_buffer
->truncate_lines
))
2688 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2689 ? WINDOW_WRAP
: WORD_WRAP
;
2691 it
->line_wrap
= TRUNCATE
;
2693 /* Get dimensions of truncation and continuation glyphs. These are
2694 displayed as fringe bitmaps under X, so we don't need them for such
2696 if (!FRAME_WINDOW_P (it
->f
))
2698 if (it
->line_wrap
== TRUNCATE
)
2700 /* We will need the truncation glyph. */
2701 xassert (it
->glyph_row
== NULL
);
2702 produce_special_glyphs (it
, IT_TRUNCATION
);
2703 it
->truncation_pixel_width
= it
->pixel_width
;
2707 /* We will need the continuation glyph. */
2708 xassert (it
->glyph_row
== NULL
);
2709 produce_special_glyphs (it
, IT_CONTINUATION
);
2710 it
->continuation_pixel_width
= it
->pixel_width
;
2713 /* Reset these values to zero because the produce_special_glyphs
2714 above has changed them. */
2715 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2716 it
->phys_ascent
= it
->phys_descent
= 0;
2719 /* Set this after getting the dimensions of truncation and
2720 continuation glyphs, so that we don't produce glyphs when calling
2721 produce_special_glyphs, above. */
2722 it
->glyph_row
= row
;
2723 it
->area
= TEXT_AREA
;
2725 /* Forget any previous info about this row being reversed. */
2727 it
->glyph_row
->reversed_p
= 0;
2729 /* Get the dimensions of the display area. The display area
2730 consists of the visible window area plus a horizontally scrolled
2731 part to the left of the window. All x-values are relative to the
2732 start of this total display area. */
2733 if (base_face_id
!= DEFAULT_FACE_ID
)
2735 /* Mode lines, menu bar in terminal frames. */
2736 it
->first_visible_x
= 0;
2737 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2742 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2743 it
->last_visible_x
= (it
->first_visible_x
2744 + window_box_width (w
, TEXT_AREA
));
2746 /* If we truncate lines, leave room for the truncator glyph(s) at
2747 the right margin. Otherwise, leave room for the continuation
2748 glyph(s). Truncation and continuation glyphs are not inserted
2749 for window-based redisplay. */
2750 if (!FRAME_WINDOW_P (it
->f
))
2752 if (it
->line_wrap
== TRUNCATE
)
2753 it
->last_visible_x
-= it
->truncation_pixel_width
;
2755 it
->last_visible_x
-= it
->continuation_pixel_width
;
2758 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2759 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2762 /* Leave room for a border glyph. */
2763 if (!FRAME_WINDOW_P (it
->f
)
2764 && !WINDOW_RIGHTMOST_P (it
->w
))
2765 it
->last_visible_x
-= 1;
2767 it
->last_visible_y
= window_text_bottom_y (w
);
2769 /* For mode lines and alike, arrange for the first glyph having a
2770 left box line if the face specifies a box. */
2771 if (base_face_id
!= DEFAULT_FACE_ID
)
2775 it
->face_id
= remapped_base_face_id
;
2777 /* If we have a boxed mode line, make the first character appear
2778 with a left box line. */
2779 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2780 if (face
->box
!= FACE_NO_BOX
)
2781 it
->start_of_box_run_p
= 1;
2784 /* If we are to reorder bidirectional text, init the bidi
2788 /* Note the paragraph direction that this buffer wants to
2790 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2791 it
->paragraph_embedding
= L2R
;
2792 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2793 it
->paragraph_embedding
= R2L
;
2795 it
->paragraph_embedding
= NEUTRAL_DIR
;
2796 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2799 /* If a buffer position was specified, set the iterator there,
2800 getting overlays and face properties from that position. */
2801 if (charpos
>= BUF_BEG (current_buffer
))
2803 it
->end_charpos
= ZV
;
2805 IT_CHARPOS (*it
) = charpos
;
2807 /* Compute byte position if not specified. */
2808 if (bytepos
< charpos
)
2809 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2811 IT_BYTEPOS (*it
) = bytepos
;
2813 it
->start
= it
->current
;
2815 /* Compute faces etc. */
2816 reseat (it
, it
->current
.pos
, 1);
2823 /* Initialize IT for the display of window W with window start POS. */
2826 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2828 struct glyph_row
*row
;
2829 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2831 row
= w
->desired_matrix
->rows
+ first_vpos
;
2832 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2833 it
->first_vpos
= first_vpos
;
2835 /* Don't reseat to previous visible line start if current start
2836 position is in a string or image. */
2837 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2839 int start_at_line_beg_p
;
2840 int first_y
= it
->current_y
;
2842 /* If window start is not at a line start, skip forward to POS to
2843 get the correct continuation lines width. */
2844 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2845 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2846 if (!start_at_line_beg_p
)
2850 reseat_at_previous_visible_line_start (it
);
2851 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2853 new_x
= it
->current_x
+ it
->pixel_width
;
2855 /* If lines are continued, this line may end in the middle
2856 of a multi-glyph character (e.g. a control character
2857 displayed as \003, or in the middle of an overlay
2858 string). In this case move_it_to above will not have
2859 taken us to the start of the continuation line but to the
2860 end of the continued line. */
2861 if (it
->current_x
> 0
2862 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2863 && (/* And glyph doesn't fit on the line. */
2864 new_x
> it
->last_visible_x
2865 /* Or it fits exactly and we're on a window
2867 || (new_x
== it
->last_visible_x
2868 && FRAME_WINDOW_P (it
->f
))))
2870 if (it
->current
.dpvec_index
>= 0
2871 || it
->current
.overlay_string_index
>= 0)
2873 set_iterator_to_next (it
, 1);
2874 move_it_in_display_line_to (it
, -1, -1, 0);
2877 it
->continuation_lines_width
+= it
->current_x
;
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 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
= SDATA (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 handle_overlay_change_p
= 0;
3137 handled
= HANDLED_RECOMPUTE_PROPS
;
3140 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3141 handle_overlay_change_p
= 0;
3144 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3146 /* Don't check for overlay strings below when set to deliver
3147 characters from a display vector. */
3148 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3149 handle_overlay_change_p
= 0;
3151 /* Handle overlay changes.
3152 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3153 if it finds overlays. */
3154 if (handle_overlay_change_p
)
3155 handled
= handle_overlay_change (it
);
3160 setup_for_ellipsis (it
, 0);
3164 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3166 /* Determine where to stop next. */
3167 if (handled
== HANDLED_NORMALLY
)
3168 compute_stop_pos (it
);
3172 /* Compute IT->stop_charpos from text property and overlay change
3173 information for IT's current position. */
3176 compute_stop_pos (struct it
*it
)
3178 register INTERVAL iv
, next_iv
;
3179 Lisp_Object object
, limit
, position
;
3180 EMACS_INT charpos
, bytepos
, stoppos
;
3182 /* If nowhere else, stop at the end. */
3183 it
->stop_charpos
= it
->end_charpos
;
3185 if (STRINGP (it
->string
))
3187 /* Strings are usually short, so don't limit the search for
3189 object
= it
->string
;
3191 charpos
= IT_STRING_CHARPOS (*it
);
3192 bytepos
= IT_STRING_BYTEPOS (*it
);
3198 /* If next overlay change is in front of the current stop pos
3199 (which is IT->end_charpos), stop there. Note: value of
3200 next_overlay_change is point-max if no overlay change
3202 charpos
= IT_CHARPOS (*it
);
3203 bytepos
= IT_BYTEPOS (*it
);
3204 pos
= next_overlay_change (charpos
);
3205 if (pos
< it
->stop_charpos
)
3206 it
->stop_charpos
= pos
;
3208 /* If showing the region, we have to stop at the region
3209 start or end because the face might change there. */
3210 if (it
->region_beg_charpos
> 0)
3212 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3214 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3215 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3218 /* Set up variables for computing the stop position from text
3219 property changes. */
3220 XSETBUFFER (object
, current_buffer
);
3221 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3224 /* Get the interval containing IT's position. Value is a null
3225 interval if there isn't such an interval. */
3226 position
= make_number (charpos
);
3227 iv
= validate_interval_range (object
, &position
, &position
, 0);
3228 if (!NULL_INTERVAL_P (iv
))
3230 Lisp_Object values_here
[LAST_PROP_IDX
];
3233 /* Get properties here. */
3234 for (p
= it_props
; p
->handler
; ++p
)
3235 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3237 /* Look for an interval following iv that has different
3239 for (next_iv
= next_interval (iv
);
3240 (!NULL_INTERVAL_P (next_iv
)
3242 || XFASTINT (limit
) > next_iv
->position
));
3243 next_iv
= next_interval (next_iv
))
3245 for (p
= it_props
; p
->handler
; ++p
)
3247 Lisp_Object new_value
;
3249 new_value
= textget (next_iv
->plist
, *p
->name
);
3250 if (!EQ (values_here
[p
->idx
], new_value
))
3258 if (!NULL_INTERVAL_P (next_iv
))
3260 if (INTEGERP (limit
)
3261 && next_iv
->position
>= XFASTINT (limit
))
3262 /* No text property change up to limit. */
3263 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3265 /* Text properties change in next_iv. */
3266 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3270 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3273 stoppos
= it
->stop_charpos
;
3274 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3275 stoppos
, it
->string
);
3277 xassert (STRINGP (it
->string
)
3278 || (it
->stop_charpos
>= BEGV
3279 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3283 /* Return the position of the next overlay change after POS in
3284 current_buffer. Value is point-max if no overlay change
3285 follows. This is like `next-overlay-change' but doesn't use
3289 next_overlay_change (EMACS_INT pos
)
3293 Lisp_Object
*overlays
;
3296 /* Get all overlays at the given position. */
3297 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3299 /* If any of these overlays ends before endpos,
3300 use its ending point instead. */
3301 for (i
= 0; i
< noverlays
; ++i
)
3306 oend
= OVERLAY_END (overlays
[i
]);
3307 oendpos
= OVERLAY_POSITION (oend
);
3308 endpos
= min (endpos
, oendpos
);
3316 /***********************************************************************
3318 ***********************************************************************/
3320 /* Handle changes in the `fontified' property of the current buffer by
3321 calling hook functions from Qfontification_functions to fontify
3324 static enum prop_handled
3325 handle_fontified_prop (struct it
*it
)
3327 Lisp_Object prop
, pos
;
3328 enum prop_handled handled
= HANDLED_NORMALLY
;
3330 if (!NILP (Vmemory_full
))
3333 /* Get the value of the `fontified' property at IT's current buffer
3334 position. (The `fontified' property doesn't have a special
3335 meaning in strings.) If the value is nil, call functions from
3336 Qfontification_functions. */
3337 if (!STRINGP (it
->string
)
3339 && !NILP (Vfontification_functions
)
3340 && !NILP (Vrun_hooks
)
3341 && (pos
= make_number (IT_CHARPOS (*it
)),
3342 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3343 /* Ignore the special cased nil value always present at EOB since
3344 no amount of fontifying will be able to change it. */
3345 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3347 int count
= SPECPDL_INDEX ();
3350 val
= Vfontification_functions
;
3351 specbind (Qfontification_functions
, Qnil
);
3353 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3354 safe_call1 (val
, pos
);
3357 Lisp_Object globals
, fn
;
3358 struct gcpro gcpro1
, gcpro2
;
3361 GCPRO2 (val
, globals
);
3363 for (; CONSP (val
); val
= XCDR (val
))
3369 /* A value of t indicates this hook has a local
3370 binding; it means to run the global binding too.
3371 In a global value, t should not occur. If it
3372 does, we must ignore it to avoid an endless
3374 for (globals
= Fdefault_value (Qfontification_functions
);
3376 globals
= XCDR (globals
))
3378 fn
= XCAR (globals
);
3380 safe_call1 (fn
, pos
);
3384 safe_call1 (fn
, pos
);
3390 unbind_to (count
, Qnil
);
3392 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3393 something. This avoids an endless loop if they failed to
3394 fontify the text for which reason ever. */
3395 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3396 handled
= HANDLED_RECOMPUTE_PROPS
;
3404 /***********************************************************************
3406 ***********************************************************************/
3408 /* Set up iterator IT from face properties at its current position.
3409 Called from handle_stop. */
3411 static enum prop_handled
3412 handle_face_prop (struct it
*it
)
3415 EMACS_INT next_stop
;
3417 if (!STRINGP (it
->string
))
3420 = face_at_buffer_position (it
->w
,
3422 it
->region_beg_charpos
,
3423 it
->region_end_charpos
,
3426 + TEXT_PROP_DISTANCE_LIMIT
),
3427 0, it
->base_face_id
);
3429 /* Is this a start of a run of characters with box face?
3430 Caveat: this can be called for a freshly initialized
3431 iterator; face_id is -1 in this case. We know that the new
3432 face will not change until limit, i.e. if the new face has a
3433 box, all characters up to limit will have one. But, as
3434 usual, we don't know whether limit is really the end. */
3435 if (new_face_id
!= it
->face_id
)
3437 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3439 /* If new face has a box but old face has not, this is
3440 the start of a run of characters with box, i.e. it has
3441 a shadow on the left side. The value of face_id of the
3442 iterator will be -1 if this is the initial call that gets
3443 the face. In this case, we have to look in front of IT's
3444 position and see whether there is a face != new_face_id. */
3445 it
->start_of_box_run_p
3446 = (new_face
->box
!= FACE_NO_BOX
3447 && (it
->face_id
>= 0
3448 || IT_CHARPOS (*it
) == BEG
3449 || new_face_id
!= face_before_it_pos (it
)));
3450 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3455 int base_face_id
, bufpos
;
3457 Lisp_Object from_overlay
3458 = (it
->current
.overlay_string_index
>= 0
3459 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3462 /* See if we got to this string directly or indirectly from
3463 an overlay property. That includes the before-string or
3464 after-string of an overlay, strings in display properties
3465 provided by an overlay, their text properties, etc.
3467 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3468 if (! NILP (from_overlay
))
3469 for (i
= it
->sp
- 1; i
>= 0; i
--)
3471 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3473 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3474 else if (! NILP (it
->stack
[i
].from_overlay
))
3475 from_overlay
= it
->stack
[i
].from_overlay
;
3477 if (!NILP (from_overlay
))
3481 if (! NILP (from_overlay
))
3483 bufpos
= IT_CHARPOS (*it
);
3484 /* For a string from an overlay, the base face depends
3485 only on text properties and ignores overlays. */
3487 = face_for_overlay_string (it
->w
,
3489 it
->region_beg_charpos
,
3490 it
->region_end_charpos
,
3493 + TEXT_PROP_DISTANCE_LIMIT
),
3501 /* For strings from a `display' property, use the face at
3502 IT's current buffer position as the base face to merge
3503 with, so that overlay strings appear in the same face as
3504 surrounding text, unless they specify their own
3506 base_face_id
= underlying_face_id (it
);
3509 new_face_id
= face_at_string_position (it
->w
,
3511 IT_STRING_CHARPOS (*it
),
3513 it
->region_beg_charpos
,
3514 it
->region_end_charpos
,
3518 /* Is this a start of a run of characters with box? Caveat:
3519 this can be called for a freshly allocated iterator; face_id
3520 is -1 is this case. We know that the new face will not
3521 change until the next check pos, i.e. if the new face has a
3522 box, all characters up to that position will have a
3523 box. But, as usual, we don't know whether that position
3524 is really the end. */
3525 if (new_face_id
!= it
->face_id
)
3527 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3528 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3530 /* If new face has a box but old face hasn't, this is the
3531 start of a run of characters with box, i.e. it has a
3532 shadow on the left side. */
3533 it
->start_of_box_run_p
3534 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3535 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3539 it
->face_id
= new_face_id
;
3540 return HANDLED_NORMALLY
;
3544 /* Return the ID of the face ``underlying'' IT's current position,
3545 which is in a string. If the iterator is associated with a
3546 buffer, return the face at IT's current buffer position.
3547 Otherwise, use the iterator's base_face_id. */
3550 underlying_face_id (struct it
*it
)
3552 int face_id
= it
->base_face_id
, i
;
3554 xassert (STRINGP (it
->string
));
3556 for (i
= it
->sp
- 1; i
>= 0; --i
)
3557 if (NILP (it
->stack
[i
].string
))
3558 face_id
= it
->stack
[i
].face_id
;
3564 /* Compute the face one character before or after the current position
3565 of IT. BEFORE_P non-zero means get the face in front of IT's
3566 position. Value is the id of the face. */
3569 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3572 EMACS_INT next_check_charpos
;
3573 struct text_pos pos
;
3575 xassert (it
->s
== NULL
);
3577 if (STRINGP (it
->string
))
3579 int bufpos
, base_face_id
;
3581 /* No face change past the end of the string (for the case
3582 we are padding with spaces). No face change before the
3584 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3585 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3588 /* Set pos to the position before or after IT's current position. */
3590 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3592 /* For composition, we must check the character after the
3594 pos
= (it
->what
== IT_COMPOSITION
3595 ? string_pos (IT_STRING_CHARPOS (*it
)
3596 + it
->cmp_it
.nchars
, it
->string
)
3597 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3599 if (it
->current
.overlay_string_index
>= 0)
3600 bufpos
= IT_CHARPOS (*it
);
3604 base_face_id
= underlying_face_id (it
);
3606 /* Get the face for ASCII, or unibyte. */
3607 face_id
= face_at_string_position (it
->w
,
3611 it
->region_beg_charpos
,
3612 it
->region_end_charpos
,
3613 &next_check_charpos
,
3616 /* Correct the face for charsets different from ASCII. Do it
3617 for the multibyte case only. The face returned above is
3618 suitable for unibyte text if IT->string is unibyte. */
3619 if (STRING_MULTIBYTE (it
->string
))
3621 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3622 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3624 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3626 c
= string_char_and_length (p
, &len
);
3627 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3632 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3633 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3636 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3637 pos
= it
->current
.pos
;
3640 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3643 if (it
->what
== IT_COMPOSITION
)
3644 /* For composition, we must check the position after the
3646 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3648 INC_TEXT_POS (pos
, it
->multibyte_p
);
3651 /* Determine face for CHARSET_ASCII, or unibyte. */
3652 face_id
= face_at_buffer_position (it
->w
,
3654 it
->region_beg_charpos
,
3655 it
->region_end_charpos
,
3656 &next_check_charpos
,
3659 /* Correct the face for charsets different from ASCII. Do it
3660 for the multibyte case only. The face returned above is
3661 suitable for unibyte text if current_buffer is unibyte. */
3662 if (it
->multibyte_p
)
3664 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3665 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3666 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3675 /***********************************************************************
3677 ***********************************************************************/
3679 /* Set up iterator IT from invisible properties at its current
3680 position. Called from handle_stop. */
3682 static enum prop_handled
3683 handle_invisible_prop (struct it
*it
)
3685 enum prop_handled handled
= HANDLED_NORMALLY
;
3687 if (STRINGP (it
->string
))
3689 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3691 /* Get the value of the invisible text property at the
3692 current position. Value will be nil if there is no such
3694 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3695 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3698 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3700 handled
= HANDLED_RECOMPUTE_PROPS
;
3702 /* Get the position at which the next change of the
3703 invisible text property can be found in IT->string.
3704 Value will be nil if the property value is the same for
3705 all the rest of IT->string. */
3706 XSETINT (limit
, SCHARS (it
->string
));
3707 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3710 /* Text at current position is invisible. The next
3711 change in the property is at position end_charpos.
3712 Move IT's current position to that position. */
3713 if (INTEGERP (end_charpos
)
3714 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3716 struct text_pos old
;
3717 old
= it
->current
.string_pos
;
3718 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3719 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3723 /* The rest of the string is invisible. If this is an
3724 overlay string, proceed with the next overlay string
3725 or whatever comes and return a character from there. */
3726 if (it
->current
.overlay_string_index
>= 0)
3728 next_overlay_string (it
);
3729 /* Don't check for overlay strings when we just
3730 finished processing them. */
3731 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3735 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3736 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3744 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3745 Lisp_Object pos
, prop
, overlay
;
3747 /* First of all, is there invisible text at this position? */
3748 tem
= start_charpos
= IT_CHARPOS (*it
);
3749 pos
= make_number (tem
);
3750 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3752 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3754 /* If we are on invisible text, skip over it. */
3755 if (invis_p
&& start_charpos
< it
->end_charpos
)
3757 /* Record whether we have to display an ellipsis for the
3759 int display_ellipsis_p
= invis_p
== 2;
3761 handled
= HANDLED_RECOMPUTE_PROPS
;
3763 /* Loop skipping over invisible text. The loop is left at
3764 ZV or with IT on the first char being visible again. */
3767 /* Try to skip some invisible text. Return value is the
3768 position reached which can be equal to where we start
3769 if there is nothing invisible there. This skips both
3770 over invisible text properties and overlays with
3771 invisible property. */
3772 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3774 /* If we skipped nothing at all we weren't at invisible
3775 text in the first place. If everything to the end of
3776 the buffer was skipped, end the loop. */
3777 if (newpos
== tem
|| newpos
>= ZV
)
3781 /* We skipped some characters but not necessarily
3782 all there are. Check if we ended up on visible
3783 text. Fget_char_property returns the property of
3784 the char before the given position, i.e. if we
3785 get invis_p = 0, this means that the char at
3786 newpos is visible. */
3787 pos
= make_number (newpos
);
3788 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3789 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3792 /* If we ended up on invisible text, proceed to
3793 skip starting with next_stop. */
3797 /* If there are adjacent invisible texts, don't lose the
3798 second one's ellipsis. */
3800 display_ellipsis_p
= 1;
3804 /* The position newpos is now either ZV or on visible text. */
3805 if (it
->bidi_p
&& newpos
< ZV
)
3807 /* With bidi iteration, the region of invisible text
3808 could start and/or end in the middle of a non-base
3809 embedding level. Therefore, we need to skip
3810 invisible text using the bidi iterator, starting at
3811 IT's current position, until we find ourselves
3812 outside the invisible text. Skipping invisible text
3813 _after_ bidi iteration avoids affecting the visual
3814 order of the displayed text when invisible properties
3815 are added or removed. */
3816 if (it
->bidi_it
.first_elt
)
3818 /* If we were `reseat'ed to a new paragraph,
3819 determine the paragraph base direction. We need
3820 to do it now because next_element_from_buffer may
3821 not have a chance to do it, if we are going to
3822 skip any text at the beginning, which resets the
3824 bidi_paragraph_init (it
->paragraph_embedding
,
3829 bidi_move_to_visually_next (&it
->bidi_it
);
3831 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3832 && it
->bidi_it
.charpos
< newpos
);
3833 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3834 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3835 /* If we overstepped NEWPOS, record its position in the
3836 iterator, so that we skip invisible text if later the
3837 bidi iteration lands us in the invisible region
3839 if (IT_CHARPOS (*it
) >= newpos
)
3840 it
->prev_stop
= newpos
;
3844 IT_CHARPOS (*it
) = newpos
;
3845 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3848 /* If there are before-strings at the start of invisible
3849 text, and the text is invisible because of a text
3850 property, arrange to show before-strings because 20.x did
3851 it that way. (If the text is invisible because of an
3852 overlay property instead of a text property, this is
3853 already handled in the overlay code.) */
3855 && get_overlay_strings (it
, it
->stop_charpos
))
3857 handled
= HANDLED_RECOMPUTE_PROPS
;
3858 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3860 else if (display_ellipsis_p
)
3862 /* Make sure that the glyphs of the ellipsis will get
3863 correct `charpos' values. If we would not update
3864 it->position here, the glyphs would belong to the
3865 last visible character _before_ the invisible
3866 text, which confuses `set_cursor_from_row'.
3868 We use the last invisible position instead of the
3869 first because this way the cursor is always drawn on
3870 the first "." of the ellipsis, whenever PT is inside
3871 the invisible text. Otherwise the cursor would be
3872 placed _after_ the ellipsis when the point is after the
3873 first invisible character. */
3874 if (!STRINGP (it
->object
))
3876 it
->position
.charpos
= newpos
- 1;
3877 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3880 /* Let the ellipsis display before
3881 considering any properties of the following char.
3882 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3883 handled
= HANDLED_RETURN
;
3892 /* Make iterator IT return `...' next.
3893 Replaces LEN characters from buffer. */
3896 setup_for_ellipsis (struct it
*it
, int len
)
3898 /* Use the display table definition for `...'. Invalid glyphs
3899 will be handled by the method returning elements from dpvec. */
3900 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3902 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3903 it
->dpvec
= v
->contents
;
3904 it
->dpend
= v
->contents
+ v
->size
;
3908 /* Default `...'. */
3909 it
->dpvec
= default_invis_vector
;
3910 it
->dpend
= default_invis_vector
+ 3;
3913 it
->dpvec_char_len
= len
;
3914 it
->current
.dpvec_index
= 0;
3915 it
->dpvec_face_id
= -1;
3917 /* Remember the current face id in case glyphs specify faces.
3918 IT's face is restored in set_iterator_to_next.
3919 saved_face_id was set to preceding char's face in handle_stop. */
3920 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3921 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3923 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3929 /***********************************************************************
3931 ***********************************************************************/
3933 /* Set up iterator IT from `display' property at its current position.
3934 Called from handle_stop.
3935 We return HANDLED_RETURN if some part of the display property
3936 overrides the display of the buffer text itself.
3937 Otherwise we return HANDLED_NORMALLY. */
3939 static enum prop_handled
3940 handle_display_prop (struct it
*it
)
3942 Lisp_Object prop
, object
, overlay
;
3943 struct text_pos
*position
;
3944 /* Nonzero if some property replaces the display of the text itself. */
3945 int display_replaced_p
= 0;
3947 if (STRINGP (it
->string
))
3949 object
= it
->string
;
3950 position
= &it
->current
.string_pos
;
3954 XSETWINDOW (object
, it
->w
);
3955 position
= &it
->current
.pos
;
3958 /* Reset those iterator values set from display property values. */
3959 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3960 it
->space_width
= Qnil
;
3961 it
->font_height
= Qnil
;
3964 /* We don't support recursive `display' properties, i.e. string
3965 values that have a string `display' property, that have a string
3966 `display' property etc. */
3967 if (!it
->string_from_display_prop_p
)
3968 it
->area
= TEXT_AREA
;
3970 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3971 Qdisplay
, object
, &overlay
);
3973 return HANDLED_NORMALLY
;
3974 /* Now OVERLAY is the overlay that gave us this property, or nil
3975 if it was a text property. */
3977 if (!STRINGP (it
->string
))
3978 object
= it
->w
->buffer
;
3981 /* Simple properties. */
3982 && !EQ (XCAR (prop
), Qimage
)
3983 && !EQ (XCAR (prop
), Qspace
)
3984 && !EQ (XCAR (prop
), Qwhen
)
3985 && !EQ (XCAR (prop
), Qslice
)
3986 && !EQ (XCAR (prop
), Qspace_width
)
3987 && !EQ (XCAR (prop
), Qheight
)
3988 && !EQ (XCAR (prop
), Qraise
)
3989 /* Marginal area specifications. */
3990 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3991 && !EQ (XCAR (prop
), Qleft_fringe
)
3992 && !EQ (XCAR (prop
), Qright_fringe
)
3993 && !NILP (XCAR (prop
)))
3995 for (; CONSP (prop
); prop
= XCDR (prop
))
3997 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3998 position
, display_replaced_p
))
4000 display_replaced_p
= 1;
4001 /* If some text in a string is replaced, `position' no
4002 longer points to the position of `object'. */
4003 if (STRINGP (object
))
4008 else if (VECTORP (prop
))
4011 for (i
= 0; i
< ASIZE (prop
); ++i
)
4012 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4013 position
, display_replaced_p
))
4015 display_replaced_p
= 1;
4016 /* If some text in a string is replaced, `position' no
4017 longer points to the position of `object'. */
4018 if (STRINGP (object
))
4024 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4026 display_replaced_p
= 1;
4029 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4033 /* Value is the position of the end of the `display' property starting
4034 at START_POS in OBJECT. */
4036 static struct text_pos
4037 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4040 struct text_pos end_pos
;
4042 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4043 Qdisplay
, object
, Qnil
);
4044 CHARPOS (end_pos
) = XFASTINT (end
);
4045 if (STRINGP (object
))
4046 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4048 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4054 /* Set up IT from a single `display' specification PROP. OBJECT
4055 is the object in which the `display' property was found. *POSITION
4056 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4057 means that we previously saw a display specification which already
4058 replaced text display with something else, for example an image;
4059 we ignore such properties after the first one has been processed.
4061 OVERLAY is the overlay this `display' property came from,
4062 or nil if it was a text property.
4064 If PROP is a `space' or `image' specification, and in some other
4065 cases too, set *POSITION to the position where the `display'
4068 Value is non-zero if something was found which replaces the display
4069 of buffer or string text. */
4072 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4073 Lisp_Object overlay
, struct text_pos
*position
,
4074 int display_replaced_before_p
)
4077 Lisp_Object location
, value
;
4078 struct text_pos start_pos
, save_pos
;
4081 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4082 If the result is non-nil, use VALUE instead of SPEC. */
4084 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4093 if (!NILP (form
) && !EQ (form
, Qt
))
4095 int count
= SPECPDL_INDEX ();
4096 struct gcpro gcpro1
;
4098 /* Bind `object' to the object having the `display' property, a
4099 buffer or string. Bind `position' to the position in the
4100 object where the property was found, and `buffer-position'
4101 to the current position in the buffer. */
4102 specbind (Qobject
, object
);
4103 specbind (Qposition
, make_number (CHARPOS (*position
)));
4104 specbind (Qbuffer_position
,
4105 make_number (STRINGP (object
)
4106 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4108 form
= safe_eval (form
);
4110 unbind_to (count
, Qnil
);
4116 /* Handle `(height HEIGHT)' specifications. */
4118 && EQ (XCAR (spec
), Qheight
)
4119 && CONSP (XCDR (spec
)))
4121 if (!FRAME_WINDOW_P (it
->f
))
4124 it
->font_height
= XCAR (XCDR (spec
));
4125 if (!NILP (it
->font_height
))
4127 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4128 int new_height
= -1;
4130 if (CONSP (it
->font_height
)
4131 && (EQ (XCAR (it
->font_height
), Qplus
)
4132 || EQ (XCAR (it
->font_height
), Qminus
))
4133 && CONSP (XCDR (it
->font_height
))
4134 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4136 /* `(+ N)' or `(- N)' where N is an integer. */
4137 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4138 if (EQ (XCAR (it
->font_height
), Qplus
))
4140 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4142 else if (FUNCTIONP (it
->font_height
))
4144 /* Call function with current height as argument.
4145 Value is the new height. */
4147 height
= safe_call1 (it
->font_height
,
4148 face
->lface
[LFACE_HEIGHT_INDEX
]);
4149 if (NUMBERP (height
))
4150 new_height
= XFLOATINT (height
);
4152 else if (NUMBERP (it
->font_height
))
4154 /* Value is a multiple of the canonical char height. */
4157 face
= FACE_FROM_ID (it
->f
,
4158 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4159 new_height
= (XFLOATINT (it
->font_height
)
4160 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4164 /* Evaluate IT->font_height with `height' bound to the
4165 current specified height to get the new height. */
4166 int count
= SPECPDL_INDEX ();
4168 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4169 value
= safe_eval (it
->font_height
);
4170 unbind_to (count
, Qnil
);
4172 if (NUMBERP (value
))
4173 new_height
= XFLOATINT (value
);
4177 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4183 /* Handle `(space-width WIDTH)'. */
4185 && EQ (XCAR (spec
), Qspace_width
)
4186 && CONSP (XCDR (spec
)))
4188 if (!FRAME_WINDOW_P (it
->f
))
4191 value
= XCAR (XCDR (spec
));
4192 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4193 it
->space_width
= value
;
4198 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4200 && EQ (XCAR (spec
), Qslice
))
4204 if (!FRAME_WINDOW_P (it
->f
))
4207 if (tem
= XCDR (spec
), CONSP (tem
))
4209 it
->slice
.x
= XCAR (tem
);
4210 if (tem
= XCDR (tem
), CONSP (tem
))
4212 it
->slice
.y
= XCAR (tem
);
4213 if (tem
= XCDR (tem
), CONSP (tem
))
4215 it
->slice
.width
= XCAR (tem
);
4216 if (tem
= XCDR (tem
), CONSP (tem
))
4217 it
->slice
.height
= XCAR (tem
);
4225 /* Handle `(raise FACTOR)'. */
4227 && EQ (XCAR (spec
), Qraise
)
4228 && CONSP (XCDR (spec
)))
4230 if (!FRAME_WINDOW_P (it
->f
))
4233 #ifdef HAVE_WINDOW_SYSTEM
4234 value
= XCAR (XCDR (spec
));
4235 if (NUMBERP (value
))
4237 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4238 it
->voffset
= - (XFLOATINT (value
)
4239 * (FONT_HEIGHT (face
->font
)));
4241 #endif /* HAVE_WINDOW_SYSTEM */
4246 /* Don't handle the other kinds of display specifications
4247 inside a string that we got from a `display' property. */
4248 if (it
->string_from_display_prop_p
)
4251 /* Characters having this form of property are not displayed, so
4252 we have to find the end of the property. */
4253 start_pos
= *position
;
4254 *position
= display_prop_end (it
, object
, start_pos
);
4257 /* Stop the scan at that end position--we assume that all
4258 text properties change there. */
4259 it
->stop_charpos
= position
->charpos
;
4261 /* Handle `(left-fringe BITMAP [FACE])'
4262 and `(right-fringe BITMAP [FACE])'. */
4264 && (EQ (XCAR (spec
), Qleft_fringe
)
4265 || EQ (XCAR (spec
), Qright_fringe
))
4266 && CONSP (XCDR (spec
)))
4268 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4271 if (!FRAME_WINDOW_P (it
->f
))
4272 /* If we return here, POSITION has been advanced
4273 across the text with this property. */
4276 #ifdef HAVE_WINDOW_SYSTEM
4277 value
= XCAR (XCDR (spec
));
4278 if (!SYMBOLP (value
)
4279 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4280 /* If we return here, POSITION has been advanced
4281 across the text with this property. */
4284 if (CONSP (XCDR (XCDR (spec
))))
4286 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4287 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4293 /* Save current settings of IT so that we can restore them
4294 when we are finished with the glyph property value. */
4296 save_pos
= it
->position
;
4297 it
->position
= *position
;
4299 it
->position
= save_pos
;
4301 it
->area
= TEXT_AREA
;
4302 it
->what
= IT_IMAGE
;
4303 it
->image_id
= -1; /* no image */
4304 it
->position
= start_pos
;
4305 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4306 it
->method
= GET_FROM_IMAGE
;
4307 it
->from_overlay
= Qnil
;
4308 it
->face_id
= face_id
;
4310 /* Say that we haven't consumed the characters with
4311 `display' property yet. The call to pop_it in
4312 set_iterator_to_next will clean this up. */
4313 *position
= start_pos
;
4315 if (EQ (XCAR (spec
), Qleft_fringe
))
4317 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4318 it
->left_user_fringe_face_id
= face_id
;
4322 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4323 it
->right_user_fringe_face_id
= face_id
;
4325 #endif /* HAVE_WINDOW_SYSTEM */
4329 /* Prepare to handle `((margin left-margin) ...)',
4330 `((margin right-margin) ...)' and `((margin nil) ...)'
4331 prefixes for display specifications. */
4332 location
= Qunbound
;
4333 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4337 value
= XCDR (spec
);
4339 value
= XCAR (value
);
4342 if (EQ (XCAR (tem
), Qmargin
)
4343 && (tem
= XCDR (tem
),
4344 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4346 || EQ (tem
, Qleft_margin
)
4347 || EQ (tem
, Qright_margin
))))
4351 if (EQ (location
, Qunbound
))
4357 /* After this point, VALUE is the property after any
4358 margin prefix has been stripped. It must be a string,
4359 an image specification, or `(space ...)'.
4361 LOCATION specifies where to display: `left-margin',
4362 `right-margin' or nil. */
4364 valid_p
= (STRINGP (value
)
4365 #ifdef HAVE_WINDOW_SYSTEM
4366 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4367 #endif /* not HAVE_WINDOW_SYSTEM */
4368 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4370 if (valid_p
&& !display_replaced_before_p
)
4372 /* Save current settings of IT so that we can restore them
4373 when we are finished with the glyph property value. */
4374 save_pos
= it
->position
;
4375 it
->position
= *position
;
4377 it
->position
= save_pos
;
4378 it
->from_overlay
= overlay
;
4380 if (NILP (location
))
4381 it
->area
= TEXT_AREA
;
4382 else if (EQ (location
, Qleft_margin
))
4383 it
->area
= LEFT_MARGIN_AREA
;
4385 it
->area
= RIGHT_MARGIN_AREA
;
4387 if (STRINGP (value
))
4390 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4391 it
->current
.overlay_string_index
= -1;
4392 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4393 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4394 it
->method
= GET_FROM_STRING
;
4395 it
->stop_charpos
= 0;
4396 it
->string_from_display_prop_p
= 1;
4397 /* Say that we haven't consumed the characters with
4398 `display' property yet. The call to pop_it in
4399 set_iterator_to_next will clean this up. */
4400 if (BUFFERP (object
))
4401 *position
= start_pos
;
4403 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4405 it
->method
= GET_FROM_STRETCH
;
4407 *position
= it
->position
= start_pos
;
4409 #ifdef HAVE_WINDOW_SYSTEM
4412 it
->what
= IT_IMAGE
;
4413 it
->image_id
= lookup_image (it
->f
, value
);
4414 it
->position
= start_pos
;
4415 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4416 it
->method
= GET_FROM_IMAGE
;
4418 /* Say that we haven't consumed the characters with
4419 `display' property yet. The call to pop_it in
4420 set_iterator_to_next will clean this up. */
4421 *position
= start_pos
;
4423 #endif /* HAVE_WINDOW_SYSTEM */
4428 /* Invalid property or property not supported. Restore
4429 POSITION to what it was before. */
4430 *position
= start_pos
;
4435 /* Check if SPEC is a display sub-property value whose text should be
4436 treated as intangible. */
4439 single_display_spec_intangible_p (Lisp_Object prop
)
4441 /* Skip over `when FORM'. */
4442 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4456 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4457 we don't need to treat text as intangible. */
4458 if (EQ (XCAR (prop
), Qmargin
))
4466 || EQ (XCAR (prop
), Qleft_margin
)
4467 || EQ (XCAR (prop
), Qright_margin
))
4471 return (CONSP (prop
)
4472 && (EQ (XCAR (prop
), Qimage
)
4473 || EQ (XCAR (prop
), Qspace
)));
4477 /* Check if PROP is a display property value whose text should be
4478 treated as intangible. */
4481 display_prop_intangible_p (Lisp_Object prop
)
4484 && CONSP (XCAR (prop
))
4485 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4487 /* A list of sub-properties. */
4488 while (CONSP (prop
))
4490 if (single_display_spec_intangible_p (XCAR (prop
)))
4495 else if (VECTORP (prop
))
4497 /* A vector of sub-properties. */
4499 for (i
= 0; i
< ASIZE (prop
); ++i
)
4500 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4504 return single_display_spec_intangible_p (prop
);
4510 /* Return 1 if PROP is a display sub-property value containing STRING. */
4513 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4515 if (EQ (string
, prop
))
4518 /* Skip over `when FORM'. */
4519 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4528 /* Skip over `margin LOCATION'. */
4529 if (EQ (XCAR (prop
), Qmargin
))
4540 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4544 /* Return 1 if STRING appears in the `display' property PROP. */
4547 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4550 && CONSP (XCAR (prop
))
4551 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4553 /* A list of sub-properties. */
4554 while (CONSP (prop
))
4556 if (single_display_spec_string_p (XCAR (prop
), string
))
4561 else if (VECTORP (prop
))
4563 /* A vector of sub-properties. */
4565 for (i
= 0; i
< ASIZE (prop
); ++i
)
4566 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4570 return single_display_spec_string_p (prop
, string
);
4575 /* Look for STRING in overlays and text properties in W's buffer,
4576 between character positions FROM and TO (excluding TO).
4577 BACK_P non-zero means look back (in this case, TO is supposed to be
4579 Value is the first character position where STRING was found, or
4580 zero if it wasn't found before hitting TO.
4582 W's buffer must be current.
4584 This function may only use code that doesn't eval because it is
4585 called asynchronously from note_mouse_highlight. */
4588 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4589 EMACS_INT from
, EMACS_INT to
, int back_p
)
4591 Lisp_Object limit
, prop
, pos
;
4594 pos
= make_number (from
);
4596 if (!back_p
) /* looking forward */
4598 limit
= make_number (min (to
, ZV
));
4599 while (!found
&& !EQ (pos
, limit
))
4601 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4602 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4605 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4609 else /* looking back */
4611 limit
= make_number (max (to
, BEGV
));
4612 while (!found
&& !EQ (pos
, limit
))
4614 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4615 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4618 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4623 return found
? XINT (pos
) : 0;
4626 /* Determine which buffer position in W's buffer STRING comes from.
4627 AROUND_CHARPOS is an approximate position where it could come from.
4628 Value is the buffer position or 0 if it couldn't be determined.
4630 W's buffer must be current.
4632 This function is necessary because we don't record buffer positions
4633 in glyphs generated from strings (to keep struct glyph small).
4634 This function may only use code that doesn't eval because it is
4635 called asynchronously from note_mouse_highlight. */
4638 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4640 Lisp_Object limit
, prop
, pos
;
4641 const int MAX_DISTANCE
= 1000;
4642 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4643 around_charpos
+ MAX_DISTANCE
,
4647 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4648 around_charpos
- MAX_DISTANCE
, 1);
4654 /***********************************************************************
4655 `composition' property
4656 ***********************************************************************/
4658 /* Set up iterator IT from `composition' property at its current
4659 position. Called from handle_stop. */
4661 static enum prop_handled
4662 handle_composition_prop (struct it
*it
)
4664 Lisp_Object prop
, string
;
4665 EMACS_INT pos
, pos_byte
, start
, end
;
4667 if (STRINGP (it
->string
))
4671 pos
= IT_STRING_CHARPOS (*it
);
4672 pos_byte
= IT_STRING_BYTEPOS (*it
);
4673 string
= it
->string
;
4674 s
= SDATA (string
) + pos_byte
;
4675 it
->c
= STRING_CHAR (s
);
4679 pos
= IT_CHARPOS (*it
);
4680 pos_byte
= IT_BYTEPOS (*it
);
4682 it
->c
= FETCH_CHAR (pos_byte
);
4685 /* If there's a valid composition and point is not inside of the
4686 composition (in the case that the composition is from the current
4687 buffer), draw a glyph composed from the composition components. */
4688 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4689 && COMPOSITION_VALID_P (start
, end
, prop
)
4690 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4694 if (STRINGP (it
->string
))
4695 pos_byte
= string_char_to_byte (it
->string
, start
);
4697 pos_byte
= CHAR_TO_BYTE (start
);
4699 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4702 if (it
->cmp_it
.id
>= 0)
4705 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4706 it
->cmp_it
.nglyphs
= -1;
4710 return HANDLED_NORMALLY
;
4715 /***********************************************************************
4717 ***********************************************************************/
4719 /* The following structure is used to record overlay strings for
4720 later sorting in load_overlay_strings. */
4722 struct overlay_entry
4724 Lisp_Object overlay
;
4731 /* Set up iterator IT from overlay strings at its current position.
4732 Called from handle_stop. */
4734 static enum prop_handled
4735 handle_overlay_change (struct it
*it
)
4737 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4738 return HANDLED_RECOMPUTE_PROPS
;
4740 return HANDLED_NORMALLY
;
4744 /* Set up the next overlay string for delivery by IT, if there is an
4745 overlay string to deliver. Called by set_iterator_to_next when the
4746 end of the current overlay string is reached. If there are more
4747 overlay strings to display, IT->string and
4748 IT->current.overlay_string_index are set appropriately here.
4749 Otherwise IT->string is set to nil. */
4752 next_overlay_string (struct it
*it
)
4754 ++it
->current
.overlay_string_index
;
4755 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4757 /* No more overlay strings. Restore IT's settings to what
4758 they were before overlay strings were processed, and
4759 continue to deliver from current_buffer. */
4761 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4764 || (NILP (it
->string
)
4765 && it
->method
== GET_FROM_BUFFER
4766 && it
->stop_charpos
>= BEGV
4767 && it
->stop_charpos
<= it
->end_charpos
));
4768 it
->current
.overlay_string_index
= -1;
4769 it
->n_overlay_strings
= 0;
4771 /* If we're at the end of the buffer, record that we have
4772 processed the overlay strings there already, so that
4773 next_element_from_buffer doesn't try it again. */
4774 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4775 it
->overlay_strings_at_end_processed_p
= 1;
4779 /* There are more overlay strings to process. If
4780 IT->current.overlay_string_index has advanced to a position
4781 where we must load IT->overlay_strings with more strings, do
4783 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4785 if (it
->current
.overlay_string_index
&& i
== 0)
4786 load_overlay_strings (it
, 0);
4788 /* Initialize IT to deliver display elements from the overlay
4790 it
->string
= it
->overlay_strings
[i
];
4791 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4792 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4793 it
->method
= GET_FROM_STRING
;
4794 it
->stop_charpos
= 0;
4795 if (it
->cmp_it
.stop_pos
>= 0)
4796 it
->cmp_it
.stop_pos
= 0;
4803 /* Compare two overlay_entry structures E1 and E2. Used as a
4804 comparison function for qsort in load_overlay_strings. Overlay
4805 strings for the same position are sorted so that
4807 1. All after-strings come in front of before-strings, except
4808 when they come from the same overlay.
4810 2. Within after-strings, strings are sorted so that overlay strings
4811 from overlays with higher priorities come first.
4813 2. Within before-strings, strings are sorted so that overlay
4814 strings from overlays with higher priorities come last.
4816 Value is analogous to strcmp. */
4820 compare_overlay_entries (const void *e1
, const void *e2
)
4822 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4823 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4826 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4828 /* Let after-strings appear in front of before-strings if
4829 they come from different overlays. */
4830 if (EQ (entry1
->overlay
, entry2
->overlay
))
4831 result
= entry1
->after_string_p
? 1 : -1;
4833 result
= entry1
->after_string_p
? -1 : 1;
4835 else if (entry1
->after_string_p
)
4836 /* After-strings sorted in order of decreasing priority. */
4837 result
= entry2
->priority
- entry1
->priority
;
4839 /* Before-strings sorted in order of increasing priority. */
4840 result
= entry1
->priority
- entry2
->priority
;
4846 /* Load the vector IT->overlay_strings with overlay strings from IT's
4847 current buffer position, or from CHARPOS if that is > 0. Set
4848 IT->n_overlays to the total number of overlay strings found.
4850 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4851 a time. On entry into load_overlay_strings,
4852 IT->current.overlay_string_index gives the number of overlay
4853 strings that have already been loaded by previous calls to this
4856 IT->add_overlay_start contains an additional overlay start
4857 position to consider for taking overlay strings from, if non-zero.
4858 This position comes into play when the overlay has an `invisible'
4859 property, and both before and after-strings. When we've skipped to
4860 the end of the overlay, because of its `invisible' property, we
4861 nevertheless want its before-string to appear.
4862 IT->add_overlay_start will contain the overlay start position
4865 Overlay strings are sorted so that after-string strings come in
4866 front of before-string strings. Within before and after-strings,
4867 strings are sorted by overlay priority. See also function
4868 compare_overlay_entries. */
4871 load_overlay_strings (struct it
*it
, int charpos
)
4873 Lisp_Object overlay
, window
, str
, invisible
;
4874 struct Lisp_Overlay
*ov
;
4877 int n
= 0, i
, j
, invis_p
;
4878 struct overlay_entry
*entries
4879 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4882 charpos
= IT_CHARPOS (*it
);
4884 /* Append the overlay string STRING of overlay OVERLAY to vector
4885 `entries' which has size `size' and currently contains `n'
4886 elements. AFTER_P non-zero means STRING is an after-string of
4888 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4891 Lisp_Object priority; \
4895 int new_size = 2 * size; \
4896 struct overlay_entry *old = entries; \
4898 (struct overlay_entry *) alloca (new_size \
4899 * sizeof *entries); \
4900 memcpy (entries, old, size * sizeof *entries); \
4904 entries[n].string = (STRING); \
4905 entries[n].overlay = (OVERLAY); \
4906 priority = Foverlay_get ((OVERLAY), Qpriority); \
4907 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4908 entries[n].after_string_p = (AFTER_P); \
4913 /* Process overlay before the overlay center. */
4914 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4916 XSETMISC (overlay
, ov
);
4917 xassert (OVERLAYP (overlay
));
4918 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4919 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4924 /* Skip this overlay if it doesn't start or end at IT's current
4926 if (end
!= charpos
&& start
!= charpos
)
4929 /* Skip this overlay if it doesn't apply to IT->w. */
4930 window
= Foverlay_get (overlay
, Qwindow
);
4931 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4934 /* If the text ``under'' the overlay is invisible, both before-
4935 and after-strings from this overlay are visible; start and
4936 end position are indistinguishable. */
4937 invisible
= Foverlay_get (overlay
, Qinvisible
);
4938 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4940 /* If overlay has a non-empty before-string, record it. */
4941 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4942 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4944 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4946 /* If overlay has a non-empty after-string, record it. */
4947 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4948 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4950 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4953 /* Process overlays after the overlay center. */
4954 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4956 XSETMISC (overlay
, ov
);
4957 xassert (OVERLAYP (overlay
));
4958 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4959 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4961 if (start
> charpos
)
4964 /* Skip this overlay if it doesn't start or end at IT's current
4966 if (end
!= charpos
&& start
!= charpos
)
4969 /* Skip this overlay if it doesn't apply to IT->w. */
4970 window
= Foverlay_get (overlay
, Qwindow
);
4971 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4974 /* If the text ``under'' the overlay is invisible, it has a zero
4975 dimension, and both before- and after-strings apply. */
4976 invisible
= Foverlay_get (overlay
, Qinvisible
);
4977 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4979 /* If overlay has a non-empty before-string, record it. */
4980 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4981 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4983 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4985 /* If overlay has a non-empty after-string, record it. */
4986 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4987 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4989 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4992 #undef RECORD_OVERLAY_STRING
4996 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4998 /* Record the total number of strings to process. */
4999 it
->n_overlay_strings
= n
;
5001 /* IT->current.overlay_string_index is the number of overlay strings
5002 that have already been consumed by IT. Copy some of the
5003 remaining overlay strings to IT->overlay_strings. */
5005 j
= it
->current
.overlay_string_index
;
5006 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5008 it
->overlay_strings
[i
] = entries
[j
].string
;
5009 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5016 /* Get the first chunk of overlay strings at IT's current buffer
5017 position, or at CHARPOS if that is > 0. Value is non-zero if at
5018 least one overlay string was found. */
5021 get_overlay_strings_1 (struct it
*it
, int charpos
, int compute_stop_p
)
5023 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5024 process. This fills IT->overlay_strings with strings, and sets
5025 IT->n_overlay_strings to the total number of strings to process.
5026 IT->pos.overlay_string_index has to be set temporarily to zero
5027 because load_overlay_strings needs this; it must be set to -1
5028 when no overlay strings are found because a zero value would
5029 indicate a position in the first overlay string. */
5030 it
->current
.overlay_string_index
= 0;
5031 load_overlay_strings (it
, charpos
);
5033 /* If we found overlay strings, set up IT to deliver display
5034 elements from the first one. Otherwise set up IT to deliver
5035 from current_buffer. */
5036 if (it
->n_overlay_strings
)
5038 /* Make sure we know settings in current_buffer, so that we can
5039 restore meaningful values when we're done with the overlay
5042 compute_stop_pos (it
);
5043 xassert (it
->face_id
>= 0);
5045 /* Save IT's settings. They are restored after all overlay
5046 strings have been processed. */
5047 xassert (!compute_stop_p
|| it
->sp
== 0);
5049 /* When called from handle_stop, there might be an empty display
5050 string loaded. In that case, don't bother saving it. */
5051 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5054 /* Set up IT to deliver display elements from the first overlay
5056 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5057 it
->string
= it
->overlay_strings
[0];
5058 it
->from_overlay
= Qnil
;
5059 it
->stop_charpos
= 0;
5060 xassert (STRINGP (it
->string
));
5061 it
->end_charpos
= SCHARS (it
->string
);
5062 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5063 it
->method
= GET_FROM_STRING
;
5067 it
->current
.overlay_string_index
= -1;
5072 get_overlay_strings (struct it
*it
, int charpos
)
5075 it
->method
= GET_FROM_BUFFER
;
5077 (void) get_overlay_strings_1 (it
, charpos
, 1);
5081 /* Value is non-zero if we found at least one overlay string. */
5082 return STRINGP (it
->string
);
5087 /***********************************************************************
5088 Saving and restoring state
5089 ***********************************************************************/
5091 /* Save current settings of IT on IT->stack. Called, for example,
5092 before setting up IT for an overlay string, to be able to restore
5093 IT's settings to what they were after the overlay string has been
5097 push_it (struct it
*it
)
5099 struct iterator_stack_entry
*p
;
5101 xassert (it
->sp
< IT_STACK_SIZE
);
5102 p
= it
->stack
+ it
->sp
;
5104 p
->stop_charpos
= it
->stop_charpos
;
5105 p
->prev_stop
= it
->prev_stop
;
5106 p
->base_level_stop
= it
->base_level_stop
;
5107 p
->cmp_it
= it
->cmp_it
;
5108 xassert (it
->face_id
>= 0);
5109 p
->face_id
= it
->face_id
;
5110 p
->string
= it
->string
;
5111 p
->method
= it
->method
;
5112 p
->from_overlay
= it
->from_overlay
;
5115 case GET_FROM_IMAGE
:
5116 p
->u
.image
.object
= it
->object
;
5117 p
->u
.image
.image_id
= it
->image_id
;
5118 p
->u
.image
.slice
= it
->slice
;
5120 case GET_FROM_STRETCH
:
5121 p
->u
.stretch
.object
= it
->object
;
5124 p
->position
= it
->position
;
5125 p
->current
= it
->current
;
5126 p
->end_charpos
= it
->end_charpos
;
5127 p
->string_nchars
= it
->string_nchars
;
5129 p
->multibyte_p
= it
->multibyte_p
;
5130 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5131 p
->space_width
= it
->space_width
;
5132 p
->font_height
= it
->font_height
;
5133 p
->voffset
= it
->voffset
;
5134 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5135 p
->display_ellipsis_p
= 0;
5136 p
->line_wrap
= it
->line_wrap
;
5141 iterate_out_of_display_property (struct it
*it
)
5143 /* Maybe initialize paragraph direction. If we are at the beginning
5144 of a new paragraph, next_element_from_buffer may not have a
5145 chance to do that. */
5146 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5147 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
5148 /* prev_stop can be zero, so check against BEGV as well. */
5149 while (it
->bidi_it
.charpos
>= BEGV
5150 && it
->prev_stop
<= it
->bidi_it
.charpos
5151 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5152 bidi_move_to_visually_next (&it
->bidi_it
);
5153 /* Record the stop_pos we just crossed, for when we cross it
5155 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5156 it
->prev_stop
= CHARPOS (it
->position
);
5157 /* If we ended up not where pop_it put us, resync IT's
5158 positional members with the bidi iterator. */
5159 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5161 SET_TEXT_POS (it
->position
,
5162 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5163 it
->current
.pos
= it
->position
;
5167 /* Restore IT's settings from IT->stack. Called, for example, when no
5168 more overlay strings must be processed, and we return to delivering
5169 display elements from a buffer, or when the end of a string from a
5170 `display' property is reached and we return to delivering display
5171 elements from an overlay string, or from a buffer. */
5174 pop_it (struct it
*it
)
5176 struct iterator_stack_entry
*p
;
5178 xassert (it
->sp
> 0);
5180 p
= it
->stack
+ it
->sp
;
5181 it
->stop_charpos
= p
->stop_charpos
;
5182 it
->prev_stop
= p
->prev_stop
;
5183 it
->base_level_stop
= p
->base_level_stop
;
5184 it
->cmp_it
= p
->cmp_it
;
5185 it
->face_id
= p
->face_id
;
5186 it
->current
= p
->current
;
5187 it
->position
= p
->position
;
5188 it
->string
= p
->string
;
5189 it
->from_overlay
= p
->from_overlay
;
5190 if (NILP (it
->string
))
5191 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5192 it
->method
= p
->method
;
5195 case GET_FROM_IMAGE
:
5196 it
->image_id
= p
->u
.image
.image_id
;
5197 it
->object
= p
->u
.image
.object
;
5198 it
->slice
= p
->u
.image
.slice
;
5200 case GET_FROM_STRETCH
:
5201 it
->object
= p
->u
.comp
.object
;
5203 case GET_FROM_BUFFER
:
5204 it
->object
= it
->w
->buffer
;
5207 /* Bidi-iterate until we get out of the portion of text, if
5208 any, covered by a `display' text property or an overlay
5209 with `display' property. (We cannot just jump there,
5210 because the internal coherency of the bidi iterator state
5211 can not be preserved across such jumps.) We also must
5212 determine the paragraph base direction if the overlay we
5213 just processed is at the beginning of a new
5215 iterate_out_of_display_property (it
);
5218 case GET_FROM_STRING
:
5219 it
->object
= it
->string
;
5221 case GET_FROM_DISPLAY_VECTOR
:
5223 it
->method
= GET_FROM_C_STRING
;
5224 else if (STRINGP (it
->string
))
5225 it
->method
= GET_FROM_STRING
;
5228 it
->method
= GET_FROM_BUFFER
;
5229 it
->object
= it
->w
->buffer
;
5232 it
->end_charpos
= p
->end_charpos
;
5233 it
->string_nchars
= p
->string_nchars
;
5235 it
->multibyte_p
= p
->multibyte_p
;
5236 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5237 it
->space_width
= p
->space_width
;
5238 it
->font_height
= p
->font_height
;
5239 it
->voffset
= p
->voffset
;
5240 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5241 it
->line_wrap
= p
->line_wrap
;
5246 /***********************************************************************
5248 ***********************************************************************/
5250 /* Set IT's current position to the previous line start. */
5253 back_to_previous_line_start (struct it
*it
)
5255 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5256 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5260 /* Move IT to the next line start.
5262 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5263 we skipped over part of the text (as opposed to moving the iterator
5264 continuously over the text). Otherwise, don't change the value
5267 Newlines may come from buffer text, overlay strings, or strings
5268 displayed via the `display' property. That's the reason we can't
5269 simply use find_next_newline_no_quit.
5271 Note that this function may not skip over invisible text that is so
5272 because of text properties and immediately follows a newline. If
5273 it would, function reseat_at_next_visible_line_start, when called
5274 from set_iterator_to_next, would effectively make invisible
5275 characters following a newline part of the wrong glyph row, which
5276 leads to wrong cursor motion. */
5279 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5281 int old_selective
, newline_found_p
, n
;
5282 const int MAX_NEWLINE_DISTANCE
= 500;
5284 /* If already on a newline, just consume it to avoid unintended
5285 skipping over invisible text below. */
5286 if (it
->what
== IT_CHARACTER
5288 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5290 set_iterator_to_next (it
, 0);
5295 /* Don't handle selective display in the following. It's (a)
5296 unnecessary because it's done by the caller, and (b) leads to an
5297 infinite recursion because next_element_from_ellipsis indirectly
5298 calls this function. */
5299 old_selective
= it
->selective
;
5302 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5303 from buffer text. */
5304 for (n
= newline_found_p
= 0;
5305 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5306 n
+= STRINGP (it
->string
) ? 0 : 1)
5308 if (!get_next_display_element (it
))
5310 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5311 set_iterator_to_next (it
, 0);
5314 /* If we didn't find a newline near enough, see if we can use a
5316 if (!newline_found_p
)
5318 int start
= IT_CHARPOS (*it
);
5319 int limit
= find_next_newline_no_quit (start
, 1);
5322 xassert (!STRINGP (it
->string
));
5324 /* If there isn't any `display' property in sight, and no
5325 overlays, we can just use the position of the newline in
5327 if (it
->stop_charpos
>= limit
5328 || ((pos
= Fnext_single_property_change (make_number (start
),
5330 Qnil
, make_number (limit
)),
5332 && next_overlay_change (start
) == ZV
))
5334 IT_CHARPOS (*it
) = limit
;
5335 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5336 *skipped_p
= newline_found_p
= 1;
5340 while (get_next_display_element (it
)
5341 && !newline_found_p
)
5343 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5344 set_iterator_to_next (it
, 0);
5349 it
->selective
= old_selective
;
5350 return newline_found_p
;
5354 /* Set IT's current position to the previous visible line start. Skip
5355 invisible text that is so either due to text properties or due to
5356 selective display. Caution: this does not change IT->current_x and
5360 back_to_previous_visible_line_start (struct it
*it
)
5362 while (IT_CHARPOS (*it
) > BEGV
)
5364 back_to_previous_line_start (it
);
5366 if (IT_CHARPOS (*it
) <= BEGV
)
5369 /* If selective > 0, then lines indented more than its value are
5371 if (it
->selective
> 0
5372 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5373 (double) it
->selective
)) /* iftc */
5376 /* Check the newline before point for invisibility. */
5379 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5380 Qinvisible
, it
->window
);
5381 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5385 if (IT_CHARPOS (*it
) <= BEGV
)
5392 Lisp_Object val
, overlay
;
5394 /* If newline is part of a composition, continue from start of composition */
5395 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5396 && beg
< IT_CHARPOS (*it
))
5399 /* If newline is replaced by a display property, find start of overlay
5400 or interval and continue search from that point. */
5402 pos
= --IT_CHARPOS (it2
);
5405 it2
.string_from_display_prop_p
= 0;
5406 if (handle_display_prop (&it2
) == HANDLED_RETURN
5407 && !NILP (val
= get_char_property_and_overlay
5408 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5409 && (OVERLAYP (overlay
)
5410 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5411 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5414 /* Newline is not replaced by anything -- so we are done. */
5420 IT_CHARPOS (*it
) = beg
;
5421 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5425 it
->continuation_lines_width
= 0;
5427 xassert (IT_CHARPOS (*it
) >= BEGV
);
5428 xassert (IT_CHARPOS (*it
) == BEGV
5429 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5434 /* Reseat iterator IT at the previous visible line start. Skip
5435 invisible text that is so either due to text properties or due to
5436 selective display. At the end, update IT's overlay information,
5437 face information etc. */
5440 reseat_at_previous_visible_line_start (struct it
*it
)
5442 back_to_previous_visible_line_start (it
);
5443 reseat (it
, it
->current
.pos
, 1);
5448 /* Reseat iterator IT on the next visible line start in the current
5449 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5450 preceding the line start. Skip over invisible text that is so
5451 because of selective display. Compute faces, overlays etc at the
5452 new position. Note that this function does not skip over text that
5453 is invisible because of text properties. */
5456 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5458 int newline_found_p
, skipped_p
= 0;
5460 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5462 /* Skip over lines that are invisible because they are indented
5463 more than the value of IT->selective. */
5464 if (it
->selective
> 0)
5465 while (IT_CHARPOS (*it
) < ZV
5466 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5467 (double) it
->selective
)) /* iftc */
5469 xassert (IT_BYTEPOS (*it
) == BEGV
5470 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5471 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5474 /* Position on the newline if that's what's requested. */
5475 if (on_newline_p
&& newline_found_p
)
5477 if (STRINGP (it
->string
))
5479 if (IT_STRING_CHARPOS (*it
) > 0)
5481 --IT_STRING_CHARPOS (*it
);
5482 --IT_STRING_BYTEPOS (*it
);
5485 else if (IT_CHARPOS (*it
) > BEGV
)
5489 reseat (it
, it
->current
.pos
, 0);
5493 reseat (it
, it
->current
.pos
, 0);
5500 /***********************************************************************
5501 Changing an iterator's position
5502 ***********************************************************************/
5504 /* Change IT's current position to POS in current_buffer. If FORCE_P
5505 is non-zero, always check for text properties at the new position.
5506 Otherwise, text properties are only looked up if POS >=
5507 IT->check_charpos of a property. */
5510 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5512 int original_pos
= IT_CHARPOS (*it
);
5514 reseat_1 (it
, pos
, 0);
5516 /* Determine where to check text properties. Avoid doing it
5517 where possible because text property lookup is very expensive. */
5519 || CHARPOS (pos
) > it
->stop_charpos
5520 || CHARPOS (pos
) < original_pos
)
5524 /* For bidi iteration, we need to prime prev_stop and
5525 base_level_stop with our best estimations. */
5526 if (CHARPOS (pos
) < it
->prev_stop
)
5528 handle_stop_backwards (it
, BEGV
);
5529 if (CHARPOS (pos
) < it
->base_level_stop
)
5530 it
->base_level_stop
= 0;
5532 else if (CHARPOS (pos
) > it
->stop_charpos
5533 && it
->stop_charpos
>= BEGV
)
5534 handle_stop_backwards (it
, it
->stop_charpos
);
5541 it
->prev_stop
= it
->base_level_stop
= 0;
5550 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5551 IT->stop_pos to POS, also. */
5554 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5556 /* Don't call this function when scanning a C string. */
5557 xassert (it
->s
== NULL
);
5559 /* POS must be a reasonable value. */
5560 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5562 it
->current
.pos
= it
->position
= pos
;
5563 it
->end_charpos
= ZV
;
5565 it
->current
.dpvec_index
= -1;
5566 it
->current
.overlay_string_index
= -1;
5567 IT_STRING_CHARPOS (*it
) = -1;
5568 IT_STRING_BYTEPOS (*it
) = -1;
5570 it
->string_from_display_prop_p
= 0;
5571 it
->method
= GET_FROM_BUFFER
;
5572 it
->object
= it
->w
->buffer
;
5573 it
->area
= TEXT_AREA
;
5574 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5576 it
->string_from_display_prop_p
= 0;
5577 it
->face_before_selective_p
= 0;
5579 it
->bidi_it
.first_elt
= 1;
5583 it
->stop_charpos
= CHARPOS (pos
);
5584 it
->base_level_stop
= CHARPOS (pos
);
5589 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5590 If S is non-null, it is a C string to iterate over. Otherwise,
5591 STRING gives a Lisp string to iterate over.
5593 If PRECISION > 0, don't return more then PRECISION number of
5594 characters from the string.
5596 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5597 characters have been returned. FIELD_WIDTH < 0 means an infinite
5600 MULTIBYTE = 0 means disable processing of multibyte characters,
5601 MULTIBYTE > 0 means enable it,
5602 MULTIBYTE < 0 means use IT->multibyte_p.
5604 IT must be initialized via a prior call to init_iterator before
5605 calling this function. */
5608 reseat_to_string (struct it
*it
, const unsigned char *s
, Lisp_Object string
,
5609 int charpos
, int precision
, int field_width
, int multibyte
)
5611 /* No region in strings. */
5612 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5614 /* No text property checks performed by default, but see below. */
5615 it
->stop_charpos
= -1;
5617 /* Set iterator position and end position. */
5618 memset (&it
->current
, 0, sizeof it
->current
);
5619 it
->current
.overlay_string_index
= -1;
5620 it
->current
.dpvec_index
= -1;
5621 xassert (charpos
>= 0);
5623 /* If STRING is specified, use its multibyteness, otherwise use the
5624 setting of MULTIBYTE, if specified. */
5626 it
->multibyte_p
= multibyte
> 0;
5630 xassert (STRINGP (string
));
5631 it
->string
= string
;
5633 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5634 it
->method
= GET_FROM_STRING
;
5635 it
->current
.string_pos
= string_pos (charpos
, string
);
5642 /* Note that we use IT->current.pos, not it->current.string_pos,
5643 for displaying C strings. */
5644 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5645 if (it
->multibyte_p
)
5647 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5648 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5652 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5653 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5656 it
->method
= GET_FROM_C_STRING
;
5659 /* PRECISION > 0 means don't return more than PRECISION characters
5661 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5662 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5664 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5665 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5666 FIELD_WIDTH < 0 means infinite field width. This is useful for
5667 padding with `-' at the end of a mode line. */
5668 if (field_width
< 0)
5669 field_width
= INFINITY
;
5670 if (field_width
> it
->end_charpos
- charpos
)
5671 it
->end_charpos
= charpos
+ field_width
;
5673 /* Use the standard display table for displaying strings. */
5674 if (DISP_TABLE_P (Vstandard_display_table
))
5675 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5677 it
->stop_charpos
= charpos
;
5678 if (s
== NULL
&& it
->multibyte_p
)
5680 EMACS_INT endpos
= SCHARS (it
->string
);
5681 if (endpos
> it
->end_charpos
)
5682 endpos
= it
->end_charpos
;
5683 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5691 /***********************************************************************
5693 ***********************************************************************/
5695 /* Map enum it_method value to corresponding next_element_from_* function. */
5697 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5699 next_element_from_buffer
,
5700 next_element_from_display_vector
,
5701 next_element_from_string
,
5702 next_element_from_c_string
,
5703 next_element_from_image
,
5704 next_element_from_stretch
5707 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5710 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5711 (possibly with the following characters). */
5713 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5714 ((IT)->cmp_it.id >= 0 \
5715 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5716 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5717 END_CHARPOS, (IT)->w, \
5718 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5722 /* Load IT's display element fields with information about the next
5723 display element from the current position of IT. Value is zero if
5724 end of buffer (or C string) is reached. */
5726 static struct frame
*last_escape_glyph_frame
= NULL
;
5727 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5728 static int last_escape_glyph_merged_face_id
= 0;
5731 get_next_display_element (struct it
*it
)
5733 /* Non-zero means that we found a display element. Zero means that
5734 we hit the end of what we iterate over. Performance note: the
5735 function pointer `method' used here turns out to be faster than
5736 using a sequence of if-statements. */
5740 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5742 if (it
->what
== IT_CHARACTER
)
5744 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5745 and only if (a) the resolved directionality of that character
5747 /* FIXME: Do we need an exception for characters from display
5749 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5750 it
->c
= bidi_mirror_char (it
->c
);
5751 /* Map via display table or translate control characters.
5752 IT->c, IT->len etc. have been set to the next character by
5753 the function call above. If we have a display table, and it
5754 contains an entry for IT->c, translate it. Don't do this if
5755 IT->c itself comes from a display table, otherwise we could
5756 end up in an infinite recursion. (An alternative could be to
5757 count the recursion depth of this function and signal an
5758 error when a certain maximum depth is reached.) Is it worth
5760 if (success_p
&& it
->dpvec
== NULL
)
5763 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5764 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5765 nbsp_or_shy
= char_is_other
;
5766 int c
= it
->c
; /* This is the character to display. */
5768 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5770 xassert (SINGLE_BYTE_CHAR_P (c
));
5771 if (unibyte_display_via_language_environment
)
5773 c
= DECODE_CHAR (unibyte
, c
);
5775 c
= BYTE8_TO_CHAR (it
->c
);
5778 c
= BYTE8_TO_CHAR (it
->c
);
5782 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5785 struct Lisp_Vector
*v
= XVECTOR (dv
);
5787 /* Return the first character from the display table
5788 entry, if not empty. If empty, don't display the
5789 current character. */
5792 it
->dpvec_char_len
= it
->len
;
5793 it
->dpvec
= v
->contents
;
5794 it
->dpend
= v
->contents
+ v
->size
;
5795 it
->current
.dpvec_index
= 0;
5796 it
->dpvec_face_id
= -1;
5797 it
->saved_face_id
= it
->face_id
;
5798 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5803 set_iterator_to_next (it
, 0);
5808 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5809 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5810 : c
== 0xAD ? char_is_soft_hyphen
5813 /* Translate control characters into `\003' or `^C' form.
5814 Control characters coming from a display table entry are
5815 currently not translated because we use IT->dpvec to hold
5816 the translation. This could easily be changed but I
5817 don't believe that it is worth doing.
5819 NBSP and SOFT-HYPEN are property translated too.
5821 Non-printable characters and raw-byte characters are also
5822 translated to octal form. */
5823 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5824 ? (it
->area
!= TEXT_AREA
5825 /* In mode line, treat \n, \t like other crl chars. */
5828 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5829 || (c
!= '\n' && c
!= '\t'))
5832 || ! CHAR_PRINTABLE_P (c
))))
5834 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5835 or a non-printable character which must be displayed
5836 either as '\003' or as `^C' where the '\\' and '^'
5837 can be defined in the display table. Fill
5838 IT->ctl_chars with glyphs for what we have to
5839 display. Then, set IT->dpvec to these glyphs. */
5842 int face_id
, lface_id
= 0 ;
5845 /* Handle control characters with ^. */
5847 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5851 g
= '^'; /* default glyph for Control */
5852 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5854 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5855 && GLYPH_CODE_CHAR_VALID_P (gc
))
5857 g
= GLYPH_CODE_CHAR (gc
);
5858 lface_id
= GLYPH_CODE_FACE (gc
);
5862 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5864 else if (it
->f
== last_escape_glyph_frame
5865 && it
->face_id
== last_escape_glyph_face_id
)
5867 face_id
= last_escape_glyph_merged_face_id
;
5871 /* Merge the escape-glyph face into the current face. */
5872 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5874 last_escape_glyph_frame
= it
->f
;
5875 last_escape_glyph_face_id
= it
->face_id
;
5876 last_escape_glyph_merged_face_id
= face_id
;
5879 XSETINT (it
->ctl_chars
[0], g
);
5880 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5882 goto display_control
;
5885 /* Handle non-break space in the mode where it only gets
5888 if (EQ (Vnobreak_char_display
, Qt
)
5889 && nbsp_or_shy
== char_is_nbsp
)
5891 /* Merge the no-break-space face into the current face. */
5892 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5896 XSETINT (it
->ctl_chars
[0], ' ');
5898 goto display_control
;
5901 /* Handle sequences that start with the "escape glyph". */
5903 /* the default escape glyph is \. */
5904 escape_glyph
= '\\';
5907 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5908 && GLYPH_CODE_CHAR_VALID_P (gc
))
5910 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5911 lface_id
= GLYPH_CODE_FACE (gc
);
5915 /* The display table specified a face.
5916 Merge it into face_id and also into escape_glyph. */
5917 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5920 else if (it
->f
== last_escape_glyph_frame
5921 && it
->face_id
== last_escape_glyph_face_id
)
5923 face_id
= last_escape_glyph_merged_face_id
;
5927 /* Merge the escape-glyph face into the current face. */
5928 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5930 last_escape_glyph_frame
= it
->f
;
5931 last_escape_glyph_face_id
= it
->face_id
;
5932 last_escape_glyph_merged_face_id
= face_id
;
5935 /* Handle soft hyphens in the mode where they only get
5938 if (EQ (Vnobreak_char_display
, Qt
)
5939 && nbsp_or_shy
== char_is_soft_hyphen
)
5941 XSETINT (it
->ctl_chars
[0], '-');
5943 goto display_control
;
5946 /* Handle non-break space and soft hyphen
5947 with the escape glyph. */
5951 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5952 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5953 XSETINT (it
->ctl_chars
[1], c
);
5955 goto display_control
;
5962 if (CHAR_BYTE8_P (c
))
5963 /* Display \200 instead of \17777600. */
5964 c
= CHAR_TO_BYTE8 (c
);
5965 len
= sprintf (str
, "%03o", c
);
5967 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5968 for (i
= 0; i
< len
; i
++)
5969 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5974 /* Set up IT->dpvec and return first character from it. */
5975 it
->dpvec_char_len
= it
->len
;
5976 it
->dpvec
= it
->ctl_chars
;
5977 it
->dpend
= it
->dpvec
+ ctl_len
;
5978 it
->current
.dpvec_index
= 0;
5979 it
->dpvec_face_id
= face_id
;
5980 it
->saved_face_id
= it
->face_id
;
5981 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5985 it
->char_to_display
= c
;
5989 it
->char_to_display
= it
->c
;
5993 #ifdef HAVE_WINDOW_SYSTEM
5994 /* Adjust face id for a multibyte character. There are no multibyte
5995 character in unibyte text. */
5996 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5999 && FRAME_WINDOW_P (it
->f
))
6001 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6003 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6005 /* Automatic composition with glyph-string. */
6006 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6008 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6012 int pos
= (it
->s
? -1
6013 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6014 : IT_CHARPOS (*it
));
6016 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6022 /* Is this character the last one of a run of characters with
6023 box? If yes, set IT->end_of_box_run_p to 1. */
6027 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6029 int face_id
= underlying_face_id (it
);
6030 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6034 if (face
->box
== FACE_NO_BOX
)
6036 /* If the box comes from face properties in a
6037 display string, check faces in that string. */
6038 int string_face_id
= face_after_it_pos (it
);
6039 it
->end_of_box_run_p
6040 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6043 /* Otherwise, the box comes from the underlying face.
6044 If this is the last string character displayed, check
6045 the next buffer location. */
6046 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6047 && (it
->current
.overlay_string_index
6048 == it
->n_overlay_strings
- 1))
6052 struct text_pos pos
= it
->current
.pos
;
6053 INC_TEXT_POS (pos
, it
->multibyte_p
);
6055 next_face_id
= face_at_buffer_position
6056 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6057 it
->region_end_charpos
, &ignore
,
6058 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6060 it
->end_of_box_run_p
6061 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6068 int face_id
= face_after_it_pos (it
);
6069 it
->end_of_box_run_p
6070 = (face_id
!= it
->face_id
6071 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6075 /* Value is 0 if end of buffer or string reached. */
6080 /* Move IT to the next display element.
6082 RESEAT_P non-zero means if called on a newline in buffer text,
6083 skip to the next visible line start.
6085 Functions get_next_display_element and set_iterator_to_next are
6086 separate because I find this arrangement easier to handle than a
6087 get_next_display_element function that also increments IT's
6088 position. The way it is we can first look at an iterator's current
6089 display element, decide whether it fits on a line, and if it does,
6090 increment the iterator position. The other way around we probably
6091 would either need a flag indicating whether the iterator has to be
6092 incremented the next time, or we would have to implement a
6093 decrement position function which would not be easy to write. */
6096 set_iterator_to_next (struct it
*it
, int reseat_p
)
6098 /* Reset flags indicating start and end of a sequence of characters
6099 with box. Reset them at the start of this function because
6100 moving the iterator to a new position might set them. */
6101 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6105 case GET_FROM_BUFFER
:
6106 /* The current display element of IT is a character from
6107 current_buffer. Advance in the buffer, and maybe skip over
6108 invisible lines that are so because of selective display. */
6109 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6110 reseat_at_next_visible_line_start (it
, 0);
6111 else if (it
->cmp_it
.id
>= 0)
6113 /* We are currently getting glyphs from a composition. */
6118 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6119 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6120 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6122 it
->cmp_it
.from
= it
->cmp_it
.to
;
6127 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6129 it
->stop_charpos
, Qnil
);
6132 else if (! it
->cmp_it
.reversed_p
)
6134 /* Composition created while scanning forward. */
6135 /* Update IT's char/byte positions to point to the first
6136 character of the next grapheme cluster, or to the
6137 character visually after the current composition. */
6138 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6139 bidi_move_to_visually_next (&it
->bidi_it
);
6140 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6141 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6143 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6145 /* Proceed to the next grapheme cluster. */
6146 it
->cmp_it
.from
= it
->cmp_it
.to
;
6150 /* No more grapheme clusters in this composition.
6151 Find the next stop position. */
6152 EMACS_INT stop
= it
->stop_charpos
;
6153 if (it
->bidi_it
.scan_dir
< 0)
6154 /* Now we are scanning backward and don't know
6157 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6158 IT_BYTEPOS (*it
), stop
, Qnil
);
6163 /* Composition created while scanning backward. */
6164 /* Update IT's char/byte positions to point to the last
6165 character of the previous grapheme cluster, or the
6166 character visually after the current composition. */
6167 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6168 bidi_move_to_visually_next (&it
->bidi_it
);
6169 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6170 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6171 if (it
->cmp_it
.from
> 0)
6173 /* Proceed to the previous grapheme cluster. */
6174 it
->cmp_it
.to
= it
->cmp_it
.from
;
6178 /* No more grapheme clusters in this composition.
6179 Find the next stop position. */
6180 EMACS_INT stop
= it
->stop_charpos
;
6181 if (it
->bidi_it
.scan_dir
< 0)
6182 /* Now we are scanning backward and don't know
6185 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6186 IT_BYTEPOS (*it
), stop
, Qnil
);
6192 xassert (it
->len
!= 0);
6196 IT_BYTEPOS (*it
) += it
->len
;
6197 IT_CHARPOS (*it
) += 1;
6201 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6202 /* If this is a new paragraph, determine its base
6203 direction (a.k.a. its base embedding level). */
6204 if (it
->bidi_it
.new_paragraph
)
6205 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6206 bidi_move_to_visually_next (&it
->bidi_it
);
6207 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6208 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6209 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6211 /* As the scan direction was changed, we must
6212 re-compute the stop position for composition. */
6213 EMACS_INT stop
= it
->stop_charpos
;
6214 if (it
->bidi_it
.scan_dir
< 0)
6216 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6217 IT_BYTEPOS (*it
), stop
, Qnil
);
6220 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6224 case GET_FROM_C_STRING
:
6225 /* Current display element of IT is from a C string. */
6226 IT_BYTEPOS (*it
) += it
->len
;
6227 IT_CHARPOS (*it
) += 1;
6230 case GET_FROM_DISPLAY_VECTOR
:
6231 /* Current display element of IT is from a display table entry.
6232 Advance in the display table definition. Reset it to null if
6233 end reached, and continue with characters from buffers/
6235 ++it
->current
.dpvec_index
;
6237 /* Restore face of the iterator to what they were before the
6238 display vector entry (these entries may contain faces). */
6239 it
->face_id
= it
->saved_face_id
;
6241 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6243 int recheck_faces
= it
->ellipsis_p
;
6246 it
->method
= GET_FROM_C_STRING
;
6247 else if (STRINGP (it
->string
))
6248 it
->method
= GET_FROM_STRING
;
6251 it
->method
= GET_FROM_BUFFER
;
6252 it
->object
= it
->w
->buffer
;
6256 it
->current
.dpvec_index
= -1;
6258 /* Skip over characters which were displayed via IT->dpvec. */
6259 if (it
->dpvec_char_len
< 0)
6260 reseat_at_next_visible_line_start (it
, 1);
6261 else if (it
->dpvec_char_len
> 0)
6263 if (it
->method
== GET_FROM_STRING
6264 && it
->n_overlay_strings
> 0)
6265 it
->ignore_overlay_strings_at_pos_p
= 1;
6266 it
->len
= it
->dpvec_char_len
;
6267 set_iterator_to_next (it
, reseat_p
);
6270 /* Maybe recheck faces after display vector */
6272 it
->stop_charpos
= IT_CHARPOS (*it
);
6276 case GET_FROM_STRING
:
6277 /* Current display element is a character from a Lisp string. */
6278 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6279 if (it
->cmp_it
.id
>= 0)
6281 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6282 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6283 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6284 it
->cmp_it
.from
= it
->cmp_it
.to
;
6288 composition_compute_stop_pos (&it
->cmp_it
,
6289 IT_STRING_CHARPOS (*it
),
6290 IT_STRING_BYTEPOS (*it
),
6291 it
->stop_charpos
, it
->string
);
6296 IT_STRING_BYTEPOS (*it
) += it
->len
;
6297 IT_STRING_CHARPOS (*it
) += 1;
6300 consider_string_end
:
6302 if (it
->current
.overlay_string_index
>= 0)
6304 /* IT->string is an overlay string. Advance to the
6305 next, if there is one. */
6306 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6309 next_overlay_string (it
);
6311 setup_for_ellipsis (it
, 0);
6316 /* IT->string is not an overlay string. If we reached
6317 its end, and there is something on IT->stack, proceed
6318 with what is on the stack. This can be either another
6319 string, this time an overlay string, or a buffer. */
6320 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6324 if (it
->method
== GET_FROM_STRING
)
6325 goto consider_string_end
;
6330 case GET_FROM_IMAGE
:
6331 case GET_FROM_STRETCH
:
6332 /* The position etc with which we have to proceed are on
6333 the stack. The position may be at the end of a string,
6334 if the `display' property takes up the whole string. */
6335 xassert (it
->sp
> 0);
6337 if (it
->method
== GET_FROM_STRING
)
6338 goto consider_string_end
;
6342 /* There are no other methods defined, so this should be a bug. */
6346 xassert (it
->method
!= GET_FROM_STRING
6347 || (STRINGP (it
->string
)
6348 && IT_STRING_CHARPOS (*it
) >= 0));
6351 /* Load IT's display element fields with information about the next
6352 display element which comes from a display table entry or from the
6353 result of translating a control character to one of the forms `^C'
6356 IT->dpvec holds the glyphs to return as characters.
6357 IT->saved_face_id holds the face id before the display vector--it
6358 is restored into IT->face_id in set_iterator_to_next. */
6361 next_element_from_display_vector (struct it
*it
)
6366 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6368 it
->face_id
= it
->saved_face_id
;
6370 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6371 That seemed totally bogus - so I changed it... */
6372 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6374 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6376 it
->c
= GLYPH_CODE_CHAR (gc
);
6377 it
->len
= CHAR_BYTES (it
->c
);
6379 /* The entry may contain a face id to use. Such a face id is
6380 the id of a Lisp face, not a realized face. A face id of
6381 zero means no face is specified. */
6382 if (it
->dpvec_face_id
>= 0)
6383 it
->face_id
= it
->dpvec_face_id
;
6386 int lface_id
= GLYPH_CODE_FACE (gc
);
6388 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6393 /* Display table entry is invalid. Return a space. */
6394 it
->c
= ' ', it
->len
= 1;
6396 /* Don't change position and object of the iterator here. They are
6397 still the values of the character that had this display table
6398 entry or was translated, and that's what we want. */
6399 it
->what
= IT_CHARACTER
;
6404 /* Load IT with the next display element from Lisp string IT->string.
6405 IT->current.string_pos is the current position within the string.
6406 If IT->current.overlay_string_index >= 0, the Lisp string is an
6410 next_element_from_string (struct it
*it
)
6412 struct text_pos position
;
6414 xassert (STRINGP (it
->string
));
6415 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6416 position
= it
->current
.string_pos
;
6418 /* Time to check for invisible text? */
6419 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6420 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6424 /* Since a handler may have changed IT->method, we must
6426 return GET_NEXT_DISPLAY_ELEMENT (it
);
6429 if (it
->current
.overlay_string_index
>= 0)
6431 /* Get the next character from an overlay string. In overlay
6432 strings, There is no field width or padding with spaces to
6434 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6439 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6440 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6441 && next_element_from_composition (it
))
6445 else if (STRING_MULTIBYTE (it
->string
))
6447 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6448 const unsigned char *s
= (SDATA (it
->string
)
6449 + IT_STRING_BYTEPOS (*it
));
6450 it
->c
= string_char_and_length (s
, &it
->len
);
6454 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6460 /* Get the next character from a Lisp string that is not an
6461 overlay string. Such strings come from the mode line, for
6462 example. We may have to pad with spaces, or truncate the
6463 string. See also next_element_from_c_string. */
6464 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6469 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6471 /* Pad with spaces. */
6472 it
->c
= ' ', it
->len
= 1;
6473 CHARPOS (position
) = BYTEPOS (position
) = -1;
6475 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6476 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6477 && next_element_from_composition (it
))
6481 else if (STRING_MULTIBYTE (it
->string
))
6483 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6484 const unsigned char *s
= (SDATA (it
->string
)
6485 + IT_STRING_BYTEPOS (*it
));
6486 it
->c
= string_char_and_length (s
, &it
->len
);
6490 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6495 /* Record what we have and where it came from. */
6496 it
->what
= IT_CHARACTER
;
6497 it
->object
= it
->string
;
6498 it
->position
= position
;
6503 /* Load IT with next display element from C string IT->s.
6504 IT->string_nchars is the maximum number of characters to return
6505 from the string. IT->end_charpos may be greater than
6506 IT->string_nchars when this function is called, in which case we
6507 may have to return padding spaces. Value is zero if end of string
6508 reached, including padding spaces. */
6511 next_element_from_c_string (struct it
*it
)
6516 it
->what
= IT_CHARACTER
;
6517 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6520 /* IT's position can be greater IT->string_nchars in case a field
6521 width or precision has been specified when the iterator was
6523 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6525 /* End of the game. */
6529 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6531 /* Pad with spaces. */
6532 it
->c
= ' ', it
->len
= 1;
6533 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6535 else if (it
->multibyte_p
)
6537 /* Implementation note: The calls to strlen apparently aren't a
6538 performance problem because there is no noticeable performance
6539 difference between Emacs running in unibyte or multibyte mode. */
6540 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6541 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6544 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6550 /* Set up IT to return characters from an ellipsis, if appropriate.
6551 The definition of the ellipsis glyphs may come from a display table
6552 entry. This function fills IT with the first glyph from the
6553 ellipsis if an ellipsis is to be displayed. */
6556 next_element_from_ellipsis (struct it
*it
)
6558 if (it
->selective_display_ellipsis_p
)
6559 setup_for_ellipsis (it
, it
->len
);
6562 /* The face at the current position may be different from the
6563 face we find after the invisible text. Remember what it
6564 was in IT->saved_face_id, and signal that it's there by
6565 setting face_before_selective_p. */
6566 it
->saved_face_id
= it
->face_id
;
6567 it
->method
= GET_FROM_BUFFER
;
6568 it
->object
= it
->w
->buffer
;
6569 reseat_at_next_visible_line_start (it
, 1);
6570 it
->face_before_selective_p
= 1;
6573 return GET_NEXT_DISPLAY_ELEMENT (it
);
6577 /* Deliver an image display element. The iterator IT is already
6578 filled with image information (done in handle_display_prop). Value
6583 next_element_from_image (struct it
*it
)
6585 it
->what
= IT_IMAGE
;
6586 it
->ignore_overlay_strings_at_pos_p
= 0;
6591 /* Fill iterator IT with next display element from a stretch glyph
6592 property. IT->object is the value of the text property. Value is
6596 next_element_from_stretch (struct it
*it
)
6598 it
->what
= IT_STRETCH
;
6602 /* Scan forward from CHARPOS in the current buffer, until we find a
6603 stop position > current IT's position. Then handle the stop
6604 position before that. This is called when we bump into a stop
6605 position while reordering bidirectional text. CHARPOS should be
6606 the last previously processed stop_pos (or BEGV, if none were
6607 processed yet) whose position is less that IT's current
6611 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6613 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6614 struct display_pos save_current
= it
->current
;
6615 struct text_pos save_position
= it
->position
;
6616 struct text_pos pos1
;
6617 EMACS_INT next_stop
;
6619 /* Scan in strict logical order. */
6623 it
->prev_stop
= charpos
;
6624 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6625 reseat_1 (it
, pos1
, 0);
6626 compute_stop_pos (it
);
6627 /* We must advance forward, right? */
6628 if (it
->stop_charpos
<= it
->prev_stop
)
6630 charpos
= it
->stop_charpos
;
6632 while (charpos
<= where_we_are
);
6634 next_stop
= it
->stop_charpos
;
6635 it
->stop_charpos
= it
->prev_stop
;
6637 it
->current
= save_current
;
6638 it
->position
= save_position
;
6640 it
->stop_charpos
= next_stop
;
6643 /* Load IT with the next display element from current_buffer. Value
6644 is zero if end of buffer reached. IT->stop_charpos is the next
6645 position at which to stop and check for text properties or buffer
6649 next_element_from_buffer (struct it
*it
)
6653 xassert (IT_CHARPOS (*it
) >= BEGV
);
6655 /* With bidi reordering, the character to display might not be the
6656 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6657 we were reseat()ed to a new buffer position, which is potentially
6658 a different paragraph. */
6659 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6661 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6662 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6663 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6665 /* Nothing to do, but reset the FIRST_ELT flag, like
6666 bidi_paragraph_init does, because we are not going to
6668 it
->bidi_it
.first_elt
= 0;
6670 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6671 /* FIXME: Should support all Unicode line separators. */
6672 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6673 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6675 /* If we are at the beginning of a line, we can produce the
6676 next element right away. */
6677 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6678 bidi_move_to_visually_next (&it
->bidi_it
);
6682 int orig_bytepos
= IT_BYTEPOS (*it
);
6684 /* We need to prime the bidi iterator starting at the line's
6685 beginning, before we will be able to produce the next
6687 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6688 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6689 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6690 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6691 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6694 /* Now return to buffer position where we were asked to
6695 get the next display element, and produce that. */
6696 bidi_move_to_visually_next (&it
->bidi_it
);
6698 while (it
->bidi_it
.bytepos
!= orig_bytepos
6699 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6702 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6703 /* Adjust IT's position information to where we ended up. */
6704 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6705 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6706 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6708 EMACS_INT stop
= it
->stop_charpos
;
6709 if (it
->bidi_it
.scan_dir
< 0)
6711 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6712 IT_BYTEPOS (*it
), stop
, Qnil
);
6716 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6718 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6720 int overlay_strings_follow_p
;
6722 /* End of the game, except when overlay strings follow that
6723 haven't been returned yet. */
6724 if (it
->overlay_strings_at_end_processed_p
)
6725 overlay_strings_follow_p
= 0;
6728 it
->overlay_strings_at_end_processed_p
= 1;
6729 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6732 if (overlay_strings_follow_p
)
6733 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6737 it
->position
= it
->current
.pos
;
6741 else if (!(!it
->bidi_p
6742 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6743 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6745 /* With bidi non-linear iteration, we could find ourselves
6746 far beyond the last computed stop_charpos, with several
6747 other stop positions in between that we missed. Scan
6748 them all now, in buffer's logical order, until we find
6749 and handle the last stop_charpos that precedes our
6750 current position. */
6751 handle_stop_backwards (it
, it
->stop_charpos
);
6752 return GET_NEXT_DISPLAY_ELEMENT (it
);
6758 /* Take note of the stop position we just moved across,
6759 for when we will move back across it. */
6760 it
->prev_stop
= it
->stop_charpos
;
6761 /* If we are at base paragraph embedding level, take
6762 note of the last stop position seen at this
6764 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6765 it
->base_level_stop
= it
->stop_charpos
;
6768 return GET_NEXT_DISPLAY_ELEMENT (it
);
6772 /* We can sometimes back up for reasons that have nothing
6773 to do with bidi reordering. E.g., compositions. The
6774 code below is only needed when we are above the base
6775 embedding level, so test for that explicitly. */
6776 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6777 && IT_CHARPOS (*it
) < it
->prev_stop
)
6779 if (it
->base_level_stop
<= 0)
6780 it
->base_level_stop
= BEGV
;
6781 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6783 handle_stop_backwards (it
, it
->base_level_stop
);
6784 return GET_NEXT_DISPLAY_ELEMENT (it
);
6788 /* No face changes, overlays etc. in sight, so just return a
6789 character from current_buffer. */
6793 /* Maybe run the redisplay end trigger hook. Performance note:
6794 This doesn't seem to cost measurable time. */
6795 if (it
->redisplay_end_trigger_charpos
6797 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6798 run_redisplay_end_trigger_hook (it
);
6800 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6801 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6803 && next_element_from_composition (it
))
6808 /* Get the next character, maybe multibyte. */
6809 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6810 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6811 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6813 it
->c
= *p
, it
->len
= 1;
6815 /* Record what we have and where it came from. */
6816 it
->what
= IT_CHARACTER
;
6817 it
->object
= it
->w
->buffer
;
6818 it
->position
= it
->current
.pos
;
6820 /* Normally we return the character found above, except when we
6821 really want to return an ellipsis for selective display. */
6826 /* A value of selective > 0 means hide lines indented more
6827 than that number of columns. */
6828 if (it
->selective
> 0
6829 && IT_CHARPOS (*it
) + 1 < ZV
6830 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6831 IT_BYTEPOS (*it
) + 1,
6832 (double) it
->selective
)) /* iftc */
6834 success_p
= next_element_from_ellipsis (it
);
6835 it
->dpvec_char_len
= -1;
6838 else if (it
->c
== '\r' && it
->selective
== -1)
6840 /* A value of selective == -1 means that everything from the
6841 CR to the end of the line is invisible, with maybe an
6842 ellipsis displayed for it. */
6843 success_p
= next_element_from_ellipsis (it
);
6844 it
->dpvec_char_len
= -1;
6849 /* Value is zero if end of buffer reached. */
6850 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6855 /* Run the redisplay end trigger hook for IT. */
6858 run_redisplay_end_trigger_hook (struct it
*it
)
6860 Lisp_Object args
[3];
6862 /* IT->glyph_row should be non-null, i.e. we should be actually
6863 displaying something, or otherwise we should not run the hook. */
6864 xassert (it
->glyph_row
);
6866 /* Set up hook arguments. */
6867 args
[0] = Qredisplay_end_trigger_functions
;
6868 args
[1] = it
->window
;
6869 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6870 it
->redisplay_end_trigger_charpos
= 0;
6872 /* Since we are *trying* to run these functions, don't try to run
6873 them again, even if they get an error. */
6874 it
->w
->redisplay_end_trigger
= Qnil
;
6875 Frun_hook_with_args (3, args
);
6877 /* Notice if it changed the face of the character we are on. */
6878 handle_face_prop (it
);
6882 /* Deliver a composition display element. Unlike the other
6883 next_element_from_XXX, this function is not registered in the array
6884 get_next_element[]. It is called from next_element_from_buffer and
6885 next_element_from_string when necessary. */
6888 next_element_from_composition (struct it
*it
)
6890 it
->what
= IT_COMPOSITION
;
6891 it
->len
= it
->cmp_it
.nbytes
;
6892 if (STRINGP (it
->string
))
6896 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6897 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6900 it
->position
= it
->current
.string_pos
;
6901 it
->object
= it
->string
;
6902 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6903 IT_STRING_BYTEPOS (*it
), it
->string
);
6909 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6910 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6913 if (it
->bidi_it
.new_paragraph
)
6914 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6915 /* Resync the bidi iterator with IT's new position.
6916 FIXME: this doesn't support bidirectional text. */
6917 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6918 bidi_move_to_visually_next (&it
->bidi_it
);
6922 it
->position
= it
->current
.pos
;
6923 it
->object
= it
->w
->buffer
;
6924 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6925 IT_BYTEPOS (*it
), Qnil
);
6932 /***********************************************************************
6933 Moving an iterator without producing glyphs
6934 ***********************************************************************/
6936 /* Check if iterator is at a position corresponding to a valid buffer
6937 position after some move_it_ call. */
6939 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6940 ((it)->method == GET_FROM_STRING \
6941 ? IT_STRING_CHARPOS (*it) == 0 \
6945 /* Move iterator IT to a specified buffer or X position within one
6946 line on the display without producing glyphs.
6948 OP should be a bit mask including some or all of these bits:
6949 MOVE_TO_X: Stop upon reaching x-position TO_X.
6950 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6951 Regardless of OP's value, stop upon reaching the end of the display line.
6953 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6954 This means, in particular, that TO_X includes window's horizontal
6957 The return value has several possible values that
6958 say what condition caused the scan to stop:
6960 MOVE_POS_MATCH_OR_ZV
6961 - when TO_POS or ZV was reached.
6964 -when TO_X was reached before TO_POS or ZV were reached.
6967 - when we reached the end of the display area and the line must
6971 - when we reached the end of the display area and the line is
6975 - when we stopped at a line end, i.e. a newline or a CR and selective
6978 static enum move_it_result
6979 move_it_in_display_line_to (struct it
*it
,
6980 EMACS_INT to_charpos
, int to_x
,
6981 enum move_operation_enum op
)
6983 enum move_it_result result
= MOVE_UNDEFINED
;
6984 struct glyph_row
*saved_glyph_row
;
6985 struct it wrap_it
, atpos_it
, atx_it
;
6987 enum it_method prev_method
= it
->method
;
6988 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6990 /* Don't produce glyphs in produce_glyphs. */
6991 saved_glyph_row
= it
->glyph_row
;
6992 it
->glyph_row
= NULL
;
6994 /* Use wrap_it to save a copy of IT wherever a word wrap could
6995 occur. Use atpos_it to save a copy of IT at the desired buffer
6996 position, if found, so that we can scan ahead and check if the
6997 word later overshoots the window edge. Use atx_it similarly, for
7003 #define BUFFER_POS_REACHED_P() \
7004 ((op & MOVE_TO_POS) != 0 \
7005 && BUFFERP (it->object) \
7006 && (IT_CHARPOS (*it) == to_charpos \
7007 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7008 && (it->method == GET_FROM_BUFFER \
7009 || (it->method == GET_FROM_DISPLAY_VECTOR \
7010 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7012 /* If there's a line-/wrap-prefix, handle it. */
7013 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7014 && it
->current_y
< it
->last_visible_y
)
7015 handle_line_prefix (it
);
7019 int x
, i
, ascent
= 0, descent
= 0;
7021 /* Utility macro to reset an iterator with x, ascent, and descent. */
7022 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7023 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7024 (IT)->max_descent = descent)
7026 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7028 if ((op
& MOVE_TO_POS
) != 0
7029 && BUFFERP (it
->object
)
7030 && it
->method
== GET_FROM_BUFFER
7031 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7033 && (prev_method
== GET_FROM_IMAGE
7034 || prev_method
== GET_FROM_STRETCH
)
7035 /* Passed TO_CHARPOS from left to right. */
7036 && ((prev_pos
< to_charpos
7037 && IT_CHARPOS (*it
) > to_charpos
)
7038 /* Passed TO_CHARPOS from right to left. */
7039 || (prev_pos
> to_charpos
7040 && IT_CHARPOS (*it
) < to_charpos
)))))
7042 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7044 result
= MOVE_POS_MATCH_OR_ZV
;
7047 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7048 /* If wrap_it is valid, the current position might be in a
7049 word that is wrapped. So, save the iterator in
7050 atpos_it and continue to see if wrapping happens. */
7054 prev_method
= it
->method
;
7055 if (it
->method
== GET_FROM_BUFFER
)
7056 prev_pos
= IT_CHARPOS (*it
);
7057 /* Stop when ZV reached.
7058 We used to stop here when TO_CHARPOS reached as well, but that is
7059 too soon if this glyph does not fit on this line. So we handle it
7060 explicitly below. */
7061 if (!get_next_display_element (it
))
7063 result
= MOVE_POS_MATCH_OR_ZV
;
7067 if (it
->line_wrap
== TRUNCATE
)
7069 if (BUFFER_POS_REACHED_P ())
7071 result
= MOVE_POS_MATCH_OR_ZV
;
7077 if (it
->line_wrap
== WORD_WRAP
)
7079 if (IT_DISPLAYING_WHITESPACE (it
))
7083 /* We have reached a glyph that follows one or more
7084 whitespace characters. If the position is
7085 already found, we are done. */
7086 if (atpos_it
.sp
>= 0)
7089 result
= MOVE_POS_MATCH_OR_ZV
;
7095 result
= MOVE_X_REACHED
;
7098 /* Otherwise, we can wrap here. */
7105 /* Remember the line height for the current line, in case
7106 the next element doesn't fit on the line. */
7107 ascent
= it
->max_ascent
;
7108 descent
= it
->max_descent
;
7110 /* The call to produce_glyphs will get the metrics of the
7111 display element IT is loaded with. Record the x-position
7112 before this display element, in case it doesn't fit on the
7116 PRODUCE_GLYPHS (it
);
7118 if (it
->area
!= TEXT_AREA
)
7120 set_iterator_to_next (it
, 1);
7124 /* The number of glyphs we get back in IT->nglyphs will normally
7125 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7126 character on a terminal frame, or (iii) a line end. For the
7127 second case, IT->nglyphs - 1 padding glyphs will be present.
7128 (On X frames, there is only one glyph produced for a
7129 composite character.)
7131 The behavior implemented below means, for continuation lines,
7132 that as many spaces of a TAB as fit on the current line are
7133 displayed there. For terminal frames, as many glyphs of a
7134 multi-glyph character are displayed in the current line, too.
7135 This is what the old redisplay code did, and we keep it that
7136 way. Under X, the whole shape of a complex character must
7137 fit on the line or it will be completely displayed in the
7140 Note that both for tabs and padding glyphs, all glyphs have
7144 /* More than one glyph or glyph doesn't fit on line. All
7145 glyphs have the same width. */
7146 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7148 int x_before_this_char
= x
;
7149 int hpos_before_this_char
= it
->hpos
;
7151 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7153 new_x
= x
+ single_glyph_width
;
7155 /* We want to leave anything reaching TO_X to the caller. */
7156 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7158 if (BUFFER_POS_REACHED_P ())
7160 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7161 goto buffer_pos_reached
;
7162 if (atpos_it
.sp
< 0)
7165 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7170 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7173 result
= MOVE_X_REACHED
;
7179 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7184 if (/* Lines are continued. */
7185 it
->line_wrap
!= TRUNCATE
7186 && (/* And glyph doesn't fit on the line. */
7187 new_x
> it
->last_visible_x
7188 /* Or it fits exactly and we're on a window
7190 || (new_x
== it
->last_visible_x
7191 && FRAME_WINDOW_P (it
->f
))))
7193 if (/* IT->hpos == 0 means the very first glyph
7194 doesn't fit on the line, e.g. a wide image. */
7196 || (new_x
== it
->last_visible_x
7197 && FRAME_WINDOW_P (it
->f
)))
7200 it
->current_x
= new_x
;
7202 /* The character's last glyph just barely fits
7204 if (i
== it
->nglyphs
- 1)
7206 /* If this is the destination position,
7207 return a position *before* it in this row,
7208 now that we know it fits in this row. */
7209 if (BUFFER_POS_REACHED_P ())
7211 if (it
->line_wrap
!= WORD_WRAP
7214 it
->hpos
= hpos_before_this_char
;
7215 it
->current_x
= x_before_this_char
;
7216 result
= MOVE_POS_MATCH_OR_ZV
;
7219 if (it
->line_wrap
== WORD_WRAP
7223 atpos_it
.current_x
= x_before_this_char
;
7224 atpos_it
.hpos
= hpos_before_this_char
;
7228 set_iterator_to_next (it
, 1);
7229 /* On graphical terminals, newlines may
7230 "overflow" into the fringe if
7231 overflow-newline-into-fringe is non-nil.
7232 On text-only terminals, newlines may
7233 overflow into the last glyph on the
7235 if (!FRAME_WINDOW_P (it
->f
)
7236 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7238 if (!get_next_display_element (it
))
7240 result
= MOVE_POS_MATCH_OR_ZV
;
7243 if (BUFFER_POS_REACHED_P ())
7245 if (ITERATOR_AT_END_OF_LINE_P (it
))
7246 result
= MOVE_POS_MATCH_OR_ZV
;
7248 result
= MOVE_LINE_CONTINUED
;
7251 if (ITERATOR_AT_END_OF_LINE_P (it
))
7253 result
= MOVE_NEWLINE_OR_CR
;
7260 IT_RESET_X_ASCENT_DESCENT (it
);
7262 if (wrap_it
.sp
>= 0)
7269 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7271 result
= MOVE_LINE_CONTINUED
;
7275 if (BUFFER_POS_REACHED_P ())
7277 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7278 goto buffer_pos_reached
;
7279 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7282 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7286 if (new_x
> it
->first_visible_x
)
7288 /* Glyph is visible. Increment number of glyphs that
7289 would be displayed. */
7294 if (result
!= MOVE_UNDEFINED
)
7297 else if (BUFFER_POS_REACHED_P ())
7300 IT_RESET_X_ASCENT_DESCENT (it
);
7301 result
= MOVE_POS_MATCH_OR_ZV
;
7304 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7306 /* Stop when TO_X specified and reached. This check is
7307 necessary here because of lines consisting of a line end,
7308 only. The line end will not produce any glyphs and we
7309 would never get MOVE_X_REACHED. */
7310 xassert (it
->nglyphs
== 0);
7311 result
= MOVE_X_REACHED
;
7315 /* Is this a line end? If yes, we're done. */
7316 if (ITERATOR_AT_END_OF_LINE_P (it
))
7318 result
= MOVE_NEWLINE_OR_CR
;
7322 if (it
->method
== GET_FROM_BUFFER
)
7323 prev_pos
= IT_CHARPOS (*it
);
7324 /* The current display element has been consumed. Advance
7326 set_iterator_to_next (it
, 1);
7328 /* Stop if lines are truncated and IT's current x-position is
7329 past the right edge of the window now. */
7330 if (it
->line_wrap
== TRUNCATE
7331 && it
->current_x
>= it
->last_visible_x
)
7333 if (!FRAME_WINDOW_P (it
->f
)
7334 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7336 if (!get_next_display_element (it
)
7337 || BUFFER_POS_REACHED_P ())
7339 result
= MOVE_POS_MATCH_OR_ZV
;
7342 if (ITERATOR_AT_END_OF_LINE_P (it
))
7344 result
= MOVE_NEWLINE_OR_CR
;
7348 result
= MOVE_LINE_TRUNCATED
;
7351 #undef IT_RESET_X_ASCENT_DESCENT
7354 #undef BUFFER_POS_REACHED_P
7356 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7357 restore the saved iterator. */
7358 if (atpos_it
.sp
>= 0)
7360 else if (atx_it
.sp
>= 0)
7365 /* Restore the iterator settings altered at the beginning of this
7367 it
->glyph_row
= saved_glyph_row
;
7371 /* For external use. */
7373 move_it_in_display_line (struct it
*it
,
7374 EMACS_INT to_charpos
, int to_x
,
7375 enum move_operation_enum op
)
7377 if (it
->line_wrap
== WORD_WRAP
7378 && (op
& MOVE_TO_X
))
7380 struct it save_it
= *it
;
7381 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7382 /* When word-wrap is on, TO_X may lie past the end
7383 of a wrapped line. Then it->current is the
7384 character on the next line, so backtrack to the
7385 space before the wrap point. */
7386 if (skip
== MOVE_LINE_CONTINUED
)
7388 int prev_x
= max (it
->current_x
- 1, 0);
7390 move_it_in_display_line_to
7391 (it
, -1, prev_x
, MOVE_TO_X
);
7395 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7399 /* Move IT forward until it satisfies one or more of the criteria in
7400 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7402 OP is a bit-mask that specifies where to stop, and in particular,
7403 which of those four position arguments makes a difference. See the
7404 description of enum move_operation_enum.
7406 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7407 screen line, this function will set IT to the next position >
7411 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7413 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7414 int line_height
, line_start_x
= 0, reached
= 0;
7418 if (op
& MOVE_TO_VPOS
)
7420 /* If no TO_CHARPOS and no TO_X specified, stop at the
7421 start of the line TO_VPOS. */
7422 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7424 if (it
->vpos
== to_vpos
)
7430 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7434 /* TO_VPOS >= 0 means stop at TO_X in the line at
7435 TO_VPOS, or at TO_POS, whichever comes first. */
7436 if (it
->vpos
== to_vpos
)
7442 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7444 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7449 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7451 /* We have reached TO_X but not in the line we want. */
7452 skip
= move_it_in_display_line_to (it
, to_charpos
,
7454 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7462 else if (op
& MOVE_TO_Y
)
7464 struct it it_backup
;
7466 if (it
->line_wrap
== WORD_WRAP
)
7469 /* TO_Y specified means stop at TO_X in the line containing
7470 TO_Y---or at TO_CHARPOS if this is reached first. The
7471 problem is that we can't really tell whether the line
7472 contains TO_Y before we have completely scanned it, and
7473 this may skip past TO_X. What we do is to first scan to
7476 If TO_X is not specified, use a TO_X of zero. The reason
7477 is to make the outcome of this function more predictable.
7478 If we didn't use TO_X == 0, we would stop at the end of
7479 the line which is probably not what a caller would expect
7481 skip
= move_it_in_display_line_to
7482 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7483 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7485 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7486 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7488 else if (skip
== MOVE_X_REACHED
)
7490 /* If TO_X was reached, we want to know whether TO_Y is
7491 in the line. We know this is the case if the already
7492 scanned glyphs make the line tall enough. Otherwise,
7493 we must check by scanning the rest of the line. */
7494 line_height
= it
->max_ascent
+ it
->max_descent
;
7495 if (to_y
>= it
->current_y
7496 && to_y
< it
->current_y
+ line_height
)
7502 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7503 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7505 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7506 line_height
= it
->max_ascent
+ it
->max_descent
;
7507 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7509 if (to_y
>= it
->current_y
7510 && to_y
< it
->current_y
+ line_height
)
7512 /* If TO_Y is in this line and TO_X was reached
7513 above, we scanned too far. We have to restore
7514 IT's settings to the ones before skipping. */
7521 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7527 /* Check whether TO_Y is in this line. */
7528 line_height
= it
->max_ascent
+ it
->max_descent
;
7529 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7531 if (to_y
>= it
->current_y
7532 && to_y
< it
->current_y
+ line_height
)
7534 /* When word-wrap is on, TO_X may lie past the end
7535 of a wrapped line. Then it->current is the
7536 character on the next line, so backtrack to the
7537 space before the wrap point. */
7538 if (skip
== MOVE_LINE_CONTINUED
7539 && it
->line_wrap
== WORD_WRAP
)
7541 int prev_x
= max (it
->current_x
- 1, 0);
7543 skip
= move_it_in_display_line_to
7544 (it
, -1, prev_x
, MOVE_TO_X
);
7553 else if (BUFFERP (it
->object
)
7554 && (it
->method
== GET_FROM_BUFFER
7555 || it
->method
== GET_FROM_STRETCH
)
7556 && IT_CHARPOS (*it
) >= to_charpos
)
7557 skip
= MOVE_POS_MATCH_OR_ZV
;
7559 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7563 case MOVE_POS_MATCH_OR_ZV
:
7567 case MOVE_NEWLINE_OR_CR
:
7568 set_iterator_to_next (it
, 1);
7569 it
->continuation_lines_width
= 0;
7572 case MOVE_LINE_TRUNCATED
:
7573 it
->continuation_lines_width
= 0;
7574 reseat_at_next_visible_line_start (it
, 0);
7575 if ((op
& MOVE_TO_POS
) != 0
7576 && IT_CHARPOS (*it
) > to_charpos
)
7583 case MOVE_LINE_CONTINUED
:
7584 /* For continued lines ending in a tab, some of the glyphs
7585 associated with the tab are displayed on the current
7586 line. Since it->current_x does not include these glyphs,
7587 we use it->last_visible_x instead. */
7590 it
->continuation_lines_width
+= it
->last_visible_x
;
7591 /* When moving by vpos, ensure that the iterator really
7592 advances to the next line (bug#847, bug#969). Fixme:
7593 do we need to do this in other circumstances? */
7594 if (it
->current_x
!= it
->last_visible_x
7595 && (op
& MOVE_TO_VPOS
)
7596 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7598 line_start_x
= it
->current_x
+ it
->pixel_width
7599 - it
->last_visible_x
;
7600 set_iterator_to_next (it
, 0);
7604 it
->continuation_lines_width
+= it
->current_x
;
7611 /* Reset/increment for the next run. */
7612 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7613 it
->current_x
= line_start_x
;
7616 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7618 last_height
= it
->max_ascent
+ it
->max_descent
;
7619 last_max_ascent
= it
->max_ascent
;
7620 it
->max_ascent
= it
->max_descent
= 0;
7625 /* On text terminals, we may stop at the end of a line in the middle
7626 of a multi-character glyph. If the glyph itself is continued,
7627 i.e. it is actually displayed on the next line, don't treat this
7628 stopping point as valid; move to the next line instead (unless
7629 that brings us offscreen). */
7630 if (!FRAME_WINDOW_P (it
->f
)
7632 && IT_CHARPOS (*it
) == to_charpos
7633 && it
->what
== IT_CHARACTER
7635 && it
->line_wrap
== WINDOW_WRAP
7636 && it
->current_x
== it
->last_visible_x
- 1
7639 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7641 it
->continuation_lines_width
+= it
->current_x
;
7642 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7643 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7645 last_height
= it
->max_ascent
+ it
->max_descent
;
7646 last_max_ascent
= it
->max_ascent
;
7649 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7653 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7655 If DY > 0, move IT backward at least that many pixels. DY = 0
7656 means move IT backward to the preceding line start or BEGV. This
7657 function may move over more than DY pixels if IT->current_y - DY
7658 ends up in the middle of a line; in this case IT->current_y will be
7659 set to the top of the line moved to. */
7662 move_it_vertically_backward (struct it
*it
, int dy
)
7671 start_pos
= IT_CHARPOS (*it
);
7673 /* Estimate how many newlines we must move back. */
7674 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7676 /* Set the iterator's position that many lines back. */
7677 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7678 back_to_previous_visible_line_start (it
);
7680 /* Reseat the iterator here. When moving backward, we don't want
7681 reseat to skip forward over invisible text, set up the iterator
7682 to deliver from overlay strings at the new position etc. So,
7683 use reseat_1 here. */
7684 reseat_1 (it
, it
->current
.pos
, 1);
7686 /* We are now surely at a line start. */
7687 it
->current_x
= it
->hpos
= 0;
7688 it
->continuation_lines_width
= 0;
7690 /* Move forward and see what y-distance we moved. First move to the
7691 start of the next line so that we get its height. We need this
7692 height to be able to tell whether we reached the specified
7695 it2
.max_ascent
= it2
.max_descent
= 0;
7698 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7699 MOVE_TO_POS
| MOVE_TO_VPOS
);
7701 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7702 xassert (IT_CHARPOS (*it
) >= BEGV
);
7705 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7706 xassert (IT_CHARPOS (*it
) >= BEGV
);
7707 /* H is the actual vertical distance from the position in *IT
7708 and the starting position. */
7709 h
= it2
.current_y
- it
->current_y
;
7710 /* NLINES is the distance in number of lines. */
7711 nlines
= it2
.vpos
- it
->vpos
;
7713 /* Correct IT's y and vpos position
7714 so that they are relative to the starting point. */
7720 /* DY == 0 means move to the start of the screen line. The
7721 value of nlines is > 0 if continuation lines were involved. */
7723 move_it_by_lines (it
, nlines
, 1);
7727 /* The y-position we try to reach, relative to *IT.
7728 Note that H has been subtracted in front of the if-statement. */
7729 int target_y
= it
->current_y
+ h
- dy
;
7730 int y0
= it3
.current_y
;
7731 int y1
= line_bottom_y (&it3
);
7732 int line_height
= y1
- y0
;
7734 /* If we did not reach target_y, try to move further backward if
7735 we can. If we moved too far backward, try to move forward. */
7736 if (target_y
< it
->current_y
7737 /* This is heuristic. In a window that's 3 lines high, with
7738 a line height of 13 pixels each, recentering with point
7739 on the bottom line will try to move -39/2 = 19 pixels
7740 backward. Try to avoid moving into the first line. */
7741 && (it
->current_y
- target_y
7742 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7743 && IT_CHARPOS (*it
) > BEGV
)
7745 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7746 target_y
- it
->current_y
));
7747 dy
= it
->current_y
- target_y
;
7748 goto move_further_back
;
7750 else if (target_y
>= it
->current_y
+ line_height
7751 && IT_CHARPOS (*it
) < ZV
)
7753 /* Should move forward by at least one line, maybe more.
7755 Note: Calling move_it_by_lines can be expensive on
7756 terminal frames, where compute_motion is used (via
7757 vmotion) to do the job, when there are very long lines
7758 and truncate-lines is nil. That's the reason for
7759 treating terminal frames specially here. */
7761 if (!FRAME_WINDOW_P (it
->f
))
7762 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7767 move_it_by_lines (it
, 1, 1);
7769 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7776 /* Move IT by a specified amount of pixel lines DY. DY negative means
7777 move backwards. DY = 0 means move to start of screen line. At the
7778 end, IT will be on the start of a screen line. */
7781 move_it_vertically (struct it
*it
, int dy
)
7784 move_it_vertically_backward (it
, -dy
);
7787 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7788 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7789 MOVE_TO_POS
| MOVE_TO_Y
);
7790 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7792 /* If buffer ends in ZV without a newline, move to the start of
7793 the line to satisfy the post-condition. */
7794 if (IT_CHARPOS (*it
) == ZV
7796 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7797 move_it_by_lines (it
, 0, 0);
7802 /* Move iterator IT past the end of the text line it is in. */
7805 move_it_past_eol (struct it
*it
)
7807 enum move_it_result rc
;
7809 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7810 if (rc
== MOVE_NEWLINE_OR_CR
)
7811 set_iterator_to_next (it
, 0);
7815 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7816 negative means move up. DVPOS == 0 means move to the start of the
7817 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7818 NEED_Y_P is zero, IT->current_y will be left unchanged.
7820 Further optimization ideas: If we would know that IT->f doesn't use
7821 a face with proportional font, we could be faster for
7822 truncate-lines nil. */
7825 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7827 struct position pos
;
7829 /* The commented-out optimization uses vmotion on terminals. This
7830 gives bad results, because elements like it->what, on which
7831 callers such as pos_visible_p rely, aren't updated. */
7832 /* if (!FRAME_WINDOW_P (it->f))
7834 struct text_pos textpos;
7836 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7837 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7838 reseat (it, textpos, 1);
7839 it->vpos += pos.vpos;
7840 it->current_y += pos.vpos;
7846 /* DVPOS == 0 means move to the start of the screen line. */
7847 move_it_vertically_backward (it
, 0);
7848 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7849 /* Let next call to line_bottom_y calculate real line height */
7854 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7855 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7856 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7861 int start_charpos
, i
;
7863 /* Start at the beginning of the screen line containing IT's
7864 position. This may actually move vertically backwards,
7865 in case of overlays, so adjust dvpos accordingly. */
7867 move_it_vertically_backward (it
, 0);
7870 /* Go back -DVPOS visible lines and reseat the iterator there. */
7871 start_charpos
= IT_CHARPOS (*it
);
7872 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7873 back_to_previous_visible_line_start (it
);
7874 reseat (it
, it
->current
.pos
, 1);
7876 /* Move further back if we end up in a string or an image. */
7877 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7879 /* First try to move to start of display line. */
7881 move_it_vertically_backward (it
, 0);
7883 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7885 /* If start of line is still in string or image,
7886 move further back. */
7887 back_to_previous_visible_line_start (it
);
7888 reseat (it
, it
->current
.pos
, 1);
7892 it
->current_x
= it
->hpos
= 0;
7894 /* Above call may have moved too far if continuation lines
7895 are involved. Scan forward and see if it did. */
7897 it2
.vpos
= it2
.current_y
= 0;
7898 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7899 it
->vpos
-= it2
.vpos
;
7900 it
->current_y
-= it2
.current_y
;
7901 it
->current_x
= it
->hpos
= 0;
7903 /* If we moved too far back, move IT some lines forward. */
7904 if (it2
.vpos
> -dvpos
)
7906 int delta
= it2
.vpos
+ dvpos
;
7908 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7909 /* Move back again if we got too far ahead. */
7910 if (IT_CHARPOS (*it
) >= start_charpos
)
7916 /* Return 1 if IT points into the middle of a display vector. */
7919 in_display_vector_p (struct it
*it
)
7921 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7922 && it
->current
.dpvec_index
> 0
7923 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7927 /***********************************************************************
7929 ***********************************************************************/
7932 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7936 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7938 Lisp_Object args
[3];
7939 Lisp_Object msg
, fmt
;
7942 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7945 /* Do nothing if called asynchronously. Inserting text into
7946 a buffer may call after-change-functions and alike and
7947 that would means running Lisp asynchronously. */
7948 if (handling_signal
)
7952 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7954 args
[0] = fmt
= build_string (format
);
7957 msg
= Fformat (3, args
);
7959 len
= SBYTES (msg
) + 1;
7960 SAFE_ALLOCA (buffer
, char *, len
);
7961 memcpy (buffer
, SDATA (msg
), len
);
7963 message_dolog (buffer
, len
- 1, 1, 0);
7970 /* Output a newline in the *Messages* buffer if "needs" one. */
7973 message_log_maybe_newline (void)
7975 if (message_log_need_newline
)
7976 message_dolog ("", 0, 1, 0);
7980 /* Add a string M of length NBYTES to the message log, optionally
7981 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7982 nonzero, means interpret the contents of M as multibyte. This
7983 function calls low-level routines in order to bypass text property
7984 hooks, etc. which might not be safe to run.
7986 This may GC (insert may run before/after change hooks),
7987 so the buffer M must NOT point to a Lisp string. */
7990 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
7992 if (!NILP (Vmemory_full
))
7995 if (!NILP (Vmessage_log_max
))
7997 struct buffer
*oldbuf
;
7998 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7999 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8000 int point_at_end
= 0;
8002 Lisp_Object old_deactivate_mark
, tem
;
8003 struct gcpro gcpro1
;
8005 old_deactivate_mark
= Vdeactivate_mark
;
8006 oldbuf
= current_buffer
;
8007 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8008 current_buffer
->undo_list
= Qt
;
8010 oldpoint
= message_dolog_marker1
;
8011 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8012 oldbegv
= message_dolog_marker2
;
8013 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8014 oldzv
= message_dolog_marker3
;
8015 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8016 GCPRO1 (old_deactivate_mark
);
8024 BEGV_BYTE
= BEG_BYTE
;
8027 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8029 /* Insert the string--maybe converting multibyte to single byte
8030 or vice versa, so that all the text fits the buffer. */
8032 && NILP (current_buffer
->enable_multibyte_characters
))
8034 int i
, c
, char_bytes
;
8035 unsigned char work
[1];
8037 /* Convert a multibyte string to single-byte
8038 for the *Message* buffer. */
8039 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8041 c
= string_char_and_length (m
+ i
, &char_bytes
);
8042 work
[0] = (ASCII_CHAR_P (c
)
8044 : multibyte_char_to_unibyte (c
, Qnil
));
8045 insert_1_both (work
, 1, 1, 1, 0, 0);
8048 else if (! multibyte
8049 && ! NILP (current_buffer
->enable_multibyte_characters
))
8051 int i
, c
, char_bytes
;
8052 unsigned char *msg
= (unsigned char *) m
;
8053 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8054 /* Convert a single-byte string to multibyte
8055 for the *Message* buffer. */
8056 for (i
= 0; i
< nbytes
; i
++)
8059 MAKE_CHAR_MULTIBYTE (c
);
8060 char_bytes
= CHAR_STRING (c
, str
);
8061 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8065 insert_1 (m
, nbytes
, 1, 0, 0);
8069 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8070 insert_1 ("\n", 1, 1, 0, 0);
8072 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8074 this_bol_byte
= PT_BYTE
;
8076 /* See if this line duplicates the previous one.
8077 If so, combine duplicates. */
8080 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8082 prev_bol_byte
= PT_BYTE
;
8084 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8085 this_bol
, this_bol_byte
);
8088 del_range_both (prev_bol
, prev_bol_byte
,
8089 this_bol
, this_bol_byte
, 0);
8095 /* If you change this format, don't forget to also
8096 change message_log_check_duplicate. */
8097 sprintf (dupstr
, " [%d times]", dup
);
8098 duplen
= strlen (dupstr
);
8099 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8100 insert_1 (dupstr
, duplen
, 1, 0, 1);
8105 /* If we have more than the desired maximum number of lines
8106 in the *Messages* buffer now, delete the oldest ones.
8107 This is safe because we don't have undo in this buffer. */
8109 if (NATNUMP (Vmessage_log_max
))
8111 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8112 -XFASTINT (Vmessage_log_max
) - 1, 0);
8113 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8116 BEGV
= XMARKER (oldbegv
)->charpos
;
8117 BEGV_BYTE
= marker_byte_position (oldbegv
);
8126 ZV
= XMARKER (oldzv
)->charpos
;
8127 ZV_BYTE
= marker_byte_position (oldzv
);
8131 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8133 /* We can't do Fgoto_char (oldpoint) because it will run some
8135 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8136 XMARKER (oldpoint
)->bytepos
);
8139 unchain_marker (XMARKER (oldpoint
));
8140 unchain_marker (XMARKER (oldbegv
));
8141 unchain_marker (XMARKER (oldzv
));
8143 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8144 set_buffer_internal (oldbuf
);
8146 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8147 message_log_need_newline
= !nlflag
;
8148 Vdeactivate_mark
= old_deactivate_mark
;
8153 /* We are at the end of the buffer after just having inserted a newline.
8154 (Note: We depend on the fact we won't be crossing the gap.)
8155 Check to see if the most recent message looks a lot like the previous one.
8156 Return 0 if different, 1 if the new one should just replace it, or a
8157 value N > 1 if we should also append " [N times]". */
8160 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8161 int this_bol
, int this_bol_byte
)
8164 int len
= Z_BYTE
- 1 - this_bol_byte
;
8166 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8167 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8169 for (i
= 0; i
< len
; i
++)
8171 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8179 if (*p1
++ == ' ' && *p1
++ == '[')
8182 while (*p1
>= '0' && *p1
<= '9')
8183 n
= n
* 10 + *p1
++ - '0';
8184 if (strncmp (p1
, " times]\n", 8) == 0)
8191 /* Display an echo area message M with a specified length of NBYTES
8192 bytes. The string may include null characters. If M is 0, clear
8193 out any existing message, and let the mini-buffer text show
8196 This may GC, so the buffer M must NOT point to a Lisp string. */
8199 message2 (const char *m
, int nbytes
, int multibyte
)
8201 /* First flush out any partial line written with print. */
8202 message_log_maybe_newline ();
8204 message_dolog (m
, nbytes
, 1, multibyte
);
8205 message2_nolog (m
, nbytes
, multibyte
);
8209 /* The non-logging counterpart of message2. */
8212 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8214 struct frame
*sf
= SELECTED_FRAME ();
8215 message_enable_multibyte
= multibyte
;
8217 if (FRAME_INITIAL_P (sf
))
8219 if (noninteractive_need_newline
)
8220 putc ('\n', stderr
);
8221 noninteractive_need_newline
= 0;
8223 fwrite (m
, nbytes
, 1, stderr
);
8224 if (cursor_in_echo_area
== 0)
8225 fprintf (stderr
, "\n");
8228 /* A null message buffer means that the frame hasn't really been
8229 initialized yet. Error messages get reported properly by
8230 cmd_error, so this must be just an informative message; toss it. */
8231 else if (INTERACTIVE
8232 && sf
->glyphs_initialized_p
8233 && FRAME_MESSAGE_BUF (sf
))
8235 Lisp_Object mini_window
;
8238 /* Get the frame containing the mini-buffer
8239 that the selected frame is using. */
8240 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8241 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8243 FRAME_SAMPLE_VISIBILITY (f
);
8244 if (FRAME_VISIBLE_P (sf
)
8245 && ! FRAME_VISIBLE_P (f
))
8246 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8250 set_message (m
, Qnil
, nbytes
, multibyte
);
8251 if (minibuffer_auto_raise
)
8252 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8255 clear_message (1, 1);
8257 do_pending_window_change (0);
8258 echo_area_display (1);
8259 do_pending_window_change (0);
8260 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8261 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8266 /* Display an echo area message M with a specified length of NBYTES
8267 bytes. The string may include null characters. If M is not a
8268 string, clear out any existing message, and let the mini-buffer
8271 This function cancels echoing. */
8274 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8276 struct gcpro gcpro1
;
8279 clear_message (1,1);
8282 /* First flush out any partial line written with print. */
8283 message_log_maybe_newline ();
8289 SAFE_ALLOCA (buffer
, char *, nbytes
);
8290 memcpy (buffer
, SDATA (m
), nbytes
);
8291 message_dolog (buffer
, nbytes
, 1, multibyte
);
8294 message3_nolog (m
, nbytes
, multibyte
);
8300 /* The non-logging version of message3.
8301 This does not cancel echoing, because it is used for echoing.
8302 Perhaps we need to make a separate function for echoing
8303 and make this cancel echoing. */
8306 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8308 struct frame
*sf
= SELECTED_FRAME ();
8309 message_enable_multibyte
= multibyte
;
8311 if (FRAME_INITIAL_P (sf
))
8313 if (noninteractive_need_newline
)
8314 putc ('\n', stderr
);
8315 noninteractive_need_newline
= 0;
8317 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8318 if (cursor_in_echo_area
== 0)
8319 fprintf (stderr
, "\n");
8322 /* A null message buffer means that the frame hasn't really been
8323 initialized yet. Error messages get reported properly by
8324 cmd_error, so this must be just an informative message; toss it. */
8325 else if (INTERACTIVE
8326 && sf
->glyphs_initialized_p
8327 && FRAME_MESSAGE_BUF (sf
))
8329 Lisp_Object mini_window
;
8333 /* Get the frame containing the mini-buffer
8334 that the selected frame is using. */
8335 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8336 frame
= XWINDOW (mini_window
)->frame
;
8339 FRAME_SAMPLE_VISIBILITY (f
);
8340 if (FRAME_VISIBLE_P (sf
)
8341 && !FRAME_VISIBLE_P (f
))
8342 Fmake_frame_visible (frame
);
8344 if (STRINGP (m
) && SCHARS (m
) > 0)
8346 set_message (NULL
, m
, nbytes
, multibyte
);
8347 if (minibuffer_auto_raise
)
8348 Fraise_frame (frame
);
8349 /* Assume we are not echoing.
8350 (If we are, echo_now will override this.) */
8351 echo_message_buffer
= Qnil
;
8354 clear_message (1, 1);
8356 do_pending_window_change (0);
8357 echo_area_display (1);
8358 do_pending_window_change (0);
8359 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8360 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8365 /* Display a null-terminated echo area message M. If M is 0, clear
8366 out any existing message, and let the mini-buffer text show through.
8368 The buffer M must continue to exist until after the echo area gets
8369 cleared or some other message gets displayed there. Do not pass
8370 text that is stored in a Lisp string. Do not pass text in a buffer
8371 that was alloca'd. */
8374 message1 (const char *m
)
8376 message2 (m
, (m
? strlen (m
) : 0), 0);
8380 /* The non-logging counterpart of message1. */
8383 message1_nolog (const char *m
)
8385 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8388 /* Display a message M which contains a single %s
8389 which gets replaced with STRING. */
8392 message_with_string (const char *m
, Lisp_Object string
, int log
)
8394 CHECK_STRING (string
);
8400 if (noninteractive_need_newline
)
8401 putc ('\n', stderr
);
8402 noninteractive_need_newline
= 0;
8403 fprintf (stderr
, m
, SDATA (string
));
8404 if (!cursor_in_echo_area
)
8405 fprintf (stderr
, "\n");
8409 else if (INTERACTIVE
)
8411 /* The frame whose minibuffer we're going to display the message on.
8412 It may be larger than the selected frame, so we need
8413 to use its buffer, not the selected frame's buffer. */
8414 Lisp_Object mini_window
;
8415 struct frame
*f
, *sf
= SELECTED_FRAME ();
8417 /* Get the frame containing the minibuffer
8418 that the selected frame is using. */
8419 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8420 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8422 /* A null message buffer means that the frame hasn't really been
8423 initialized yet. Error messages get reported properly by
8424 cmd_error, so this must be just an informative message; toss it. */
8425 if (FRAME_MESSAGE_BUF (f
))
8427 Lisp_Object args
[2], message
;
8428 struct gcpro gcpro1
, gcpro2
;
8430 args
[0] = build_string (m
);
8431 args
[1] = message
= string
;
8432 GCPRO2 (args
[0], message
);
8435 message
= Fformat (2, args
);
8438 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8440 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8444 /* Print should start at the beginning of the message
8445 buffer next time. */
8446 message_buf_print
= 0;
8452 /* Dump an informative message to the minibuf. If M is 0, clear out
8453 any existing message, and let the mini-buffer text show through. */
8456 vmessage (const char *m
, va_list ap
)
8462 if (noninteractive_need_newline
)
8463 putc ('\n', stderr
);
8464 noninteractive_need_newline
= 0;
8465 vfprintf (stderr
, m
, ap
);
8466 if (cursor_in_echo_area
== 0)
8467 fprintf (stderr
, "\n");
8471 else if (INTERACTIVE
)
8473 /* The frame whose mini-buffer we're going to display the message
8474 on. It may be larger than the selected frame, so we need to
8475 use its buffer, not the selected frame's buffer. */
8476 Lisp_Object mini_window
;
8477 struct frame
*f
, *sf
= SELECTED_FRAME ();
8479 /* Get the frame containing the mini-buffer
8480 that the selected frame is using. */
8481 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8482 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8484 /* A null message buffer means that the frame hasn't really been
8485 initialized yet. Error messages get reported properly by
8486 cmd_error, so this must be just an informative message; toss
8488 if (FRAME_MESSAGE_BUF (f
))
8494 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8495 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8497 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8502 /* Print should start at the beginning of the message
8503 buffer next time. */
8504 message_buf_print
= 0;
8510 message (const char *m
, ...)
8519 /* The non-logging version of message. */
8522 message_nolog (const char *m
, ...)
8524 Lisp_Object old_log_max
;
8527 old_log_max
= Vmessage_log_max
;
8528 Vmessage_log_max
= Qnil
;
8530 Vmessage_log_max
= old_log_max
;
8535 /* Display the current message in the current mini-buffer. This is
8536 only called from error handlers in process.c, and is not time
8540 update_echo_area (void)
8542 if (!NILP (echo_area_buffer
[0]))
8545 string
= Fcurrent_message ();
8546 message3 (string
, SBYTES (string
),
8547 !NILP (current_buffer
->enable_multibyte_characters
));
8552 /* Make sure echo area buffers in `echo_buffers' are live.
8553 If they aren't, make new ones. */
8556 ensure_echo_area_buffers (void)
8560 for (i
= 0; i
< 2; ++i
)
8561 if (!BUFFERP (echo_buffer
[i
])
8562 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8565 Lisp_Object old_buffer
;
8568 old_buffer
= echo_buffer
[i
];
8569 sprintf (name
, " *Echo Area %d*", i
);
8570 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8571 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8572 /* to force word wrap in echo area -
8573 it was decided to postpone this*/
8574 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8576 for (j
= 0; j
< 2; ++j
)
8577 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8578 echo_area_buffer
[j
] = echo_buffer
[i
];
8583 /* Call FN with args A1..A4 with either the current or last displayed
8584 echo_area_buffer as current buffer.
8586 WHICH zero means use the current message buffer
8587 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8588 from echo_buffer[] and clear it.
8590 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8591 suitable buffer from echo_buffer[] and clear it.
8593 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8594 that the current message becomes the last displayed one, make
8595 choose a suitable buffer for echo_area_buffer[0], and clear it.
8597 Value is what FN returns. */
8600 with_echo_area_buffer (struct window
*w
, int which
,
8601 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8602 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8605 int this_one
, the_other
, clear_buffer_p
, rc
;
8606 int count
= SPECPDL_INDEX ();
8608 /* If buffers aren't live, make new ones. */
8609 ensure_echo_area_buffers ();
8614 this_one
= 0, the_other
= 1;
8616 this_one
= 1, the_other
= 0;
8619 this_one
= 0, the_other
= 1;
8622 /* We need a fresh one in case the current echo buffer equals
8623 the one containing the last displayed echo area message. */
8624 if (!NILP (echo_area_buffer
[this_one
])
8625 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8626 echo_area_buffer
[this_one
] = Qnil
;
8629 /* Choose a suitable buffer from echo_buffer[] is we don't
8631 if (NILP (echo_area_buffer
[this_one
]))
8633 echo_area_buffer
[this_one
]
8634 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8635 ? echo_buffer
[the_other
]
8636 : echo_buffer
[this_one
]);
8640 buffer
= echo_area_buffer
[this_one
];
8642 /* Don't get confused by reusing the buffer used for echoing
8643 for a different purpose. */
8644 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8647 record_unwind_protect (unwind_with_echo_area_buffer
,
8648 with_echo_area_buffer_unwind_data (w
));
8650 /* Make the echo area buffer current. Note that for display
8651 purposes, it is not necessary that the displayed window's buffer
8652 == current_buffer, except for text property lookup. So, let's
8653 only set that buffer temporarily here without doing a full
8654 Fset_window_buffer. We must also change w->pointm, though,
8655 because otherwise an assertions in unshow_buffer fails, and Emacs
8657 set_buffer_internal_1 (XBUFFER (buffer
));
8661 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8664 current_buffer
->undo_list
= Qt
;
8665 current_buffer
->read_only
= Qnil
;
8666 specbind (Qinhibit_read_only
, Qt
);
8667 specbind (Qinhibit_modification_hooks
, Qt
);
8669 if (clear_buffer_p
&& Z
> BEG
)
8672 xassert (BEGV
>= BEG
);
8673 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8675 rc
= fn (a1
, a2
, a3
, a4
);
8677 xassert (BEGV
>= BEG
);
8678 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8680 unbind_to (count
, Qnil
);
8685 /* Save state that should be preserved around the call to the function
8686 FN called in with_echo_area_buffer. */
8689 with_echo_area_buffer_unwind_data (struct window
*w
)
8692 Lisp_Object vector
, tmp
;
8694 /* Reduce consing by keeping one vector in
8695 Vwith_echo_area_save_vector. */
8696 vector
= Vwith_echo_area_save_vector
;
8697 Vwith_echo_area_save_vector
= Qnil
;
8700 vector
= Fmake_vector (make_number (7), Qnil
);
8702 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8703 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8704 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8708 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8709 ASET (vector
, i
, w
->buffer
); ++i
;
8710 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8711 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8716 for (; i
< end
; ++i
)
8717 ASET (vector
, i
, Qnil
);
8720 xassert (i
== ASIZE (vector
));
8725 /* Restore global state from VECTOR which was created by
8726 with_echo_area_buffer_unwind_data. */
8729 unwind_with_echo_area_buffer (Lisp_Object vector
)
8731 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8732 Vdeactivate_mark
= AREF (vector
, 1);
8733 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8735 if (WINDOWP (AREF (vector
, 3)))
8738 Lisp_Object buffer
, charpos
, bytepos
;
8740 w
= XWINDOW (AREF (vector
, 3));
8741 buffer
= AREF (vector
, 4);
8742 charpos
= AREF (vector
, 5);
8743 bytepos
= AREF (vector
, 6);
8746 set_marker_both (w
->pointm
, buffer
,
8747 XFASTINT (charpos
), XFASTINT (bytepos
));
8750 Vwith_echo_area_save_vector
= vector
;
8755 /* Set up the echo area for use by print functions. MULTIBYTE_P
8756 non-zero means we will print multibyte. */
8759 setup_echo_area_for_printing (int multibyte_p
)
8761 /* If we can't find an echo area any more, exit. */
8762 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8765 ensure_echo_area_buffers ();
8767 if (!message_buf_print
)
8769 /* A message has been output since the last time we printed.
8770 Choose a fresh echo area buffer. */
8771 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8772 echo_area_buffer
[0] = echo_buffer
[1];
8774 echo_area_buffer
[0] = echo_buffer
[0];
8776 /* Switch to that buffer and clear it. */
8777 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8778 current_buffer
->truncate_lines
= Qnil
;
8782 int count
= SPECPDL_INDEX ();
8783 specbind (Qinhibit_read_only
, Qt
);
8784 /* Note that undo recording is always disabled. */
8786 unbind_to (count
, Qnil
);
8788 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8790 /* Set up the buffer for the multibyteness we need. */
8792 != !NILP (current_buffer
->enable_multibyte_characters
))
8793 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8795 /* Raise the frame containing the echo area. */
8796 if (minibuffer_auto_raise
)
8798 struct frame
*sf
= SELECTED_FRAME ();
8799 Lisp_Object mini_window
;
8800 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8801 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8804 message_log_maybe_newline ();
8805 message_buf_print
= 1;
8809 if (NILP (echo_area_buffer
[0]))
8811 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8812 echo_area_buffer
[0] = echo_buffer
[1];
8814 echo_area_buffer
[0] = echo_buffer
[0];
8817 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8819 /* Someone switched buffers between print requests. */
8820 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8821 current_buffer
->truncate_lines
= Qnil
;
8827 /* Display an echo area message in window W. Value is non-zero if W's
8828 height is changed. If display_last_displayed_message_p is
8829 non-zero, display the message that was last displayed, otherwise
8830 display the current message. */
8833 display_echo_area (struct window
*w
)
8835 int i
, no_message_p
, window_height_changed_p
, count
;
8837 /* Temporarily disable garbage collections while displaying the echo
8838 area. This is done because a GC can print a message itself.
8839 That message would modify the echo area buffer's contents while a
8840 redisplay of the buffer is going on, and seriously confuse
8842 count
= inhibit_garbage_collection ();
8844 /* If there is no message, we must call display_echo_area_1
8845 nevertheless because it resizes the window. But we will have to
8846 reset the echo_area_buffer in question to nil at the end because
8847 with_echo_area_buffer will sets it to an empty buffer. */
8848 i
= display_last_displayed_message_p
? 1 : 0;
8849 no_message_p
= NILP (echo_area_buffer
[i
]);
8851 window_height_changed_p
8852 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8853 display_echo_area_1
,
8854 (EMACS_INT
) w
, Qnil
, 0, 0);
8857 echo_area_buffer
[i
] = Qnil
;
8859 unbind_to (count
, Qnil
);
8860 return window_height_changed_p
;
8864 /* Helper for display_echo_area. Display the current buffer which
8865 contains the current echo area message in window W, a mini-window,
8866 a pointer to which is passed in A1. A2..A4 are currently not used.
8867 Change the height of W so that all of the message is displayed.
8868 Value is non-zero if height of W was changed. */
8871 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8873 struct window
*w
= (struct window
*) a1
;
8875 struct text_pos start
;
8876 int window_height_changed_p
= 0;
8878 /* Do this before displaying, so that we have a large enough glyph
8879 matrix for the display. If we can't get enough space for the
8880 whole text, display the last N lines. That works by setting w->start. */
8881 window_height_changed_p
= resize_mini_window (w
, 0);
8883 /* Use the starting position chosen by resize_mini_window. */
8884 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8887 clear_glyph_matrix (w
->desired_matrix
);
8888 XSETWINDOW (window
, w
);
8889 try_window (window
, start
, 0);
8891 return window_height_changed_p
;
8895 /* Resize the echo area window to exactly the size needed for the
8896 currently displayed message, if there is one. If a mini-buffer
8897 is active, don't shrink it. */
8900 resize_echo_area_exactly (void)
8902 if (BUFFERP (echo_area_buffer
[0])
8903 && WINDOWP (echo_area_window
))
8905 struct window
*w
= XWINDOW (echo_area_window
);
8907 Lisp_Object resize_exactly
;
8909 if (minibuf_level
== 0)
8910 resize_exactly
= Qt
;
8912 resize_exactly
= Qnil
;
8914 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8915 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8918 ++windows_or_buffers_changed
;
8919 ++update_mode_lines
;
8920 redisplay_internal (0);
8926 /* Callback function for with_echo_area_buffer, when used from
8927 resize_echo_area_exactly. A1 contains a pointer to the window to
8928 resize, EXACTLY non-nil means resize the mini-window exactly to the
8929 size of the text displayed. A3 and A4 are not used. Value is what
8930 resize_mini_window returns. */
8933 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8935 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8939 /* Resize mini-window W to fit the size of its contents. EXACT_P
8940 means size the window exactly to the size needed. Otherwise, it's
8941 only enlarged until W's buffer is empty.
8943 Set W->start to the right place to begin display. If the whole
8944 contents fit, start at the beginning. Otherwise, start so as
8945 to make the end of the contents appear. This is particularly
8946 important for y-or-n-p, but seems desirable generally.
8948 Value is non-zero if the window height has been changed. */
8951 resize_mini_window (struct window
*w
, int exact_p
)
8953 struct frame
*f
= XFRAME (w
->frame
);
8954 int window_height_changed_p
= 0;
8956 xassert (MINI_WINDOW_P (w
));
8958 /* By default, start display at the beginning. */
8959 set_marker_both (w
->start
, w
->buffer
,
8960 BUF_BEGV (XBUFFER (w
->buffer
)),
8961 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8963 /* Don't resize windows while redisplaying a window; it would
8964 confuse redisplay functions when the size of the window they are
8965 displaying changes from under them. Such a resizing can happen,
8966 for instance, when which-func prints a long message while
8967 we are running fontification-functions. We're running these
8968 functions with safe_call which binds inhibit-redisplay to t. */
8969 if (!NILP (Vinhibit_redisplay
))
8972 /* Nil means don't try to resize. */
8973 if (NILP (Vresize_mini_windows
)
8974 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8977 if (!FRAME_MINIBUF_ONLY_P (f
))
8980 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8981 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8982 int height
, max_height
;
8983 int unit
= FRAME_LINE_HEIGHT (f
);
8984 struct text_pos start
;
8985 struct buffer
*old_current_buffer
= NULL
;
8987 if (current_buffer
!= XBUFFER (w
->buffer
))
8989 old_current_buffer
= current_buffer
;
8990 set_buffer_internal (XBUFFER (w
->buffer
));
8993 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8995 /* Compute the max. number of lines specified by the user. */
8996 if (FLOATP (Vmax_mini_window_height
))
8997 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8998 else if (INTEGERP (Vmax_mini_window_height
))
8999 max_height
= XINT (Vmax_mini_window_height
);
9001 max_height
= total_height
/ 4;
9003 /* Correct that max. height if it's bogus. */
9004 max_height
= max (1, max_height
);
9005 max_height
= min (total_height
, max_height
);
9007 /* Find out the height of the text in the window. */
9008 if (it
.line_wrap
== TRUNCATE
)
9013 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9014 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9015 height
= it
.current_y
+ last_height
;
9017 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9018 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9019 height
= (height
+ unit
- 1) / unit
;
9022 /* Compute a suitable window start. */
9023 if (height
> max_height
)
9025 height
= max_height
;
9026 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9027 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9028 start
= it
.current
.pos
;
9031 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9032 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9034 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9036 /* Let it grow only, until we display an empty message, in which
9037 case the window shrinks again. */
9038 if (height
> WINDOW_TOTAL_LINES (w
))
9040 int old_height
= WINDOW_TOTAL_LINES (w
);
9041 freeze_window_starts (f
, 1);
9042 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9043 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9045 else if (height
< WINDOW_TOTAL_LINES (w
)
9046 && (exact_p
|| BEGV
== ZV
))
9048 int old_height
= WINDOW_TOTAL_LINES (w
);
9049 freeze_window_starts (f
, 0);
9050 shrink_mini_window (w
);
9051 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9056 /* Always resize to exact size needed. */
9057 if (height
> WINDOW_TOTAL_LINES (w
))
9059 int old_height
= WINDOW_TOTAL_LINES (w
);
9060 freeze_window_starts (f
, 1);
9061 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9062 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9064 else if (height
< WINDOW_TOTAL_LINES (w
))
9066 int old_height
= WINDOW_TOTAL_LINES (w
);
9067 freeze_window_starts (f
, 0);
9068 shrink_mini_window (w
);
9072 freeze_window_starts (f
, 1);
9073 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9076 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9080 if (old_current_buffer
)
9081 set_buffer_internal (old_current_buffer
);
9084 return window_height_changed_p
;
9088 /* Value is the current message, a string, or nil if there is no
9092 current_message (void)
9096 if (!BUFFERP (echo_area_buffer
[0]))
9100 with_echo_area_buffer (0, 0, current_message_1
,
9101 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9103 echo_area_buffer
[0] = Qnil
;
9111 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9113 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9116 *msg
= make_buffer_string (BEG
, Z
, 1);
9123 /* Push the current message on Vmessage_stack for later restauration
9124 by restore_message. Value is non-zero if the current message isn't
9125 empty. This is a relatively infrequent operation, so it's not
9126 worth optimizing. */
9132 msg
= current_message ();
9133 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9134 return STRINGP (msg
);
9138 /* Restore message display from the top of Vmessage_stack. */
9141 restore_message (void)
9145 xassert (CONSP (Vmessage_stack
));
9146 msg
= XCAR (Vmessage_stack
);
9148 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9150 message3_nolog (msg
, 0, 0);
9154 /* Handler for record_unwind_protect calling pop_message. */
9157 pop_message_unwind (Lisp_Object dummy
)
9163 /* Pop the top-most entry off Vmessage_stack. */
9168 xassert (CONSP (Vmessage_stack
));
9169 Vmessage_stack
= XCDR (Vmessage_stack
);
9173 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9174 exits. If the stack is not empty, we have a missing pop_message
9178 check_message_stack (void)
9180 if (!NILP (Vmessage_stack
))
9185 /* Truncate to NCHARS what will be displayed in the echo area the next
9186 time we display it---but don't redisplay it now. */
9189 truncate_echo_area (int nchars
)
9192 echo_area_buffer
[0] = Qnil
;
9193 /* A null message buffer means that the frame hasn't really been
9194 initialized yet. Error messages get reported properly by
9195 cmd_error, so this must be just an informative message; toss it. */
9196 else if (!noninteractive
9198 && !NILP (echo_area_buffer
[0]))
9200 struct frame
*sf
= SELECTED_FRAME ();
9201 if (FRAME_MESSAGE_BUF (sf
))
9202 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9207 /* Helper function for truncate_echo_area. Truncate the current
9208 message to at most NCHARS characters. */
9211 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9213 if (BEG
+ nchars
< Z
)
9214 del_range (BEG
+ nchars
, Z
);
9216 echo_area_buffer
[0] = Qnil
;
9221 /* Set the current message to a substring of S or STRING.
9223 If STRING is a Lisp string, set the message to the first NBYTES
9224 bytes from STRING. NBYTES zero means use the whole string. If
9225 STRING is multibyte, the message will be displayed multibyte.
9227 If S is not null, set the message to the first LEN bytes of S. LEN
9228 zero means use the whole string. MULTIBYTE_P non-zero means S is
9229 multibyte. Display the message multibyte in that case.
9231 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9232 to t before calling set_message_1 (which calls insert).
9236 set_message (const char *s
, Lisp_Object string
, int nbytes
, int multibyte_p
)
9238 message_enable_multibyte
9239 = ((s
&& multibyte_p
)
9240 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9242 with_echo_area_buffer (0, -1, set_message_1
,
9243 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9244 message_buf_print
= 0;
9245 help_echo_showing_p
= 0;
9249 /* Helper function for set_message. Arguments have the same meaning
9250 as there, with A1 corresponding to S and A2 corresponding to STRING
9251 This function is called with the echo area buffer being
9255 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9257 const char *s
= (const char *) a1
;
9258 Lisp_Object string
= a2
;
9260 /* Change multibyteness of the echo buffer appropriately. */
9261 if (message_enable_multibyte
9262 != !NILP (current_buffer
->enable_multibyte_characters
))
9263 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9265 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9267 /* Insert new message at BEG. */
9268 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9270 if (STRINGP (string
))
9275 nbytes
= SBYTES (string
);
9276 nchars
= string_byte_to_char (string
, nbytes
);
9278 /* This function takes care of single/multibyte conversion. We
9279 just have to ensure that the echo area buffer has the right
9280 setting of enable_multibyte_characters. */
9281 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9286 nbytes
= strlen (s
);
9288 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9290 /* Convert from multi-byte to single-byte. */
9292 unsigned char work
[1];
9294 /* Convert a multibyte string to single-byte. */
9295 for (i
= 0; i
< nbytes
; i
+= n
)
9297 c
= string_char_and_length (s
+ i
, &n
);
9298 work
[0] = (ASCII_CHAR_P (c
)
9300 : multibyte_char_to_unibyte (c
, Qnil
));
9301 insert_1_both (work
, 1, 1, 1, 0, 0);
9304 else if (!multibyte_p
9305 && !NILP (current_buffer
->enable_multibyte_characters
))
9307 /* Convert from single-byte to multi-byte. */
9309 const unsigned char *msg
= (const unsigned char *) s
;
9310 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9312 /* Convert a single-byte string to multibyte. */
9313 for (i
= 0; i
< nbytes
; i
++)
9316 MAKE_CHAR_MULTIBYTE (c
);
9317 n
= CHAR_STRING (c
, str
);
9318 insert_1_both (str
, 1, n
, 1, 0, 0);
9322 insert_1 (s
, nbytes
, 1, 0, 0);
9329 /* Clear messages. CURRENT_P non-zero means clear the current
9330 message. LAST_DISPLAYED_P non-zero means clear the message
9334 clear_message (int current_p
, int last_displayed_p
)
9338 echo_area_buffer
[0] = Qnil
;
9339 message_cleared_p
= 1;
9342 if (last_displayed_p
)
9343 echo_area_buffer
[1] = Qnil
;
9345 message_buf_print
= 0;
9348 /* Clear garbaged frames.
9350 This function is used where the old redisplay called
9351 redraw_garbaged_frames which in turn called redraw_frame which in
9352 turn called clear_frame. The call to clear_frame was a source of
9353 flickering. I believe a clear_frame is not necessary. It should
9354 suffice in the new redisplay to invalidate all current matrices,
9355 and ensure a complete redisplay of all windows. */
9358 clear_garbaged_frames (void)
9362 Lisp_Object tail
, frame
;
9363 int changed_count
= 0;
9365 FOR_EACH_FRAME (tail
, frame
)
9367 struct frame
*f
= XFRAME (frame
);
9369 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9373 Fredraw_frame (frame
);
9374 f
->force_flush_display_p
= 1;
9376 clear_current_matrices (f
);
9385 ++windows_or_buffers_changed
;
9390 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9391 is non-zero update selected_frame. Value is non-zero if the
9392 mini-windows height has been changed. */
9395 echo_area_display (int update_frame_p
)
9397 Lisp_Object mini_window
;
9400 int window_height_changed_p
= 0;
9401 struct frame
*sf
= SELECTED_FRAME ();
9403 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9404 w
= XWINDOW (mini_window
);
9405 f
= XFRAME (WINDOW_FRAME (w
));
9407 /* Don't display if frame is invisible or not yet initialized. */
9408 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9411 #ifdef HAVE_WINDOW_SYSTEM
9412 /* When Emacs starts, selected_frame may be the initial terminal
9413 frame. If we let this through, a message would be displayed on
9415 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9417 #endif /* HAVE_WINDOW_SYSTEM */
9419 /* Redraw garbaged frames. */
9421 clear_garbaged_frames ();
9423 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9425 echo_area_window
= mini_window
;
9426 window_height_changed_p
= display_echo_area (w
);
9427 w
->must_be_updated_p
= 1;
9429 /* Update the display, unless called from redisplay_internal.
9430 Also don't update the screen during redisplay itself. The
9431 update will happen at the end of redisplay, and an update
9432 here could cause confusion. */
9433 if (update_frame_p
&& !redisplaying_p
)
9437 /* If the display update has been interrupted by pending
9438 input, update mode lines in the frame. Due to the
9439 pending input, it might have been that redisplay hasn't
9440 been called, so that mode lines above the echo area are
9441 garbaged. This looks odd, so we prevent it here. */
9442 if (!display_completed
)
9443 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9445 if (window_height_changed_p
9446 /* Don't do this if Emacs is shutting down. Redisplay
9447 needs to run hooks. */
9448 && !NILP (Vrun_hooks
))
9450 /* Must update other windows. Likewise as in other
9451 cases, don't let this update be interrupted by
9453 int count
= SPECPDL_INDEX ();
9454 specbind (Qredisplay_dont_pause
, Qt
);
9455 windows_or_buffers_changed
= 1;
9456 redisplay_internal (0);
9457 unbind_to (count
, Qnil
);
9459 else if (FRAME_WINDOW_P (f
) && n
== 0)
9461 /* Window configuration is the same as before.
9462 Can do with a display update of the echo area,
9463 unless we displayed some mode lines. */
9464 update_single_window (w
, 1);
9465 FRAME_RIF (f
)->flush_display (f
);
9468 update_frame (f
, 1, 1);
9470 /* If cursor is in the echo area, make sure that the next
9471 redisplay displays the minibuffer, so that the cursor will
9472 be replaced with what the minibuffer wants. */
9473 if (cursor_in_echo_area
)
9474 ++windows_or_buffers_changed
;
9477 else if (!EQ (mini_window
, selected_window
))
9478 windows_or_buffers_changed
++;
9480 /* Last displayed message is now the current message. */
9481 echo_area_buffer
[1] = echo_area_buffer
[0];
9482 /* Inform read_char that we're not echoing. */
9483 echo_message_buffer
= Qnil
;
9485 /* Prevent redisplay optimization in redisplay_internal by resetting
9486 this_line_start_pos. This is done because the mini-buffer now
9487 displays the message instead of its buffer text. */
9488 if (EQ (mini_window
, selected_window
))
9489 CHARPOS (this_line_start_pos
) = 0;
9491 return window_height_changed_p
;
9496 /***********************************************************************
9497 Mode Lines and Frame Titles
9498 ***********************************************************************/
9500 /* A buffer for constructing non-propertized mode-line strings and
9501 frame titles in it; allocated from the heap in init_xdisp and
9502 resized as needed in store_mode_line_noprop_char. */
9504 static char *mode_line_noprop_buf
;
9506 /* The buffer's end, and a current output position in it. */
9508 static char *mode_line_noprop_buf_end
;
9509 static char *mode_line_noprop_ptr
;
9511 #define MODE_LINE_NOPROP_LEN(start) \
9512 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9515 MODE_LINE_DISPLAY
= 0,
9521 /* Alist that caches the results of :propertize.
9522 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9523 static Lisp_Object mode_line_proptrans_alist
;
9525 /* List of strings making up the mode-line. */
9526 static Lisp_Object mode_line_string_list
;
9528 /* Base face property when building propertized mode line string. */
9529 static Lisp_Object mode_line_string_face
;
9530 static Lisp_Object mode_line_string_face_prop
;
9533 /* Unwind data for mode line strings */
9535 static Lisp_Object Vmode_line_unwind_vector
;
9538 format_mode_line_unwind_data (struct buffer
*obuf
,
9542 Lisp_Object vector
, tmp
;
9544 /* Reduce consing by keeping one vector in
9545 Vwith_echo_area_save_vector. */
9546 vector
= Vmode_line_unwind_vector
;
9547 Vmode_line_unwind_vector
= Qnil
;
9550 vector
= Fmake_vector (make_number (8), Qnil
);
9552 ASET (vector
, 0, make_number (mode_line_target
));
9553 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9554 ASET (vector
, 2, mode_line_string_list
);
9555 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9556 ASET (vector
, 4, mode_line_string_face
);
9557 ASET (vector
, 5, mode_line_string_face_prop
);
9560 XSETBUFFER (tmp
, obuf
);
9563 ASET (vector
, 6, tmp
);
9564 ASET (vector
, 7, owin
);
9570 unwind_format_mode_line (Lisp_Object vector
)
9572 mode_line_target
= XINT (AREF (vector
, 0));
9573 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9574 mode_line_string_list
= AREF (vector
, 2);
9575 if (! EQ (AREF (vector
, 3), Qt
))
9576 mode_line_proptrans_alist
= AREF (vector
, 3);
9577 mode_line_string_face
= AREF (vector
, 4);
9578 mode_line_string_face_prop
= AREF (vector
, 5);
9580 if (!NILP (AREF (vector
, 7)))
9581 /* Select window before buffer, since it may change the buffer. */
9582 Fselect_window (AREF (vector
, 7), Qt
);
9584 if (!NILP (AREF (vector
, 6)))
9586 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9587 ASET (vector
, 6, Qnil
);
9590 Vmode_line_unwind_vector
= vector
;
9595 /* Store a single character C for the frame title in mode_line_noprop_buf.
9596 Re-allocate mode_line_noprop_buf if necessary. */
9599 store_mode_line_noprop_char (char c
)
9601 /* If output position has reached the end of the allocated buffer,
9602 double the buffer's size. */
9603 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9605 int len
= MODE_LINE_NOPROP_LEN (0);
9606 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9607 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9608 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9609 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9612 *mode_line_noprop_ptr
++ = c
;
9616 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9617 mode_line_noprop_ptr. STR is the string to store. Do not copy
9618 characters that yield more columns than PRECISION; PRECISION <= 0
9619 means copy the whole string. Pad with spaces until FIELD_WIDTH
9620 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9621 pad. Called from display_mode_element when it is used to build a
9625 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9630 /* Copy at most PRECISION chars from STR. */
9631 nbytes
= strlen (str
);
9632 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9634 store_mode_line_noprop_char (*str
++);
9636 /* Fill up with spaces until FIELD_WIDTH reached. */
9637 while (field_width
> 0
9640 store_mode_line_noprop_char (' ');
9647 /***********************************************************************
9649 ***********************************************************************/
9651 #ifdef HAVE_WINDOW_SYSTEM
9653 /* Set the title of FRAME, if it has changed. The title format is
9654 Vicon_title_format if FRAME is iconified, otherwise it is
9655 frame_title_format. */
9658 x_consider_frame_title (Lisp_Object frame
)
9660 struct frame
*f
= XFRAME (frame
);
9662 if (FRAME_WINDOW_P (f
)
9663 || FRAME_MINIBUF_ONLY_P (f
)
9664 || f
->explicit_name
)
9666 /* Do we have more than one visible frame on this X display? */
9673 int count
= SPECPDL_INDEX ();
9675 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9677 Lisp_Object other_frame
= XCAR (tail
);
9678 struct frame
*tf
= XFRAME (other_frame
);
9681 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9682 && !FRAME_MINIBUF_ONLY_P (tf
)
9683 && !EQ (other_frame
, tip_frame
)
9684 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9688 /* Set global variable indicating that multiple frames exist. */
9689 multiple_frames
= CONSP (tail
);
9691 /* Switch to the buffer of selected window of the frame. Set up
9692 mode_line_target so that display_mode_element will output into
9693 mode_line_noprop_buf; then display the title. */
9694 record_unwind_protect (unwind_format_mode_line
,
9695 format_mode_line_unwind_data
9696 (current_buffer
, selected_window
, 0));
9698 Fselect_window (f
->selected_window
, Qt
);
9699 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9700 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9702 mode_line_target
= MODE_LINE_TITLE
;
9703 title_start
= MODE_LINE_NOPROP_LEN (0);
9704 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9705 NULL
, DEFAULT_FACE_ID
);
9706 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9707 len
= MODE_LINE_NOPROP_LEN (title_start
);
9708 title
= mode_line_noprop_buf
+ title_start
;
9709 unbind_to (count
, Qnil
);
9711 /* Set the title only if it's changed. This avoids consing in
9712 the common case where it hasn't. (If it turns out that we've
9713 already wasted too much time by walking through the list with
9714 display_mode_element, then we might need to optimize at a
9715 higher level than this.) */
9716 if (! STRINGP (f
->name
)
9717 || SBYTES (f
->name
) != len
9718 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9719 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9723 #endif /* not HAVE_WINDOW_SYSTEM */
9728 /***********************************************************************
9730 ***********************************************************************/
9733 /* Prepare for redisplay by updating menu-bar item lists when
9734 appropriate. This can call eval. */
9737 prepare_menu_bars (void)
9740 struct gcpro gcpro1
, gcpro2
;
9742 Lisp_Object tooltip_frame
;
9744 #ifdef HAVE_WINDOW_SYSTEM
9745 tooltip_frame
= tip_frame
;
9747 tooltip_frame
= Qnil
;
9750 /* Update all frame titles based on their buffer names, etc. We do
9751 this before the menu bars so that the buffer-menu will show the
9752 up-to-date frame titles. */
9753 #ifdef HAVE_WINDOW_SYSTEM
9754 if (windows_or_buffers_changed
|| update_mode_lines
)
9756 Lisp_Object tail
, frame
;
9758 FOR_EACH_FRAME (tail
, frame
)
9761 if (!EQ (frame
, tooltip_frame
)
9762 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9763 x_consider_frame_title (frame
);
9766 #endif /* HAVE_WINDOW_SYSTEM */
9768 /* Update the menu bar item lists, if appropriate. This has to be
9769 done before any actual redisplay or generation of display lines. */
9770 all_windows
= (update_mode_lines
9771 || buffer_shared
> 1
9772 || windows_or_buffers_changed
);
9775 Lisp_Object tail
, frame
;
9776 int count
= SPECPDL_INDEX ();
9777 /* 1 means that update_menu_bar has run its hooks
9778 so any further calls to update_menu_bar shouldn't do so again. */
9779 int menu_bar_hooks_run
= 0;
9781 record_unwind_save_match_data ();
9783 FOR_EACH_FRAME (tail
, frame
)
9787 /* Ignore tooltip frame. */
9788 if (EQ (frame
, tooltip_frame
))
9791 /* If a window on this frame changed size, report that to
9792 the user and clear the size-change flag. */
9793 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9795 Lisp_Object functions
;
9797 /* Clear flag first in case we get an error below. */
9798 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9799 functions
= Vwindow_size_change_functions
;
9800 GCPRO2 (tail
, functions
);
9802 while (CONSP (functions
))
9804 if (!EQ (XCAR (functions
), Qt
))
9805 call1 (XCAR (functions
), frame
);
9806 functions
= XCDR (functions
);
9812 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9813 #ifdef HAVE_WINDOW_SYSTEM
9814 update_tool_bar (f
, 0);
9817 if (windows_or_buffers_changed
9819 ns_set_doc_edited (f
, Fbuffer_modified_p
9820 (XWINDOW (f
->selected_window
)->buffer
));
9825 unbind_to (count
, Qnil
);
9829 struct frame
*sf
= SELECTED_FRAME ();
9830 update_menu_bar (sf
, 1, 0);
9831 #ifdef HAVE_WINDOW_SYSTEM
9832 update_tool_bar (sf
, 1);
9838 /* Update the menu bar item list for frame F. This has to be done
9839 before we start to fill in any display lines, because it can call
9842 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9844 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9845 already ran the menu bar hooks for this redisplay, so there
9846 is no need to run them again. The return value is the
9847 updated value of this flag, to pass to the next call. */
9850 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9853 register struct window
*w
;
9855 /* If called recursively during a menu update, do nothing. This can
9856 happen when, for instance, an activate-menubar-hook causes a
9858 if (inhibit_menubar_update
)
9861 window
= FRAME_SELECTED_WINDOW (f
);
9862 w
= XWINDOW (window
);
9864 if (FRAME_WINDOW_P (f
)
9866 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9867 || defined (HAVE_NS) || defined (USE_GTK)
9868 FRAME_EXTERNAL_MENU_BAR (f
)
9870 FRAME_MENU_BAR_LINES (f
) > 0
9872 : FRAME_MENU_BAR_LINES (f
) > 0)
9874 /* If the user has switched buffers or windows, we need to
9875 recompute to reflect the new bindings. But we'll
9876 recompute when update_mode_lines is set too; that means
9877 that people can use force-mode-line-update to request
9878 that the menu bar be recomputed. The adverse effect on
9879 the rest of the redisplay algorithm is about the same as
9880 windows_or_buffers_changed anyway. */
9881 if (windows_or_buffers_changed
9882 /* This used to test w->update_mode_line, but we believe
9883 there is no need to recompute the menu in that case. */
9884 || update_mode_lines
9885 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9886 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9887 != !NILP (w
->last_had_star
))
9888 || ((!NILP (Vtransient_mark_mode
)
9889 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9890 != !NILP (w
->region_showing
)))
9892 struct buffer
*prev
= current_buffer
;
9893 int count
= SPECPDL_INDEX ();
9895 specbind (Qinhibit_menubar_update
, Qt
);
9897 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9898 if (save_match_data
)
9899 record_unwind_save_match_data ();
9900 if (NILP (Voverriding_local_map_menu_flag
))
9902 specbind (Qoverriding_terminal_local_map
, Qnil
);
9903 specbind (Qoverriding_local_map
, Qnil
);
9908 /* Run the Lucid hook. */
9909 safe_run_hooks (Qactivate_menubar_hook
);
9911 /* If it has changed current-menubar from previous value,
9912 really recompute the menu-bar from the value. */
9913 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9914 call0 (Qrecompute_lucid_menubar
);
9916 safe_run_hooks (Qmenu_bar_update_hook
);
9921 XSETFRAME (Vmenu_updating_frame
, f
);
9922 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9924 /* Redisplay the menu bar in case we changed it. */
9925 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9926 || defined (HAVE_NS) || defined (USE_GTK)
9927 if (FRAME_WINDOW_P (f
))
9929 #if defined (HAVE_NS)
9930 /* All frames on Mac OS share the same menubar. So only
9931 the selected frame should be allowed to set it. */
9932 if (f
== SELECTED_FRAME ())
9934 set_frame_menubar (f
, 0, 0);
9937 /* On a terminal screen, the menu bar is an ordinary screen
9938 line, and this makes it get updated. */
9939 w
->update_mode_line
= Qt
;
9940 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9941 /* In the non-toolkit version, the menu bar is an ordinary screen
9942 line, and this makes it get updated. */
9943 w
->update_mode_line
= Qt
;
9944 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9946 unbind_to (count
, Qnil
);
9947 set_buffer_internal_1 (prev
);
9956 /***********************************************************************
9958 ***********************************************************************/
9960 #ifdef HAVE_WINDOW_SYSTEM
9963 Nominal cursor position -- where to draw output.
9964 HPOS and VPOS are window relative glyph matrix coordinates.
9965 X and Y are window relative pixel coordinates. */
9967 struct cursor_pos output_cursor
;
9971 Set the global variable output_cursor to CURSOR. All cursor
9972 positions are relative to updated_window. */
9975 set_output_cursor (struct cursor_pos
*cursor
)
9977 output_cursor
.hpos
= cursor
->hpos
;
9978 output_cursor
.vpos
= cursor
->vpos
;
9979 output_cursor
.x
= cursor
->x
;
9980 output_cursor
.y
= cursor
->y
;
9985 Set a nominal cursor position.
9987 HPOS and VPOS are column/row positions in a window glyph matrix. X
9988 and Y are window text area relative pixel positions.
9990 If this is done during an update, updated_window will contain the
9991 window that is being updated and the position is the future output
9992 cursor position for that window. If updated_window is null, use
9993 selected_window and display the cursor at the given position. */
9996 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10000 /* If updated_window is not set, work on selected_window. */
10001 if (updated_window
)
10002 w
= updated_window
;
10004 w
= XWINDOW (selected_window
);
10006 /* Set the output cursor. */
10007 output_cursor
.hpos
= hpos
;
10008 output_cursor
.vpos
= vpos
;
10009 output_cursor
.x
= x
;
10010 output_cursor
.y
= y
;
10012 /* If not called as part of an update, really display the cursor.
10013 This will also set the cursor position of W. */
10014 if (updated_window
== NULL
)
10017 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10018 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10019 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10024 #endif /* HAVE_WINDOW_SYSTEM */
10027 /***********************************************************************
10029 ***********************************************************************/
10031 #ifdef HAVE_WINDOW_SYSTEM
10033 /* Where the mouse was last time we reported a mouse event. */
10035 FRAME_PTR last_mouse_frame
;
10037 /* Tool-bar item index of the item on which a mouse button was pressed
10040 int last_tool_bar_item
;
10044 update_tool_bar_unwind (Lisp_Object frame
)
10046 selected_frame
= frame
;
10050 /* Update the tool-bar item list for frame F. This has to be done
10051 before we start to fill in any display lines. Called from
10052 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10053 and restore it here. */
10056 update_tool_bar (struct frame
*f
, int save_match_data
)
10058 #if defined (USE_GTK) || defined (HAVE_NS)
10059 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10061 int do_update
= WINDOWP (f
->tool_bar_window
)
10062 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10067 Lisp_Object window
;
10070 window
= FRAME_SELECTED_WINDOW (f
);
10071 w
= XWINDOW (window
);
10073 /* If the user has switched buffers or windows, we need to
10074 recompute to reflect the new bindings. But we'll
10075 recompute when update_mode_lines is set too; that means
10076 that people can use force-mode-line-update to request
10077 that the menu bar be recomputed. The adverse effect on
10078 the rest of the redisplay algorithm is about the same as
10079 windows_or_buffers_changed anyway. */
10080 if (windows_or_buffers_changed
10081 || !NILP (w
->update_mode_line
)
10082 || update_mode_lines
10083 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10084 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10085 != !NILP (w
->last_had_star
))
10086 || ((!NILP (Vtransient_mark_mode
)
10087 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10088 != !NILP (w
->region_showing
)))
10090 struct buffer
*prev
= current_buffer
;
10091 int count
= SPECPDL_INDEX ();
10092 Lisp_Object frame
, new_tool_bar
;
10093 int new_n_tool_bar
;
10094 struct gcpro gcpro1
;
10096 /* Set current_buffer to the buffer of the selected
10097 window of the frame, so that we get the right local
10099 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10101 /* Save match data, if we must. */
10102 if (save_match_data
)
10103 record_unwind_save_match_data ();
10105 /* Make sure that we don't accidentally use bogus keymaps. */
10106 if (NILP (Voverriding_local_map_menu_flag
))
10108 specbind (Qoverriding_terminal_local_map
, Qnil
);
10109 specbind (Qoverriding_local_map
, Qnil
);
10112 GCPRO1 (new_tool_bar
);
10114 /* We must temporarily set the selected frame to this frame
10115 before calling tool_bar_items, because the calculation of
10116 the tool-bar keymap uses the selected frame (see
10117 `tool-bar-make-keymap' in tool-bar.el). */
10118 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10119 XSETFRAME (frame
, f
);
10120 selected_frame
= frame
;
10122 /* Build desired tool-bar items from keymaps. */
10123 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10126 /* Redisplay the tool-bar if we changed it. */
10127 if (new_n_tool_bar
!= f
->n_tool_bar_items
10128 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10130 /* Redisplay that happens asynchronously due to an expose event
10131 may access f->tool_bar_items. Make sure we update both
10132 variables within BLOCK_INPUT so no such event interrupts. */
10134 f
->tool_bar_items
= new_tool_bar
;
10135 f
->n_tool_bar_items
= new_n_tool_bar
;
10136 w
->update_mode_line
= Qt
;
10142 unbind_to (count
, Qnil
);
10143 set_buffer_internal_1 (prev
);
10149 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10150 F's desired tool-bar contents. F->tool_bar_items must have
10151 been set up previously by calling prepare_menu_bars. */
10154 build_desired_tool_bar_string (struct frame
*f
)
10156 int i
, size
, size_needed
;
10157 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10158 Lisp_Object image
, plist
, props
;
10160 image
= plist
= props
= Qnil
;
10161 GCPRO3 (image
, plist
, props
);
10163 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10164 Otherwise, make a new string. */
10166 /* The size of the string we might be able to reuse. */
10167 size
= (STRINGP (f
->desired_tool_bar_string
)
10168 ? SCHARS (f
->desired_tool_bar_string
)
10171 /* We need one space in the string for each image. */
10172 size_needed
= f
->n_tool_bar_items
;
10174 /* Reuse f->desired_tool_bar_string, if possible. */
10175 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10176 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10177 make_number (' '));
10180 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10181 Fremove_text_properties (make_number (0), make_number (size
),
10182 props
, f
->desired_tool_bar_string
);
10185 /* Put a `display' property on the string for the images to display,
10186 put a `menu_item' property on tool-bar items with a value that
10187 is the index of the item in F's tool-bar item vector. */
10188 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10190 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10192 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10193 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10194 int hmargin
, vmargin
, relief
, idx
, end
;
10196 /* If image is a vector, choose the image according to the
10198 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10199 if (VECTORP (image
))
10203 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10204 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10207 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10208 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10210 xassert (ASIZE (image
) >= idx
);
10211 image
= AREF (image
, idx
);
10216 /* Ignore invalid image specifications. */
10217 if (!valid_image_p (image
))
10220 /* Display the tool-bar button pressed, or depressed. */
10221 plist
= Fcopy_sequence (XCDR (image
));
10223 /* Compute margin and relief to draw. */
10224 relief
= (tool_bar_button_relief
>= 0
10225 ? tool_bar_button_relief
10226 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10227 hmargin
= vmargin
= relief
;
10229 if (INTEGERP (Vtool_bar_button_margin
)
10230 && XINT (Vtool_bar_button_margin
) > 0)
10232 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10233 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10235 else if (CONSP (Vtool_bar_button_margin
))
10237 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10238 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10239 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10241 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10242 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10243 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10246 if (auto_raise_tool_bar_buttons_p
)
10248 /* Add a `:relief' property to the image spec if the item is
10252 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10259 /* If image is selected, display it pressed, i.e. with a
10260 negative relief. If it's not selected, display it with a
10262 plist
= Fplist_put (plist
, QCrelief
,
10264 ? make_number (-relief
)
10265 : make_number (relief
)));
10270 /* Put a margin around the image. */
10271 if (hmargin
|| vmargin
)
10273 if (hmargin
== vmargin
)
10274 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10276 plist
= Fplist_put (plist
, QCmargin
,
10277 Fcons (make_number (hmargin
),
10278 make_number (vmargin
)));
10281 /* If button is not enabled, and we don't have special images
10282 for the disabled state, make the image appear disabled by
10283 applying an appropriate algorithm to it. */
10284 if (!enabled_p
&& idx
< 0)
10285 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10287 /* Put a `display' text property on the string for the image to
10288 display. Put a `menu-item' property on the string that gives
10289 the start of this item's properties in the tool-bar items
10291 image
= Fcons (Qimage
, plist
);
10292 props
= list4 (Qdisplay
, image
,
10293 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10295 /* Let the last image hide all remaining spaces in the tool bar
10296 string. The string can be longer than needed when we reuse a
10297 previous string. */
10298 if (i
+ 1 == f
->n_tool_bar_items
)
10299 end
= SCHARS (f
->desired_tool_bar_string
);
10302 Fadd_text_properties (make_number (i
), make_number (end
),
10303 props
, f
->desired_tool_bar_string
);
10311 /* Display one line of the tool-bar of frame IT->f.
10313 HEIGHT specifies the desired height of the tool-bar line.
10314 If the actual height of the glyph row is less than HEIGHT, the
10315 row's height is increased to HEIGHT, and the icons are centered
10316 vertically in the new height.
10318 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10319 count a final empty row in case the tool-bar width exactly matches
10324 display_tool_bar_line (struct it
*it
, int height
)
10326 struct glyph_row
*row
= it
->glyph_row
;
10327 int max_x
= it
->last_visible_x
;
10328 struct glyph
*last
;
10330 prepare_desired_row (row
);
10331 row
->y
= it
->current_y
;
10333 /* Note that this isn't made use of if the face hasn't a box,
10334 so there's no need to check the face here. */
10335 it
->start_of_box_run_p
= 1;
10337 while (it
->current_x
< max_x
)
10339 int x
, n_glyphs_before
, i
, nglyphs
;
10340 struct it it_before
;
10342 /* Get the next display element. */
10343 if (!get_next_display_element (it
))
10345 /* Don't count empty row if we are counting needed tool-bar lines. */
10346 if (height
< 0 && !it
->hpos
)
10351 /* Produce glyphs. */
10352 n_glyphs_before
= row
->used
[TEXT_AREA
];
10355 PRODUCE_GLYPHS (it
);
10357 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10359 x
= it_before
.current_x
;
10360 while (i
< nglyphs
)
10362 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10364 if (x
+ glyph
->pixel_width
> max_x
)
10366 /* Glyph doesn't fit on line. Backtrack. */
10367 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10369 /* If this is the only glyph on this line, it will never fit on the
10370 toolbar, so skip it. But ensure there is at least one glyph,
10371 so we don't accidentally disable the tool-bar. */
10372 if (n_glyphs_before
== 0
10373 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10379 x
+= glyph
->pixel_width
;
10383 /* Stop at line ends. */
10384 if (ITERATOR_AT_END_OF_LINE_P (it
))
10387 set_iterator_to_next (it
, 1);
10392 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10394 /* Use default face for the border below the tool bar.
10396 FIXME: When auto-resize-tool-bars is grow-only, there is
10397 no additional border below the possibly empty tool-bar lines.
10398 So to make the extra empty lines look "normal", we have to
10399 use the tool-bar face for the border too. */
10400 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10401 it
->face_id
= DEFAULT_FACE_ID
;
10403 extend_face_to_end_of_line (it
);
10404 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10405 last
->right_box_line_p
= 1;
10406 if (last
== row
->glyphs
[TEXT_AREA
])
10407 last
->left_box_line_p
= 1;
10409 /* Make line the desired height and center it vertically. */
10410 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10412 /* Don't add more than one line height. */
10413 height
%= FRAME_LINE_HEIGHT (it
->f
);
10414 it
->max_ascent
+= height
/ 2;
10415 it
->max_descent
+= (height
+ 1) / 2;
10418 compute_line_metrics (it
);
10420 /* If line is empty, make it occupy the rest of the tool-bar. */
10421 if (!row
->displays_text_p
)
10423 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10424 row
->visible_height
= row
->height
;
10425 row
->ascent
= row
->phys_ascent
= 0;
10426 row
->extra_line_spacing
= 0;
10429 row
->full_width_p
= 1;
10430 row
->continued_p
= 0;
10431 row
->truncated_on_left_p
= 0;
10432 row
->truncated_on_right_p
= 0;
10434 it
->current_x
= it
->hpos
= 0;
10435 it
->current_y
+= row
->height
;
10441 /* Max tool-bar height. */
10443 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10444 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10446 /* Value is the number of screen lines needed to make all tool-bar
10447 items of frame F visible. The number of actual rows needed is
10448 returned in *N_ROWS if non-NULL. */
10451 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10453 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10455 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10456 the desired matrix, so use (unused) mode-line row as temporary row to
10457 avoid destroying the first tool-bar row. */
10458 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10460 /* Initialize an iterator for iteration over
10461 F->desired_tool_bar_string in the tool-bar window of frame F. */
10462 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10463 it
.first_visible_x
= 0;
10464 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10465 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10467 while (!ITERATOR_AT_END_P (&it
))
10469 clear_glyph_row (temp_row
);
10470 it
.glyph_row
= temp_row
;
10471 display_tool_bar_line (&it
, -1);
10473 clear_glyph_row (temp_row
);
10475 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10477 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10479 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10483 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10485 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10486 (Lisp_Object frame
)
10493 frame
= selected_frame
;
10495 CHECK_FRAME (frame
);
10496 f
= XFRAME (frame
);
10498 if (WINDOWP (f
->tool_bar_window
)
10499 || (w
= XWINDOW (f
->tool_bar_window
),
10500 WINDOW_TOTAL_LINES (w
) > 0))
10502 update_tool_bar (f
, 1);
10503 if (f
->n_tool_bar_items
)
10505 build_desired_tool_bar_string (f
);
10506 nlines
= tool_bar_lines_needed (f
, NULL
);
10510 return make_number (nlines
);
10514 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10515 height should be changed. */
10518 redisplay_tool_bar (struct frame
*f
)
10522 struct glyph_row
*row
;
10524 #if defined (USE_GTK) || defined (HAVE_NS)
10525 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10526 update_frame_tool_bar (f
);
10530 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10531 do anything. This means you must start with tool-bar-lines
10532 non-zero to get the auto-sizing effect. Or in other words, you
10533 can turn off tool-bars by specifying tool-bar-lines zero. */
10534 if (!WINDOWP (f
->tool_bar_window
)
10535 || (w
= XWINDOW (f
->tool_bar_window
),
10536 WINDOW_TOTAL_LINES (w
) == 0))
10539 /* Set up an iterator for the tool-bar window. */
10540 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10541 it
.first_visible_x
= 0;
10542 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10543 row
= it
.glyph_row
;
10545 /* Build a string that represents the contents of the tool-bar. */
10546 build_desired_tool_bar_string (f
);
10547 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10549 if (f
->n_tool_bar_rows
== 0)
10553 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10554 nlines
!= WINDOW_TOTAL_LINES (w
)))
10557 int old_height
= WINDOW_TOTAL_LINES (w
);
10559 XSETFRAME (frame
, f
);
10560 Fmodify_frame_parameters (frame
,
10561 Fcons (Fcons (Qtool_bar_lines
,
10562 make_number (nlines
)),
10564 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10566 clear_glyph_matrix (w
->desired_matrix
);
10567 fonts_changed_p
= 1;
10573 /* Display as many lines as needed to display all tool-bar items. */
10575 if (f
->n_tool_bar_rows
> 0)
10577 int border
, rows
, height
, extra
;
10579 if (INTEGERP (Vtool_bar_border
))
10580 border
= XINT (Vtool_bar_border
);
10581 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10582 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10583 else if (EQ (Vtool_bar_border
, Qborder_width
))
10584 border
= f
->border_width
;
10590 rows
= f
->n_tool_bar_rows
;
10591 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10592 extra
= it
.last_visible_y
- border
- height
* rows
;
10594 while (it
.current_y
< it
.last_visible_y
)
10597 if (extra
> 0 && rows
-- > 0)
10599 h
= (extra
+ rows
- 1) / rows
;
10602 display_tool_bar_line (&it
, height
+ h
);
10607 while (it
.current_y
< it
.last_visible_y
)
10608 display_tool_bar_line (&it
, 0);
10611 /* It doesn't make much sense to try scrolling in the tool-bar
10612 window, so don't do it. */
10613 w
->desired_matrix
->no_scrolling_p
= 1;
10614 w
->must_be_updated_p
= 1;
10616 if (!NILP (Vauto_resize_tool_bars
))
10618 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10619 int change_height_p
= 0;
10621 /* If we couldn't display everything, change the tool-bar's
10622 height if there is room for more. */
10623 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10624 && it
.current_y
< max_tool_bar_height
)
10625 change_height_p
= 1;
10627 row
= it
.glyph_row
- 1;
10629 /* If there are blank lines at the end, except for a partially
10630 visible blank line at the end that is smaller than
10631 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10632 if (!row
->displays_text_p
10633 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10634 change_height_p
= 1;
10636 /* If row displays tool-bar items, but is partially visible,
10637 change the tool-bar's height. */
10638 if (row
->displays_text_p
10639 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10640 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10641 change_height_p
= 1;
10643 /* Resize windows as needed by changing the `tool-bar-lines'
10644 frame parameter. */
10645 if (change_height_p
)
10648 int old_height
= WINDOW_TOTAL_LINES (w
);
10650 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10652 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10653 && !f
->minimize_tool_bar_window_p
)
10654 ? (nlines
> old_height
)
10655 : (nlines
!= old_height
));
10656 f
->minimize_tool_bar_window_p
= 0;
10658 if (change_height_p
)
10660 XSETFRAME (frame
, f
);
10661 Fmodify_frame_parameters (frame
,
10662 Fcons (Fcons (Qtool_bar_lines
,
10663 make_number (nlines
)),
10665 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10667 clear_glyph_matrix (w
->desired_matrix
);
10668 f
->n_tool_bar_rows
= nrows
;
10669 fonts_changed_p
= 1;
10676 f
->minimize_tool_bar_window_p
= 0;
10681 /* Get information about the tool-bar item which is displayed in GLYPH
10682 on frame F. Return in *PROP_IDX the index where tool-bar item
10683 properties start in F->tool_bar_items. Value is zero if
10684 GLYPH doesn't display a tool-bar item. */
10687 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10693 /* This function can be called asynchronously, which means we must
10694 exclude any possibility that Fget_text_property signals an
10696 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10697 charpos
= max (0, charpos
);
10699 /* Get the text property `menu-item' at pos. The value of that
10700 property is the start index of this item's properties in
10701 F->tool_bar_items. */
10702 prop
= Fget_text_property (make_number (charpos
),
10703 Qmenu_item
, f
->current_tool_bar_string
);
10704 if (INTEGERP (prop
))
10706 *prop_idx
= XINT (prop
);
10716 /* Get information about the tool-bar item at position X/Y on frame F.
10717 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10718 the current matrix of the tool-bar window of F, or NULL if not
10719 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10720 item in F->tool_bar_items. Value is
10722 -1 if X/Y is not on a tool-bar item
10723 0 if X/Y is on the same item that was highlighted before.
10727 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10728 int *hpos
, int *vpos
, int *prop_idx
)
10730 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10731 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10734 /* Find the glyph under X/Y. */
10735 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10736 if (*glyph
== NULL
)
10739 /* Get the start of this tool-bar item's properties in
10740 f->tool_bar_items. */
10741 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10744 /* Is mouse on the highlighted item? */
10745 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10746 && *vpos
>= dpyinfo
->mouse_face_beg_row
10747 && *vpos
<= dpyinfo
->mouse_face_end_row
10748 && (*vpos
> dpyinfo
->mouse_face_beg_row
10749 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10750 && (*vpos
< dpyinfo
->mouse_face_end_row
10751 || *hpos
< dpyinfo
->mouse_face_end_col
10752 || dpyinfo
->mouse_face_past_end
))
10760 Handle mouse button event on the tool-bar of frame F, at
10761 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10762 0 for button release. MODIFIERS is event modifiers for button
10766 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10767 unsigned int modifiers
)
10769 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10770 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10771 int hpos
, vpos
, prop_idx
;
10772 struct glyph
*glyph
;
10773 Lisp_Object enabled_p
;
10775 /* If not on the highlighted tool-bar item, return. */
10776 frame_to_window_pixel_xy (w
, &x
, &y
);
10777 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10780 /* If item is disabled, do nothing. */
10781 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10782 if (NILP (enabled_p
))
10787 /* Show item in pressed state. */
10788 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10789 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10790 last_tool_bar_item
= prop_idx
;
10794 Lisp_Object key
, frame
;
10795 struct input_event event
;
10796 EVENT_INIT (event
);
10798 /* Show item in released state. */
10799 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10800 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10802 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10804 XSETFRAME (frame
, f
);
10805 event
.kind
= TOOL_BAR_EVENT
;
10806 event
.frame_or_window
= frame
;
10808 kbd_buffer_store_event (&event
);
10810 event
.kind
= TOOL_BAR_EVENT
;
10811 event
.frame_or_window
= frame
;
10813 event
.modifiers
= modifiers
;
10814 kbd_buffer_store_event (&event
);
10815 last_tool_bar_item
= -1;
10820 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10821 tool-bar window-relative coordinates X/Y. Called from
10822 note_mouse_highlight. */
10825 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10827 Lisp_Object window
= f
->tool_bar_window
;
10828 struct window
*w
= XWINDOW (window
);
10829 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10831 struct glyph
*glyph
;
10832 struct glyph_row
*row
;
10834 Lisp_Object enabled_p
;
10836 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10837 int mouse_down_p
, rc
;
10839 /* Function note_mouse_highlight is called with negative X/Y
10840 values when mouse moves outside of the frame. */
10841 if (x
<= 0 || y
<= 0)
10843 clear_mouse_face (dpyinfo
);
10847 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10850 /* Not on tool-bar item. */
10851 clear_mouse_face (dpyinfo
);
10855 /* On same tool-bar item as before. */
10856 goto set_help_echo
;
10858 clear_mouse_face (dpyinfo
);
10860 /* Mouse is down, but on different tool-bar item? */
10861 mouse_down_p
= (dpyinfo
->grabbed
10862 && f
== last_mouse_frame
10863 && FRAME_LIVE_P (f
));
10865 && last_tool_bar_item
!= prop_idx
)
10868 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10869 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10871 /* If tool-bar item is not enabled, don't highlight it. */
10872 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10873 if (!NILP (enabled_p
))
10875 /* Compute the x-position of the glyph. In front and past the
10876 image is a space. We include this in the highlighted area. */
10877 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10878 for (i
= x
= 0; i
< hpos
; ++i
)
10879 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10881 /* Record this as the current active region. */
10882 dpyinfo
->mouse_face_beg_col
= hpos
;
10883 dpyinfo
->mouse_face_beg_row
= vpos
;
10884 dpyinfo
->mouse_face_beg_x
= x
;
10885 dpyinfo
->mouse_face_beg_y
= row
->y
;
10886 dpyinfo
->mouse_face_past_end
= 0;
10888 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10889 dpyinfo
->mouse_face_end_row
= vpos
;
10890 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10891 dpyinfo
->mouse_face_end_y
= row
->y
;
10892 dpyinfo
->mouse_face_window
= window
;
10893 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10895 /* Display it as active. */
10896 show_mouse_face (dpyinfo
, draw
);
10897 dpyinfo
->mouse_face_image_state
= draw
;
10902 /* Set help_echo_string to a help string to display for this tool-bar item.
10903 XTread_socket does the rest. */
10904 help_echo_object
= help_echo_window
= Qnil
;
10905 help_echo_pos
= -1;
10906 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10907 if (NILP (help_echo_string
))
10908 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10911 #endif /* HAVE_WINDOW_SYSTEM */
10915 /************************************************************************
10916 Horizontal scrolling
10917 ************************************************************************/
10919 static int hscroll_window_tree (Lisp_Object
);
10920 static int hscroll_windows (Lisp_Object
);
10922 /* For all leaf windows in the window tree rooted at WINDOW, set their
10923 hscroll value so that PT is (i) visible in the window, and (ii) so
10924 that it is not within a certain margin at the window's left and
10925 right border. Value is non-zero if any window's hscroll has been
10929 hscroll_window_tree (Lisp_Object window
)
10931 int hscrolled_p
= 0;
10932 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10933 int hscroll_step_abs
= 0;
10934 double hscroll_step_rel
= 0;
10936 if (hscroll_relative_p
)
10938 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10939 if (hscroll_step_rel
< 0)
10941 hscroll_relative_p
= 0;
10942 hscroll_step_abs
= 0;
10945 else if (INTEGERP (Vhscroll_step
))
10947 hscroll_step_abs
= XINT (Vhscroll_step
);
10948 if (hscroll_step_abs
< 0)
10949 hscroll_step_abs
= 0;
10952 hscroll_step_abs
= 0;
10954 while (WINDOWP (window
))
10956 struct window
*w
= XWINDOW (window
);
10958 if (WINDOWP (w
->hchild
))
10959 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10960 else if (WINDOWP (w
->vchild
))
10961 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10962 else if (w
->cursor
.vpos
>= 0)
10965 int text_area_width
;
10966 struct glyph_row
*current_cursor_row
10967 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10968 struct glyph_row
*desired_cursor_row
10969 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10970 struct glyph_row
*cursor_row
10971 = (desired_cursor_row
->enabled_p
10972 ? desired_cursor_row
10973 : current_cursor_row
);
10975 text_area_width
= window_box_width (w
, TEXT_AREA
);
10977 /* Scroll when cursor is inside this scroll margin. */
10978 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10980 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10981 && ((XFASTINT (w
->hscroll
)
10982 && w
->cursor
.x
<= h_margin
)
10983 || (cursor_row
->enabled_p
10984 && cursor_row
->truncated_on_right_p
10985 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10989 struct buffer
*saved_current_buffer
;
10993 /* Find point in a display of infinite width. */
10994 saved_current_buffer
= current_buffer
;
10995 current_buffer
= XBUFFER (w
->buffer
);
10997 if (w
== XWINDOW (selected_window
))
10998 pt
= BUF_PT (current_buffer
);
11001 pt
= marker_position (w
->pointm
);
11002 pt
= max (BEGV
, pt
);
11006 /* Move iterator to pt starting at cursor_row->start in
11007 a line with infinite width. */
11008 init_to_row_start (&it
, w
, cursor_row
);
11009 it
.last_visible_x
= INFINITY
;
11010 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11011 current_buffer
= saved_current_buffer
;
11013 /* Position cursor in window. */
11014 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11015 hscroll
= max (0, (it
.current_x
11016 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11017 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11018 : (text_area_width
/ 2))))
11019 / FRAME_COLUMN_WIDTH (it
.f
);
11020 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11022 if (hscroll_relative_p
)
11023 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11026 wanted_x
= text_area_width
11027 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11030 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11034 if (hscroll_relative_p
)
11035 wanted_x
= text_area_width
* hscroll_step_rel
11038 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11041 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11043 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11045 /* Don't call Fset_window_hscroll if value hasn't
11046 changed because it will prevent redisplay
11048 if (XFASTINT (w
->hscroll
) != hscroll
)
11050 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11051 w
->hscroll
= make_number (hscroll
);
11060 /* Value is non-zero if hscroll of any leaf window has been changed. */
11061 return hscrolled_p
;
11065 /* Set hscroll so that cursor is visible and not inside horizontal
11066 scroll margins for all windows in the tree rooted at WINDOW. See
11067 also hscroll_window_tree above. Value is non-zero if any window's
11068 hscroll has been changed. If it has, desired matrices on the frame
11069 of WINDOW are cleared. */
11072 hscroll_windows (Lisp_Object window
)
11074 int hscrolled_p
= hscroll_window_tree (window
);
11076 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11077 return hscrolled_p
;
11082 /************************************************************************
11084 ************************************************************************/
11086 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11087 to a non-zero value. This is sometimes handy to have in a debugger
11092 /* First and last unchanged row for try_window_id. */
11094 int debug_first_unchanged_at_end_vpos
;
11095 int debug_last_unchanged_at_beg_vpos
;
11097 /* Delta vpos and y. */
11099 int debug_dvpos
, debug_dy
;
11101 /* Delta in characters and bytes for try_window_id. */
11103 int debug_delta
, debug_delta_bytes
;
11105 /* Values of window_end_pos and window_end_vpos at the end of
11108 EMACS_INT debug_end_pos
, debug_end_vpos
;
11110 /* Append a string to W->desired_matrix->method. FMT is a printf
11111 format string. A1...A9 are a supplement for a variable-length
11112 argument list. If trace_redisplay_p is non-zero also printf the
11113 resulting string to stderr. */
11116 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11119 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11122 char *method
= w
->desired_matrix
->method
;
11123 int len
= strlen (method
);
11124 int size
= sizeof w
->desired_matrix
->method
;
11125 int remaining
= size
- len
- 1;
11127 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11128 if (len
&& remaining
)
11131 --remaining
, ++len
;
11134 strncpy (method
+ len
, buffer
, remaining
);
11136 if (trace_redisplay_p
)
11137 fprintf (stderr
, "%p (%s): %s\n",
11139 ((BUFFERP (w
->buffer
)
11140 && STRINGP (XBUFFER (w
->buffer
)->name
))
11141 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11146 #endif /* GLYPH_DEBUG */
11149 /* Value is non-zero if all changes in window W, which displays
11150 current_buffer, are in the text between START and END. START is a
11151 buffer position, END is given as a distance from Z. Used in
11152 redisplay_internal for display optimization. */
11155 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11157 int unchanged_p
= 1;
11159 /* If text or overlays have changed, see where. */
11160 if (XFASTINT (w
->last_modified
) < MODIFF
11161 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11163 /* Gap in the line? */
11164 if (GPT
< start
|| Z
- GPT
< end
)
11167 /* Changes start in front of the line, or end after it? */
11169 && (BEG_UNCHANGED
< start
- 1
11170 || END_UNCHANGED
< end
))
11173 /* If selective display, can't optimize if changes start at the
11174 beginning of the line. */
11176 && INTEGERP (current_buffer
->selective_display
)
11177 && XINT (current_buffer
->selective_display
) > 0
11178 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11181 /* If there are overlays at the start or end of the line, these
11182 may have overlay strings with newlines in them. A change at
11183 START, for instance, may actually concern the display of such
11184 overlay strings as well, and they are displayed on different
11185 lines. So, quickly rule out this case. (For the future, it
11186 might be desirable to implement something more telling than
11187 just BEG/END_UNCHANGED.) */
11190 if (BEG
+ BEG_UNCHANGED
== start
11191 && overlay_touches_p (start
))
11193 if (END_UNCHANGED
== end
11194 && overlay_touches_p (Z
- end
))
11198 /* Under bidi reordering, adding or deleting a character in the
11199 beginning of a paragraph, before the first strong directional
11200 character, can change the base direction of the paragraph (unless
11201 the buffer specifies a fixed paragraph direction), which will
11202 require to redisplay the whole paragraph. It might be worthwhile
11203 to find the paragraph limits and widen the range of redisplayed
11204 lines to that, but for now just give up this optimization. */
11205 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11206 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11210 return unchanged_p
;
11214 /* Do a frame update, taking possible shortcuts into account. This is
11215 the main external entry point for redisplay.
11217 If the last redisplay displayed an echo area message and that message
11218 is no longer requested, we clear the echo area or bring back the
11219 mini-buffer if that is in use. */
11224 redisplay_internal (0);
11229 overlay_arrow_string_or_property (Lisp_Object var
)
11233 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11236 return Voverlay_arrow_string
;
11239 /* Return 1 if there are any overlay-arrows in current_buffer. */
11241 overlay_arrow_in_current_buffer_p (void)
11245 for (vlist
= Voverlay_arrow_variable_list
;
11247 vlist
= XCDR (vlist
))
11249 Lisp_Object var
= XCAR (vlist
);
11252 if (!SYMBOLP (var
))
11254 val
= find_symbol_value (var
);
11256 && current_buffer
== XMARKER (val
)->buffer
)
11263 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11267 overlay_arrows_changed_p (void)
11271 for (vlist
= Voverlay_arrow_variable_list
;
11273 vlist
= XCDR (vlist
))
11275 Lisp_Object var
= XCAR (vlist
);
11276 Lisp_Object val
, pstr
;
11278 if (!SYMBOLP (var
))
11280 val
= find_symbol_value (var
);
11281 if (!MARKERP (val
))
11283 if (! EQ (COERCE_MARKER (val
),
11284 Fget (var
, Qlast_arrow_position
))
11285 || ! (pstr
= overlay_arrow_string_or_property (var
),
11286 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11292 /* Mark overlay arrows to be updated on next redisplay. */
11295 update_overlay_arrows (int up_to_date
)
11299 for (vlist
= Voverlay_arrow_variable_list
;
11301 vlist
= XCDR (vlist
))
11303 Lisp_Object var
= XCAR (vlist
);
11305 if (!SYMBOLP (var
))
11308 if (up_to_date
> 0)
11310 Lisp_Object val
= find_symbol_value (var
);
11311 Fput (var
, Qlast_arrow_position
,
11312 COERCE_MARKER (val
));
11313 Fput (var
, Qlast_arrow_string
,
11314 overlay_arrow_string_or_property (var
));
11316 else if (up_to_date
< 0
11317 || !NILP (Fget (var
, Qlast_arrow_position
)))
11319 Fput (var
, Qlast_arrow_position
, Qt
);
11320 Fput (var
, Qlast_arrow_string
, Qt
);
11326 /* Return overlay arrow string to display at row.
11327 Return integer (bitmap number) for arrow bitmap in left fringe.
11328 Return nil if no overlay arrow. */
11331 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11335 for (vlist
= Voverlay_arrow_variable_list
;
11337 vlist
= XCDR (vlist
))
11339 Lisp_Object var
= XCAR (vlist
);
11342 if (!SYMBOLP (var
))
11345 val
= find_symbol_value (var
);
11348 && current_buffer
== XMARKER (val
)->buffer
11349 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11351 if (FRAME_WINDOW_P (it
->f
)
11352 /* FIXME: if ROW->reversed_p is set, this should test
11353 the right fringe, not the left one. */
11354 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11356 #ifdef HAVE_WINDOW_SYSTEM
11357 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11360 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11361 return make_number (fringe_bitmap
);
11364 return make_number (-1); /* Use default arrow bitmap */
11366 return overlay_arrow_string_or_property (var
);
11373 /* Return 1 if point moved out of or into a composition. Otherwise
11374 return 0. PREV_BUF and PREV_PT are the last point buffer and
11375 position. BUF and PT are the current point buffer and position. */
11378 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11379 struct buffer
*buf
, int pt
)
11381 EMACS_INT start
, end
;
11383 Lisp_Object buffer
;
11385 XSETBUFFER (buffer
, buf
);
11386 /* Check a composition at the last point if point moved within the
11388 if (prev_buf
== buf
)
11391 /* Point didn't move. */
11394 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11395 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11396 && COMPOSITION_VALID_P (start
, end
, prop
)
11397 && start
< prev_pt
&& end
> prev_pt
)
11398 /* The last point was within the composition. Return 1 iff
11399 point moved out of the composition. */
11400 return (pt
<= start
|| pt
>= end
);
11403 /* Check a composition at the current point. */
11404 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11405 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11406 && COMPOSITION_VALID_P (start
, end
, prop
)
11407 && start
< pt
&& end
> pt
);
11411 /* Reconsider the setting of B->clip_changed which is displayed
11415 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11417 if (b
->clip_changed
11418 && !NILP (w
->window_end_valid
)
11419 && w
->current_matrix
->buffer
== b
11420 && w
->current_matrix
->zv
== BUF_ZV (b
)
11421 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11422 b
->clip_changed
= 0;
11424 /* If display wasn't paused, and W is not a tool bar window, see if
11425 point has been moved into or out of a composition. In that case,
11426 we set b->clip_changed to 1 to force updating the screen. If
11427 b->clip_changed has already been set to 1, we can skip this
11429 if (!b
->clip_changed
11430 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11434 if (w
== XWINDOW (selected_window
))
11435 pt
= BUF_PT (current_buffer
);
11437 pt
= marker_position (w
->pointm
);
11439 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11440 || pt
!= XINT (w
->last_point
))
11441 && check_point_in_composition (w
->current_matrix
->buffer
,
11442 XINT (w
->last_point
),
11443 XBUFFER (w
->buffer
), pt
))
11444 b
->clip_changed
= 1;
11449 /* Select FRAME to forward the values of frame-local variables into C
11450 variables so that the redisplay routines can access those values
11454 select_frame_for_redisplay (Lisp_Object frame
)
11456 Lisp_Object tail
, tem
;
11457 Lisp_Object old
= selected_frame
;
11458 struct Lisp_Symbol
*sym
;
11460 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11462 selected_frame
= frame
;
11465 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11466 if (CONSP (XCAR (tail
))
11467 && (tem
= XCAR (XCAR (tail
)),
11469 && (sym
= indirect_variable (XSYMBOL (tem
)),
11470 sym
->redirect
== SYMBOL_LOCALIZED
)
11471 && sym
->val
.blv
->frame_local
)
11472 /* Use find_symbol_value rather than Fsymbol_value
11473 to avoid an error if it is void. */
11474 find_symbol_value (tem
);
11475 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11479 #define STOP_POLLING \
11480 do { if (! polling_stopped_here) stop_polling (); \
11481 polling_stopped_here = 1; } while (0)
11483 #define RESUME_POLLING \
11484 do { if (polling_stopped_here) start_polling (); \
11485 polling_stopped_here = 0; } while (0)
11488 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11489 response to any user action; therefore, we should preserve the echo
11490 area. (Actually, our caller does that job.) Perhaps in the future
11491 avoid recentering windows if it is not necessary; currently that
11492 causes some problems. */
11495 redisplay_internal (int preserve_echo_area
)
11497 struct window
*w
= XWINDOW (selected_window
);
11500 int must_finish
= 0;
11501 struct text_pos tlbufpos
, tlendpos
;
11502 int number_of_visible_frames
;
11505 int polling_stopped_here
= 0;
11506 Lisp_Object old_frame
= selected_frame
;
11508 /* Non-zero means redisplay has to consider all windows on all
11509 frames. Zero means, only selected_window is considered. */
11510 int consider_all_windows_p
;
11512 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11514 /* No redisplay if running in batch mode or frame is not yet fully
11515 initialized, or redisplay is explicitly turned off by setting
11516 Vinhibit_redisplay. */
11517 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11518 || !NILP (Vinhibit_redisplay
))
11521 /* Don't examine these until after testing Vinhibit_redisplay.
11522 When Emacs is shutting down, perhaps because its connection to
11523 X has dropped, we should not look at them at all. */
11524 f
= XFRAME (w
->frame
);
11525 sf
= SELECTED_FRAME ();
11527 if (!f
->glyphs_initialized_p
)
11530 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11531 if (popup_activated ())
11535 /* I don't think this happens but let's be paranoid. */
11536 if (redisplaying_p
)
11539 /* Record a function that resets redisplaying_p to its old value
11540 when we leave this function. */
11541 count
= SPECPDL_INDEX ();
11542 record_unwind_protect (unwind_redisplay
,
11543 Fcons (make_number (redisplaying_p
), selected_frame
));
11545 specbind (Qinhibit_free_realized_faces
, Qnil
);
11548 Lisp_Object tail
, frame
;
11550 FOR_EACH_FRAME (tail
, frame
)
11552 struct frame
*f
= XFRAME (frame
);
11553 f
->already_hscrolled_p
= 0;
11558 if (!EQ (old_frame
, selected_frame
)
11559 && FRAME_LIVE_P (XFRAME (old_frame
)))
11560 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11561 selected_frame and selected_window to be temporarily out-of-sync so
11562 when we come back here via `goto retry', we need to resync because we
11563 may need to run Elisp code (via prepare_menu_bars). */
11564 select_frame_for_redisplay (old_frame
);
11567 reconsider_clip_changes (w
, current_buffer
);
11568 last_escape_glyph_frame
= NULL
;
11569 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11571 /* If new fonts have been loaded that make a glyph matrix adjustment
11572 necessary, do it. */
11573 if (fonts_changed_p
)
11575 adjust_glyphs (NULL
);
11576 ++windows_or_buffers_changed
;
11577 fonts_changed_p
= 0;
11580 /* If face_change_count is non-zero, init_iterator will free all
11581 realized faces, which includes the faces referenced from current
11582 matrices. So, we can't reuse current matrices in this case. */
11583 if (face_change_count
)
11584 ++windows_or_buffers_changed
;
11586 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11587 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11589 /* Since frames on a single ASCII terminal share the same
11590 display area, displaying a different frame means redisplay
11591 the whole thing. */
11592 windows_or_buffers_changed
++;
11593 SET_FRAME_GARBAGED (sf
);
11595 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11597 FRAME_TTY (sf
)->previous_frame
= sf
;
11600 /* Set the visible flags for all frames. Do this before checking
11601 for resized or garbaged frames; they want to know if their frames
11602 are visible. See the comment in frame.h for
11603 FRAME_SAMPLE_VISIBILITY. */
11605 Lisp_Object tail
, frame
;
11607 number_of_visible_frames
= 0;
11609 FOR_EACH_FRAME (tail
, frame
)
11611 struct frame
*f
= XFRAME (frame
);
11613 FRAME_SAMPLE_VISIBILITY (f
);
11614 if (FRAME_VISIBLE_P (f
))
11615 ++number_of_visible_frames
;
11616 clear_desired_matrices (f
);
11620 /* Notice any pending interrupt request to change frame size. */
11621 do_pending_window_change (1);
11623 /* Clear frames marked as garbaged. */
11624 if (frame_garbaged
)
11625 clear_garbaged_frames ();
11627 /* Build menubar and tool-bar items. */
11628 if (NILP (Vmemory_full
))
11629 prepare_menu_bars ();
11631 if (windows_or_buffers_changed
)
11632 update_mode_lines
++;
11634 /* Detect case that we need to write or remove a star in the mode line. */
11635 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11637 w
->update_mode_line
= Qt
;
11638 if (buffer_shared
> 1)
11639 update_mode_lines
++;
11642 /* Avoid invocation of point motion hooks by `current_column' below. */
11643 count1
= SPECPDL_INDEX ();
11644 specbind (Qinhibit_point_motion_hooks
, Qt
);
11646 /* If %c is in the mode line, update it if needed. */
11647 if (!NILP (w
->column_number_displayed
)
11648 /* This alternative quickly identifies a common case
11649 where no change is needed. */
11650 && !(PT
== XFASTINT (w
->last_point
)
11651 && XFASTINT (w
->last_modified
) >= MODIFF
11652 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11653 && (XFASTINT (w
->column_number_displayed
)
11654 != (int) current_column ())) /* iftc */
11655 w
->update_mode_line
= Qt
;
11657 unbind_to (count1
, Qnil
);
11659 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11661 /* The variable buffer_shared is set in redisplay_window and
11662 indicates that we redisplay a buffer in different windows. See
11664 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11665 || cursor_type_changed
);
11667 /* If specs for an arrow have changed, do thorough redisplay
11668 to ensure we remove any arrow that should no longer exist. */
11669 if (overlay_arrows_changed_p ())
11670 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11672 /* Normally the message* functions will have already displayed and
11673 updated the echo area, but the frame may have been trashed, or
11674 the update may have been preempted, so display the echo area
11675 again here. Checking message_cleared_p captures the case that
11676 the echo area should be cleared. */
11677 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11678 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11679 || (message_cleared_p
11680 && minibuf_level
== 0
11681 /* If the mini-window is currently selected, this means the
11682 echo-area doesn't show through. */
11683 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11685 int window_height_changed_p
= echo_area_display (0);
11688 /* If we don't display the current message, don't clear the
11689 message_cleared_p flag, because, if we did, we wouldn't clear
11690 the echo area in the next redisplay which doesn't preserve
11692 if (!display_last_displayed_message_p
)
11693 message_cleared_p
= 0;
11695 if (fonts_changed_p
)
11697 else if (window_height_changed_p
)
11699 consider_all_windows_p
= 1;
11700 ++update_mode_lines
;
11701 ++windows_or_buffers_changed
;
11703 /* If window configuration was changed, frames may have been
11704 marked garbaged. Clear them or we will experience
11705 surprises wrt scrolling. */
11706 if (frame_garbaged
)
11707 clear_garbaged_frames ();
11710 else if (EQ (selected_window
, minibuf_window
)
11711 && (current_buffer
->clip_changed
11712 || XFASTINT (w
->last_modified
) < MODIFF
11713 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11714 && resize_mini_window (w
, 0))
11716 /* Resized active mini-window to fit the size of what it is
11717 showing if its contents might have changed. */
11719 /* FIXME: this causes all frames to be updated, which seems unnecessary
11720 since only the current frame needs to be considered. This function needs
11721 to be rewritten with two variables, consider_all_windows and
11722 consider_all_frames. */
11723 consider_all_windows_p
= 1;
11724 ++windows_or_buffers_changed
;
11725 ++update_mode_lines
;
11727 /* If window configuration was changed, frames may have been
11728 marked garbaged. Clear them or we will experience
11729 surprises wrt scrolling. */
11730 if (frame_garbaged
)
11731 clear_garbaged_frames ();
11735 /* If showing the region, and mark has changed, we must redisplay
11736 the whole window. The assignment to this_line_start_pos prevents
11737 the optimization directly below this if-statement. */
11738 if (((!NILP (Vtransient_mark_mode
)
11739 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11740 != !NILP (w
->region_showing
))
11741 || (!NILP (w
->region_showing
)
11742 && !EQ (w
->region_showing
,
11743 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11744 CHARPOS (this_line_start_pos
) = 0;
11746 /* Optimize the case that only the line containing the cursor in the
11747 selected window has changed. Variables starting with this_ are
11748 set in display_line and record information about the line
11749 containing the cursor. */
11750 tlbufpos
= this_line_start_pos
;
11751 tlendpos
= this_line_end_pos
;
11752 if (!consider_all_windows_p
11753 && CHARPOS (tlbufpos
) > 0
11754 && NILP (w
->update_mode_line
)
11755 && !current_buffer
->clip_changed
11756 && !current_buffer
->prevent_redisplay_optimizations_p
11757 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11758 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11759 /* Make sure recorded data applies to current buffer, etc. */
11760 && this_line_buffer
== current_buffer
11761 && current_buffer
== XBUFFER (w
->buffer
)
11762 && NILP (w
->force_start
)
11763 && NILP (w
->optional_new_start
)
11764 /* Point must be on the line that we have info recorded about. */
11765 && PT
>= CHARPOS (tlbufpos
)
11766 && PT
<= Z
- CHARPOS (tlendpos
)
11767 /* All text outside that line, including its final newline,
11768 must be unchanged. */
11769 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11770 CHARPOS (tlendpos
)))
11772 if (CHARPOS (tlbufpos
) > BEGV
11773 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11774 && (CHARPOS (tlbufpos
) == ZV
11775 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11776 /* Former continuation line has disappeared by becoming empty. */
11778 else if (XFASTINT (w
->last_modified
) < MODIFF
11779 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11780 || MINI_WINDOW_P (w
))
11782 /* We have to handle the case of continuation around a
11783 wide-column character (see the comment in indent.c around
11786 For instance, in the following case:
11788 -------- Insert --------
11789 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11790 J_I_ ==> J_I_ `^^' are cursors.
11794 As we have to redraw the line above, we cannot use this
11798 int line_height_before
= this_line_pixel_height
;
11800 /* Note that start_display will handle the case that the
11801 line starting at tlbufpos is a continuation line. */
11802 start_display (&it
, w
, tlbufpos
);
11804 /* Implementation note: It this still necessary? */
11805 if (it
.current_x
!= this_line_start_x
)
11808 TRACE ((stderr
, "trying display optimization 1\n"));
11809 w
->cursor
.vpos
= -1;
11810 overlay_arrow_seen
= 0;
11811 it
.vpos
= this_line_vpos
;
11812 it
.current_y
= this_line_y
;
11813 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11814 display_line (&it
);
11816 /* If line contains point, is not continued,
11817 and ends at same distance from eob as before, we win. */
11818 if (w
->cursor
.vpos
>= 0
11819 /* Line is not continued, otherwise this_line_start_pos
11820 would have been set to 0 in display_line. */
11821 && CHARPOS (this_line_start_pos
)
11822 /* Line ends as before. */
11823 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11824 /* Line has same height as before. Otherwise other lines
11825 would have to be shifted up or down. */
11826 && this_line_pixel_height
== line_height_before
)
11828 /* If this is not the window's last line, we must adjust
11829 the charstarts of the lines below. */
11830 if (it
.current_y
< it
.last_visible_y
)
11832 struct glyph_row
*row
11833 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11834 int delta
, delta_bytes
;
11836 /* We used to distinguish between two cases here,
11837 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11838 when the line ends in a newline or the end of the
11839 buffer's accessible portion. But both cases did
11840 the same, so they were collapsed. */
11842 - CHARPOS (tlendpos
)
11843 - MATRIX_ROW_START_CHARPOS (row
));
11844 delta_bytes
= (Z_BYTE
11845 - BYTEPOS (tlendpos
)
11846 - MATRIX_ROW_START_BYTEPOS (row
));
11848 increment_matrix_positions (w
->current_matrix
,
11849 this_line_vpos
+ 1,
11850 w
->current_matrix
->nrows
,
11851 delta
, delta_bytes
);
11854 /* If this row displays text now but previously didn't,
11855 or vice versa, w->window_end_vpos may have to be
11857 if ((it
.glyph_row
- 1)->displays_text_p
)
11859 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11860 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11862 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11863 && this_line_vpos
> 0)
11864 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11865 w
->window_end_valid
= Qnil
;
11867 /* Update hint: No need to try to scroll in update_window. */
11868 w
->desired_matrix
->no_scrolling_p
= 1;
11871 *w
->desired_matrix
->method
= 0;
11872 debug_method_add (w
, "optimization 1");
11874 #ifdef HAVE_WINDOW_SYSTEM
11875 update_window_fringes (w
, 0);
11882 else if (/* Cursor position hasn't changed. */
11883 PT
== XFASTINT (w
->last_point
)
11884 /* Make sure the cursor was last displayed
11885 in this window. Otherwise we have to reposition it. */
11886 && 0 <= w
->cursor
.vpos
11887 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11891 do_pending_window_change (1);
11893 /* We used to always goto end_of_redisplay here, but this
11894 isn't enough if we have a blinking cursor. */
11895 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11896 goto end_of_redisplay
;
11900 /* If highlighting the region, or if the cursor is in the echo area,
11901 then we can't just move the cursor. */
11902 else if (! (!NILP (Vtransient_mark_mode
)
11903 && !NILP (current_buffer
->mark_active
))
11904 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11905 || highlight_nonselected_windows
)
11906 && NILP (w
->region_showing
)
11907 && NILP (Vshow_trailing_whitespace
)
11908 && !cursor_in_echo_area
)
11911 struct glyph_row
*row
;
11913 /* Skip from tlbufpos to PT and see where it is. Note that
11914 PT may be in invisible text. If so, we will end at the
11915 next visible position. */
11916 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11917 NULL
, DEFAULT_FACE_ID
);
11918 it
.current_x
= this_line_start_x
;
11919 it
.current_y
= this_line_y
;
11920 it
.vpos
= this_line_vpos
;
11922 /* The call to move_it_to stops in front of PT, but
11923 moves over before-strings. */
11924 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11926 if (it
.vpos
== this_line_vpos
11927 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11930 xassert (this_line_vpos
== it
.vpos
);
11931 xassert (this_line_y
== it
.current_y
);
11932 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11934 *w
->desired_matrix
->method
= 0;
11935 debug_method_add (w
, "optimization 3");
11944 /* Text changed drastically or point moved off of line. */
11945 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11948 CHARPOS (this_line_start_pos
) = 0;
11949 consider_all_windows_p
|= buffer_shared
> 1;
11950 ++clear_face_cache_count
;
11951 #ifdef HAVE_WINDOW_SYSTEM
11952 ++clear_image_cache_count
;
11955 /* Build desired matrices, and update the display. If
11956 consider_all_windows_p is non-zero, do it for all windows on all
11957 frames. Otherwise do it for selected_window, only. */
11959 if (consider_all_windows_p
)
11961 Lisp_Object tail
, frame
;
11963 FOR_EACH_FRAME (tail
, frame
)
11964 XFRAME (frame
)->updated_p
= 0;
11966 /* Recompute # windows showing selected buffer. This will be
11967 incremented each time such a window is displayed. */
11970 FOR_EACH_FRAME (tail
, frame
)
11972 struct frame
*f
= XFRAME (frame
);
11974 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11976 if (! EQ (frame
, selected_frame
))
11977 /* Select the frame, for the sake of frame-local
11979 select_frame_for_redisplay (frame
);
11981 /* Mark all the scroll bars to be removed; we'll redeem
11982 the ones we want when we redisplay their windows. */
11983 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11984 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11986 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11987 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11989 /* The X error handler may have deleted that frame. */
11990 if (!FRAME_LIVE_P (f
))
11993 /* Any scroll bars which redisplay_windows should have
11994 nuked should now go away. */
11995 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11996 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11998 /* If fonts changed, display again. */
11999 /* ??? rms: I suspect it is a mistake to jump all the way
12000 back to retry here. It should just retry this frame. */
12001 if (fonts_changed_p
)
12004 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12006 /* See if we have to hscroll. */
12007 if (!f
->already_hscrolled_p
)
12009 f
->already_hscrolled_p
= 1;
12010 if (hscroll_windows (f
->root_window
))
12014 /* Prevent various kinds of signals during display
12015 update. stdio is not robust about handling
12016 signals, which can cause an apparent I/O
12018 if (interrupt_input
)
12019 unrequest_sigio ();
12022 /* Update the display. */
12023 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12024 pause
|= update_frame (f
, 0, 0);
12030 if (!EQ (old_frame
, selected_frame
)
12031 && FRAME_LIVE_P (XFRAME (old_frame
)))
12032 /* We played a bit fast-and-loose above and allowed selected_frame
12033 and selected_window to be temporarily out-of-sync but let's make
12034 sure this stays contained. */
12035 select_frame_for_redisplay (old_frame
);
12036 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12040 /* Do the mark_window_display_accurate after all windows have
12041 been redisplayed because this call resets flags in buffers
12042 which are needed for proper redisplay. */
12043 FOR_EACH_FRAME (tail
, frame
)
12045 struct frame
*f
= XFRAME (frame
);
12048 mark_window_display_accurate (f
->root_window
, 1);
12049 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12050 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12055 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12057 Lisp_Object mini_window
;
12058 struct frame
*mini_frame
;
12060 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12061 /* Use list_of_error, not Qerror, so that
12062 we catch only errors and don't run the debugger. */
12063 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12065 redisplay_window_error
);
12067 /* Compare desired and current matrices, perform output. */
12070 /* If fonts changed, display again. */
12071 if (fonts_changed_p
)
12074 /* Prevent various kinds of signals during display update.
12075 stdio is not robust about handling signals,
12076 which can cause an apparent I/O error. */
12077 if (interrupt_input
)
12078 unrequest_sigio ();
12081 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12083 if (hscroll_windows (selected_window
))
12086 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12087 pause
= update_frame (sf
, 0, 0);
12090 /* We may have called echo_area_display at the top of this
12091 function. If the echo area is on another frame, that may
12092 have put text on a frame other than the selected one, so the
12093 above call to update_frame would not have caught it. Catch
12095 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12096 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12098 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12100 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12101 pause
|= update_frame (mini_frame
, 0, 0);
12102 if (!pause
&& hscroll_windows (mini_window
))
12107 /* If display was paused because of pending input, make sure we do a
12108 thorough update the next time. */
12111 /* Prevent the optimization at the beginning of
12112 redisplay_internal that tries a single-line update of the
12113 line containing the cursor in the selected window. */
12114 CHARPOS (this_line_start_pos
) = 0;
12116 /* Let the overlay arrow be updated the next time. */
12117 update_overlay_arrows (0);
12119 /* If we pause after scrolling, some rows in the current
12120 matrices of some windows are not valid. */
12121 if (!WINDOW_FULL_WIDTH_P (w
)
12122 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12123 update_mode_lines
= 1;
12127 if (!consider_all_windows_p
)
12129 /* This has already been done above if
12130 consider_all_windows_p is set. */
12131 mark_window_display_accurate_1 (w
, 1);
12133 /* Say overlay arrows are up to date. */
12134 update_overlay_arrows (1);
12136 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12137 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12140 update_mode_lines
= 0;
12141 windows_or_buffers_changed
= 0;
12142 cursor_type_changed
= 0;
12145 /* Start SIGIO interrupts coming again. Having them off during the
12146 code above makes it less likely one will discard output, but not
12147 impossible, since there might be stuff in the system buffer here.
12148 But it is much hairier to try to do anything about that. */
12149 if (interrupt_input
)
12153 /* If a frame has become visible which was not before, redisplay
12154 again, so that we display it. Expose events for such a frame
12155 (which it gets when becoming visible) don't call the parts of
12156 redisplay constructing glyphs, so simply exposing a frame won't
12157 display anything in this case. So, we have to display these
12158 frames here explicitly. */
12161 Lisp_Object tail
, frame
;
12164 FOR_EACH_FRAME (tail
, frame
)
12166 int this_is_visible
= 0;
12168 if (XFRAME (frame
)->visible
)
12169 this_is_visible
= 1;
12170 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12171 if (XFRAME (frame
)->visible
)
12172 this_is_visible
= 1;
12174 if (this_is_visible
)
12178 if (new_count
!= number_of_visible_frames
)
12179 windows_or_buffers_changed
++;
12182 /* Change frame size now if a change is pending. */
12183 do_pending_window_change (1);
12185 /* If we just did a pending size change, or have additional
12186 visible frames, redisplay again. */
12187 if (windows_or_buffers_changed
&& !pause
)
12190 /* Clear the face and image caches.
12192 We used to do this only if consider_all_windows_p. But the cache
12193 needs to be cleared if a timer creates images in the current
12194 buffer (e.g. the test case in Bug#6230). */
12196 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12198 clear_face_cache (0);
12199 clear_face_cache_count
= 0;
12202 #ifdef HAVE_WINDOW_SYSTEM
12203 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12205 clear_image_caches (Qnil
);
12206 clear_image_cache_count
= 0;
12208 #endif /* HAVE_WINDOW_SYSTEM */
12211 unbind_to (count
, Qnil
);
12216 /* Redisplay, but leave alone any recent echo area message unless
12217 another message has been requested in its place.
12219 This is useful in situations where you need to redisplay but no
12220 user action has occurred, making it inappropriate for the message
12221 area to be cleared. See tracking_off and
12222 wait_reading_process_output for examples of these situations.
12224 FROM_WHERE is an integer saying from where this function was
12225 called. This is useful for debugging. */
12228 redisplay_preserve_echo_area (int from_where
)
12230 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12232 if (!NILP (echo_area_buffer
[1]))
12234 /* We have a previously displayed message, but no current
12235 message. Redisplay the previous message. */
12236 display_last_displayed_message_p
= 1;
12237 redisplay_internal (1);
12238 display_last_displayed_message_p
= 0;
12241 redisplay_internal (1);
12243 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12244 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12245 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12249 /* Function registered with record_unwind_protect in
12250 redisplay_internal. Reset redisplaying_p to the value it had
12251 before redisplay_internal was called, and clear
12252 prevent_freeing_realized_faces_p. It also selects the previously
12253 selected frame, unless it has been deleted (by an X connection
12254 failure during redisplay, for example). */
12257 unwind_redisplay (Lisp_Object val
)
12259 Lisp_Object old_redisplaying_p
, old_frame
;
12261 old_redisplaying_p
= XCAR (val
);
12262 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12263 old_frame
= XCDR (val
);
12264 if (! EQ (old_frame
, selected_frame
)
12265 && FRAME_LIVE_P (XFRAME (old_frame
)))
12266 select_frame_for_redisplay (old_frame
);
12271 /* Mark the display of window W as accurate or inaccurate. If
12272 ACCURATE_P is non-zero mark display of W as accurate. If
12273 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12274 redisplay_internal is called. */
12277 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12279 if (BUFFERP (w
->buffer
))
12281 struct buffer
*b
= XBUFFER (w
->buffer
);
12284 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12285 w
->last_overlay_modified
12286 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12288 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12292 b
->clip_changed
= 0;
12293 b
->prevent_redisplay_optimizations_p
= 0;
12295 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12296 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12297 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12298 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12300 w
->current_matrix
->buffer
= b
;
12301 w
->current_matrix
->begv
= BUF_BEGV (b
);
12302 w
->current_matrix
->zv
= BUF_ZV (b
);
12304 w
->last_cursor
= w
->cursor
;
12305 w
->last_cursor_off_p
= w
->cursor_off_p
;
12307 if (w
== XWINDOW (selected_window
))
12308 w
->last_point
= make_number (BUF_PT (b
));
12310 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12316 w
->window_end_valid
= w
->buffer
;
12317 w
->update_mode_line
= Qnil
;
12322 /* Mark the display of windows in the window tree rooted at WINDOW as
12323 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12324 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12325 be redisplayed the next time redisplay_internal is called. */
12328 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12332 for (; !NILP (window
); window
= w
->next
)
12334 w
= XWINDOW (window
);
12335 mark_window_display_accurate_1 (w
, accurate_p
);
12337 if (!NILP (w
->vchild
))
12338 mark_window_display_accurate (w
->vchild
, accurate_p
);
12339 if (!NILP (w
->hchild
))
12340 mark_window_display_accurate (w
->hchild
, accurate_p
);
12345 update_overlay_arrows (1);
12349 /* Force a thorough redisplay the next time by setting
12350 last_arrow_position and last_arrow_string to t, which is
12351 unequal to any useful value of Voverlay_arrow_... */
12352 update_overlay_arrows (-1);
12357 /* Return value in display table DP (Lisp_Char_Table *) for character
12358 C. Since a display table doesn't have any parent, we don't have to
12359 follow parent. Do not call this function directly but use the
12360 macro DISP_CHAR_VECTOR. */
12363 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12367 if (ASCII_CHAR_P (c
))
12370 if (SUB_CHAR_TABLE_P (val
))
12371 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12377 XSETCHAR_TABLE (table
, dp
);
12378 val
= char_table_ref (table
, c
);
12387 /***********************************************************************
12389 ***********************************************************************/
12391 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12394 redisplay_windows (Lisp_Object window
)
12396 while (!NILP (window
))
12398 struct window
*w
= XWINDOW (window
);
12400 if (!NILP (w
->hchild
))
12401 redisplay_windows (w
->hchild
);
12402 else if (!NILP (w
->vchild
))
12403 redisplay_windows (w
->vchild
);
12404 else if (!NILP (w
->buffer
))
12406 displayed_buffer
= XBUFFER (w
->buffer
);
12407 /* Use list_of_error, not Qerror, so that
12408 we catch only errors and don't run the debugger. */
12409 internal_condition_case_1 (redisplay_window_0
, window
,
12411 redisplay_window_error
);
12419 redisplay_window_error (Lisp_Object ignore
)
12421 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12426 redisplay_window_0 (Lisp_Object window
)
12428 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12429 redisplay_window (window
, 0);
12434 redisplay_window_1 (Lisp_Object window
)
12436 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12437 redisplay_window (window
, 1);
12442 /* Increment GLYPH until it reaches END or CONDITION fails while
12443 adding (GLYPH)->pixel_width to X. */
12445 #define SKIP_GLYPHS(glyph, end, x, condition) \
12448 (x) += (glyph)->pixel_width; \
12451 while ((glyph) < (end) && (condition))
12454 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12455 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12456 which positions recorded in ROW differ from current buffer
12459 Return 0 if cursor is not on this row, 1 otherwise. */
12462 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12463 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12466 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12467 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12468 struct glyph
*cursor
= NULL
;
12469 /* The last known character position in row. */
12470 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12472 EMACS_INT pt_old
= PT
- delta
;
12473 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12474 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12475 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12476 /* A glyph beyond the edge of TEXT_AREA which we should never
12478 struct glyph
*glyphs_end
= end
;
12479 /* Non-zero means we've found a match for cursor position, but that
12480 glyph has the avoid_cursor_p flag set. */
12481 int match_with_avoid_cursor
= 0;
12482 /* Non-zero means we've seen at least one glyph that came from a
12484 int string_seen
= 0;
12485 /* Largest buffer position seen so far during scan of glyph row. */
12486 EMACS_INT bpos_max
= last_pos
;
12487 /* Last buffer position covered by an overlay string with an integer
12488 `cursor' property. */
12489 EMACS_INT bpos_covered
= 0;
12491 /* Skip over glyphs not having an object at the start and the end of
12492 the row. These are special glyphs like truncation marks on
12493 terminal frames. */
12494 if (row
->displays_text_p
)
12496 if (!row
->reversed_p
)
12499 && INTEGERP (glyph
->object
)
12500 && glyph
->charpos
< 0)
12502 x
+= glyph
->pixel_width
;
12506 && INTEGERP ((end
- 1)->object
)
12507 /* CHARPOS is zero for blanks and stretch glyphs
12508 inserted by extend_face_to_end_of_line. */
12509 && (end
- 1)->charpos
<= 0)
12511 glyph_before
= glyph
- 1;
12518 /* If the glyph row is reversed, we need to process it from back
12519 to front, so swap the edge pointers. */
12520 glyphs_end
= end
= glyph
- 1;
12521 glyph
+= row
->used
[TEXT_AREA
] - 1;
12523 while (glyph
> end
+ 1
12524 && INTEGERP (glyph
->object
)
12525 && glyph
->charpos
< 0)
12528 x
-= glyph
->pixel_width
;
12530 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12532 /* By default, in reversed rows we put the cursor on the
12533 rightmost (first in the reading order) glyph. */
12534 for (g
= end
+ 1; g
< glyph
; g
++)
12535 x
+= g
->pixel_width
;
12537 && INTEGERP ((end
+ 1)->object
)
12538 && (end
+ 1)->charpos
<= 0)
12540 glyph_before
= glyph
+ 1;
12544 else if (row
->reversed_p
)
12546 /* In R2L rows that don't display text, put the cursor on the
12547 rightmost glyph. Case in point: an empty last line that is
12548 part of an R2L paragraph. */
12550 /* Avoid placing the cursor on the last glyph of the row, where
12551 on terminal frames we hold the vertical border between
12552 adjacent windows. */
12553 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12554 && !WINDOW_RIGHTMOST_P (w
)
12555 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12557 x
= -1; /* will be computed below, at label compute_x */
12560 /* Step 1: Try to find the glyph whose character position
12561 corresponds to point. If that's not possible, find 2 glyphs
12562 whose character positions are the closest to point, one before
12563 point, the other after it. */
12564 if (!row
->reversed_p
)
12565 while (/* not marched to end of glyph row */
12567 /* glyph was not inserted by redisplay for internal purposes */
12568 && !INTEGERP (glyph
->object
))
12570 if (BUFFERP (glyph
->object
))
12572 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12574 if (glyph
->charpos
> bpos_max
)
12575 bpos_max
= glyph
->charpos
;
12576 if (!glyph
->avoid_cursor_p
)
12578 /* If we hit point, we've found the glyph on which to
12579 display the cursor. */
12582 match_with_avoid_cursor
= 0;
12585 /* See if we've found a better approximation to
12586 POS_BEFORE or to POS_AFTER. Note that we want the
12587 first (leftmost) glyph of all those that are the
12588 closest from below, and the last (rightmost) of all
12589 those from above. */
12590 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12592 pos_before
= glyph
->charpos
;
12593 glyph_before
= glyph
;
12595 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12597 pos_after
= glyph
->charpos
;
12598 glyph_after
= glyph
;
12601 else if (dpos
== 0)
12602 match_with_avoid_cursor
= 1;
12604 else if (STRINGP (glyph
->object
))
12606 Lisp_Object chprop
;
12607 int glyph_pos
= glyph
->charpos
;
12609 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12611 if (INTEGERP (chprop
))
12613 bpos_covered
= bpos_max
+ XINT (chprop
);
12614 /* If the `cursor' property covers buffer positions up
12615 to and including point, we should display cursor on
12616 this glyph. Note that overlays and text properties
12617 with string values stop bidi reordering, so every
12618 buffer position to the left of the string is always
12619 smaller than any position to the right of the
12620 string. Therefore, if a `cursor' property on one
12621 of the string's characters has an integer value, we
12622 will break out of the loop below _before_ we get to
12623 the position match above. IOW, integer values of
12624 the `cursor' property override the "exact match for
12625 point" strategy of positioning the cursor. */
12626 /* Implementation note: bpos_max == pt_old when, e.g.,
12627 we are in an empty line, where bpos_max is set to
12628 MATRIX_ROW_START_CHARPOS, see above. */
12629 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12638 x
+= glyph
->pixel_width
;
12641 else if (glyph
> end
) /* row is reversed */
12642 while (!INTEGERP (glyph
->object
))
12644 if (BUFFERP (glyph
->object
))
12646 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12648 if (glyph
->charpos
> bpos_max
)
12649 bpos_max
= glyph
->charpos
;
12650 if (!glyph
->avoid_cursor_p
)
12654 match_with_avoid_cursor
= 0;
12657 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12659 pos_before
= glyph
->charpos
;
12660 glyph_before
= glyph
;
12662 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12664 pos_after
= glyph
->charpos
;
12665 glyph_after
= glyph
;
12668 else if (dpos
== 0)
12669 match_with_avoid_cursor
= 1;
12671 else if (STRINGP (glyph
->object
))
12673 Lisp_Object chprop
;
12674 int glyph_pos
= glyph
->charpos
;
12676 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12678 if (INTEGERP (chprop
))
12680 bpos_covered
= bpos_max
+ XINT (chprop
);
12681 /* If the `cursor' property covers buffer positions up
12682 to and including point, we should display cursor on
12684 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12693 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12695 x
--; /* can't use any pixel_width */
12698 x
-= glyph
->pixel_width
;
12701 /* Step 2: If we didn't find an exact match for point, we need to
12702 look for a proper place to put the cursor among glyphs between
12703 GLYPH_BEFORE and GLYPH_AFTER. */
12704 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12705 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12706 && bpos_covered
< pt_old
)
12708 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12710 EMACS_INT ellipsis_pos
;
12712 /* Scan back over the ellipsis glyphs. */
12713 if (!row
->reversed_p
)
12715 ellipsis_pos
= (glyph
- 1)->charpos
;
12716 while (glyph
> row
->glyphs
[TEXT_AREA
]
12717 && (glyph
- 1)->charpos
== ellipsis_pos
)
12718 glyph
--, x
-= glyph
->pixel_width
;
12719 /* That loop always goes one position too far, including
12720 the glyph before the ellipsis. So scan forward over
12722 x
+= glyph
->pixel_width
;
12725 else /* row is reversed */
12727 ellipsis_pos
= (glyph
+ 1)->charpos
;
12728 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12729 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12730 glyph
++, x
+= glyph
->pixel_width
;
12731 x
-= glyph
->pixel_width
;
12735 else if (match_with_avoid_cursor
12736 /* zero-width characters produce no glyphs */
12737 || ((row
->reversed_p
12738 ? glyph_after
> glyphs_end
12739 : glyph_after
< glyphs_end
)
12740 && eabs (glyph_after
- glyph_before
) == 1))
12742 cursor
= glyph_after
;
12745 else if (string_seen
)
12747 int incr
= row
->reversed_p
? -1 : +1;
12749 /* Need to find the glyph that came out of a string which is
12750 present at point. That glyph is somewhere between
12751 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12752 positioned between POS_BEFORE and POS_AFTER in the
12754 struct glyph
*stop
= glyph_after
;
12755 EMACS_INT pos
= pos_before
;
12758 for (glyph
= glyph_before
+ incr
;
12759 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12762 /* Any glyphs that come from the buffer are here because
12763 of bidi reordering. Skip them, and only pay
12764 attention to glyphs that came from some string. */
12765 if (STRINGP (glyph
->object
))
12770 str
= glyph
->object
;
12771 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12772 if (tem
== 0 /* from overlay */
12775 /* If the string from which this glyph came is
12776 found in the buffer at point, then we've
12777 found the glyph we've been looking for. If
12778 it comes from an overlay (tem == 0), and it
12779 has the `cursor' property on one of its
12780 glyphs, record that glyph as a candidate for
12781 displaying the cursor. (As in the
12782 unidirectional version, we will display the
12783 cursor on the last candidate we find.) */
12784 if (tem
== 0 || tem
== pt_old
)
12786 /* The glyphs from this string could have
12787 been reordered. Find the one with the
12788 smallest string position. Or there could
12789 be a character in the string with the
12790 `cursor' property, which means display
12791 cursor on that character's glyph. */
12792 int strpos
= glyph
->charpos
;
12795 for (glyph
+= incr
;
12796 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12797 && EQ (glyph
->object
, str
);
12801 int gpos
= glyph
->charpos
;
12803 cprop
= Fget_char_property (make_number (gpos
),
12811 if (glyph
->charpos
< strpos
)
12813 strpos
= glyph
->charpos
;
12822 pos
= tem
+ 1; /* don't find previous instances */
12824 /* This string is not what we want; skip all of the
12825 glyphs that came from it. */
12828 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12829 && EQ (glyph
->object
, str
));
12835 /* If we reached the end of the line, and END was from a string,
12836 the cursor is not on this line. */
12838 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12839 && STRINGP (end
->object
)
12840 && row
->continued_p
)
12846 if (cursor
!= NULL
)
12852 /* Need to compute x that corresponds to GLYPH. */
12853 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12855 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12857 x
+= g
->pixel_width
;
12861 /* ROW could be part of a continued line, which, under bidi
12862 reordering, might have other rows whose start and end charpos
12863 occlude point. Only set w->cursor if we found a better
12864 approximation to the cursor position than we have from previously
12865 examined candidate rows belonging to the same continued line. */
12866 if (/* we already have a candidate row */
12867 w
->cursor
.vpos
>= 0
12868 /* that candidate is not the row we are processing */
12869 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12870 /* the row we are processing is part of a continued line */
12871 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12872 /* Make sure cursor.vpos specifies a row whose start and end
12873 charpos occlude point. This is because some callers of this
12874 function leave cursor.vpos at the row where the cursor was
12875 displayed during the last redisplay cycle. */
12876 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12877 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12880 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12882 /* Don't consider glyphs that are outside TEXT_AREA. */
12883 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12885 /* Keep the candidate whose buffer position is the closest to
12887 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12888 w
->cursor
.hpos
>= 0
12889 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12890 && BUFFERP (g1
->object
)
12891 && (g1
->charpos
== pt_old
/* an exact match always wins */
12892 || (BUFFERP (glyph
->object
)
12893 && eabs (g1
->charpos
- pt_old
)
12894 < eabs (glyph
->charpos
- pt_old
))))
12896 /* If this candidate gives an exact match, use that. */
12897 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12898 /* Otherwise, keep the candidate that comes from a row
12899 spanning less buffer positions. This may win when one or
12900 both candidate positions are on glyphs that came from
12901 display strings, for which we cannot compare buffer
12903 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12904 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12905 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12908 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12910 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12911 w
->cursor
.y
= row
->y
+ dy
;
12913 if (w
== XWINDOW (selected_window
))
12915 if (!row
->continued_p
12916 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12919 this_line_buffer
= XBUFFER (w
->buffer
);
12921 CHARPOS (this_line_start_pos
)
12922 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12923 BYTEPOS (this_line_start_pos
)
12924 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12926 CHARPOS (this_line_end_pos
)
12927 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12928 BYTEPOS (this_line_end_pos
)
12929 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12931 this_line_y
= w
->cursor
.y
;
12932 this_line_pixel_height
= row
->height
;
12933 this_line_vpos
= w
->cursor
.vpos
;
12934 this_line_start_x
= row
->x
;
12937 CHARPOS (this_line_start_pos
) = 0;
12944 /* Run window scroll functions, if any, for WINDOW with new window
12945 start STARTP. Sets the window start of WINDOW to that position.
12947 We assume that the window's buffer is really current. */
12949 static INLINE
struct text_pos
12950 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12952 struct window
*w
= XWINDOW (window
);
12953 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12955 if (current_buffer
!= XBUFFER (w
->buffer
))
12958 if (!NILP (Vwindow_scroll_functions
))
12960 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12961 make_number (CHARPOS (startp
)));
12962 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12963 /* In case the hook functions switch buffers. */
12964 if (current_buffer
!= XBUFFER (w
->buffer
))
12965 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12972 /* Make sure the line containing the cursor is fully visible.
12973 A value of 1 means there is nothing to be done.
12974 (Either the line is fully visible, or it cannot be made so,
12975 or we cannot tell.)
12977 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12978 is higher than window.
12980 A value of 0 means the caller should do scrolling
12981 as if point had gone off the screen. */
12984 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12986 struct glyph_matrix
*matrix
;
12987 struct glyph_row
*row
;
12990 if (!make_cursor_line_fully_visible_p
)
12993 /* It's not always possible to find the cursor, e.g, when a window
12994 is full of overlay strings. Don't do anything in that case. */
12995 if (w
->cursor
.vpos
< 0)
12998 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12999 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13001 /* If the cursor row is not partially visible, there's nothing to do. */
13002 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13005 /* If the row the cursor is in is taller than the window's height,
13006 it's not clear what to do, so do nothing. */
13007 window_height
= window_box_height (w
);
13008 if (row
->height
>= window_height
)
13010 if (!force_p
|| MINI_WINDOW_P (w
)
13011 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13018 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13019 non-zero means only WINDOW is redisplayed in redisplay_internal.
13020 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13021 in redisplay_window to bring a partially visible line into view in
13022 the case that only the cursor has moved.
13024 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13025 last screen line's vertical height extends past the end of the screen.
13029 1 if scrolling succeeded
13031 0 if scrolling didn't find point.
13033 -1 if new fonts have been loaded so that we must interrupt
13034 redisplay, adjust glyph matrices, and try again. */
13040 SCROLLING_NEED_LARGER_MATRICES
13044 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13045 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13046 int temp_scroll_step
, int last_line_misfit
)
13048 struct window
*w
= XWINDOW (window
);
13049 struct frame
*f
= XFRAME (w
->frame
);
13050 struct text_pos pos
, startp
;
13052 int this_scroll_margin
, scroll_max
, rc
, height
;
13053 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13054 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13055 Lisp_Object aggressive
;
13056 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13059 debug_method_add (w
, "try_scrolling");
13062 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13064 /* Compute scroll margin height in pixels. We scroll when point is
13065 within this distance from the top or bottom of the window. */
13066 if (scroll_margin
> 0)
13067 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13068 * FRAME_LINE_HEIGHT (f
);
13070 this_scroll_margin
= 0;
13072 /* Force scroll_conservatively to have a reasonable value, to avoid
13073 overflow while computing how much to scroll. Note that the user
13074 can supply scroll-conservatively equal to `most-positive-fixnum',
13075 which can be larger than INT_MAX. */
13076 if (scroll_conservatively
> scroll_limit
)
13078 scroll_conservatively
= scroll_limit
;
13079 scroll_max
= INT_MAX
;
13081 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13082 /* Compute how much we should try to scroll maximally to bring
13083 point into view. */
13084 scroll_max
= (max (scroll_step
,
13085 max (scroll_conservatively
, temp_scroll_step
))
13086 * FRAME_LINE_HEIGHT (f
));
13087 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13088 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13089 /* We're trying to scroll because of aggressive scrolling but no
13090 scroll_step is set. Choose an arbitrary one. */
13091 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13097 /* Decide whether to scroll down. */
13098 if (PT
> CHARPOS (startp
))
13100 int scroll_margin_y
;
13102 /* Compute the pixel ypos of the scroll margin, then move it to
13103 either that ypos or PT, whichever comes first. */
13104 start_display (&it
, w
, startp
);
13105 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13106 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13107 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13108 (MOVE_TO_POS
| MOVE_TO_Y
));
13110 if (PT
> CHARPOS (it
.current
.pos
))
13112 int y0
= line_bottom_y (&it
);
13113 /* Compute how many pixels below window bottom to stop searching
13114 for PT. This avoids costly search for PT that is far away if
13115 the user limited scrolling by a small number of lines, but
13116 always finds PT if scroll_conservatively is set to a large
13117 number, such as most-positive-fixnum. */
13118 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13120 slack
>= INT_MAX
- it
.last_visible_y
13122 : it
.last_visible_y
+ slack
;
13124 /* Compute the distance from the scroll margin to PT or to
13125 the scroll limit, whichever comes first. This should
13126 include the height of the cursor line, to make that line
13128 move_it_to (&it
, PT
, -1, y_to_move
,
13129 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13130 dy
= line_bottom_y (&it
) - y0
;
13132 if (dy
> scroll_max
)
13133 return SCROLLING_FAILED
;
13141 /* Point is in or below the bottom scroll margin, so move the
13142 window start down. If scrolling conservatively, move it just
13143 enough down to make point visible. If scroll_step is set,
13144 move it down by scroll_step. */
13145 if (scroll_conservatively
)
13147 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13148 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13149 else if (scroll_step
|| temp_scroll_step
)
13150 amount_to_scroll
= scroll_max
;
13153 aggressive
= current_buffer
->scroll_up_aggressively
;
13154 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13155 if (NUMBERP (aggressive
))
13157 double float_amount
= XFLOATINT (aggressive
) * height
;
13158 amount_to_scroll
= float_amount
;
13159 if (amount_to_scroll
== 0 && float_amount
> 0)
13160 amount_to_scroll
= 1;
13164 if (amount_to_scroll
<= 0)
13165 return SCROLLING_FAILED
;
13167 start_display (&it
, w
, startp
);
13168 if (scroll_max
< INT_MAX
)
13169 move_it_vertically (&it
, amount_to_scroll
);
13172 /* Extra precision for users who set scroll-conservatively
13173 to most-positive-fixnum: make sure the amount we scroll
13174 the window start is never less than amount_to_scroll,
13175 which was computed as distance from window bottom to
13176 point. This matters when lines at window top and lines
13177 below window bottom have different height. */
13178 struct it it1
= it
;
13179 /* We use a temporary it1 because line_bottom_y can modify
13180 its argument, if it moves one line down; see there. */
13181 int start_y
= line_bottom_y (&it1
);
13184 move_it_by_lines (&it
, 1, 1);
13186 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13189 /* If STARTP is unchanged, move it down another screen line. */
13190 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13191 move_it_by_lines (&it
, 1, 1);
13192 startp
= it
.current
.pos
;
13196 struct text_pos scroll_margin_pos
= startp
;
13198 /* See if point is inside the scroll margin at the top of the
13200 if (this_scroll_margin
)
13202 start_display (&it
, w
, startp
);
13203 move_it_vertically (&it
, this_scroll_margin
);
13204 scroll_margin_pos
= it
.current
.pos
;
13207 if (PT
< CHARPOS (scroll_margin_pos
))
13209 /* Point is in the scroll margin at the top of the window or
13210 above what is displayed in the window. */
13213 /* Compute the vertical distance from PT to the scroll
13214 margin position. Give up if distance is greater than
13216 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13217 start_display (&it
, w
, pos
);
13219 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13220 it
.last_visible_y
, -1,
13221 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13222 dy
= it
.current_y
- y0
;
13223 if (dy
> scroll_max
)
13224 return SCROLLING_FAILED
;
13226 /* Compute new window start. */
13227 start_display (&it
, w
, startp
);
13229 if (scroll_conservatively
)
13231 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13232 else if (scroll_step
|| temp_scroll_step
)
13233 amount_to_scroll
= scroll_max
;
13236 aggressive
= current_buffer
->scroll_down_aggressively
;
13237 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13238 if (NUMBERP (aggressive
))
13240 double float_amount
= XFLOATINT (aggressive
) * height
;
13241 amount_to_scroll
= float_amount
;
13242 if (amount_to_scroll
== 0 && float_amount
> 0)
13243 amount_to_scroll
= 1;
13247 if (amount_to_scroll
<= 0)
13248 return SCROLLING_FAILED
;
13250 move_it_vertically_backward (&it
, amount_to_scroll
);
13251 startp
= it
.current
.pos
;
13255 /* Run window scroll functions. */
13256 startp
= run_window_scroll_functions (window
, startp
);
13258 /* Display the window. Give up if new fonts are loaded, or if point
13260 if (!try_window (window
, startp
, 0))
13261 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13262 else if (w
->cursor
.vpos
< 0)
13264 clear_glyph_matrix (w
->desired_matrix
);
13265 rc
= SCROLLING_FAILED
;
13269 /* Maybe forget recorded base line for line number display. */
13270 if (!just_this_one_p
13271 || current_buffer
->clip_changed
13272 || BEG_UNCHANGED
< CHARPOS (startp
))
13273 w
->base_line_number
= Qnil
;
13275 /* If cursor ends up on a partially visible line,
13276 treat that as being off the bottom of the screen. */
13277 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13279 clear_glyph_matrix (w
->desired_matrix
);
13280 ++extra_scroll_margin_lines
;
13283 rc
= SCROLLING_SUCCESS
;
13290 /* Compute a suitable window start for window W if display of W starts
13291 on a continuation line. Value is non-zero if a new window start
13294 The new window start will be computed, based on W's width, starting
13295 from the start of the continued line. It is the start of the
13296 screen line with the minimum distance from the old start W->start. */
13299 compute_window_start_on_continuation_line (struct window
*w
)
13301 struct text_pos pos
, start_pos
;
13302 int window_start_changed_p
= 0;
13304 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13306 /* If window start is on a continuation line... Window start may be
13307 < BEGV in case there's invisible text at the start of the
13308 buffer (M-x rmail, for example). */
13309 if (CHARPOS (start_pos
) > BEGV
13310 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13313 struct glyph_row
*row
;
13315 /* Handle the case that the window start is out of range. */
13316 if (CHARPOS (start_pos
) < BEGV
)
13317 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13318 else if (CHARPOS (start_pos
) > ZV
)
13319 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13321 /* Find the start of the continued line. This should be fast
13322 because scan_buffer is fast (newline cache). */
13323 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13324 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13325 row
, DEFAULT_FACE_ID
);
13326 reseat_at_previous_visible_line_start (&it
);
13328 /* If the line start is "too far" away from the window start,
13329 say it takes too much time to compute a new window start. */
13330 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13331 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13333 int min_distance
, distance
;
13335 /* Move forward by display lines to find the new window
13336 start. If window width was enlarged, the new start can
13337 be expected to be > the old start. If window width was
13338 decreased, the new window start will be < the old start.
13339 So, we're looking for the display line start with the
13340 minimum distance from the old window start. */
13341 pos
= it
.current
.pos
;
13342 min_distance
= INFINITY
;
13343 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13344 distance
< min_distance
)
13346 min_distance
= distance
;
13347 pos
= it
.current
.pos
;
13348 move_it_by_lines (&it
, 1, 0);
13351 /* Set the window start there. */
13352 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13353 window_start_changed_p
= 1;
13357 return window_start_changed_p
;
13361 /* Try cursor movement in case text has not changed in window WINDOW,
13362 with window start STARTP. Value is
13364 CURSOR_MOVEMENT_SUCCESS if successful
13366 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13368 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13369 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13370 we want to scroll as if scroll-step were set to 1. See the code.
13372 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13373 which case we have to abort this redisplay, and adjust matrices
13378 CURSOR_MOVEMENT_SUCCESS
,
13379 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13380 CURSOR_MOVEMENT_MUST_SCROLL
,
13381 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13385 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13387 struct window
*w
= XWINDOW (window
);
13388 struct frame
*f
= XFRAME (w
->frame
);
13389 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13392 if (inhibit_try_cursor_movement
)
13396 /* Handle case where text has not changed, only point, and it has
13397 not moved off the frame. */
13398 if (/* Point may be in this window. */
13399 PT
>= CHARPOS (startp
)
13400 /* Selective display hasn't changed. */
13401 && !current_buffer
->clip_changed
13402 /* Function force-mode-line-update is used to force a thorough
13403 redisplay. It sets either windows_or_buffers_changed or
13404 update_mode_lines. So don't take a shortcut here for these
13406 && !update_mode_lines
13407 && !windows_or_buffers_changed
13408 && !cursor_type_changed
13409 /* Can't use this case if highlighting a region. When a
13410 region exists, cursor movement has to do more than just
13412 && !(!NILP (Vtransient_mark_mode
)
13413 && !NILP (current_buffer
->mark_active
))
13414 && NILP (w
->region_showing
)
13415 && NILP (Vshow_trailing_whitespace
)
13416 /* Right after splitting windows, last_point may be nil. */
13417 && INTEGERP (w
->last_point
)
13418 /* This code is not used for mini-buffer for the sake of the case
13419 of redisplaying to replace an echo area message; since in
13420 that case the mini-buffer contents per se are usually
13421 unchanged. This code is of no real use in the mini-buffer
13422 since the handling of this_line_start_pos, etc., in redisplay
13423 handles the same cases. */
13424 && !EQ (window
, minibuf_window
)
13425 /* When splitting windows or for new windows, it happens that
13426 redisplay is called with a nil window_end_vpos or one being
13427 larger than the window. This should really be fixed in
13428 window.c. I don't have this on my list, now, so we do
13429 approximately the same as the old redisplay code. --gerd. */
13430 && INTEGERP (w
->window_end_vpos
)
13431 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13432 && (FRAME_WINDOW_P (f
)
13433 || !overlay_arrow_in_current_buffer_p ()))
13435 int this_scroll_margin
, top_scroll_margin
;
13436 struct glyph_row
*row
= NULL
;
13439 debug_method_add (w
, "cursor movement");
13442 /* Scroll if point within this distance from the top or bottom
13443 of the window. This is a pixel value. */
13444 if (scroll_margin
> 0)
13446 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13447 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13450 this_scroll_margin
= 0;
13452 top_scroll_margin
= this_scroll_margin
;
13453 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13454 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13456 /* Start with the row the cursor was displayed during the last
13457 not paused redisplay. Give up if that row is not valid. */
13458 if (w
->last_cursor
.vpos
< 0
13459 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13460 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13463 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13464 if (row
->mode_line_p
)
13466 if (!row
->enabled_p
)
13467 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13470 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13472 int scroll_p
= 0, must_scroll
= 0;
13473 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13475 if (PT
> XFASTINT (w
->last_point
))
13477 /* Point has moved forward. */
13478 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13479 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13481 xassert (row
->enabled_p
);
13485 /* If the end position of a row equals the start
13486 position of the next row, and PT is at that position,
13487 we would rather display cursor in the next line. */
13488 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13489 && MATRIX_ROW_END_CHARPOS (row
) == PT
13490 && row
< w
->current_matrix
->rows
13491 + w
->current_matrix
->nrows
- 1
13492 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13493 && !cursor_row_p (w
, row
))
13496 /* If within the scroll margin, scroll. Note that
13497 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13498 the next line would be drawn, and that
13499 this_scroll_margin can be zero. */
13500 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13501 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13502 /* Line is completely visible last line in window
13503 and PT is to be set in the next line. */
13504 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13505 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13506 && !row
->ends_at_zv_p
13507 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13510 else if (PT
< XFASTINT (w
->last_point
))
13512 /* Cursor has to be moved backward. Note that PT >=
13513 CHARPOS (startp) because of the outer if-statement. */
13514 while (!row
->mode_line_p
13515 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13516 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13517 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13518 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13519 row
> w
->current_matrix
->rows
13520 && (row
-1)->ends_in_newline_from_string_p
))))
13521 && (row
->y
> top_scroll_margin
13522 || CHARPOS (startp
) == BEGV
))
13524 xassert (row
->enabled_p
);
13528 /* Consider the following case: Window starts at BEGV,
13529 there is invisible, intangible text at BEGV, so that
13530 display starts at some point START > BEGV. It can
13531 happen that we are called with PT somewhere between
13532 BEGV and START. Try to handle that case. */
13533 if (row
< w
->current_matrix
->rows
13534 || row
->mode_line_p
)
13536 row
= w
->current_matrix
->rows
;
13537 if (row
->mode_line_p
)
13541 /* Due to newlines in overlay strings, we may have to
13542 skip forward over overlay strings. */
13543 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13544 && MATRIX_ROW_END_CHARPOS (row
) == PT
13545 && !cursor_row_p (w
, row
))
13548 /* If within the scroll margin, scroll. */
13549 if (row
->y
< top_scroll_margin
13550 && CHARPOS (startp
) != BEGV
)
13555 /* Cursor did not move. So don't scroll even if cursor line
13556 is partially visible, as it was so before. */
13557 rc
= CURSOR_MOVEMENT_SUCCESS
;
13560 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13561 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13563 /* if PT is not in the glyph row, give up. */
13564 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13567 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13568 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13570 /* If rows are bidi-reordered and point moved, back up
13571 until we find a row that does not belong to a
13572 continuation line. This is because we must consider
13573 all rows of a continued line as candidates for the
13574 new cursor positioning, since row start and end
13575 positions change non-linearly with vertical position
13577 /* FIXME: Revisit this when glyph ``spilling'' in
13578 continuation lines' rows is implemented for
13579 bidi-reordered rows. */
13580 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13582 xassert (row
->enabled_p
);
13584 /* If we hit the beginning of the displayed portion
13585 without finding the first row of a continued
13587 if (row
<= w
->current_matrix
->rows
)
13589 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13597 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13598 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13599 && make_cursor_line_fully_visible_p
)
13601 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13602 && !row
->ends_at_zv_p
13603 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13604 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13605 else if (row
->height
> window_box_height (w
))
13607 /* If we end up in a partially visible line, let's
13608 make it fully visible, except when it's taller
13609 than the window, in which case we can't do much
13612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13616 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13617 if (!cursor_row_fully_visible_p (w
, 0, 1))
13618 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13620 rc
= CURSOR_MOVEMENT_SUCCESS
;
13624 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13625 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13626 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13628 /* With bidi-reordered rows, there could be more than
13629 one candidate row whose start and end positions
13630 occlude point. We need to let set_cursor_from_row
13631 find the best candidate. */
13632 /* FIXME: Revisit this when glyph ``spilling'' in
13633 continuation lines' rows is implemented for
13634 bidi-reordered rows. */
13639 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13640 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13641 && cursor_row_p (w
, row
))
13642 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13644 /* As soon as we've found the first suitable row
13645 whose ends_at_zv_p flag is set, we are done. */
13647 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13649 rc
= CURSOR_MOVEMENT_SUCCESS
;
13654 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13655 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13656 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13657 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13658 /* If we didn't find any candidate rows, or exited the
13659 loop before all the candidates were examined, signal
13660 to the caller that this method failed. */
13661 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13662 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13663 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13665 rc
= CURSOR_MOVEMENT_SUCCESS
;
13671 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13673 rc
= CURSOR_MOVEMENT_SUCCESS
;
13678 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13679 && MATRIX_ROW_START_CHARPOS (row
) == PT
13680 && cursor_row_p (w
, row
));
13689 set_vertical_scroll_bar (struct window
*w
)
13691 int start
, end
, whole
;
13693 /* Calculate the start and end positions for the current window.
13694 At some point, it would be nice to choose between scrollbars
13695 which reflect the whole buffer size, with special markers
13696 indicating narrowing, and scrollbars which reflect only the
13699 Note that mini-buffers sometimes aren't displaying any text. */
13700 if (!MINI_WINDOW_P (w
)
13701 || (w
== XWINDOW (minibuf_window
)
13702 && NILP (echo_area_buffer
[0])))
13704 struct buffer
*buf
= XBUFFER (w
->buffer
);
13705 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13706 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13707 /* I don't think this is guaranteed to be right. For the
13708 moment, we'll pretend it is. */
13709 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13713 if (whole
< (end
- start
))
13714 whole
= end
- start
;
13717 start
= end
= whole
= 0;
13719 /* Indicate what this scroll bar ought to be displaying now. */
13720 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13721 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13722 (w
, end
- start
, whole
, start
);
13726 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13727 selected_window is redisplayed.
13729 We can return without actually redisplaying the window if
13730 fonts_changed_p is nonzero. In that case, redisplay_internal will
13734 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13736 struct window
*w
= XWINDOW (window
);
13737 struct frame
*f
= XFRAME (w
->frame
);
13738 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13739 struct buffer
*old
= current_buffer
;
13740 struct text_pos lpoint
, opoint
, startp
;
13741 int update_mode_line
;
13744 /* Record it now because it's overwritten. */
13745 int current_matrix_up_to_date_p
= 0;
13746 int used_current_matrix_p
= 0;
13747 /* This is less strict than current_matrix_up_to_date_p.
13748 It indictes that the buffer contents and narrowing are unchanged. */
13749 int buffer_unchanged_p
= 0;
13750 int temp_scroll_step
= 0;
13751 int count
= SPECPDL_INDEX ();
13753 int centering_position
= -1;
13754 int last_line_misfit
= 0;
13755 int beg_unchanged
, end_unchanged
;
13757 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13760 /* W must be a leaf window here. */
13761 xassert (!NILP (w
->buffer
));
13763 *w
->desired_matrix
->method
= 0;
13767 reconsider_clip_changes (w
, buffer
);
13769 /* Has the mode line to be updated? */
13770 update_mode_line
= (!NILP (w
->update_mode_line
)
13771 || update_mode_lines
13772 || buffer
->clip_changed
13773 || buffer
->prevent_redisplay_optimizations_p
);
13775 if (MINI_WINDOW_P (w
))
13777 if (w
== XWINDOW (echo_area_window
)
13778 && !NILP (echo_area_buffer
[0]))
13780 if (update_mode_line
)
13781 /* We may have to update a tty frame's menu bar or a
13782 tool-bar. Example `M-x C-h C-h C-g'. */
13783 goto finish_menu_bars
;
13785 /* We've already displayed the echo area glyphs in this window. */
13786 goto finish_scroll_bars
;
13788 else if ((w
!= XWINDOW (minibuf_window
)
13789 || minibuf_level
== 0)
13790 /* When buffer is nonempty, redisplay window normally. */
13791 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13792 /* Quail displays non-mini buffers in minibuffer window.
13793 In that case, redisplay the window normally. */
13794 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13796 /* W is a mini-buffer window, but it's not active, so clear
13798 int yb
= window_text_bottom_y (w
);
13799 struct glyph_row
*row
;
13802 for (y
= 0, row
= w
->desired_matrix
->rows
;
13804 y
+= row
->height
, ++row
)
13805 blank_row (w
, row
, y
);
13806 goto finish_scroll_bars
;
13809 clear_glyph_matrix (w
->desired_matrix
);
13812 /* Otherwise set up data on this window; select its buffer and point
13814 /* Really select the buffer, for the sake of buffer-local
13816 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13818 current_matrix_up_to_date_p
13819 = (!NILP (w
->window_end_valid
)
13820 && !current_buffer
->clip_changed
13821 && !current_buffer
->prevent_redisplay_optimizations_p
13822 && XFASTINT (w
->last_modified
) >= MODIFF
13823 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13825 /* Run the window-bottom-change-functions
13826 if it is possible that the text on the screen has changed
13827 (either due to modification of the text, or any other reason). */
13828 if (!current_matrix_up_to_date_p
13829 && !NILP (Vwindow_text_change_functions
))
13831 safe_run_hooks (Qwindow_text_change_functions
);
13835 beg_unchanged
= BEG_UNCHANGED
;
13836 end_unchanged
= END_UNCHANGED
;
13838 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13840 specbind (Qinhibit_point_motion_hooks
, Qt
);
13843 = (!NILP (w
->window_end_valid
)
13844 && !current_buffer
->clip_changed
13845 && XFASTINT (w
->last_modified
) >= MODIFF
13846 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13848 /* When windows_or_buffers_changed is non-zero, we can't rely on
13849 the window end being valid, so set it to nil there. */
13850 if (windows_or_buffers_changed
)
13852 /* If window starts on a continuation line, maybe adjust the
13853 window start in case the window's width changed. */
13854 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13855 compute_window_start_on_continuation_line (w
);
13857 w
->window_end_valid
= Qnil
;
13860 /* Some sanity checks. */
13861 CHECK_WINDOW_END (w
);
13862 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13864 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13867 /* If %c is in mode line, update it if needed. */
13868 if (!NILP (w
->column_number_displayed
)
13869 /* This alternative quickly identifies a common case
13870 where no change is needed. */
13871 && !(PT
== XFASTINT (w
->last_point
)
13872 && XFASTINT (w
->last_modified
) >= MODIFF
13873 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13874 && (XFASTINT (w
->column_number_displayed
)
13875 != (int) current_column ())) /* iftc */
13876 update_mode_line
= 1;
13878 /* Count number of windows showing the selected buffer. An indirect
13879 buffer counts as its base buffer. */
13880 if (!just_this_one_p
)
13882 struct buffer
*current_base
, *window_base
;
13883 current_base
= current_buffer
;
13884 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13885 if (current_base
->base_buffer
)
13886 current_base
= current_base
->base_buffer
;
13887 if (window_base
->base_buffer
)
13888 window_base
= window_base
->base_buffer
;
13889 if (current_base
== window_base
)
13893 /* Point refers normally to the selected window. For any other
13894 window, set up appropriate value. */
13895 if (!EQ (window
, selected_window
))
13897 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13898 int new_pt_byte
= marker_byte_position (w
->pointm
);
13902 new_pt_byte
= BEGV_BYTE
;
13903 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13905 else if (new_pt
> (ZV
- 1))
13908 new_pt_byte
= ZV_BYTE
;
13909 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13912 /* We don't use SET_PT so that the point-motion hooks don't run. */
13913 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13916 /* If any of the character widths specified in the display table
13917 have changed, invalidate the width run cache. It's true that
13918 this may be a bit late to catch such changes, but the rest of
13919 redisplay goes (non-fatally) haywire when the display table is
13920 changed, so why should we worry about doing any better? */
13921 if (current_buffer
->width_run_cache
)
13923 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13925 if (! disptab_matches_widthtab (disptab
,
13926 XVECTOR (current_buffer
->width_table
)))
13928 invalidate_region_cache (current_buffer
,
13929 current_buffer
->width_run_cache
,
13931 recompute_width_table (current_buffer
, disptab
);
13935 /* If window-start is screwed up, choose a new one. */
13936 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13939 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13941 /* If someone specified a new starting point but did not insist,
13942 check whether it can be used. */
13943 if (!NILP (w
->optional_new_start
)
13944 && CHARPOS (startp
) >= BEGV
13945 && CHARPOS (startp
) <= ZV
)
13947 w
->optional_new_start
= Qnil
;
13948 start_display (&it
, w
, startp
);
13949 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13950 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13951 if (IT_CHARPOS (it
) == PT
)
13952 w
->force_start
= Qt
;
13953 /* IT may overshoot PT if text at PT is invisible. */
13954 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13955 w
->force_start
= Qt
;
13960 /* Handle case where place to start displaying has been specified,
13961 unless the specified location is outside the accessible range. */
13962 if (!NILP (w
->force_start
)
13963 || w
->frozen_window_start_p
)
13965 /* We set this later on if we have to adjust point. */
13968 w
->force_start
= Qnil
;
13970 w
->window_end_valid
= Qnil
;
13972 /* Forget any recorded base line for line number display. */
13973 if (!buffer_unchanged_p
)
13974 w
->base_line_number
= Qnil
;
13976 /* Redisplay the mode line. Select the buffer properly for that.
13977 Also, run the hook window-scroll-functions
13978 because we have scrolled. */
13979 /* Note, we do this after clearing force_start because
13980 if there's an error, it is better to forget about force_start
13981 than to get into an infinite loop calling the hook functions
13982 and having them get more errors. */
13983 if (!update_mode_line
13984 || ! NILP (Vwindow_scroll_functions
))
13986 update_mode_line
= 1;
13987 w
->update_mode_line
= Qt
;
13988 startp
= run_window_scroll_functions (window
, startp
);
13991 w
->last_modified
= make_number (0);
13992 w
->last_overlay_modified
= make_number (0);
13993 if (CHARPOS (startp
) < BEGV
)
13994 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13995 else if (CHARPOS (startp
) > ZV
)
13996 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13998 /* Redisplay, then check if cursor has been set during the
13999 redisplay. Give up if new fonts were loaded. */
14000 /* We used to issue a CHECK_MARGINS argument to try_window here,
14001 but this causes scrolling to fail when point begins inside
14002 the scroll margin (bug#148) -- cyd */
14003 if (!try_window (window
, startp
, 0))
14005 w
->force_start
= Qt
;
14006 clear_glyph_matrix (w
->desired_matrix
);
14007 goto need_larger_matrices
;
14010 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14012 /* If point does not appear, try to move point so it does
14013 appear. The desired matrix has been built above, so we
14014 can use it here. */
14015 new_vpos
= window_box_height (w
) / 2;
14018 if (!cursor_row_fully_visible_p (w
, 0, 0))
14020 /* Point does appear, but on a line partly visible at end of window.
14021 Move it back to a fully-visible line. */
14022 new_vpos
= window_box_height (w
);
14025 /* If we need to move point for either of the above reasons,
14026 now actually do it. */
14029 struct glyph_row
*row
;
14031 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14032 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14035 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14036 MATRIX_ROW_START_BYTEPOS (row
));
14038 if (w
!= XWINDOW (selected_window
))
14039 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14040 else if (current_buffer
== old
)
14041 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14043 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14045 /* If we are highlighting the region, then we just changed
14046 the region, so redisplay to show it. */
14047 if (!NILP (Vtransient_mark_mode
)
14048 && !NILP (current_buffer
->mark_active
))
14050 clear_glyph_matrix (w
->desired_matrix
);
14051 if (!try_window (window
, startp
, 0))
14052 goto need_larger_matrices
;
14057 debug_method_add (w
, "forced window start");
14062 /* Handle case where text has not changed, only point, and it has
14063 not moved off the frame, and we are not retrying after hscroll.
14064 (current_matrix_up_to_date_p is nonzero when retrying.) */
14065 if (current_matrix_up_to_date_p
14066 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14067 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14071 case CURSOR_MOVEMENT_SUCCESS
:
14072 used_current_matrix_p
= 1;
14075 case CURSOR_MOVEMENT_MUST_SCROLL
:
14076 goto try_to_scroll
;
14082 /* If current starting point was originally the beginning of a line
14083 but no longer is, find a new starting point. */
14084 else if (!NILP (w
->start_at_line_beg
)
14085 && !(CHARPOS (startp
) <= BEGV
14086 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14089 debug_method_add (w
, "recenter 1");
14094 /* Try scrolling with try_window_id. Value is > 0 if update has
14095 been done, it is -1 if we know that the same window start will
14096 not work. It is 0 if unsuccessful for some other reason. */
14097 else if ((tem
= try_window_id (w
)) != 0)
14100 debug_method_add (w
, "try_window_id %d", tem
);
14103 if (fonts_changed_p
)
14104 goto need_larger_matrices
;
14108 /* Otherwise try_window_id has returned -1 which means that we
14109 don't want the alternative below this comment to execute. */
14111 else if (CHARPOS (startp
) >= BEGV
14112 && CHARPOS (startp
) <= ZV
14113 && PT
>= CHARPOS (startp
)
14114 && (CHARPOS (startp
) < ZV
14115 /* Avoid starting at end of buffer. */
14116 || CHARPOS (startp
) == BEGV
14117 || (XFASTINT (w
->last_modified
) >= MODIFF
14118 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14121 /* If first window line is a continuation line, and window start
14122 is inside the modified region, but the first change is before
14123 current window start, we must select a new window start.
14125 However, if this is the result of a down-mouse event (e.g. by
14126 extending the mouse-drag-overlay), we don't want to select a
14127 new window start, since that would change the position under
14128 the mouse, resulting in an unwanted mouse-movement rather
14129 than a simple mouse-click. */
14130 if (NILP (w
->start_at_line_beg
)
14131 && NILP (do_mouse_tracking
)
14132 && CHARPOS (startp
) > BEGV
14133 && CHARPOS (startp
) > BEG
+ beg_unchanged
14134 && CHARPOS (startp
) <= Z
- end_unchanged
14135 /* Even if w->start_at_line_beg is nil, a new window may
14136 start at a line_beg, since that's how set_buffer_window
14137 sets it. So, we need to check the return value of
14138 compute_window_start_on_continuation_line. (See also
14140 && XMARKER (w
->start
)->buffer
== current_buffer
14141 && compute_window_start_on_continuation_line (w
))
14143 w
->force_start
= Qt
;
14144 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14149 debug_method_add (w
, "same window start");
14152 /* Try to redisplay starting at same place as before.
14153 If point has not moved off frame, accept the results. */
14154 if (!current_matrix_up_to_date_p
14155 /* Don't use try_window_reusing_current_matrix in this case
14156 because a window scroll function can have changed the
14158 || !NILP (Vwindow_scroll_functions
)
14159 || MINI_WINDOW_P (w
)
14160 || !(used_current_matrix_p
14161 = try_window_reusing_current_matrix (w
)))
14163 IF_DEBUG (debug_method_add (w
, "1"));
14164 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14165 /* -1 means we need to scroll.
14166 0 means we need new matrices, but fonts_changed_p
14167 is set in that case, so we will detect it below. */
14168 goto try_to_scroll
;
14171 if (fonts_changed_p
)
14172 goto need_larger_matrices
;
14174 if (w
->cursor
.vpos
>= 0)
14176 if (!just_this_one_p
14177 || current_buffer
->clip_changed
14178 || BEG_UNCHANGED
< CHARPOS (startp
))
14179 /* Forget any recorded base line for line number display. */
14180 w
->base_line_number
= Qnil
;
14182 if (!cursor_row_fully_visible_p (w
, 1, 0))
14184 clear_glyph_matrix (w
->desired_matrix
);
14185 last_line_misfit
= 1;
14187 /* Drop through and scroll. */
14192 clear_glyph_matrix (w
->desired_matrix
);
14197 w
->last_modified
= make_number (0);
14198 w
->last_overlay_modified
= make_number (0);
14200 /* Redisplay the mode line. Select the buffer properly for that. */
14201 if (!update_mode_line
)
14203 update_mode_line
= 1;
14204 w
->update_mode_line
= Qt
;
14207 /* Try to scroll by specified few lines. */
14208 if ((scroll_conservatively
14210 || temp_scroll_step
14211 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14212 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14213 && !current_buffer
->clip_changed
14214 && CHARPOS (startp
) >= BEGV
14215 && CHARPOS (startp
) <= ZV
)
14217 /* The function returns -1 if new fonts were loaded, 1 if
14218 successful, 0 if not successful. */
14219 int rc
= try_scrolling (window
, just_this_one_p
,
14220 scroll_conservatively
,
14222 temp_scroll_step
, last_line_misfit
);
14225 case SCROLLING_SUCCESS
:
14228 case SCROLLING_NEED_LARGER_MATRICES
:
14229 goto need_larger_matrices
;
14231 case SCROLLING_FAILED
:
14239 /* Finally, just choose place to start which centers point */
14242 if (centering_position
< 0)
14243 centering_position
= window_box_height (w
) / 2;
14246 debug_method_add (w
, "recenter");
14249 /* w->vscroll = 0; */
14251 /* Forget any previously recorded base line for line number display. */
14252 if (!buffer_unchanged_p
)
14253 w
->base_line_number
= Qnil
;
14255 /* Move backward half the height of the window. */
14256 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14257 it
.current_y
= it
.last_visible_y
;
14258 move_it_vertically_backward (&it
, centering_position
);
14259 xassert (IT_CHARPOS (it
) >= BEGV
);
14261 /* The function move_it_vertically_backward may move over more
14262 than the specified y-distance. If it->w is small, e.g. a
14263 mini-buffer window, we may end up in front of the window's
14264 display area. Start displaying at the start of the line
14265 containing PT in this case. */
14266 if (it
.current_y
<= 0)
14268 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14269 move_it_vertically_backward (&it
, 0);
14273 it
.current_x
= it
.hpos
= 0;
14275 /* Set startp here explicitly in case that helps avoid an infinite loop
14276 in case the window-scroll-functions functions get errors. */
14277 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14279 /* Run scroll hooks. */
14280 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14282 /* Redisplay the window. */
14283 if (!current_matrix_up_to_date_p
14284 || windows_or_buffers_changed
14285 || cursor_type_changed
14286 /* Don't use try_window_reusing_current_matrix in this case
14287 because it can have changed the buffer. */
14288 || !NILP (Vwindow_scroll_functions
)
14289 || !just_this_one_p
14290 || MINI_WINDOW_P (w
)
14291 || !(used_current_matrix_p
14292 = try_window_reusing_current_matrix (w
)))
14293 try_window (window
, startp
, 0);
14295 /* If new fonts have been loaded (due to fontsets), give up. We
14296 have to start a new redisplay since we need to re-adjust glyph
14298 if (fonts_changed_p
)
14299 goto need_larger_matrices
;
14301 /* If cursor did not appear assume that the middle of the window is
14302 in the first line of the window. Do it again with the next line.
14303 (Imagine a window of height 100, displaying two lines of height
14304 60. Moving back 50 from it->last_visible_y will end in the first
14306 if (w
->cursor
.vpos
< 0)
14308 if (!NILP (w
->window_end_valid
)
14309 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14311 clear_glyph_matrix (w
->desired_matrix
);
14312 move_it_by_lines (&it
, 1, 0);
14313 try_window (window
, it
.current
.pos
, 0);
14315 else if (PT
< IT_CHARPOS (it
))
14317 clear_glyph_matrix (w
->desired_matrix
);
14318 move_it_by_lines (&it
, -1, 0);
14319 try_window (window
, it
.current
.pos
, 0);
14323 /* Not much we can do about it. */
14327 /* Consider the following case: Window starts at BEGV, there is
14328 invisible, intangible text at BEGV, so that display starts at
14329 some point START > BEGV. It can happen that we are called with
14330 PT somewhere between BEGV and START. Try to handle that case. */
14331 if (w
->cursor
.vpos
< 0)
14333 struct glyph_row
*row
= w
->current_matrix
->rows
;
14334 if (row
->mode_line_p
)
14336 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14339 if (!cursor_row_fully_visible_p (w
, 0, 0))
14341 /* If vscroll is enabled, disable it and try again. */
14345 clear_glyph_matrix (w
->desired_matrix
);
14349 /* If centering point failed to make the whole line visible,
14350 put point at the top instead. That has to make the whole line
14351 visible, if it can be done. */
14352 if (centering_position
== 0)
14355 clear_glyph_matrix (w
->desired_matrix
);
14356 centering_position
= 0;
14362 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14363 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14364 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14367 /* Display the mode line, if we must. */
14368 if ((update_mode_line
14369 /* If window not full width, must redo its mode line
14370 if (a) the window to its side is being redone and
14371 (b) we do a frame-based redisplay. This is a consequence
14372 of how inverted lines are drawn in frame-based redisplay. */
14373 || (!just_this_one_p
14374 && !FRAME_WINDOW_P (f
)
14375 && !WINDOW_FULL_WIDTH_P (w
))
14376 /* Line number to display. */
14377 || INTEGERP (w
->base_line_pos
)
14378 /* Column number is displayed and different from the one displayed. */
14379 || (!NILP (w
->column_number_displayed
)
14380 && (XFASTINT (w
->column_number_displayed
)
14381 != (int) current_column ()))) /* iftc */
14382 /* This means that the window has a mode line. */
14383 && (WINDOW_WANTS_MODELINE_P (w
)
14384 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14386 display_mode_lines (w
);
14388 /* If mode line height has changed, arrange for a thorough
14389 immediate redisplay using the correct mode line height. */
14390 if (WINDOW_WANTS_MODELINE_P (w
)
14391 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14393 fonts_changed_p
= 1;
14394 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14395 = DESIRED_MODE_LINE_HEIGHT (w
);
14398 /* If header line height has changed, arrange for a thorough
14399 immediate redisplay using the correct header line height. */
14400 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14401 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14403 fonts_changed_p
= 1;
14404 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14405 = DESIRED_HEADER_LINE_HEIGHT (w
);
14408 if (fonts_changed_p
)
14409 goto need_larger_matrices
;
14412 if (!line_number_displayed
14413 && !BUFFERP (w
->base_line_pos
))
14415 w
->base_line_pos
= Qnil
;
14416 w
->base_line_number
= Qnil
;
14421 /* When we reach a frame's selected window, redo the frame's menu bar. */
14422 if (update_mode_line
14423 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14425 int redisplay_menu_p
= 0;
14426 int redisplay_tool_bar_p
= 0;
14428 if (FRAME_WINDOW_P (f
))
14430 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14431 || defined (HAVE_NS) || defined (USE_GTK)
14432 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14434 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14438 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14440 if (redisplay_menu_p
)
14441 display_menu_bar (w
);
14443 #ifdef HAVE_WINDOW_SYSTEM
14444 if (FRAME_WINDOW_P (f
))
14446 #if defined (USE_GTK) || defined (HAVE_NS)
14447 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14449 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14450 && (FRAME_TOOL_BAR_LINES (f
) > 0
14451 || !NILP (Vauto_resize_tool_bars
));
14454 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14456 ignore_mouse_drag_p
= 1;
14462 #ifdef HAVE_WINDOW_SYSTEM
14463 if (FRAME_WINDOW_P (f
)
14464 && update_window_fringes (w
, (just_this_one_p
14465 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14466 || w
->pseudo_window_p
)))
14470 if (draw_window_fringes (w
, 1))
14471 x_draw_vertical_border (w
);
14475 #endif /* HAVE_WINDOW_SYSTEM */
14477 /* We go to this label, with fonts_changed_p nonzero,
14478 if it is necessary to try again using larger glyph matrices.
14479 We have to redeem the scroll bar even in this case,
14480 because the loop in redisplay_internal expects that. */
14481 need_larger_matrices
:
14483 finish_scroll_bars
:
14485 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14487 /* Set the thumb's position and size. */
14488 set_vertical_scroll_bar (w
);
14490 /* Note that we actually used the scroll bar attached to this
14491 window, so it shouldn't be deleted at the end of redisplay. */
14492 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14493 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14496 /* Restore current_buffer and value of point in it. The window
14497 update may have changed the buffer, so first make sure `opoint'
14498 is still valid (Bug#6177). */
14499 if (CHARPOS (opoint
) < BEGV
)
14500 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14501 else if (CHARPOS (opoint
) > ZV
)
14502 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14504 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14506 set_buffer_internal_1 (old
);
14507 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14508 shorter. This can be caused by log truncation in *Messages*. */
14509 if (CHARPOS (lpoint
) <= ZV
)
14510 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14512 unbind_to (count
, Qnil
);
14516 /* Build the complete desired matrix of WINDOW with a window start
14517 buffer position POS.
14519 Value is 1 if successful. It is zero if fonts were loaded during
14520 redisplay which makes re-adjusting glyph matrices necessary, and -1
14521 if point would appear in the scroll margins.
14522 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14523 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14527 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14529 struct window
*w
= XWINDOW (window
);
14531 struct glyph_row
*last_text_row
= NULL
;
14532 struct frame
*f
= XFRAME (w
->frame
);
14534 /* Make POS the new window start. */
14535 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14537 /* Mark cursor position as unknown. No overlay arrow seen. */
14538 w
->cursor
.vpos
= -1;
14539 overlay_arrow_seen
= 0;
14541 /* Initialize iterator and info to start at POS. */
14542 start_display (&it
, w
, pos
);
14544 /* Display all lines of W. */
14545 while (it
.current_y
< it
.last_visible_y
)
14547 if (display_line (&it
))
14548 last_text_row
= it
.glyph_row
- 1;
14549 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14553 /* Don't let the cursor end in the scroll margins. */
14554 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14555 && !MINI_WINDOW_P (w
))
14557 int this_scroll_margin
;
14559 if (scroll_margin
> 0)
14561 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14562 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14565 this_scroll_margin
= 0;
14567 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14568 && w
->cursor
.y
< this_scroll_margin
14569 && CHARPOS (pos
) > BEGV
14570 && IT_CHARPOS (it
) < ZV
)
14571 /* rms: considering make_cursor_line_fully_visible_p here
14572 seems to give wrong results. We don't want to recenter
14573 when the last line is partly visible, we want to allow
14574 that case to be handled in the usual way. */
14575 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14577 w
->cursor
.vpos
= -1;
14578 clear_glyph_matrix (w
->desired_matrix
);
14583 /* If bottom moved off end of frame, change mode line percentage. */
14584 if (XFASTINT (w
->window_end_pos
) <= 0
14585 && Z
!= IT_CHARPOS (it
))
14586 w
->update_mode_line
= Qt
;
14588 /* Set window_end_pos to the offset of the last character displayed
14589 on the window from the end of current_buffer. Set
14590 window_end_vpos to its row number. */
14593 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14594 w
->window_end_bytepos
14595 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14597 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14599 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14600 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14601 ->displays_text_p
);
14605 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14606 w
->window_end_pos
= make_number (Z
- ZV
);
14607 w
->window_end_vpos
= make_number (0);
14610 /* But that is not valid info until redisplay finishes. */
14611 w
->window_end_valid
= Qnil
;
14617 /************************************************************************
14618 Window redisplay reusing current matrix when buffer has not changed
14619 ************************************************************************/
14621 /* Try redisplay of window W showing an unchanged buffer with a
14622 different window start than the last time it was displayed by
14623 reusing its current matrix. Value is non-zero if successful.
14624 W->start is the new window start. */
14627 try_window_reusing_current_matrix (struct window
*w
)
14629 struct frame
*f
= XFRAME (w
->frame
);
14630 struct glyph_row
*row
, *bottom_row
;
14633 struct text_pos start
, new_start
;
14634 int nrows_scrolled
, i
;
14635 struct glyph_row
*last_text_row
;
14636 struct glyph_row
*last_reused_text_row
;
14637 struct glyph_row
*start_row
;
14638 int start_vpos
, min_y
, max_y
;
14641 if (inhibit_try_window_reusing
)
14645 if (/* This function doesn't handle terminal frames. */
14646 !FRAME_WINDOW_P (f
)
14647 /* Don't try to reuse the display if windows have been split
14649 || windows_or_buffers_changed
14650 || cursor_type_changed
)
14653 /* Can't do this if region may have changed. */
14654 if ((!NILP (Vtransient_mark_mode
)
14655 && !NILP (current_buffer
->mark_active
))
14656 || !NILP (w
->region_showing
)
14657 || !NILP (Vshow_trailing_whitespace
))
14660 /* If top-line visibility has changed, give up. */
14661 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14662 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14665 /* Give up if old or new display is scrolled vertically. We could
14666 make this function handle this, but right now it doesn't. */
14667 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14668 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14671 /* The variable new_start now holds the new window start. The old
14672 start `start' can be determined from the current matrix. */
14673 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14674 start
= start_row
->minpos
;
14675 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14677 /* Clear the desired matrix for the display below. */
14678 clear_glyph_matrix (w
->desired_matrix
);
14680 if (CHARPOS (new_start
) <= CHARPOS (start
))
14684 /* Don't use this method if the display starts with an ellipsis
14685 displayed for invisible text. It's not easy to handle that case
14686 below, and it's certainly not worth the effort since this is
14687 not a frequent case. */
14688 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14691 IF_DEBUG (debug_method_add (w
, "twu1"));
14693 /* Display up to a row that can be reused. The variable
14694 last_text_row is set to the last row displayed that displays
14695 text. Note that it.vpos == 0 if or if not there is a
14696 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14697 start_display (&it
, w
, new_start
);
14698 first_row_y
= it
.current_y
;
14699 w
->cursor
.vpos
= -1;
14700 last_text_row
= last_reused_text_row
= NULL
;
14702 while (it
.current_y
< it
.last_visible_y
14703 && !fonts_changed_p
)
14705 /* If we have reached into the characters in the START row,
14706 that means the line boundaries have changed. So we
14707 can't start copying with the row START. Maybe it will
14708 work to start copying with the following row. */
14709 while (IT_CHARPOS (it
) > CHARPOS (start
))
14711 /* Advance to the next row as the "start". */
14713 start
= start_row
->minpos
;
14714 /* If there are no more rows to try, or just one, give up. */
14715 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14716 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14717 || CHARPOS (start
) == ZV
)
14719 clear_glyph_matrix (w
->desired_matrix
);
14723 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14725 /* If we have reached alignment,
14726 we can copy the rest of the rows. */
14727 if (IT_CHARPOS (it
) == CHARPOS (start
))
14730 if (display_line (&it
))
14731 last_text_row
= it
.glyph_row
- 1;
14734 /* A value of current_y < last_visible_y means that we stopped
14735 at the previous window start, which in turn means that we
14736 have at least one reusable row. */
14737 if (it
.current_y
< it
.last_visible_y
)
14739 /* IT.vpos always starts from 0; it counts text lines. */
14740 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14742 /* Find PT if not already found in the lines displayed. */
14743 if (w
->cursor
.vpos
< 0)
14745 int dy
= it
.current_y
- start_row
->y
;
14747 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14748 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14750 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14751 dy
, nrows_scrolled
);
14754 clear_glyph_matrix (w
->desired_matrix
);
14759 /* Scroll the display. Do it before the current matrix is
14760 changed. The problem here is that update has not yet
14761 run, i.e. part of the current matrix is not up to date.
14762 scroll_run_hook will clear the cursor, and use the
14763 current matrix to get the height of the row the cursor is
14765 run
.current_y
= start_row
->y
;
14766 run
.desired_y
= it
.current_y
;
14767 run
.height
= it
.last_visible_y
- it
.current_y
;
14769 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14772 FRAME_RIF (f
)->update_window_begin_hook (w
);
14773 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14774 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14775 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14779 /* Shift current matrix down by nrows_scrolled lines. */
14780 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14781 rotate_matrix (w
->current_matrix
,
14783 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14786 /* Disable lines that must be updated. */
14787 for (i
= 0; i
< nrows_scrolled
; ++i
)
14788 (start_row
+ i
)->enabled_p
= 0;
14790 /* Re-compute Y positions. */
14791 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14792 max_y
= it
.last_visible_y
;
14793 for (row
= start_row
+ nrows_scrolled
;
14797 row
->y
= it
.current_y
;
14798 row
->visible_height
= row
->height
;
14800 if (row
->y
< min_y
)
14801 row
->visible_height
-= min_y
- row
->y
;
14802 if (row
->y
+ row
->height
> max_y
)
14803 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14804 row
->redraw_fringe_bitmaps_p
= 1;
14806 it
.current_y
+= row
->height
;
14808 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14809 last_reused_text_row
= row
;
14810 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14814 /* Disable lines in the current matrix which are now
14815 below the window. */
14816 for (++row
; row
< bottom_row
; ++row
)
14817 row
->enabled_p
= row
->mode_line_p
= 0;
14820 /* Update window_end_pos etc.; last_reused_text_row is the last
14821 reused row from the current matrix containing text, if any.
14822 The value of last_text_row is the last displayed line
14823 containing text. */
14824 if (last_reused_text_row
)
14826 w
->window_end_bytepos
14827 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14829 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14831 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14832 w
->current_matrix
));
14834 else if (last_text_row
)
14836 w
->window_end_bytepos
14837 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14839 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14841 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14845 /* This window must be completely empty. */
14846 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14847 w
->window_end_pos
= make_number (Z
- ZV
);
14848 w
->window_end_vpos
= make_number (0);
14850 w
->window_end_valid
= Qnil
;
14852 /* Update hint: don't try scrolling again in update_window. */
14853 w
->desired_matrix
->no_scrolling_p
= 1;
14856 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14860 else if (CHARPOS (new_start
) > CHARPOS (start
))
14862 struct glyph_row
*pt_row
, *row
;
14863 struct glyph_row
*first_reusable_row
;
14864 struct glyph_row
*first_row_to_display
;
14866 int yb
= window_text_bottom_y (w
);
14868 /* Find the row starting at new_start, if there is one. Don't
14869 reuse a partially visible line at the end. */
14870 first_reusable_row
= start_row
;
14871 while (first_reusable_row
->enabled_p
14872 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14873 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14874 < CHARPOS (new_start
)))
14875 ++first_reusable_row
;
14877 /* Give up if there is no row to reuse. */
14878 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14879 || !first_reusable_row
->enabled_p
14880 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14881 != CHARPOS (new_start
)))
14884 /* We can reuse fully visible rows beginning with
14885 first_reusable_row to the end of the window. Set
14886 first_row_to_display to the first row that cannot be reused.
14887 Set pt_row to the row containing point, if there is any. */
14889 for (first_row_to_display
= first_reusable_row
;
14890 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14891 ++first_row_to_display
)
14893 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14894 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14895 pt_row
= first_row_to_display
;
14898 /* Start displaying at the start of first_row_to_display. */
14899 xassert (first_row_to_display
->y
< yb
);
14900 init_to_row_start (&it
, w
, first_row_to_display
);
14902 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14904 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14906 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14907 + WINDOW_HEADER_LINE_HEIGHT (w
));
14909 /* Display lines beginning with first_row_to_display in the
14910 desired matrix. Set last_text_row to the last row displayed
14911 that displays text. */
14912 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14913 if (pt_row
== NULL
)
14914 w
->cursor
.vpos
= -1;
14915 last_text_row
= NULL
;
14916 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14917 if (display_line (&it
))
14918 last_text_row
= it
.glyph_row
- 1;
14920 /* If point is in a reused row, adjust y and vpos of the cursor
14924 w
->cursor
.vpos
-= nrows_scrolled
;
14925 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14928 /* Give up if point isn't in a row displayed or reused. (This
14929 also handles the case where w->cursor.vpos < nrows_scrolled
14930 after the calls to display_line, which can happen with scroll
14931 margins. See bug#1295.) */
14932 if (w
->cursor
.vpos
< 0)
14934 clear_glyph_matrix (w
->desired_matrix
);
14938 /* Scroll the display. */
14939 run
.current_y
= first_reusable_row
->y
;
14940 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14941 run
.height
= it
.last_visible_y
- run
.current_y
;
14942 dy
= run
.current_y
- run
.desired_y
;
14947 FRAME_RIF (f
)->update_window_begin_hook (w
);
14948 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14949 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14950 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14954 /* Adjust Y positions of reused rows. */
14955 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14956 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14957 max_y
= it
.last_visible_y
;
14958 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14961 row
->visible_height
= row
->height
;
14962 if (row
->y
< min_y
)
14963 row
->visible_height
-= min_y
- row
->y
;
14964 if (row
->y
+ row
->height
> max_y
)
14965 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14966 row
->redraw_fringe_bitmaps_p
= 1;
14969 /* Scroll the current matrix. */
14970 xassert (nrows_scrolled
> 0);
14971 rotate_matrix (w
->current_matrix
,
14973 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14976 /* Disable rows not reused. */
14977 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14978 row
->enabled_p
= 0;
14980 /* Point may have moved to a different line, so we cannot assume that
14981 the previous cursor position is valid; locate the correct row. */
14984 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14985 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14989 w
->cursor
.y
= row
->y
;
14991 if (row
< bottom_row
)
14993 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14994 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14996 /* Can't use this optimization with bidi-reordered glyph
14997 rows, unless cursor is already at point. */
14998 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15000 if (!(w
->cursor
.hpos
>= 0
15001 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15002 && BUFFERP (glyph
->object
)
15003 && glyph
->charpos
== PT
))
15008 && (!BUFFERP (glyph
->object
)
15009 || glyph
->charpos
< PT
);
15013 w
->cursor
.x
+= glyph
->pixel_width
;
15018 /* Adjust window end. A null value of last_text_row means that
15019 the window end is in reused rows which in turn means that
15020 only its vpos can have changed. */
15023 w
->window_end_bytepos
15024 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15026 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15028 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15033 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15036 w
->window_end_valid
= Qnil
;
15037 w
->desired_matrix
->no_scrolling_p
= 1;
15040 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15050 /************************************************************************
15051 Window redisplay reusing current matrix when buffer has changed
15052 ************************************************************************/
15054 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15055 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15057 static struct glyph_row
*
15058 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15059 struct glyph_row
*);
15062 /* Return the last row in MATRIX displaying text. If row START is
15063 non-null, start searching with that row. IT gives the dimensions
15064 of the display. Value is null if matrix is empty; otherwise it is
15065 a pointer to the row found. */
15067 static struct glyph_row
*
15068 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15069 struct glyph_row
*start
)
15071 struct glyph_row
*row
, *row_found
;
15073 /* Set row_found to the last row in IT->w's current matrix
15074 displaying text. The loop looks funny but think of partially
15077 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15078 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15080 xassert (row
->enabled_p
);
15082 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15091 /* Return the last row in the current matrix of W that is not affected
15092 by changes at the start of current_buffer that occurred since W's
15093 current matrix was built. Value is null if no such row exists.
15095 BEG_UNCHANGED us the number of characters unchanged at the start of
15096 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15097 first changed character in current_buffer. Characters at positions <
15098 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15099 when the current matrix was built. */
15101 static struct glyph_row
*
15102 find_last_unchanged_at_beg_row (struct window
*w
)
15104 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15105 struct glyph_row
*row
;
15106 struct glyph_row
*row_found
= NULL
;
15107 int yb
= window_text_bottom_y (w
);
15109 /* Find the last row displaying unchanged text. */
15110 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15111 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15112 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15115 if (/* If row ends before first_changed_pos, it is unchanged,
15116 except in some case. */
15117 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15118 /* When row ends in ZV and we write at ZV it is not
15120 && !row
->ends_at_zv_p
15121 /* When first_changed_pos is the end of a continued line,
15122 row is not unchanged because it may be no longer
15124 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15125 && (row
->continued_p
15126 || row
->exact_window_width_line_p
)))
15129 /* Stop if last visible row. */
15130 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15138 /* Find the first glyph row in the current matrix of W that is not
15139 affected by changes at the end of current_buffer since the
15140 time W's current matrix was built.
15142 Return in *DELTA the number of chars by which buffer positions in
15143 unchanged text at the end of current_buffer must be adjusted.
15145 Return in *DELTA_BYTES the corresponding number of bytes.
15147 Value is null if no such row exists, i.e. all rows are affected by
15150 static struct glyph_row
*
15151 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15153 struct glyph_row
*row
;
15154 struct glyph_row
*row_found
= NULL
;
15156 *delta
= *delta_bytes
= 0;
15158 /* Display must not have been paused, otherwise the current matrix
15159 is not up to date. */
15160 eassert (!NILP (w
->window_end_valid
));
15162 /* A value of window_end_pos >= END_UNCHANGED means that the window
15163 end is in the range of changed text. If so, there is no
15164 unchanged row at the end of W's current matrix. */
15165 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15168 /* Set row to the last row in W's current matrix displaying text. */
15169 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15171 /* If matrix is entirely empty, no unchanged row exists. */
15172 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15174 /* The value of row is the last glyph row in the matrix having a
15175 meaningful buffer position in it. The end position of row
15176 corresponds to window_end_pos. This allows us to translate
15177 buffer positions in the current matrix to current buffer
15178 positions for characters not in changed text. */
15179 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15180 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15181 int last_unchanged_pos
, last_unchanged_pos_old
;
15182 struct glyph_row
*first_text_row
15183 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15185 *delta
= Z
- Z_old
;
15186 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15188 /* Set last_unchanged_pos to the buffer position of the last
15189 character in the buffer that has not been changed. Z is the
15190 index + 1 of the last character in current_buffer, i.e. by
15191 subtracting END_UNCHANGED we get the index of the last
15192 unchanged character, and we have to add BEG to get its buffer
15194 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15195 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15197 /* Search backward from ROW for a row displaying a line that
15198 starts at a minimum position >= last_unchanged_pos_old. */
15199 for (; row
> first_text_row
; --row
)
15201 /* This used to abort, but it can happen.
15202 It is ok to just stop the search instead here. KFS. */
15203 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15206 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15211 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15217 /* Make sure that glyph rows in the current matrix of window W
15218 reference the same glyph memory as corresponding rows in the
15219 frame's frame matrix. This function is called after scrolling W's
15220 current matrix on a terminal frame in try_window_id and
15221 try_window_reusing_current_matrix. */
15224 sync_frame_with_window_matrix_rows (struct window
*w
)
15226 struct frame
*f
= XFRAME (w
->frame
);
15227 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15229 /* Preconditions: W must be a leaf window and full-width. Its frame
15230 must have a frame matrix. */
15231 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15232 xassert (WINDOW_FULL_WIDTH_P (w
));
15233 xassert (!FRAME_WINDOW_P (f
));
15235 /* If W is a full-width window, glyph pointers in W's current matrix
15236 have, by definition, to be the same as glyph pointers in the
15237 corresponding frame matrix. Note that frame matrices have no
15238 marginal areas (see build_frame_matrix). */
15239 window_row
= w
->current_matrix
->rows
;
15240 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15241 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15242 while (window_row
< window_row_end
)
15244 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15245 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15247 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15248 frame_row
->glyphs
[TEXT_AREA
] = start
;
15249 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15250 frame_row
->glyphs
[LAST_AREA
] = end
;
15252 /* Disable frame rows whose corresponding window rows have
15253 been disabled in try_window_id. */
15254 if (!window_row
->enabled_p
)
15255 frame_row
->enabled_p
= 0;
15257 ++window_row
, ++frame_row
;
15262 /* Find the glyph row in window W containing CHARPOS. Consider all
15263 rows between START and END (not inclusive). END null means search
15264 all rows to the end of the display area of W. Value is the row
15265 containing CHARPOS or null. */
15268 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15269 struct glyph_row
*end
, int dy
)
15271 struct glyph_row
*row
= start
;
15272 struct glyph_row
*best_row
= NULL
;
15273 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15276 /* If we happen to start on a header-line, skip that. */
15277 if (row
->mode_line_p
)
15280 if ((end
&& row
>= end
) || !row
->enabled_p
)
15283 last_y
= window_text_bottom_y (w
) - dy
;
15287 /* Give up if we have gone too far. */
15288 if (end
&& row
>= end
)
15290 /* This formerly returned if they were equal.
15291 I think that both quantities are of a "last plus one" type;
15292 if so, when they are equal, the row is within the screen. -- rms. */
15293 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15296 /* If it is in this row, return this row. */
15297 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15298 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15299 /* The end position of a row equals the start
15300 position of the next row. If CHARPOS is there, we
15301 would rather display it in the next line, except
15302 when this line ends in ZV. */
15303 && !row
->ends_at_zv_p
15304 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15305 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15309 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15311 /* In bidi-reordered rows, there could be several rows
15312 occluding point. We need to find the one which fits
15313 CHARPOS the best. */
15314 for (g
= row
->glyphs
[TEXT_AREA
];
15315 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15318 if (!STRINGP (g
->object
))
15320 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15322 mindif
= eabs (g
->charpos
- charpos
);
15335 /* Try to redisplay window W by reusing its existing display. W's
15336 current matrix must be up to date when this function is called,
15337 i.e. window_end_valid must not be nil.
15341 1 if display has been updated
15342 0 if otherwise unsuccessful
15343 -1 if redisplay with same window start is known not to succeed
15345 The following steps are performed:
15347 1. Find the last row in the current matrix of W that is not
15348 affected by changes at the start of current_buffer. If no such row
15351 2. Find the first row in W's current matrix that is not affected by
15352 changes at the end of current_buffer. Maybe there is no such row.
15354 3. Display lines beginning with the row + 1 found in step 1 to the
15355 row found in step 2 or, if step 2 didn't find a row, to the end of
15358 4. If cursor is not known to appear on the window, give up.
15360 5. If display stopped at the row found in step 2, scroll the
15361 display and current matrix as needed.
15363 6. Maybe display some lines at the end of W, if we must. This can
15364 happen under various circumstances, like a partially visible line
15365 becoming fully visible, or because newly displayed lines are displayed
15366 in smaller font sizes.
15368 7. Update W's window end information. */
15371 try_window_id (struct window
*w
)
15373 struct frame
*f
= XFRAME (w
->frame
);
15374 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15375 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15376 struct glyph_row
*last_unchanged_at_beg_row
;
15377 struct glyph_row
*first_unchanged_at_end_row
;
15378 struct glyph_row
*row
;
15379 struct glyph_row
*bottom_row
;
15382 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15383 struct text_pos start_pos
;
15385 int first_unchanged_at_end_vpos
= 0;
15386 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15387 struct text_pos start
;
15388 int first_changed_charpos
, last_changed_charpos
;
15391 if (inhibit_try_window_id
)
15395 /* This is handy for debugging. */
15397 #define GIVE_UP(X) \
15399 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15403 #define GIVE_UP(X) return 0
15406 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15408 /* Don't use this for mini-windows because these can show
15409 messages and mini-buffers, and we don't handle that here. */
15410 if (MINI_WINDOW_P (w
))
15413 /* This flag is used to prevent redisplay optimizations. */
15414 if (windows_or_buffers_changed
|| cursor_type_changed
)
15417 /* Verify that narrowing has not changed.
15418 Also verify that we were not told to prevent redisplay optimizations.
15419 It would be nice to further
15420 reduce the number of cases where this prevents try_window_id. */
15421 if (current_buffer
->clip_changed
15422 || current_buffer
->prevent_redisplay_optimizations_p
)
15425 /* Window must either use window-based redisplay or be full width. */
15426 if (!FRAME_WINDOW_P (f
)
15427 && (!FRAME_LINE_INS_DEL_OK (f
)
15428 || !WINDOW_FULL_WIDTH_P (w
)))
15431 /* Give up if point is known NOT to appear in W. */
15432 if (PT
< CHARPOS (start
))
15435 /* Another way to prevent redisplay optimizations. */
15436 if (XFASTINT (w
->last_modified
) == 0)
15439 /* Verify that window is not hscrolled. */
15440 if (XFASTINT (w
->hscroll
) != 0)
15443 /* Verify that display wasn't paused. */
15444 if (NILP (w
->window_end_valid
))
15447 /* Can't use this if highlighting a region because a cursor movement
15448 will do more than just set the cursor. */
15449 if (!NILP (Vtransient_mark_mode
)
15450 && !NILP (current_buffer
->mark_active
))
15453 /* Likewise if highlighting trailing whitespace. */
15454 if (!NILP (Vshow_trailing_whitespace
))
15457 /* Likewise if showing a region. */
15458 if (!NILP (w
->region_showing
))
15461 /* Can't use this if overlay arrow position and/or string have
15463 if (overlay_arrows_changed_p ())
15466 /* When word-wrap is on, adding a space to the first word of a
15467 wrapped line can change the wrap position, altering the line
15468 above it. It might be worthwhile to handle this more
15469 intelligently, but for now just redisplay from scratch. */
15470 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15473 /* Under bidi reordering, adding or deleting a character in the
15474 beginning of a paragraph, before the first strong directional
15475 character, can change the base direction of the paragraph (unless
15476 the buffer specifies a fixed paragraph direction), which will
15477 require to redisplay the whole paragraph. It might be worthwhile
15478 to find the paragraph limits and widen the range of redisplayed
15479 lines to that, but for now just give up this optimization and
15480 redisplay from scratch. */
15481 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15482 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15485 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15486 only if buffer has really changed. The reason is that the gap is
15487 initially at Z for freshly visited files. The code below would
15488 set end_unchanged to 0 in that case. */
15489 if (MODIFF
> SAVE_MODIFF
15490 /* This seems to happen sometimes after saving a buffer. */
15491 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15493 if (GPT
- BEG
< BEG_UNCHANGED
)
15494 BEG_UNCHANGED
= GPT
- BEG
;
15495 if (Z
- GPT
< END_UNCHANGED
)
15496 END_UNCHANGED
= Z
- GPT
;
15499 /* The position of the first and last character that has been changed. */
15500 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15501 last_changed_charpos
= Z
- END_UNCHANGED
;
15503 /* If window starts after a line end, and the last change is in
15504 front of that newline, then changes don't affect the display.
15505 This case happens with stealth-fontification. Note that although
15506 the display is unchanged, glyph positions in the matrix have to
15507 be adjusted, of course. */
15508 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15509 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15510 && ((last_changed_charpos
< CHARPOS (start
)
15511 && CHARPOS (start
) == BEGV
)
15512 || (last_changed_charpos
< CHARPOS (start
) - 1
15513 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15515 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15516 struct glyph_row
*r0
;
15518 /* Compute how many chars/bytes have been added to or removed
15519 from the buffer. */
15520 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15521 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15523 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15525 /* Give up if PT is not in the window. Note that it already has
15526 been checked at the start of try_window_id that PT is not in
15527 front of the window start. */
15528 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15531 /* If window start is unchanged, we can reuse the whole matrix
15532 as is, after adjusting glyph positions. No need to compute
15533 the window end again, since its offset from Z hasn't changed. */
15534 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15535 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15536 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15537 /* PT must not be in a partially visible line. */
15538 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15539 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15541 /* Adjust positions in the glyph matrix. */
15542 if (delta
|| delta_bytes
)
15544 struct glyph_row
*r1
15545 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15546 increment_matrix_positions (w
->current_matrix
,
15547 MATRIX_ROW_VPOS (r0
, current_matrix
),
15548 MATRIX_ROW_VPOS (r1
, current_matrix
),
15549 delta
, delta_bytes
);
15552 /* Set the cursor. */
15553 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15555 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15562 /* Handle the case that changes are all below what is displayed in
15563 the window, and that PT is in the window. This shortcut cannot
15564 be taken if ZV is visible in the window, and text has been added
15565 there that is visible in the window. */
15566 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15567 /* ZV is not visible in the window, or there are no
15568 changes at ZV, actually. */
15569 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15570 || first_changed_charpos
== last_changed_charpos
))
15572 struct glyph_row
*r0
;
15574 /* Give up if PT is not in the window. Note that it already has
15575 been checked at the start of try_window_id that PT is not in
15576 front of the window start. */
15577 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15580 /* If window start is unchanged, we can reuse the whole matrix
15581 as is, without changing glyph positions since no text has
15582 been added/removed in front of the window end. */
15583 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15584 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15585 /* PT must not be in a partially visible line. */
15586 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15587 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15589 /* We have to compute the window end anew since text
15590 could have been added/removed after it. */
15592 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15593 w
->window_end_bytepos
15594 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15596 /* Set the cursor. */
15597 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15599 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15606 /* Give up if window start is in the changed area.
15608 The condition used to read
15610 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15612 but why that was tested escapes me at the moment. */
15613 if (CHARPOS (start
) >= first_changed_charpos
15614 && CHARPOS (start
) <= last_changed_charpos
)
15617 /* Check that window start agrees with the start of the first glyph
15618 row in its current matrix. Check this after we know the window
15619 start is not in changed text, otherwise positions would not be
15621 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15622 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15625 /* Give up if the window ends in strings. Overlay strings
15626 at the end are difficult to handle, so don't try. */
15627 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15628 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15631 /* Compute the position at which we have to start displaying new
15632 lines. Some of the lines at the top of the window might be
15633 reusable because they are not displaying changed text. Find the
15634 last row in W's current matrix not affected by changes at the
15635 start of current_buffer. Value is null if changes start in the
15636 first line of window. */
15637 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15638 if (last_unchanged_at_beg_row
)
15640 /* Avoid starting to display in the moddle of a character, a TAB
15641 for instance. This is easier than to set up the iterator
15642 exactly, and it's not a frequent case, so the additional
15643 effort wouldn't really pay off. */
15644 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15645 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15646 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15647 --last_unchanged_at_beg_row
;
15649 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15652 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15654 start_pos
= it
.current
.pos
;
15656 /* Start displaying new lines in the desired matrix at the same
15657 vpos we would use in the current matrix, i.e. below
15658 last_unchanged_at_beg_row. */
15659 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15661 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15662 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15664 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15668 /* There are no reusable lines at the start of the window.
15669 Start displaying in the first text line. */
15670 start_display (&it
, w
, start
);
15671 it
.vpos
= it
.first_vpos
;
15672 start_pos
= it
.current
.pos
;
15675 /* Find the first row that is not affected by changes at the end of
15676 the buffer. Value will be null if there is no unchanged row, in
15677 which case we must redisplay to the end of the window. delta
15678 will be set to the value by which buffer positions beginning with
15679 first_unchanged_at_end_row have to be adjusted due to text
15681 first_unchanged_at_end_row
15682 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15683 IF_DEBUG (debug_delta
= delta
);
15684 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15686 /* Set stop_pos to the buffer position up to which we will have to
15687 display new lines. If first_unchanged_at_end_row != NULL, this
15688 is the buffer position of the start of the line displayed in that
15689 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15690 that we don't stop at a buffer position. */
15692 if (first_unchanged_at_end_row
)
15694 xassert (last_unchanged_at_beg_row
== NULL
15695 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15697 /* If this is a continuation line, move forward to the next one
15698 that isn't. Changes in lines above affect this line.
15699 Caution: this may move first_unchanged_at_end_row to a row
15700 not displaying text. */
15701 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15702 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15703 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15704 < it
.last_visible_y
))
15705 ++first_unchanged_at_end_row
;
15707 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15708 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15709 >= it
.last_visible_y
))
15710 first_unchanged_at_end_row
= NULL
;
15713 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15715 first_unchanged_at_end_vpos
15716 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15717 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15720 else if (last_unchanged_at_beg_row
== NULL
)
15726 /* Either there is no unchanged row at the end, or the one we have
15727 now displays text. This is a necessary condition for the window
15728 end pos calculation at the end of this function. */
15729 xassert (first_unchanged_at_end_row
== NULL
15730 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15732 debug_last_unchanged_at_beg_vpos
15733 = (last_unchanged_at_beg_row
15734 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15736 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15738 #endif /* GLYPH_DEBUG != 0 */
15741 /* Display new lines. Set last_text_row to the last new line
15742 displayed which has text on it, i.e. might end up as being the
15743 line where the window_end_vpos is. */
15744 w
->cursor
.vpos
= -1;
15745 last_text_row
= NULL
;
15746 overlay_arrow_seen
= 0;
15747 while (it
.current_y
< it
.last_visible_y
15748 && !fonts_changed_p
15749 && (first_unchanged_at_end_row
== NULL
15750 || IT_CHARPOS (it
) < stop_pos
))
15752 if (display_line (&it
))
15753 last_text_row
= it
.glyph_row
- 1;
15756 if (fonts_changed_p
)
15760 /* Compute differences in buffer positions, y-positions etc. for
15761 lines reused at the bottom of the window. Compute what we can
15763 if (first_unchanged_at_end_row
15764 /* No lines reused because we displayed everything up to the
15765 bottom of the window. */
15766 && it
.current_y
< it
.last_visible_y
)
15769 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15771 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15772 run
.current_y
= first_unchanged_at_end_row
->y
;
15773 run
.desired_y
= run
.current_y
+ dy
;
15774 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15778 delta
= delta_bytes
= dvpos
= dy
15779 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15780 first_unchanged_at_end_row
= NULL
;
15782 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15785 /* Find the cursor if not already found. We have to decide whether
15786 PT will appear on this window (it sometimes doesn't, but this is
15787 not a very frequent case.) This decision has to be made before
15788 the current matrix is altered. A value of cursor.vpos < 0 means
15789 that PT is either in one of the lines beginning at
15790 first_unchanged_at_end_row or below the window. Don't care for
15791 lines that might be displayed later at the window end; as
15792 mentioned, this is not a frequent case. */
15793 if (w
->cursor
.vpos
< 0)
15795 /* Cursor in unchanged rows at the top? */
15796 if (PT
< CHARPOS (start_pos
)
15797 && last_unchanged_at_beg_row
)
15799 row
= row_containing_pos (w
, PT
,
15800 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15801 last_unchanged_at_beg_row
+ 1, 0);
15803 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15806 /* Start from first_unchanged_at_end_row looking for PT. */
15807 else if (first_unchanged_at_end_row
)
15809 row
= row_containing_pos (w
, PT
- delta
,
15810 first_unchanged_at_end_row
, NULL
, 0);
15812 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15813 delta_bytes
, dy
, dvpos
);
15816 /* Give up if cursor was not found. */
15817 if (w
->cursor
.vpos
< 0)
15819 clear_glyph_matrix (w
->desired_matrix
);
15824 /* Don't let the cursor end in the scroll margins. */
15826 int this_scroll_margin
, cursor_height
;
15828 this_scroll_margin
= max (0, scroll_margin
);
15829 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15830 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15831 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15833 if ((w
->cursor
.y
< this_scroll_margin
15834 && CHARPOS (start
) > BEGV
)
15835 /* Old redisplay didn't take scroll margin into account at the bottom,
15836 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15837 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15838 ? cursor_height
+ this_scroll_margin
15839 : 1)) > it
.last_visible_y
)
15841 w
->cursor
.vpos
= -1;
15842 clear_glyph_matrix (w
->desired_matrix
);
15847 /* Scroll the display. Do it before changing the current matrix so
15848 that xterm.c doesn't get confused about where the cursor glyph is
15850 if (dy
&& run
.height
)
15854 if (FRAME_WINDOW_P (f
))
15856 FRAME_RIF (f
)->update_window_begin_hook (w
);
15857 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15858 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15859 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15863 /* Terminal frame. In this case, dvpos gives the number of
15864 lines to scroll by; dvpos < 0 means scroll up. */
15865 int first_unchanged_at_end_vpos
15866 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15867 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15868 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15869 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15870 + window_internal_height (w
));
15872 /* Perform the operation on the screen. */
15875 /* Scroll last_unchanged_at_beg_row to the end of the
15876 window down dvpos lines. */
15877 set_terminal_window (f
, end
);
15879 /* On dumb terminals delete dvpos lines at the end
15880 before inserting dvpos empty lines. */
15881 if (!FRAME_SCROLL_REGION_OK (f
))
15882 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15884 /* Insert dvpos empty lines in front of
15885 last_unchanged_at_beg_row. */
15886 ins_del_lines (f
, from
, dvpos
);
15888 else if (dvpos
< 0)
15890 /* Scroll up last_unchanged_at_beg_vpos to the end of
15891 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15892 set_terminal_window (f
, end
);
15894 /* Delete dvpos lines in front of
15895 last_unchanged_at_beg_vpos. ins_del_lines will set
15896 the cursor to the given vpos and emit |dvpos| delete
15898 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15900 /* On a dumb terminal insert dvpos empty lines at the
15902 if (!FRAME_SCROLL_REGION_OK (f
))
15903 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15906 set_terminal_window (f
, 0);
15912 /* Shift reused rows of the current matrix to the right position.
15913 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15915 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15916 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15919 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15920 bottom_vpos
, dvpos
);
15921 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15924 else if (dvpos
> 0)
15926 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15927 bottom_vpos
, dvpos
);
15928 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15929 first_unchanged_at_end_vpos
+ dvpos
, 0);
15932 /* For frame-based redisplay, make sure that current frame and window
15933 matrix are in sync with respect to glyph memory. */
15934 if (!FRAME_WINDOW_P (f
))
15935 sync_frame_with_window_matrix_rows (w
);
15937 /* Adjust buffer positions in reused rows. */
15938 if (delta
|| delta_bytes
)
15939 increment_matrix_positions (current_matrix
,
15940 first_unchanged_at_end_vpos
+ dvpos
,
15941 bottom_vpos
, delta
, delta_bytes
);
15943 /* Adjust Y positions. */
15945 shift_glyph_matrix (w
, current_matrix
,
15946 first_unchanged_at_end_vpos
+ dvpos
,
15949 if (first_unchanged_at_end_row
)
15951 first_unchanged_at_end_row
+= dvpos
;
15952 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15953 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15954 first_unchanged_at_end_row
= NULL
;
15957 /* If scrolling up, there may be some lines to display at the end of
15959 last_text_row_at_end
= NULL
;
15962 /* Scrolling up can leave for example a partially visible line
15963 at the end of the window to be redisplayed. */
15964 /* Set last_row to the glyph row in the current matrix where the
15965 window end line is found. It has been moved up or down in
15966 the matrix by dvpos. */
15967 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15968 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15970 /* If last_row is the window end line, it should display text. */
15971 xassert (last_row
->displays_text_p
);
15973 /* If window end line was partially visible before, begin
15974 displaying at that line. Otherwise begin displaying with the
15975 line following it. */
15976 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15978 init_to_row_start (&it
, w
, last_row
);
15979 it
.vpos
= last_vpos
;
15980 it
.current_y
= last_row
->y
;
15984 init_to_row_end (&it
, w
, last_row
);
15985 it
.vpos
= 1 + last_vpos
;
15986 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15990 /* We may start in a continuation line. If so, we have to
15991 get the right continuation_lines_width and current_x. */
15992 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15993 it
.hpos
= it
.current_x
= 0;
15995 /* Display the rest of the lines at the window end. */
15996 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15997 while (it
.current_y
< it
.last_visible_y
15998 && !fonts_changed_p
)
16000 /* Is it always sure that the display agrees with lines in
16001 the current matrix? I don't think so, so we mark rows
16002 displayed invalid in the current matrix by setting their
16003 enabled_p flag to zero. */
16004 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16005 if (display_line (&it
))
16006 last_text_row_at_end
= it
.glyph_row
- 1;
16010 /* Update window_end_pos and window_end_vpos. */
16011 if (first_unchanged_at_end_row
16012 && !last_text_row_at_end
)
16014 /* Window end line if one of the preserved rows from the current
16015 matrix. Set row to the last row displaying text in current
16016 matrix starting at first_unchanged_at_end_row, after
16018 xassert (first_unchanged_at_end_row
->displays_text_p
);
16019 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16020 first_unchanged_at_end_row
);
16021 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16023 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16024 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16026 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16027 xassert (w
->window_end_bytepos
>= 0);
16028 IF_DEBUG (debug_method_add (w
, "A"));
16030 else if (last_text_row_at_end
)
16033 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16034 w
->window_end_bytepos
16035 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16037 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16038 xassert (w
->window_end_bytepos
>= 0);
16039 IF_DEBUG (debug_method_add (w
, "B"));
16041 else if (last_text_row
)
16043 /* We have displayed either to the end of the window or at the
16044 end of the window, i.e. the last row with text is to be found
16045 in the desired matrix. */
16047 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16048 w
->window_end_bytepos
16049 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16051 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16052 xassert (w
->window_end_bytepos
>= 0);
16054 else if (first_unchanged_at_end_row
== NULL
16055 && last_text_row
== NULL
16056 && last_text_row_at_end
== NULL
)
16058 /* Displayed to end of window, but no line containing text was
16059 displayed. Lines were deleted at the end of the window. */
16060 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16061 int vpos
= XFASTINT (w
->window_end_vpos
);
16062 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16063 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16066 row
== NULL
&& vpos
>= first_vpos
;
16067 --vpos
, --current_row
, --desired_row
)
16069 if (desired_row
->enabled_p
)
16071 if (desired_row
->displays_text_p
)
16074 else if (current_row
->displays_text_p
)
16078 xassert (row
!= NULL
);
16079 w
->window_end_vpos
= make_number (vpos
+ 1);
16080 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16081 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16082 xassert (w
->window_end_bytepos
>= 0);
16083 IF_DEBUG (debug_method_add (w
, "C"));
16088 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16089 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16091 /* Record that display has not been completed. */
16092 w
->window_end_valid
= Qnil
;
16093 w
->desired_matrix
->no_scrolling_p
= 1;
16101 /***********************************************************************
16102 More debugging support
16103 ***********************************************************************/
16107 void dump_glyph_row (struct glyph_row
*, int, int);
16108 void dump_glyph_matrix (struct glyph_matrix
*, int);
16109 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16112 /* Dump the contents of glyph matrix MATRIX on stderr.
16114 GLYPHS 0 means don't show glyph contents.
16115 GLYPHS 1 means show glyphs in short form
16116 GLYPHS > 1 means show glyphs in long form. */
16119 dump_glyph_matrix (matrix
, glyphs
)
16120 struct glyph_matrix
*matrix
;
16124 for (i
= 0; i
< matrix
->nrows
; ++i
)
16125 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16129 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16130 the glyph row and area where the glyph comes from. */
16133 dump_glyph (row
, glyph
, area
)
16134 struct glyph_row
*row
;
16135 struct glyph
*glyph
;
16138 if (glyph
->type
== CHAR_GLYPH
)
16141 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16142 glyph
- row
->glyphs
[TEXT_AREA
],
16145 (BUFFERP (glyph
->object
)
16147 : (STRINGP (glyph
->object
)
16150 glyph
->pixel_width
,
16152 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16156 glyph
->left_box_line_p
,
16157 glyph
->right_box_line_p
);
16159 else if (glyph
->type
== STRETCH_GLYPH
)
16162 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16163 glyph
- row
->glyphs
[TEXT_AREA
],
16166 (BUFFERP (glyph
->object
)
16168 : (STRINGP (glyph
->object
)
16171 glyph
->pixel_width
,
16175 glyph
->left_box_line_p
,
16176 glyph
->right_box_line_p
);
16178 else if (glyph
->type
== IMAGE_GLYPH
)
16181 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16182 glyph
- row
->glyphs
[TEXT_AREA
],
16185 (BUFFERP (glyph
->object
)
16187 : (STRINGP (glyph
->object
)
16190 glyph
->pixel_width
,
16194 glyph
->left_box_line_p
,
16195 glyph
->right_box_line_p
);
16197 else if (glyph
->type
== COMPOSITE_GLYPH
)
16200 " %5d %4c %6d %c %3d 0x%05x",
16201 glyph
- row
->glyphs
[TEXT_AREA
],
16204 (BUFFERP (glyph
->object
)
16206 : (STRINGP (glyph
->object
)
16209 glyph
->pixel_width
,
16211 if (glyph
->u
.cmp
.automatic
)
16214 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16215 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16217 glyph
->left_box_line_p
,
16218 glyph
->right_box_line_p
);
16223 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16224 GLYPHS 0 means don't show glyph contents.
16225 GLYPHS 1 means show glyphs in short form
16226 GLYPHS > 1 means show glyphs in long form. */
16229 dump_glyph_row (row
, vpos
, glyphs
)
16230 struct glyph_row
*row
;
16235 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16236 fprintf (stderr
, "======================================================================\n");
16238 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16239 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16241 MATRIX_ROW_START_CHARPOS (row
),
16242 MATRIX_ROW_END_CHARPOS (row
),
16243 row
->used
[TEXT_AREA
],
16244 row
->contains_overlapping_glyphs_p
,
16246 row
->truncated_on_left_p
,
16247 row
->truncated_on_right_p
,
16249 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16250 row
->displays_text_p
,
16253 row
->ends_in_middle_of_char_p
,
16254 row
->starts_in_middle_of_char_p
,
16260 row
->visible_height
,
16263 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16264 row
->end
.overlay_string_index
,
16265 row
->continuation_lines_width
);
16266 fprintf (stderr
, "%9d %5d\n",
16267 CHARPOS (row
->start
.string_pos
),
16268 CHARPOS (row
->end
.string_pos
));
16269 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16270 row
->end
.dpvec_index
);
16277 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16279 struct glyph
*glyph
= row
->glyphs
[area
];
16280 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16282 /* Glyph for a line end in text. */
16283 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16286 if (glyph
< glyph_end
)
16287 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16289 for (; glyph
< glyph_end
; ++glyph
)
16290 dump_glyph (row
, glyph
, area
);
16293 else if (glyphs
== 1)
16297 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16299 char *s
= (char *) alloca (row
->used
[area
] + 1);
16302 for (i
= 0; i
< row
->used
[area
]; ++i
)
16304 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16305 if (glyph
->type
== CHAR_GLYPH
16306 && glyph
->u
.ch
< 0x80
16307 && glyph
->u
.ch
>= ' ')
16308 s
[i
] = glyph
->u
.ch
;
16314 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16320 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16321 Sdump_glyph_matrix
, 0, 1, "p",
16322 doc
: /* Dump the current matrix of the selected window to stderr.
16323 Shows contents of glyph row structures. With non-nil
16324 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16325 glyphs in short form, otherwise show glyphs in long form. */)
16326 (Lisp_Object glyphs
)
16328 struct window
*w
= XWINDOW (selected_window
);
16329 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16331 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16332 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16333 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16334 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16335 fprintf (stderr
, "=============================================\n");
16336 dump_glyph_matrix (w
->current_matrix
,
16337 NILP (glyphs
) ? 0 : XINT (glyphs
));
16342 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16343 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16346 struct frame
*f
= XFRAME (selected_frame
);
16347 dump_glyph_matrix (f
->current_matrix
, 1);
16352 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16353 doc
: /* Dump glyph row ROW to stderr.
16354 GLYPH 0 means don't dump glyphs.
16355 GLYPH 1 means dump glyphs in short form.
16356 GLYPH > 1 or omitted means dump glyphs in long form. */)
16357 (Lisp_Object row
, Lisp_Object glyphs
)
16359 struct glyph_matrix
*matrix
;
16362 CHECK_NUMBER (row
);
16363 matrix
= XWINDOW (selected_window
)->current_matrix
;
16365 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16366 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16368 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16373 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16374 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16375 GLYPH 0 means don't dump glyphs.
16376 GLYPH 1 means dump glyphs in short form.
16377 GLYPH > 1 or omitted means dump glyphs in long form. */)
16378 (Lisp_Object row
, Lisp_Object glyphs
)
16380 struct frame
*sf
= SELECTED_FRAME ();
16381 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16384 CHECK_NUMBER (row
);
16386 if (vpos
>= 0 && vpos
< m
->nrows
)
16387 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16388 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16393 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16394 doc
: /* Toggle tracing of redisplay.
16395 With ARG, turn tracing on if and only if ARG is positive. */)
16399 trace_redisplay_p
= !trace_redisplay_p
;
16402 arg
= Fprefix_numeric_value (arg
);
16403 trace_redisplay_p
= XINT (arg
) > 0;
16410 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16411 doc
: /* Like `format', but print result to stderr.
16412 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16413 (int nargs
, Lisp_Object
*args
)
16415 Lisp_Object s
= Fformat (nargs
, args
);
16416 fprintf (stderr
, "%s", SDATA (s
));
16420 #endif /* GLYPH_DEBUG */
16424 /***********************************************************************
16425 Building Desired Matrix Rows
16426 ***********************************************************************/
16428 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16429 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16431 static struct glyph_row
*
16432 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16434 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16435 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16436 struct buffer
*old
= current_buffer
;
16437 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16438 int arrow_len
= SCHARS (overlay_arrow_string
);
16439 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16440 const unsigned char *p
;
16443 int n_glyphs_before
;
16445 set_buffer_temp (buffer
);
16446 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16447 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16448 SET_TEXT_POS (it
.position
, 0, 0);
16450 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16452 while (p
< arrow_end
)
16454 Lisp_Object face
, ilisp
;
16456 /* Get the next character. */
16458 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16461 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16462 if (! ASCII_CHAR_P (it
.c
))
16463 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16467 /* Get its face. */
16468 ilisp
= make_number (p
- arrow_string
);
16469 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16470 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16472 /* Compute its width, get its glyphs. */
16473 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16474 SET_TEXT_POS (it
.position
, -1, -1);
16475 PRODUCE_GLYPHS (&it
);
16477 /* If this character doesn't fit any more in the line, we have
16478 to remove some glyphs. */
16479 if (it
.current_x
> it
.last_visible_x
)
16481 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16486 set_buffer_temp (old
);
16487 return it
.glyph_row
;
16491 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16492 glyphs are only inserted for terminal frames since we can't really
16493 win with truncation glyphs when partially visible glyphs are
16494 involved. Which glyphs to insert is determined by
16495 produce_special_glyphs. */
16498 insert_left_trunc_glyphs (struct it
*it
)
16500 struct it truncate_it
;
16501 struct glyph
*from
, *end
, *to
, *toend
;
16503 xassert (!FRAME_WINDOW_P (it
->f
));
16505 /* Get the truncation glyphs. */
16507 truncate_it
.current_x
= 0;
16508 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16509 truncate_it
.glyph_row
= &scratch_glyph_row
;
16510 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16511 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16512 truncate_it
.object
= make_number (0);
16513 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16515 /* Overwrite glyphs from IT with truncation glyphs. */
16516 if (!it
->glyph_row
->reversed_p
)
16518 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16519 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16520 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16521 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16526 /* There may be padding glyphs left over. Overwrite them too. */
16527 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16529 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16535 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16539 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16540 that back to front. */
16541 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16542 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16543 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16544 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16546 while (from
>= end
&& to
>= toend
)
16548 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16551 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16552 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16553 while (from
>= end
&& to
>= toend
)
16558 /* Need to free some room before prepending additional
16560 int move_by
= from
- end
+ 1;
16561 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16562 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16564 for ( ; g
>= g0
; g
--)
16566 while (from
>= end
)
16568 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16574 /* Compute the pixel height and width of IT->glyph_row.
16576 Most of the time, ascent and height of a display line will be equal
16577 to the max_ascent and max_height values of the display iterator
16578 structure. This is not the case if
16580 1. We hit ZV without displaying anything. In this case, max_ascent
16581 and max_height will be zero.
16583 2. We have some glyphs that don't contribute to the line height.
16584 (The glyph row flag contributes_to_line_height_p is for future
16585 pixmap extensions).
16587 The first case is easily covered by using default values because in
16588 these cases, the line height does not really matter, except that it
16589 must not be zero. */
16592 compute_line_metrics (struct it
*it
)
16594 struct glyph_row
*row
= it
->glyph_row
;
16597 if (FRAME_WINDOW_P (it
->f
))
16599 int i
, min_y
, max_y
;
16601 /* The line may consist of one space only, that was added to
16602 place the cursor on it. If so, the row's height hasn't been
16604 if (row
->height
== 0)
16606 if (it
->max_ascent
+ it
->max_descent
== 0)
16607 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16608 row
->ascent
= it
->max_ascent
;
16609 row
->height
= it
->max_ascent
+ it
->max_descent
;
16610 row
->phys_ascent
= it
->max_phys_ascent
;
16611 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16612 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16615 /* Compute the width of this line. */
16616 row
->pixel_width
= row
->x
;
16617 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16618 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16620 xassert (row
->pixel_width
>= 0);
16621 xassert (row
->ascent
>= 0 && row
->height
> 0);
16623 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16624 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16626 /* If first line's physical ascent is larger than its logical
16627 ascent, use the physical ascent, and make the row taller.
16628 This makes accented characters fully visible. */
16629 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16630 && row
->phys_ascent
> row
->ascent
)
16632 row
->height
+= row
->phys_ascent
- row
->ascent
;
16633 row
->ascent
= row
->phys_ascent
;
16636 /* Compute how much of the line is visible. */
16637 row
->visible_height
= row
->height
;
16639 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16640 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16642 if (row
->y
< min_y
)
16643 row
->visible_height
-= min_y
- row
->y
;
16644 if (row
->y
+ row
->height
> max_y
)
16645 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16649 row
->pixel_width
= row
->used
[TEXT_AREA
];
16650 if (row
->continued_p
)
16651 row
->pixel_width
-= it
->continuation_pixel_width
;
16652 else if (row
->truncated_on_right_p
)
16653 row
->pixel_width
-= it
->truncation_pixel_width
;
16654 row
->ascent
= row
->phys_ascent
= 0;
16655 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16656 row
->extra_line_spacing
= 0;
16659 /* Compute a hash code for this row. */
16661 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16662 for (i
= 0; i
< row
->used
[area
]; ++i
)
16663 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16664 + row
->glyphs
[area
][i
].u
.val
16665 + row
->glyphs
[area
][i
].face_id
16666 + row
->glyphs
[area
][i
].padding_p
16667 + (row
->glyphs
[area
][i
].type
<< 2));
16669 it
->max_ascent
= it
->max_descent
= 0;
16670 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16674 /* Append one space to the glyph row of iterator IT if doing a
16675 window-based redisplay. The space has the same face as
16676 IT->face_id. Value is non-zero if a space was added.
16678 This function is called to make sure that there is always one glyph
16679 at the end of a glyph row that the cursor can be set on under
16680 window-systems. (If there weren't such a glyph we would not know
16681 how wide and tall a box cursor should be displayed).
16683 At the same time this space let's a nicely handle clearing to the
16684 end of the line if the row ends in italic text. */
16687 append_space_for_newline (struct it
*it
, int default_face_p
)
16689 if (FRAME_WINDOW_P (it
->f
))
16691 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16693 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16694 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16696 /* Save some values that must not be changed.
16697 Must save IT->c and IT->len because otherwise
16698 ITERATOR_AT_END_P wouldn't work anymore after
16699 append_space_for_newline has been called. */
16700 enum display_element_type saved_what
= it
->what
;
16701 int saved_c
= it
->c
, saved_len
= it
->len
;
16702 int saved_char_to_display
= it
->char_to_display
;
16703 int saved_x
= it
->current_x
;
16704 int saved_face_id
= it
->face_id
;
16705 struct text_pos saved_pos
;
16706 Lisp_Object saved_object
;
16709 saved_object
= it
->object
;
16710 saved_pos
= it
->position
;
16712 it
->what
= IT_CHARACTER
;
16713 memset (&it
->position
, 0, sizeof it
->position
);
16714 it
->object
= make_number (0);
16715 it
->c
= it
->char_to_display
= ' ';
16718 if (default_face_p
)
16719 it
->face_id
= DEFAULT_FACE_ID
;
16720 else if (it
->face_before_selective_p
)
16721 it
->face_id
= it
->saved_face_id
;
16722 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16723 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16725 PRODUCE_GLYPHS (it
);
16727 it
->override_ascent
= -1;
16728 it
->constrain_row_ascent_descent_p
= 0;
16729 it
->current_x
= saved_x
;
16730 it
->object
= saved_object
;
16731 it
->position
= saved_pos
;
16732 it
->what
= saved_what
;
16733 it
->face_id
= saved_face_id
;
16734 it
->len
= saved_len
;
16736 it
->char_to_display
= saved_char_to_display
;
16745 /* Extend the face of the last glyph in the text area of IT->glyph_row
16746 to the end of the display line. Called from display_line. If the
16747 glyph row is empty, add a space glyph to it so that we know the
16748 face to draw. Set the glyph row flag fill_line_p. If the glyph
16749 row is R2L, prepend a stretch glyph to cover the empty space to the
16750 left of the leftmost glyph. */
16753 extend_face_to_end_of_line (struct it
*it
)
16756 struct frame
*f
= it
->f
;
16758 /* If line is already filled, do nothing. Non window-system frames
16759 get a grace of one more ``pixel'' because their characters are
16760 1-``pixel'' wide, so they hit the equality too early. This grace
16761 is needed only for R2L rows that are not continued, to produce
16762 one extra blank where we could display the cursor. */
16763 if (it
->current_x
>= it
->last_visible_x
16764 + (!FRAME_WINDOW_P (f
)
16765 && it
->glyph_row
->reversed_p
16766 && !it
->glyph_row
->continued_p
))
16769 /* Face extension extends the background and box of IT->face_id
16770 to the end of the line. If the background equals the background
16771 of the frame, we don't have to do anything. */
16772 if (it
->face_before_selective_p
)
16773 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16775 face
= FACE_FROM_ID (f
, it
->face_id
);
16777 if (FRAME_WINDOW_P (f
)
16778 && it
->glyph_row
->displays_text_p
16779 && face
->box
== FACE_NO_BOX
16780 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16782 && !it
->glyph_row
->reversed_p
)
16785 /* Set the glyph row flag indicating that the face of the last glyph
16786 in the text area has to be drawn to the end of the text area. */
16787 it
->glyph_row
->fill_line_p
= 1;
16789 /* If current character of IT is not ASCII, make sure we have the
16790 ASCII face. This will be automatically undone the next time
16791 get_next_display_element returns a multibyte character. Note
16792 that the character will always be single byte in unibyte
16794 if (!ASCII_CHAR_P (it
->c
))
16796 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16799 if (FRAME_WINDOW_P (f
))
16801 /* If the row is empty, add a space with the current face of IT,
16802 so that we know which face to draw. */
16803 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16805 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16806 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16807 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16809 #ifdef HAVE_WINDOW_SYSTEM
16810 if (it
->glyph_row
->reversed_p
)
16812 /* Prepend a stretch glyph to the row, such that the
16813 rightmost glyph will be drawn flushed all the way to the
16814 right margin of the window. The stretch glyph that will
16815 occupy the empty space, if any, to the left of the
16817 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16818 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16819 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16821 int row_width
, stretch_ascent
, stretch_width
;
16822 struct text_pos saved_pos
;
16823 int saved_face_id
, saved_avoid_cursor
;
16825 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16826 row_width
+= g
->pixel_width
;
16827 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16828 if (stretch_width
> 0)
16831 (((it
->ascent
+ it
->descent
)
16832 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16833 saved_pos
= it
->position
;
16834 memset (&it
->position
, 0, sizeof it
->position
);
16835 saved_avoid_cursor
= it
->avoid_cursor_p
;
16836 it
->avoid_cursor_p
= 1;
16837 saved_face_id
= it
->face_id
;
16838 /* The last row's stretch glyph should get the default
16839 face, to avoid painting the rest of the window with
16840 the region face, if the region ends at ZV. */
16841 if (it
->glyph_row
->ends_at_zv_p
)
16842 it
->face_id
= DEFAULT_FACE_ID
;
16844 it
->face_id
= face
->id
;
16845 append_stretch_glyph (it
, make_number (0), stretch_width
,
16846 it
->ascent
+ it
->descent
, stretch_ascent
);
16847 it
->position
= saved_pos
;
16848 it
->avoid_cursor_p
= saved_avoid_cursor
;
16849 it
->face_id
= saved_face_id
;
16852 #endif /* HAVE_WINDOW_SYSTEM */
16856 /* Save some values that must not be changed. */
16857 int saved_x
= it
->current_x
;
16858 struct text_pos saved_pos
;
16859 Lisp_Object saved_object
;
16860 enum display_element_type saved_what
= it
->what
;
16861 int saved_face_id
= it
->face_id
;
16863 saved_object
= it
->object
;
16864 saved_pos
= it
->position
;
16866 it
->what
= IT_CHARACTER
;
16867 memset (&it
->position
, 0, sizeof it
->position
);
16868 it
->object
= make_number (0);
16869 it
->c
= it
->char_to_display
= ' ';
16871 /* The last row's blank glyphs should get the default face, to
16872 avoid painting the rest of the window with the region face,
16873 if the region ends at ZV. */
16874 if (it
->glyph_row
->ends_at_zv_p
)
16875 it
->face_id
= DEFAULT_FACE_ID
;
16877 it
->face_id
= face
->id
;
16879 PRODUCE_GLYPHS (it
);
16881 while (it
->current_x
<= it
->last_visible_x
)
16882 PRODUCE_GLYPHS (it
);
16884 /* Don't count these blanks really. It would let us insert a left
16885 truncation glyph below and make us set the cursor on them, maybe. */
16886 it
->current_x
= saved_x
;
16887 it
->object
= saved_object
;
16888 it
->position
= saved_pos
;
16889 it
->what
= saved_what
;
16890 it
->face_id
= saved_face_id
;
16895 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16896 trailing whitespace. */
16899 trailing_whitespace_p (int charpos
)
16901 int bytepos
= CHAR_TO_BYTE (charpos
);
16904 while (bytepos
< ZV_BYTE
16905 && (c
= FETCH_CHAR (bytepos
),
16906 c
== ' ' || c
== '\t'))
16909 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16911 if (bytepos
!= PT_BYTE
)
16918 /* Highlight trailing whitespace, if any, in ROW. */
16921 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16923 int used
= row
->used
[TEXT_AREA
];
16927 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16928 struct glyph
*glyph
= start
+ used
- 1;
16930 if (row
->reversed_p
)
16932 /* Right-to-left rows need to be processed in the opposite
16933 direction, so swap the edge pointers. */
16935 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16938 /* Skip over glyphs inserted to display the cursor at the
16939 end of a line, for extending the face of the last glyph
16940 to the end of the line on terminals, and for truncation
16941 and continuation glyphs. */
16942 if (!row
->reversed_p
)
16944 while (glyph
>= start
16945 && glyph
->type
== CHAR_GLYPH
16946 && INTEGERP (glyph
->object
))
16951 while (glyph
<= start
16952 && glyph
->type
== CHAR_GLYPH
16953 && INTEGERP (glyph
->object
))
16957 /* If last glyph is a space or stretch, and it's trailing
16958 whitespace, set the face of all trailing whitespace glyphs in
16959 IT->glyph_row to `trailing-whitespace'. */
16960 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16961 && BUFFERP (glyph
->object
)
16962 && (glyph
->type
== STRETCH_GLYPH
16963 || (glyph
->type
== CHAR_GLYPH
16964 && glyph
->u
.ch
== ' '))
16965 && trailing_whitespace_p (glyph
->charpos
))
16967 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16971 if (!row
->reversed_p
)
16973 while (glyph
>= start
16974 && BUFFERP (glyph
->object
)
16975 && (glyph
->type
== STRETCH_GLYPH
16976 || (glyph
->type
== CHAR_GLYPH
16977 && glyph
->u
.ch
== ' ')))
16978 (glyph
--)->face_id
= face_id
;
16982 while (glyph
<= start
16983 && BUFFERP (glyph
->object
)
16984 && (glyph
->type
== STRETCH_GLYPH
16985 || (glyph
->type
== CHAR_GLYPH
16986 && glyph
->u
.ch
== ' ')))
16987 (glyph
++)->face_id
= face_id
;
16994 /* Value is non-zero if glyph row ROW in window W should be
16995 used to hold the cursor. */
16998 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17000 int cursor_row_p
= 1;
17002 if (PT
== CHARPOS (row
->end
.pos
))
17004 /* Suppose the row ends on a string.
17005 Unless the row is continued, that means it ends on a newline
17006 in the string. If it's anything other than a display string
17007 (e.g. a before-string from an overlay), we don't want the
17008 cursor there. (This heuristic seems to give the optimal
17009 behavior for the various types of multi-line strings.) */
17010 if (CHARPOS (row
->end
.string_pos
) >= 0)
17012 if (row
->continued_p
)
17016 /* Check for `display' property. */
17017 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17018 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17019 struct glyph
*glyph
;
17022 for (glyph
= end
; glyph
>= beg
; --glyph
)
17023 if (STRINGP (glyph
->object
))
17026 = Fget_char_property (make_number (PT
),
17030 && display_prop_string_p (prop
, glyph
->object
));
17035 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17037 /* If the row ends in middle of a real character,
17038 and the line is continued, we want the cursor here.
17039 That's because CHARPOS (ROW->end.pos) would equal
17040 PT if PT is before the character. */
17041 if (!row
->ends_in_ellipsis_p
)
17042 cursor_row_p
= row
->continued_p
;
17044 /* If the row ends in an ellipsis, then
17045 CHARPOS (ROW->end.pos) will equal point after the
17046 invisible text. We want that position to be displayed
17047 after the ellipsis. */
17050 /* If the row ends at ZV, display the cursor at the end of that
17051 row instead of at the start of the row below. */
17052 else if (row
->ends_at_zv_p
)
17058 return cursor_row_p
;
17063 /* Push the display property PROP so that it will be rendered at the
17064 current position in IT. Return 1 if PROP was successfully pushed,
17068 push_display_prop (struct it
*it
, Lisp_Object prop
)
17072 if (STRINGP (prop
))
17074 if (SCHARS (prop
) == 0)
17081 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17082 it
->current
.overlay_string_index
= -1;
17083 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17084 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17085 it
->method
= GET_FROM_STRING
;
17086 it
->stop_charpos
= 0;
17088 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17090 it
->method
= GET_FROM_STRETCH
;
17093 #ifdef HAVE_WINDOW_SYSTEM
17094 else if (IMAGEP (prop
))
17096 it
->what
= IT_IMAGE
;
17097 it
->image_id
= lookup_image (it
->f
, prop
);
17098 it
->method
= GET_FROM_IMAGE
;
17100 #endif /* HAVE_WINDOW_SYSTEM */
17103 pop_it (it
); /* bogus display property, give up */
17110 /* Return the character-property PROP at the current position in IT. */
17113 get_it_property (struct it
*it
, Lisp_Object prop
)
17115 Lisp_Object position
;
17117 if (STRINGP (it
->object
))
17118 position
= make_number (IT_STRING_CHARPOS (*it
));
17119 else if (BUFFERP (it
->object
))
17120 position
= make_number (IT_CHARPOS (*it
));
17124 return Fget_char_property (position
, prop
, it
->object
);
17127 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17130 handle_line_prefix (struct it
*it
)
17132 Lisp_Object prefix
;
17133 if (it
->continuation_lines_width
> 0)
17135 prefix
= get_it_property (it
, Qwrap_prefix
);
17137 prefix
= Vwrap_prefix
;
17141 prefix
= get_it_property (it
, Qline_prefix
);
17143 prefix
= Vline_prefix
;
17145 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17147 /* If the prefix is wider than the window, and we try to wrap
17148 it, it would acquire its own wrap prefix, and so on till the
17149 iterator stack overflows. So, don't wrap the prefix. */
17150 it
->line_wrap
= TRUNCATE
;
17151 it
->avoid_cursor_p
= 1;
17157 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17158 only for R2L lines from display_line, when it decides that too many
17159 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17162 unproduce_glyphs (struct it
*it
, int n
)
17164 struct glyph
*glyph
, *end
;
17166 xassert (it
->glyph_row
);
17167 xassert (it
->glyph_row
->reversed_p
);
17168 xassert (it
->area
== TEXT_AREA
);
17169 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17171 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17172 n
= it
->glyph_row
->used
[TEXT_AREA
];
17173 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17174 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17175 for ( ; glyph
< end
; glyph
++)
17176 glyph
[-n
] = *glyph
;
17179 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17180 and ROW->maxpos. */
17182 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17183 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17184 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17186 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17187 lines' rows is implemented for bidi-reordered rows. */
17189 /* ROW->minpos is the value of min_pos, the minimal buffer position
17192 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17195 /* We didn't find _any_ valid buffer positions in any of the
17196 glyphs, so we must trust the iterator's computed
17198 row
->minpos
= row
->start
.pos
;
17199 max_pos
= CHARPOS (it
->current
.pos
);
17200 max_bpos
= BYTEPOS (it
->current
.pos
);
17206 /* Here are the various use-cases for ending the row, and the
17207 corresponding values for ROW->maxpos:
17209 Line ends in a newline from buffer eol_pos + 1
17210 Line is continued from buffer max_pos + 1
17211 Line is truncated on right it->current.pos
17212 Line ends in a newline from string max_pos
17213 Line is continued from string max_pos
17214 Line is continued from display vector max_pos
17215 Line is entirely from a string min_pos == max_pos
17216 Line is entirely from a display vector min_pos == max_pos
17217 Line that ends at ZV ZV
17219 If you discover other use-cases, please add them here as
17221 if (row
->ends_at_zv_p
)
17222 row
->maxpos
= it
->current
.pos
;
17223 else if (row
->used
[TEXT_AREA
])
17225 if (row
->ends_in_newline_from_string_p
)
17226 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17227 else if (CHARPOS (it
->eol_pos
) > 0)
17228 SET_TEXT_POS (row
->maxpos
,
17229 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17230 else if (row
->continued_p
)
17232 /* If max_pos is different from IT's current position, it
17233 means IT->method does not belong to the display element
17234 at max_pos. However, it also means that the display
17235 element at max_pos was displayed in its entirety on this
17236 line, which is equivalent to saying that the next line
17237 starts at the next buffer position. */
17238 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17239 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17242 INC_BOTH (max_pos
, max_bpos
);
17243 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17246 else if (row
->truncated_on_right_p
)
17247 /* display_line already called reseat_at_next_visible_line_start,
17248 which puts the iterator at the beginning of the next line, in
17249 the logical order. */
17250 row
->maxpos
= it
->current
.pos
;
17251 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17252 /* A line that is entirely from a string/image/stretch... */
17253 row
->maxpos
= row
->minpos
;
17258 row
->maxpos
= it
->current
.pos
;
17261 /* Construct the glyph row IT->glyph_row in the desired matrix of
17262 IT->w from text at the current position of IT. See dispextern.h
17263 for an overview of struct it. Value is non-zero if
17264 IT->glyph_row displays text, as opposed to a line displaying ZV
17268 display_line (struct it
*it
)
17270 struct glyph_row
*row
= it
->glyph_row
;
17271 Lisp_Object overlay_arrow_string
;
17273 int may_wrap
= 0, wrap_x
;
17274 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17275 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17276 int wrap_row_extra_line_spacing
;
17277 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17278 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17280 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17282 /* We always start displaying at hpos zero even if hscrolled. */
17283 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17285 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17286 >= it
->w
->desired_matrix
->nrows
)
17288 it
->w
->nrows_scale_factor
++;
17289 fonts_changed_p
= 1;
17293 /* Is IT->w showing the region? */
17294 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17296 /* Clear the result glyph row and enable it. */
17297 prepare_desired_row (row
);
17299 row
->y
= it
->current_y
;
17300 row
->start
= it
->start
;
17301 row
->continuation_lines_width
= it
->continuation_lines_width
;
17302 row
->displays_text_p
= 1;
17303 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17304 it
->starts_in_middle_of_char_p
= 0;
17306 /* Arrange the overlays nicely for our purposes. Usually, we call
17307 display_line on only one line at a time, in which case this
17308 can't really hurt too much, or we call it on lines which appear
17309 one after another in the buffer, in which case all calls to
17310 recenter_overlay_lists but the first will be pretty cheap. */
17311 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17313 /* Move over display elements that are not visible because we are
17314 hscrolled. This may stop at an x-position < IT->first_visible_x
17315 if the first glyph is partially visible or if we hit a line end. */
17316 if (it
->current_x
< it
->first_visible_x
)
17318 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17319 MOVE_TO_POS
| MOVE_TO_X
);
17323 /* We only do this when not calling `move_it_in_display_line_to'
17324 above, because move_it_in_display_line_to calls
17325 handle_line_prefix itself. */
17326 handle_line_prefix (it
);
17329 /* Get the initial row height. This is either the height of the
17330 text hscrolled, if there is any, or zero. */
17331 row
->ascent
= it
->max_ascent
;
17332 row
->height
= it
->max_ascent
+ it
->max_descent
;
17333 row
->phys_ascent
= it
->max_phys_ascent
;
17334 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17335 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17337 /* Utility macro to record max and min buffer positions seen until now. */
17338 #define RECORD_MAX_MIN_POS(IT) \
17341 if (IT_CHARPOS (*(IT)) < min_pos) \
17343 min_pos = IT_CHARPOS (*(IT)); \
17344 min_bpos = IT_BYTEPOS (*(IT)); \
17346 if (IT_CHARPOS (*(IT)) > max_pos) \
17348 max_pos = IT_CHARPOS (*(IT)); \
17349 max_bpos = IT_BYTEPOS (*(IT)); \
17354 /* Loop generating characters. The loop is left with IT on the next
17355 character to display. */
17358 int n_glyphs_before
, hpos_before
, x_before
;
17360 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17362 /* Retrieve the next thing to display. Value is zero if end of
17364 if (!get_next_display_element (it
))
17366 /* Maybe add a space at the end of this line that is used to
17367 display the cursor there under X. Set the charpos of the
17368 first glyph of blank lines not corresponding to any text
17370 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17371 row
->exact_window_width_line_p
= 1;
17372 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17373 || row
->used
[TEXT_AREA
] == 0)
17375 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17376 row
->displays_text_p
= 0;
17378 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17379 && (!MINI_WINDOW_P (it
->w
)
17380 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17381 row
->indicate_empty_line_p
= 1;
17384 it
->continuation_lines_width
= 0;
17385 row
->ends_at_zv_p
= 1;
17386 /* A row that displays right-to-left text must always have
17387 its last face extended all the way to the end of line,
17388 even if this row ends in ZV, because we still write to
17389 the screen left to right. */
17390 if (row
->reversed_p
)
17391 extend_face_to_end_of_line (it
);
17395 /* Now, get the metrics of what we want to display. This also
17396 generates glyphs in `row' (which is IT->glyph_row). */
17397 n_glyphs_before
= row
->used
[TEXT_AREA
];
17400 /* Remember the line height so far in case the next element doesn't
17401 fit on the line. */
17402 if (it
->line_wrap
!= TRUNCATE
)
17404 ascent
= it
->max_ascent
;
17405 descent
= it
->max_descent
;
17406 phys_ascent
= it
->max_phys_ascent
;
17407 phys_descent
= it
->max_phys_descent
;
17409 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17411 if (IT_DISPLAYING_WHITESPACE (it
))
17417 wrap_row_used
= row
->used
[TEXT_AREA
];
17418 wrap_row_ascent
= row
->ascent
;
17419 wrap_row_height
= row
->height
;
17420 wrap_row_phys_ascent
= row
->phys_ascent
;
17421 wrap_row_phys_height
= row
->phys_height
;
17422 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17423 wrap_row_min_pos
= min_pos
;
17424 wrap_row_min_bpos
= min_bpos
;
17425 wrap_row_max_pos
= max_pos
;
17426 wrap_row_max_bpos
= max_bpos
;
17432 PRODUCE_GLYPHS (it
);
17434 /* If this display element was in marginal areas, continue with
17436 if (it
->area
!= TEXT_AREA
)
17438 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17439 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17440 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17441 row
->phys_height
= max (row
->phys_height
,
17442 it
->max_phys_ascent
+ it
->max_phys_descent
);
17443 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17444 it
->max_extra_line_spacing
);
17445 set_iterator_to_next (it
, 1);
17449 /* Does the display element fit on the line? If we truncate
17450 lines, we should draw past the right edge of the window. If
17451 we don't truncate, we want to stop so that we can display the
17452 continuation glyph before the right margin. If lines are
17453 continued, there are two possible strategies for characters
17454 resulting in more than 1 glyph (e.g. tabs): Display as many
17455 glyphs as possible in this line and leave the rest for the
17456 continuation line, or display the whole element in the next
17457 line. Original redisplay did the former, so we do it also. */
17458 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17459 hpos_before
= it
->hpos
;
17462 if (/* Not a newline. */
17464 /* Glyphs produced fit entirely in the line. */
17465 && it
->current_x
< it
->last_visible_x
)
17467 it
->hpos
+= nglyphs
;
17468 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17469 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17470 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17471 row
->phys_height
= max (row
->phys_height
,
17472 it
->max_phys_ascent
+ it
->max_phys_descent
);
17473 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17474 it
->max_extra_line_spacing
);
17475 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17476 row
->x
= x
- it
->first_visible_x
;
17477 /* Record the maximum and minimum buffer positions seen so
17478 far in glyphs that will be displayed by this row. */
17480 RECORD_MAX_MIN_POS (it
);
17485 struct glyph
*glyph
;
17487 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17489 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17490 new_x
= x
+ glyph
->pixel_width
;
17492 if (/* Lines are continued. */
17493 it
->line_wrap
!= TRUNCATE
17494 && (/* Glyph doesn't fit on the line. */
17495 new_x
> it
->last_visible_x
17496 /* Or it fits exactly on a window system frame. */
17497 || (new_x
== it
->last_visible_x
17498 && FRAME_WINDOW_P (it
->f
))))
17500 /* End of a continued line. */
17503 || (new_x
== it
->last_visible_x
17504 && FRAME_WINDOW_P (it
->f
)))
17506 /* Current glyph is the only one on the line or
17507 fits exactly on the line. We must continue
17508 the line because we can't draw the cursor
17509 after the glyph. */
17510 row
->continued_p
= 1;
17511 it
->current_x
= new_x
;
17512 it
->continuation_lines_width
+= new_x
;
17514 /* Record the maximum and minimum buffer
17515 positions seen so far in glyphs that will be
17516 displayed by this row. */
17518 RECORD_MAX_MIN_POS (it
);
17519 if (i
== nglyphs
- 1)
17521 /* If line-wrap is on, check if a previous
17522 wrap point was found. */
17523 if (wrap_row_used
> 0
17524 /* Even if there is a previous wrap
17525 point, continue the line here as
17526 usual, if (i) the previous character
17527 was a space or tab AND (ii) the
17528 current character is not. */
17530 || IT_DISPLAYING_WHITESPACE (it
)))
17533 set_iterator_to_next (it
, 1);
17534 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17536 if (!get_next_display_element (it
))
17538 row
->exact_window_width_line_p
= 1;
17539 it
->continuation_lines_width
= 0;
17540 row
->continued_p
= 0;
17541 row
->ends_at_zv_p
= 1;
17543 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17545 row
->continued_p
= 0;
17546 row
->exact_window_width_line_p
= 1;
17551 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17552 && !FRAME_WINDOW_P (it
->f
))
17554 /* A padding glyph that doesn't fit on this line.
17555 This means the whole character doesn't fit
17557 if (row
->reversed_p
)
17558 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17559 - n_glyphs_before
);
17560 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17562 /* Fill the rest of the row with continuation
17563 glyphs like in 20.x. */
17564 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17565 < row
->glyphs
[1 + TEXT_AREA
])
17566 produce_special_glyphs (it
, IT_CONTINUATION
);
17568 row
->continued_p
= 1;
17569 it
->current_x
= x_before
;
17570 it
->continuation_lines_width
+= x_before
;
17572 /* Restore the height to what it was before the
17573 element not fitting on the line. */
17574 it
->max_ascent
= ascent
;
17575 it
->max_descent
= descent
;
17576 it
->max_phys_ascent
= phys_ascent
;
17577 it
->max_phys_descent
= phys_descent
;
17579 else if (wrap_row_used
> 0)
17582 if (row
->reversed_p
)
17583 unproduce_glyphs (it
,
17584 row
->used
[TEXT_AREA
] - wrap_row_used
);
17586 it
->continuation_lines_width
+= wrap_x
;
17587 row
->used
[TEXT_AREA
] = wrap_row_used
;
17588 row
->ascent
= wrap_row_ascent
;
17589 row
->height
= wrap_row_height
;
17590 row
->phys_ascent
= wrap_row_phys_ascent
;
17591 row
->phys_height
= wrap_row_phys_height
;
17592 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17593 min_pos
= wrap_row_min_pos
;
17594 min_bpos
= wrap_row_min_bpos
;
17595 max_pos
= wrap_row_max_pos
;
17596 max_bpos
= wrap_row_max_bpos
;
17597 row
->continued_p
= 1;
17598 row
->ends_at_zv_p
= 0;
17599 row
->exact_window_width_line_p
= 0;
17600 it
->continuation_lines_width
+= x
;
17602 /* Make sure that a non-default face is extended
17603 up to the right margin of the window. */
17604 extend_face_to_end_of_line (it
);
17606 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17608 /* A TAB that extends past the right edge of the
17609 window. This produces a single glyph on
17610 window system frames. We leave the glyph in
17611 this row and let it fill the row, but don't
17612 consume the TAB. */
17613 it
->continuation_lines_width
+= it
->last_visible_x
;
17614 row
->ends_in_middle_of_char_p
= 1;
17615 row
->continued_p
= 1;
17616 glyph
->pixel_width
= it
->last_visible_x
- x
;
17617 it
->starts_in_middle_of_char_p
= 1;
17621 /* Something other than a TAB that draws past
17622 the right edge of the window. Restore
17623 positions to values before the element. */
17624 if (row
->reversed_p
)
17625 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17626 - (n_glyphs_before
+ i
));
17627 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17629 /* Display continuation glyphs. */
17630 if (!FRAME_WINDOW_P (it
->f
))
17631 produce_special_glyphs (it
, IT_CONTINUATION
);
17632 row
->continued_p
= 1;
17634 it
->current_x
= x_before
;
17635 it
->continuation_lines_width
+= x
;
17636 extend_face_to_end_of_line (it
);
17638 if (nglyphs
> 1 && i
> 0)
17640 row
->ends_in_middle_of_char_p
= 1;
17641 it
->starts_in_middle_of_char_p
= 1;
17644 /* Restore the height to what it was before the
17645 element not fitting on the line. */
17646 it
->max_ascent
= ascent
;
17647 it
->max_descent
= descent
;
17648 it
->max_phys_ascent
= phys_ascent
;
17649 it
->max_phys_descent
= phys_descent
;
17654 else if (new_x
> it
->first_visible_x
)
17656 /* Increment number of glyphs actually displayed. */
17659 /* Record the maximum and minimum buffer positions
17660 seen so far in glyphs that will be displayed by
17663 RECORD_MAX_MIN_POS (it
);
17665 if (x
< it
->first_visible_x
)
17666 /* Glyph is partially visible, i.e. row starts at
17667 negative X position. */
17668 row
->x
= x
- it
->first_visible_x
;
17672 /* Glyph is completely off the left margin of the
17673 window. This should not happen because of the
17674 move_it_in_display_line at the start of this
17675 function, unless the text display area of the
17676 window is empty. */
17677 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17681 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17682 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17683 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17684 row
->phys_height
= max (row
->phys_height
,
17685 it
->max_phys_ascent
+ it
->max_phys_descent
);
17686 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17687 it
->max_extra_line_spacing
);
17689 /* End of this display line if row is continued. */
17690 if (row
->continued_p
|| row
->ends_at_zv_p
)
17695 /* Is this a line end? If yes, we're also done, after making
17696 sure that a non-default face is extended up to the right
17697 margin of the window. */
17698 if (ITERATOR_AT_END_OF_LINE_P (it
))
17700 int used_before
= row
->used
[TEXT_AREA
];
17702 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17704 /* Add a space at the end of the line that is used to
17705 display the cursor there. */
17706 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17707 append_space_for_newline (it
, 0);
17709 /* Extend the face to the end of the line. */
17710 extend_face_to_end_of_line (it
);
17712 /* Make sure we have the position. */
17713 if (used_before
== 0)
17714 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17716 /* Record the position of the newline, for use in
17718 it
->eol_pos
= it
->current
.pos
;
17720 /* Consume the line end. This skips over invisible lines. */
17721 set_iterator_to_next (it
, 1);
17722 it
->continuation_lines_width
= 0;
17726 /* Proceed with next display element. Note that this skips
17727 over lines invisible because of selective display. */
17728 set_iterator_to_next (it
, 1);
17730 /* If we truncate lines, we are done when the last displayed
17731 glyphs reach past the right margin of the window. */
17732 if (it
->line_wrap
== TRUNCATE
17733 && (FRAME_WINDOW_P (it
->f
)
17734 ? (it
->current_x
>= it
->last_visible_x
)
17735 : (it
->current_x
> it
->last_visible_x
)))
17737 /* Maybe add truncation glyphs. */
17738 if (!FRAME_WINDOW_P (it
->f
))
17742 if (!row
->reversed_p
)
17744 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17745 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17750 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17751 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17753 /* Remove any padding glyphs at the front of ROW, to
17754 make room for the truncation glyphs we will be
17755 adding below. The loop below always inserts at
17756 least one truncation glyph, so also remove the
17757 last glyph added to ROW. */
17758 unproduce_glyphs (it
, i
+ 1);
17759 /* Adjust i for the loop below. */
17760 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17763 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17765 row
->used
[TEXT_AREA
] = i
;
17766 produce_special_glyphs (it
, IT_TRUNCATION
);
17769 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17771 /* Don't truncate if we can overflow newline into fringe. */
17772 if (!get_next_display_element (it
))
17774 it
->continuation_lines_width
= 0;
17775 row
->ends_at_zv_p
= 1;
17776 row
->exact_window_width_line_p
= 1;
17779 if (ITERATOR_AT_END_OF_LINE_P (it
))
17781 row
->exact_window_width_line_p
= 1;
17782 goto at_end_of_line
;
17786 row
->truncated_on_right_p
= 1;
17787 it
->continuation_lines_width
= 0;
17788 reseat_at_next_visible_line_start (it
, 0);
17789 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17790 it
->hpos
= hpos_before
;
17791 it
->current_x
= x_before
;
17796 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17797 at the left window margin. */
17798 if (it
->first_visible_x
17799 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17801 if (!FRAME_WINDOW_P (it
->f
))
17802 insert_left_trunc_glyphs (it
);
17803 row
->truncated_on_left_p
= 1;
17806 /* Remember the position at which this line ends.
17808 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17809 cannot be before the call to find_row_edges below, since that is
17810 where these positions are determined. */
17811 row
->end
= it
->current
;
17814 row
->minpos
= row
->start
.pos
;
17815 row
->maxpos
= row
->end
.pos
;
17819 /* ROW->minpos and ROW->maxpos must be the smallest and
17820 `1 + the largest' buffer positions in ROW. But if ROW was
17821 bidi-reordered, these two positions can be anywhere in the
17822 row, so we must determine them now. */
17823 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17826 /* If the start of this line is the overlay arrow-position, then
17827 mark this glyph row as the one containing the overlay arrow.
17828 This is clearly a mess with variable size fonts. It would be
17829 better to let it be displayed like cursors under X. */
17830 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17831 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17832 !NILP (overlay_arrow_string
)))
17834 /* Overlay arrow in window redisplay is a fringe bitmap. */
17835 if (STRINGP (overlay_arrow_string
))
17837 struct glyph_row
*arrow_row
17838 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17839 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17840 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17841 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17842 struct glyph
*p2
, *end
;
17844 /* Copy the arrow glyphs. */
17845 while (glyph
< arrow_end
)
17848 /* Throw away padding glyphs. */
17850 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17851 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17857 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17862 xassert (INTEGERP (overlay_arrow_string
));
17863 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17865 overlay_arrow_seen
= 1;
17868 /* Compute pixel dimensions of this line. */
17869 compute_line_metrics (it
);
17871 /* Record whether this row ends inside an ellipsis. */
17872 row
->ends_in_ellipsis_p
17873 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17874 && it
->ellipsis_p
);
17876 /* Save fringe bitmaps in this row. */
17877 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17878 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17879 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17880 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17882 it
->left_user_fringe_bitmap
= 0;
17883 it
->left_user_fringe_face_id
= 0;
17884 it
->right_user_fringe_bitmap
= 0;
17885 it
->right_user_fringe_face_id
= 0;
17887 /* Maybe set the cursor. */
17888 cvpos
= it
->w
->cursor
.vpos
;
17890 /* In bidi-reordered rows, keep checking for proper cursor
17891 position even if one has been found already, because buffer
17892 positions in such rows change non-linearly with ROW->VPOS,
17893 when a line is continued. One exception: when we are at ZV,
17894 display cursor on the first suitable glyph row, since all
17895 the empty rows after that also have their position set to ZV. */
17896 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17897 lines' rows is implemented for bidi-reordered rows. */
17899 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17900 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17901 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17902 && cursor_row_p (it
->w
, row
))
17903 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17905 /* Highlight trailing whitespace. */
17906 if (!NILP (Vshow_trailing_whitespace
))
17907 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17909 /* Prepare for the next line. This line starts horizontally at (X
17910 HPOS) = (0 0). Vertical positions are incremented. As a
17911 convenience for the caller, IT->glyph_row is set to the next
17913 it
->current_x
= it
->hpos
= 0;
17914 it
->current_y
+= row
->height
;
17915 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17918 /* The next row should by default use the same value of the
17919 reversed_p flag as this one. set_iterator_to_next decides when
17920 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17921 the flag accordingly. */
17922 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17923 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17924 it
->start
= row
->end
;
17925 return row
->displays_text_p
;
17927 #undef RECORD_MAX_MIN_POS
17930 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17931 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17932 doc
: /* Return paragraph direction at point in BUFFER.
17933 Value is either `left-to-right' or `right-to-left'.
17934 If BUFFER is omitted or nil, it defaults to the current buffer.
17936 Paragraph direction determines how the text in the paragraph is displayed.
17937 In left-to-right paragraphs, text begins at the left margin of the window
17938 and the reading direction is generally left to right. In right-to-left
17939 paragraphs, text begins at the right margin and is read from right to left.
17941 See also `bidi-paragraph-direction'. */)
17942 (Lisp_Object buffer
)
17944 struct buffer
*buf
;
17945 struct buffer
*old
;
17948 buf
= current_buffer
;
17951 CHECK_BUFFER (buffer
);
17952 buf
= XBUFFER (buffer
);
17953 old
= current_buffer
;
17956 if (NILP (buf
->bidi_display_reordering
))
17957 return Qleft_to_right
;
17958 else if (!NILP (buf
->bidi_paragraph_direction
))
17959 return buf
->bidi_paragraph_direction
;
17962 /* Determine the direction from buffer text. We could try to
17963 use current_matrix if it is up to date, but this seems fast
17964 enough as it is. */
17965 struct bidi_it itb
;
17966 EMACS_INT pos
= BUF_PT (buf
);
17967 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17970 if (buf
!= current_buffer
)
17971 set_buffer_temp (buf
);
17972 /* bidi_paragraph_init finds the base direction of the paragraph
17973 by searching forward from paragraph start. We need the base
17974 direction of the current or _previous_ paragraph, so we need
17975 to make sure we are within that paragraph. To that end, find
17976 the previous non-empty line. */
17977 if (pos
>= ZV
&& pos
> BEGV
)
17980 bytepos
= CHAR_TO_BYTE (pos
);
17982 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17983 || c
== ' ' || c
== '\t' || c
== '\f')
17985 if (bytepos
<= BEGV_BYTE
)
17990 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17993 itb
.bytepos
= bytepos
;
17995 itb
.separator_limit
= -1;
17996 itb
.paragraph_dir
= NEUTRAL_DIR
;
17998 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17999 if (buf
!= current_buffer
)
18000 set_buffer_temp (old
);
18001 switch (itb
.paragraph_dir
)
18004 return Qleft_to_right
;
18007 return Qright_to_left
;
18017 /***********************************************************************
18019 ***********************************************************************/
18021 /* Redisplay the menu bar in the frame for window W.
18023 The menu bar of X frames that don't have X toolkit support is
18024 displayed in a special window W->frame->menu_bar_window.
18026 The menu bar of terminal frames is treated specially as far as
18027 glyph matrices are concerned. Menu bar lines are not part of
18028 windows, so the update is done directly on the frame matrix rows
18029 for the menu bar. */
18032 display_menu_bar (struct window
*w
)
18034 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18039 /* Don't do all this for graphical frames. */
18041 if (FRAME_W32_P (f
))
18044 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18050 if (FRAME_NS_P (f
))
18052 #endif /* HAVE_NS */
18054 #ifdef USE_X_TOOLKIT
18055 xassert (!FRAME_WINDOW_P (f
));
18056 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18057 it
.first_visible_x
= 0;
18058 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18059 #else /* not USE_X_TOOLKIT */
18060 if (FRAME_WINDOW_P (f
))
18062 /* Menu bar lines are displayed in the desired matrix of the
18063 dummy window menu_bar_window. */
18064 struct window
*menu_w
;
18065 xassert (WINDOWP (f
->menu_bar_window
));
18066 menu_w
= XWINDOW (f
->menu_bar_window
);
18067 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18069 it
.first_visible_x
= 0;
18070 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18074 /* This is a TTY frame, i.e. character hpos/vpos are used as
18076 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18078 it
.first_visible_x
= 0;
18079 it
.last_visible_x
= FRAME_COLS (f
);
18081 #endif /* not USE_X_TOOLKIT */
18083 if (! mode_line_inverse_video
)
18084 /* Force the menu-bar to be displayed in the default face. */
18085 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18087 /* Clear all rows of the menu bar. */
18088 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18090 struct glyph_row
*row
= it
.glyph_row
+ i
;
18091 clear_glyph_row (row
);
18092 row
->enabled_p
= 1;
18093 row
->full_width_p
= 1;
18096 /* Display all items of the menu bar. */
18097 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18098 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18100 Lisp_Object string
;
18102 /* Stop at nil string. */
18103 string
= AREF (items
, i
+ 1);
18107 /* Remember where item was displayed. */
18108 ASET (items
, i
+ 3, make_number (it
.hpos
));
18110 /* Display the item, pad with one space. */
18111 if (it
.current_x
< it
.last_visible_x
)
18112 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18113 SCHARS (string
) + 1, 0, 0, -1);
18116 /* Fill out the line with spaces. */
18117 if (it
.current_x
< it
.last_visible_x
)
18118 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18120 /* Compute the total height of the lines. */
18121 compute_line_metrics (&it
);
18126 /***********************************************************************
18128 ***********************************************************************/
18130 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18131 FORCE is non-zero, redisplay mode lines unconditionally.
18132 Otherwise, redisplay only mode lines that are garbaged. Value is
18133 the number of windows whose mode lines were redisplayed. */
18136 redisplay_mode_lines (Lisp_Object window
, int force
)
18140 while (!NILP (window
))
18142 struct window
*w
= XWINDOW (window
);
18144 if (WINDOWP (w
->hchild
))
18145 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18146 else if (WINDOWP (w
->vchild
))
18147 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18149 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18150 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18152 struct text_pos lpoint
;
18153 struct buffer
*old
= current_buffer
;
18155 /* Set the window's buffer for the mode line display. */
18156 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18157 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18159 /* Point refers normally to the selected window. For any
18160 other window, set up appropriate value. */
18161 if (!EQ (window
, selected_window
))
18163 struct text_pos pt
;
18165 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18166 if (CHARPOS (pt
) < BEGV
)
18167 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18168 else if (CHARPOS (pt
) > (ZV
- 1))
18169 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18171 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18174 /* Display mode lines. */
18175 clear_glyph_matrix (w
->desired_matrix
);
18176 if (display_mode_lines (w
))
18179 w
->must_be_updated_p
= 1;
18182 /* Restore old settings. */
18183 set_buffer_internal_1 (old
);
18184 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18194 /* Display the mode and/or header line of window W. Value is the
18195 sum number of mode lines and header lines displayed. */
18198 display_mode_lines (struct window
*w
)
18200 Lisp_Object old_selected_window
, old_selected_frame
;
18203 old_selected_frame
= selected_frame
;
18204 selected_frame
= w
->frame
;
18205 old_selected_window
= selected_window
;
18206 XSETWINDOW (selected_window
, w
);
18208 /* These will be set while the mode line specs are processed. */
18209 line_number_displayed
= 0;
18210 w
->column_number_displayed
= Qnil
;
18212 if (WINDOW_WANTS_MODELINE_P (w
))
18214 struct window
*sel_w
= XWINDOW (old_selected_window
);
18216 /* Select mode line face based on the real selected window. */
18217 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18218 current_buffer
->mode_line_format
);
18222 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18224 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18225 current_buffer
->header_line_format
);
18229 selected_frame
= old_selected_frame
;
18230 selected_window
= old_selected_window
;
18235 /* Display mode or header line of window W. FACE_ID specifies which
18236 line to display; it is either MODE_LINE_FACE_ID or
18237 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18238 display. Value is the pixel height of the mode/header line
18242 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18246 int count
= SPECPDL_INDEX ();
18248 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18249 /* Don't extend on a previously drawn mode-line.
18250 This may happen if called from pos_visible_p. */
18251 it
.glyph_row
->enabled_p
= 0;
18252 prepare_desired_row (it
.glyph_row
);
18254 it
.glyph_row
->mode_line_p
= 1;
18256 if (! mode_line_inverse_video
)
18257 /* Force the mode-line to be displayed in the default face. */
18258 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18260 record_unwind_protect (unwind_format_mode_line
,
18261 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18263 mode_line_target
= MODE_LINE_DISPLAY
;
18265 /* Temporarily make frame's keyboard the current kboard so that
18266 kboard-local variables in the mode_line_format will get the right
18268 push_kboard (FRAME_KBOARD (it
.f
));
18269 record_unwind_save_match_data ();
18270 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18273 unbind_to (count
, Qnil
);
18275 /* Fill up with spaces. */
18276 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18278 compute_line_metrics (&it
);
18279 it
.glyph_row
->full_width_p
= 1;
18280 it
.glyph_row
->continued_p
= 0;
18281 it
.glyph_row
->truncated_on_left_p
= 0;
18282 it
.glyph_row
->truncated_on_right_p
= 0;
18284 /* Make a 3D mode-line have a shadow at its right end. */
18285 face
= FACE_FROM_ID (it
.f
, face_id
);
18286 extend_face_to_end_of_line (&it
);
18287 if (face
->box
!= FACE_NO_BOX
)
18289 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18290 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18291 last
->right_box_line_p
= 1;
18294 return it
.glyph_row
->height
;
18297 /* Move element ELT in LIST to the front of LIST.
18298 Return the updated list. */
18301 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18303 register Lisp_Object tail
, prev
;
18304 register Lisp_Object tem
;
18308 while (CONSP (tail
))
18314 /* Splice out the link TAIL. */
18316 list
= XCDR (tail
);
18318 Fsetcdr (prev
, XCDR (tail
));
18320 /* Now make it the first. */
18321 Fsetcdr (tail
, list
);
18326 tail
= XCDR (tail
);
18330 /* Not found--return unchanged LIST. */
18334 /* Contribute ELT to the mode line for window IT->w. How it
18335 translates into text depends on its data type.
18337 IT describes the display environment in which we display, as usual.
18339 DEPTH is the depth in recursion. It is used to prevent
18340 infinite recursion here.
18342 FIELD_WIDTH is the number of characters the display of ELT should
18343 occupy in the mode line, and PRECISION is the maximum number of
18344 characters to display from ELT's representation. See
18345 display_string for details.
18347 Returns the hpos of the end of the text generated by ELT.
18349 PROPS is a property list to add to any string we encounter.
18351 If RISKY is nonzero, remove (disregard) any properties in any string
18352 we encounter, and ignore :eval and :propertize.
18354 The global variable `mode_line_target' determines whether the
18355 output is passed to `store_mode_line_noprop',
18356 `store_mode_line_string', or `display_string'. */
18359 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18360 Lisp_Object elt
, Lisp_Object props
, int risky
)
18362 int n
= 0, field
, prec
;
18367 elt
= build_string ("*too-deep*");
18371 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18375 /* A string: output it and check for %-constructs within it. */
18379 if (SCHARS (elt
) > 0
18380 && (!NILP (props
) || risky
))
18382 Lisp_Object oprops
, aelt
;
18383 oprops
= Ftext_properties_at (make_number (0), elt
);
18385 /* If the starting string's properties are not what
18386 we want, translate the string. Also, if the string
18387 is risky, do that anyway. */
18389 if (NILP (Fequal (props
, oprops
)) || risky
)
18391 /* If the starting string has properties,
18392 merge the specified ones onto the existing ones. */
18393 if (! NILP (oprops
) && !risky
)
18397 oprops
= Fcopy_sequence (oprops
);
18399 while (CONSP (tem
))
18401 oprops
= Fplist_put (oprops
, XCAR (tem
),
18402 XCAR (XCDR (tem
)));
18403 tem
= XCDR (XCDR (tem
));
18408 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18409 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18411 /* AELT is what we want. Move it to the front
18412 without consing. */
18414 mode_line_proptrans_alist
18415 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18421 /* If AELT has the wrong props, it is useless.
18422 so get rid of it. */
18424 mode_line_proptrans_alist
18425 = Fdelq (aelt
, mode_line_proptrans_alist
);
18427 elt
= Fcopy_sequence (elt
);
18428 Fset_text_properties (make_number (0), Flength (elt
),
18430 /* Add this item to mode_line_proptrans_alist. */
18431 mode_line_proptrans_alist
18432 = Fcons (Fcons (elt
, props
),
18433 mode_line_proptrans_alist
);
18434 /* Truncate mode_line_proptrans_alist
18435 to at most 50 elements. */
18436 tem
= Fnthcdr (make_number (50),
18437 mode_line_proptrans_alist
);
18439 XSETCDR (tem
, Qnil
);
18448 prec
= precision
- n
;
18449 switch (mode_line_target
)
18451 case MODE_LINE_NOPROP
:
18452 case MODE_LINE_TITLE
:
18453 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18455 case MODE_LINE_STRING
:
18456 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18458 case MODE_LINE_DISPLAY
:
18459 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18460 0, prec
, 0, STRING_MULTIBYTE (elt
));
18467 /* Handle the non-literal case. */
18469 while ((precision
<= 0 || n
< precision
)
18470 && SREF (elt
, offset
) != 0
18471 && (mode_line_target
!= MODE_LINE_DISPLAY
18472 || it
->current_x
< it
->last_visible_x
))
18474 int last_offset
= offset
;
18476 /* Advance to end of string or next format specifier. */
18477 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18480 if (offset
- 1 != last_offset
)
18482 int nchars
, nbytes
;
18484 /* Output to end of string or up to '%'. Field width
18485 is length of string. Don't output more than
18486 PRECISION allows us. */
18489 prec
= c_string_width (SDATA (elt
) + last_offset
,
18490 offset
- last_offset
, precision
- n
,
18493 switch (mode_line_target
)
18495 case MODE_LINE_NOPROP
:
18496 case MODE_LINE_TITLE
:
18497 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18499 case MODE_LINE_STRING
:
18501 int bytepos
= last_offset
;
18502 int charpos
= string_byte_to_char (elt
, bytepos
);
18503 int endpos
= (precision
<= 0
18504 ? string_byte_to_char (elt
, offset
)
18505 : charpos
+ nchars
);
18507 n
+= store_mode_line_string (NULL
,
18508 Fsubstring (elt
, make_number (charpos
),
18509 make_number (endpos
)),
18513 case MODE_LINE_DISPLAY
:
18515 int bytepos
= last_offset
;
18516 int charpos
= string_byte_to_char (elt
, bytepos
);
18518 if (precision
<= 0)
18519 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18520 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18522 STRING_MULTIBYTE (elt
));
18527 else /* c == '%' */
18529 int percent_position
= offset
;
18531 /* Get the specified minimum width. Zero means
18534 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18535 field
= field
* 10 + c
- '0';
18537 /* Don't pad beyond the total padding allowed. */
18538 if (field_width
- n
> 0 && field
> field_width
- n
)
18539 field
= field_width
- n
;
18541 /* Note that either PRECISION <= 0 or N < PRECISION. */
18542 prec
= precision
- n
;
18545 n
+= display_mode_element (it
, depth
, field
, prec
,
18546 Vglobal_mode_string
, props
,
18551 int bytepos
, charpos
;
18552 const unsigned char *spec
;
18553 Lisp_Object string
;
18555 bytepos
= percent_position
;
18556 charpos
= (STRING_MULTIBYTE (elt
)
18557 ? string_byte_to_char (elt
, bytepos
)
18559 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18560 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18562 switch (mode_line_target
)
18564 case MODE_LINE_NOPROP
:
18565 case MODE_LINE_TITLE
:
18566 n
+= store_mode_line_noprop (spec
, field
, prec
);
18568 case MODE_LINE_STRING
:
18570 int len
= strlen (spec
);
18571 Lisp_Object tem
= make_string (spec
, len
);
18572 props
= Ftext_properties_at (make_number (charpos
), elt
);
18573 /* Should only keep face property in props */
18574 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18577 case MODE_LINE_DISPLAY
:
18579 int nglyphs_before
, nwritten
;
18581 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18582 nwritten
= display_string (spec
, string
, elt
,
18587 /* Assign to the glyphs written above the
18588 string where the `%x' came from, position
18592 struct glyph
*glyph
18593 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18597 for (i
= 0; i
< nwritten
; ++i
)
18599 glyph
[i
].object
= elt
;
18600 glyph
[i
].charpos
= charpos
;
18617 /* A symbol: process the value of the symbol recursively
18618 as if it appeared here directly. Avoid error if symbol void.
18619 Special case: if value of symbol is a string, output the string
18622 register Lisp_Object tem
;
18624 /* If the variable is not marked as risky to set
18625 then its contents are risky to use. */
18626 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18629 tem
= Fboundp (elt
);
18632 tem
= Fsymbol_value (elt
);
18633 /* If value is a string, output that string literally:
18634 don't check for % within it. */
18638 if (!EQ (tem
, elt
))
18640 /* Give up right away for nil or t. */
18650 register Lisp_Object car
, tem
;
18652 /* A cons cell: five distinct cases.
18653 If first element is :eval or :propertize, do something special.
18654 If first element is a string or a cons, process all the elements
18655 and effectively concatenate them.
18656 If first element is a negative number, truncate displaying cdr to
18657 at most that many characters. If positive, pad (with spaces)
18658 to at least that many characters.
18659 If first element is a symbol, process the cadr or caddr recursively
18660 according to whether the symbol's value is non-nil or nil. */
18662 if (EQ (car
, QCeval
))
18664 /* An element of the form (:eval FORM) means evaluate FORM
18665 and use the result as mode line elements. */
18670 if (CONSP (XCDR (elt
)))
18673 spec
= safe_eval (XCAR (XCDR (elt
)));
18674 n
+= display_mode_element (it
, depth
, field_width
- n
,
18675 precision
- n
, spec
, props
,
18679 else if (EQ (car
, QCpropertize
))
18681 /* An element of the form (:propertize ELT PROPS...)
18682 means display ELT but applying properties PROPS. */
18687 if (CONSP (XCDR (elt
)))
18688 n
+= display_mode_element (it
, depth
, field_width
- n
,
18689 precision
- n
, XCAR (XCDR (elt
)),
18690 XCDR (XCDR (elt
)), risky
);
18692 else if (SYMBOLP (car
))
18694 tem
= Fboundp (car
);
18698 /* elt is now the cdr, and we know it is a cons cell.
18699 Use its car if CAR has a non-nil value. */
18702 tem
= Fsymbol_value (car
);
18709 /* Symbol's value is nil (or symbol is unbound)
18710 Get the cddr of the original list
18711 and if possible find the caddr and use that. */
18715 else if (!CONSP (elt
))
18720 else if (INTEGERP (car
))
18722 register int lim
= XINT (car
);
18726 /* Negative int means reduce maximum width. */
18727 if (precision
<= 0)
18730 precision
= min (precision
, -lim
);
18734 /* Padding specified. Don't let it be more than
18735 current maximum. */
18737 lim
= min (precision
, lim
);
18739 /* If that's more padding than already wanted, queue it.
18740 But don't reduce padding already specified even if
18741 that is beyond the current truncation point. */
18742 field_width
= max (lim
, field_width
);
18746 else if (STRINGP (car
) || CONSP (car
))
18748 Lisp_Object halftail
= elt
;
18752 && (precision
<= 0 || n
< precision
))
18754 n
+= display_mode_element (it
, depth
,
18755 /* Do padding only after the last
18756 element in the list. */
18757 (! CONSP (XCDR (elt
))
18760 precision
- n
, XCAR (elt
),
18764 if ((len
& 1) == 0)
18765 halftail
= XCDR (halftail
);
18766 /* Check for cycle. */
18767 if (EQ (halftail
, elt
))
18776 elt
= build_string ("*invalid*");
18780 /* Pad to FIELD_WIDTH. */
18781 if (field_width
> 0 && n
< field_width
)
18783 switch (mode_line_target
)
18785 case MODE_LINE_NOPROP
:
18786 case MODE_LINE_TITLE
:
18787 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18789 case MODE_LINE_STRING
:
18790 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18792 case MODE_LINE_DISPLAY
:
18793 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18802 /* Store a mode-line string element in mode_line_string_list.
18804 If STRING is non-null, display that C string. Otherwise, the Lisp
18805 string LISP_STRING is displayed.
18807 FIELD_WIDTH is the minimum number of output glyphs to produce.
18808 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18809 with spaces. FIELD_WIDTH <= 0 means don't pad.
18811 PRECISION is the maximum number of characters to output from
18812 STRING. PRECISION <= 0 means don't truncate the string.
18814 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18815 properties to the string.
18817 PROPS are the properties to add to the string.
18818 The mode_line_string_face face property is always added to the string.
18822 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18823 int field_width
, int precision
, Lisp_Object props
)
18828 if (string
!= NULL
)
18830 len
= strlen (string
);
18831 if (precision
> 0 && len
> precision
)
18833 lisp_string
= make_string (string
, len
);
18835 props
= mode_line_string_face_prop
;
18836 else if (!NILP (mode_line_string_face
))
18838 Lisp_Object face
= Fplist_get (props
, Qface
);
18839 props
= Fcopy_sequence (props
);
18841 face
= mode_line_string_face
;
18843 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18844 props
= Fplist_put (props
, Qface
, face
);
18846 Fadd_text_properties (make_number (0), make_number (len
),
18847 props
, lisp_string
);
18851 len
= XFASTINT (Flength (lisp_string
));
18852 if (precision
> 0 && len
> precision
)
18855 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18858 if (!NILP (mode_line_string_face
))
18862 props
= Ftext_properties_at (make_number (0), lisp_string
);
18863 face
= Fplist_get (props
, Qface
);
18865 face
= mode_line_string_face
;
18867 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18868 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18870 lisp_string
= Fcopy_sequence (lisp_string
);
18873 Fadd_text_properties (make_number (0), make_number (len
),
18874 props
, lisp_string
);
18879 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18883 if (field_width
> len
)
18885 field_width
-= len
;
18886 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18888 Fadd_text_properties (make_number (0), make_number (field_width
),
18889 props
, lisp_string
);
18890 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18898 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18900 doc
: /* Format a string out of a mode line format specification.
18901 First arg FORMAT specifies the mode line format (see `mode-line-format'
18902 for details) to use.
18904 Optional second arg FACE specifies the face property to put
18905 on all characters for which no face is specified.
18906 The value t means whatever face the window's mode line currently uses
18907 \(either `mode-line' or `mode-line-inactive', depending).
18908 A value of nil means the default is no face property.
18909 If FACE is an integer, the value string has no text properties.
18911 Optional third and fourth args WINDOW and BUFFER specify the window
18912 and buffer to use as the context for the formatting (defaults
18913 are the selected window and the window's buffer). */)
18914 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18919 struct buffer
*old_buffer
= NULL
;
18921 int no_props
= INTEGERP (face
);
18922 int count
= SPECPDL_INDEX ();
18924 int string_start
= 0;
18927 window
= selected_window
;
18928 CHECK_WINDOW (window
);
18929 w
= XWINDOW (window
);
18932 buffer
= w
->buffer
;
18933 CHECK_BUFFER (buffer
);
18935 /* Make formatting the modeline a non-op when noninteractive, otherwise
18936 there will be problems later caused by a partially initialized frame. */
18937 if (NILP (format
) || noninteractive
)
18938 return empty_unibyte_string
;
18946 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18947 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18951 face_id
= DEFAULT_FACE_ID
;
18953 if (XBUFFER (buffer
) != current_buffer
)
18954 old_buffer
= current_buffer
;
18956 /* Save things including mode_line_proptrans_alist,
18957 and set that to nil so that we don't alter the outer value. */
18958 record_unwind_protect (unwind_format_mode_line
,
18959 format_mode_line_unwind_data
18960 (old_buffer
, selected_window
, 1));
18961 mode_line_proptrans_alist
= Qnil
;
18963 Fselect_window (window
, Qt
);
18965 set_buffer_internal_1 (XBUFFER (buffer
));
18967 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18971 mode_line_target
= MODE_LINE_NOPROP
;
18972 mode_line_string_face_prop
= Qnil
;
18973 mode_line_string_list
= Qnil
;
18974 string_start
= MODE_LINE_NOPROP_LEN (0);
18978 mode_line_target
= MODE_LINE_STRING
;
18979 mode_line_string_list
= Qnil
;
18980 mode_line_string_face
= face
;
18981 mode_line_string_face_prop
18982 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18985 push_kboard (FRAME_KBOARD (it
.f
));
18986 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18991 len
= MODE_LINE_NOPROP_LEN (string_start
);
18992 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18996 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18997 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18998 empty_unibyte_string
);
19001 unbind_to (count
, Qnil
);
19005 /* Write a null-terminated, right justified decimal representation of
19006 the positive integer D to BUF using a minimal field width WIDTH. */
19009 pint2str (register char *buf
, register int width
, register int d
)
19011 register char *p
= buf
;
19019 *p
++ = d
% 10 + '0';
19024 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19035 /* Write a null-terminated, right justified decimal and "human
19036 readable" representation of the nonnegative integer D to BUF using
19037 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19039 static const char power_letter
[] =
19053 pint2hrstr (char *buf
, int width
, int d
)
19055 /* We aim to represent the nonnegative integer D as
19056 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19059 /* -1 means: do not use TENTHS. */
19063 /* Length of QUOTIENT.TENTHS as a string. */
19069 if (1000 <= quotient
)
19071 /* Scale to the appropriate EXPONENT. */
19074 remainder
= quotient
% 1000;
19078 while (1000 <= quotient
);
19080 /* Round to nearest and decide whether to use TENTHS or not. */
19083 tenths
= remainder
/ 100;
19084 if (50 <= remainder
% 100)
19091 if (quotient
== 10)
19099 if (500 <= remainder
)
19101 if (quotient
< 999)
19112 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19113 if (tenths
== -1 && quotient
<= 99)
19120 p
= psuffix
= buf
+ max (width
, length
);
19122 /* Print EXPONENT. */
19124 *psuffix
++ = power_letter
[exponent
];
19127 /* Print TENTHS. */
19130 *--p
= '0' + tenths
;
19134 /* Print QUOTIENT. */
19137 int digit
= quotient
% 10;
19138 *--p
= '0' + digit
;
19140 while ((quotient
/= 10) != 0);
19142 /* Print leading spaces. */
19147 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19148 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19149 type of CODING_SYSTEM. Return updated pointer into BUF. */
19151 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19154 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19157 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19158 const unsigned char *eol_str
;
19160 /* The EOL conversion we are using. */
19161 Lisp_Object eoltype
;
19163 val
= CODING_SYSTEM_SPEC (coding_system
);
19166 if (!VECTORP (val
)) /* Not yet decided. */
19171 eoltype
= eol_mnemonic_undecided
;
19172 /* Don't mention EOL conversion if it isn't decided. */
19177 Lisp_Object eolvalue
;
19179 attrs
= AREF (val
, 0);
19180 eolvalue
= AREF (val
, 2);
19183 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19187 /* The EOL conversion that is normal on this system. */
19189 if (NILP (eolvalue
)) /* Not yet decided. */
19190 eoltype
= eol_mnemonic_undecided
;
19191 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19192 eoltype
= eol_mnemonic_undecided
;
19193 else /* eolvalue is Qunix, Qdos, or Qmac. */
19194 eoltype
= (EQ (eolvalue
, Qunix
)
19195 ? eol_mnemonic_unix
19196 : (EQ (eolvalue
, Qdos
) == 1
19197 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19203 /* Mention the EOL conversion if it is not the usual one. */
19204 if (STRINGP (eoltype
))
19206 eol_str
= SDATA (eoltype
);
19207 eol_str_len
= SBYTES (eoltype
);
19209 else if (CHARACTERP (eoltype
))
19211 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19212 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19217 eol_str
= invalid_eol_type
;
19218 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19220 memcpy (buf
, eol_str
, eol_str_len
);
19221 buf
+= eol_str_len
;
19227 /* Return a string for the output of a mode line %-spec for window W,
19228 generated by character C. PRECISION >= 0 means don't return a
19229 string longer than that value. FIELD_WIDTH > 0 means pad the
19230 string returned with spaces to that value. Return a Lisp string in
19231 *STRING if the resulting string is taken from that Lisp string.
19233 Note we operate on the current buffer for most purposes,
19234 the exception being w->base_line_pos. */
19236 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19238 static const char *
19239 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19240 int precision
, Lisp_Object
*string
)
19243 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19244 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19245 struct buffer
*b
= current_buffer
;
19253 if (!NILP (b
->read_only
))
19255 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19260 /* This differs from %* only for a modified read-only buffer. */
19261 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19263 if (!NILP (b
->read_only
))
19268 /* This differs from %* in ignoring read-only-ness. */
19269 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19281 if (command_loop_level
> 5)
19283 p
= decode_mode_spec_buf
;
19284 for (i
= 0; i
< command_loop_level
; i
++)
19287 return decode_mode_spec_buf
;
19295 if (command_loop_level
> 5)
19297 p
= decode_mode_spec_buf
;
19298 for (i
= 0; i
< command_loop_level
; i
++)
19301 return decode_mode_spec_buf
;
19308 /* Let lots_of_dashes be a string of infinite length. */
19309 if (mode_line_target
== MODE_LINE_NOPROP
||
19310 mode_line_target
== MODE_LINE_STRING
)
19312 if (field_width
<= 0
19313 || field_width
> sizeof (lots_of_dashes
))
19315 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19316 decode_mode_spec_buf
[i
] = '-';
19317 decode_mode_spec_buf
[i
] = '\0';
19318 return decode_mode_spec_buf
;
19321 return lots_of_dashes
;
19329 /* %c and %l are ignored in `frame-title-format'.
19330 (In redisplay_internal, the frame title is drawn _before_ the
19331 windows are updated, so the stuff which depends on actual
19332 window contents (such as %l) may fail to render properly, or
19333 even crash emacs.) */
19334 if (mode_line_target
== MODE_LINE_TITLE
)
19338 int col
= (int) current_column (); /* iftc */
19339 w
->column_number_displayed
= make_number (col
);
19340 pint2str (decode_mode_spec_buf
, field_width
, col
);
19341 return decode_mode_spec_buf
;
19345 #ifndef SYSTEM_MALLOC
19347 if (NILP (Vmemory_full
))
19350 return "!MEM FULL! ";
19357 /* %F displays the frame name. */
19358 if (!NILP (f
->title
))
19359 return (char *) SDATA (f
->title
);
19360 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19361 return (char *) SDATA (f
->name
);
19370 int size
= ZV
- BEGV
;
19371 pint2str (decode_mode_spec_buf
, field_width
, size
);
19372 return decode_mode_spec_buf
;
19377 int size
= ZV
- BEGV
;
19378 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19379 return decode_mode_spec_buf
;
19384 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19385 int topline
, nlines
, junk
, height
;
19387 /* %c and %l are ignored in `frame-title-format'. */
19388 if (mode_line_target
== MODE_LINE_TITLE
)
19391 startpos
= XMARKER (w
->start
)->charpos
;
19392 startpos_byte
= marker_byte_position (w
->start
);
19393 height
= WINDOW_TOTAL_LINES (w
);
19395 /* If we decided that this buffer isn't suitable for line numbers,
19396 don't forget that too fast. */
19397 if (EQ (w
->base_line_pos
, w
->buffer
))
19399 /* But do forget it, if the window shows a different buffer now. */
19400 else if (BUFFERP (w
->base_line_pos
))
19401 w
->base_line_pos
= Qnil
;
19403 /* If the buffer is very big, don't waste time. */
19404 if (INTEGERP (Vline_number_display_limit
)
19405 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19407 w
->base_line_pos
= Qnil
;
19408 w
->base_line_number
= Qnil
;
19412 if (INTEGERP (w
->base_line_number
)
19413 && INTEGERP (w
->base_line_pos
)
19414 && XFASTINT (w
->base_line_pos
) <= startpos
)
19416 line
= XFASTINT (w
->base_line_number
);
19417 linepos
= XFASTINT (w
->base_line_pos
);
19418 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19423 linepos
= BUF_BEGV (b
);
19424 linepos_byte
= BUF_BEGV_BYTE (b
);
19427 /* Count lines from base line to window start position. */
19428 nlines
= display_count_lines (linepos
, linepos_byte
,
19432 topline
= nlines
+ line
;
19434 /* Determine a new base line, if the old one is too close
19435 or too far away, or if we did not have one.
19436 "Too close" means it's plausible a scroll-down would
19437 go back past it. */
19438 if (startpos
== BUF_BEGV (b
))
19440 w
->base_line_number
= make_number (topline
);
19441 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19443 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19444 || linepos
== BUF_BEGV (b
))
19446 int limit
= BUF_BEGV (b
);
19447 int limit_byte
= BUF_BEGV_BYTE (b
);
19449 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19451 if (startpos
- distance
> limit
)
19453 limit
= startpos
- distance
;
19454 limit_byte
= CHAR_TO_BYTE (limit
);
19457 nlines
= display_count_lines (startpos
, startpos_byte
,
19459 - (height
* 2 + 30),
19461 /* If we couldn't find the lines we wanted within
19462 line_number_display_limit_width chars per line,
19463 give up on line numbers for this window. */
19464 if (position
== limit_byte
&& limit
== startpos
- distance
)
19466 w
->base_line_pos
= w
->buffer
;
19467 w
->base_line_number
= Qnil
;
19471 w
->base_line_number
= make_number (topline
- nlines
);
19472 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19475 /* Now count lines from the start pos to point. */
19476 nlines
= display_count_lines (startpos
, startpos_byte
,
19477 PT_BYTE
, PT
, &junk
);
19479 /* Record that we did display the line number. */
19480 line_number_displayed
= 1;
19482 /* Make the string to show. */
19483 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19484 return decode_mode_spec_buf
;
19487 char* p
= decode_mode_spec_buf
;
19488 int pad
= field_width
- 2;
19494 return decode_mode_spec_buf
;
19500 obj
= b
->mode_name
;
19504 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19510 int pos
= marker_position (w
->start
);
19511 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19513 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19515 if (pos
<= BUF_BEGV (b
))
19520 else if (pos
<= BUF_BEGV (b
))
19524 if (total
> 1000000)
19525 /* Do it differently for a large value, to avoid overflow. */
19526 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19528 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19529 /* We can't normally display a 3-digit number,
19530 so get us a 2-digit number that is close. */
19533 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19534 return decode_mode_spec_buf
;
19538 /* Display percentage of size above the bottom of the screen. */
19541 int toppos
= marker_position (w
->start
);
19542 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19543 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19545 if (botpos
>= BUF_ZV (b
))
19547 if (toppos
<= BUF_BEGV (b
))
19554 if (total
> 1000000)
19555 /* Do it differently for a large value, to avoid overflow. */
19556 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19558 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19559 /* We can't normally display a 3-digit number,
19560 so get us a 2-digit number that is close. */
19563 if (toppos
<= BUF_BEGV (b
))
19564 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19566 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19567 return decode_mode_spec_buf
;
19572 /* status of process */
19573 obj
= Fget_buffer_process (Fcurrent_buffer ());
19575 return "no process";
19577 obj
= Fsymbol_name (Fprocess_status (obj
));
19583 int count
= inhibit_garbage_collection ();
19584 Lisp_Object val
= call1 (intern ("file-remote-p"),
19585 current_buffer
->directory
);
19586 unbind_to (count
, Qnil
);
19594 case 't': /* indicate TEXT or BINARY */
19595 #ifdef MODE_LINE_BINARY_TEXT
19596 return MODE_LINE_BINARY_TEXT (b
);
19602 /* coding-system (not including end-of-line format) */
19604 /* coding-system (including end-of-line type) */
19606 int eol_flag
= (c
== 'Z');
19607 char *p
= decode_mode_spec_buf
;
19609 if (! FRAME_WINDOW_P (f
))
19611 /* No need to mention EOL here--the terminal never needs
19612 to do EOL conversion. */
19613 p
= decode_mode_spec_coding (CODING_ID_NAME
19614 (FRAME_KEYBOARD_CODING (f
)->id
),
19616 p
= decode_mode_spec_coding (CODING_ID_NAME
19617 (FRAME_TERMINAL_CODING (f
)->id
),
19620 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19623 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19624 #ifdef subprocesses
19625 obj
= Fget_buffer_process (Fcurrent_buffer ());
19626 if (PROCESSP (obj
))
19628 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19630 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19633 #endif /* subprocesses */
19636 return decode_mode_spec_buf
;
19643 return (char *) SDATA (obj
);
19650 /* Count up to COUNT lines starting from START / START_BYTE.
19651 But don't go beyond LIMIT_BYTE.
19652 Return the number of lines thus found (always nonnegative).
19654 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19657 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19660 register unsigned char *cursor
;
19661 unsigned char *base
;
19663 register int ceiling
;
19664 register unsigned char *ceiling_addr
;
19665 int orig_count
= count
;
19667 /* If we are not in selective display mode,
19668 check only for newlines. */
19669 int selective_display
= (!NILP (current_buffer
->selective_display
)
19670 && !INTEGERP (current_buffer
->selective_display
));
19674 while (start_byte
< limit_byte
)
19676 ceiling
= BUFFER_CEILING_OF (start_byte
);
19677 ceiling
= min (limit_byte
- 1, ceiling
);
19678 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19679 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19682 if (selective_display
)
19683 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19686 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19689 if (cursor
!= ceiling_addr
)
19693 start_byte
+= cursor
- base
+ 1;
19694 *byte_pos_ptr
= start_byte
;
19698 if (++cursor
== ceiling_addr
)
19704 start_byte
+= cursor
- base
;
19709 while (start_byte
> limit_byte
)
19711 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19712 ceiling
= max (limit_byte
, ceiling
);
19713 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19714 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19717 if (selective_display
)
19718 while (--cursor
!= ceiling_addr
19719 && *cursor
!= '\n' && *cursor
!= 015)
19722 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19725 if (cursor
!= ceiling_addr
)
19729 start_byte
+= cursor
- base
+ 1;
19730 *byte_pos_ptr
= start_byte
;
19731 /* When scanning backwards, we should
19732 not count the newline posterior to which we stop. */
19733 return - orig_count
- 1;
19739 /* Here we add 1 to compensate for the last decrement
19740 of CURSOR, which took it past the valid range. */
19741 start_byte
+= cursor
- base
+ 1;
19745 *byte_pos_ptr
= limit_byte
;
19748 return - orig_count
+ count
;
19749 return orig_count
- count
;
19755 /***********************************************************************
19757 ***********************************************************************/
19759 /* Display a NUL-terminated string, starting with index START.
19761 If STRING is non-null, display that C string. Otherwise, the Lisp
19762 string LISP_STRING is displayed. There's a case that STRING is
19763 non-null and LISP_STRING is not nil. It means STRING is a string
19764 data of LISP_STRING. In that case, we display LISP_STRING while
19765 ignoring its text properties.
19767 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19768 FACE_STRING. Display STRING or LISP_STRING with the face at
19769 FACE_STRING_POS in FACE_STRING:
19771 Display the string in the environment given by IT, but use the
19772 standard display table, temporarily.
19774 FIELD_WIDTH is the minimum number of output glyphs to produce.
19775 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19776 with spaces. If STRING has more characters, more than FIELD_WIDTH
19777 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19779 PRECISION is the maximum number of characters to output from
19780 STRING. PRECISION < 0 means don't truncate the string.
19782 This is roughly equivalent to printf format specifiers:
19784 FIELD_WIDTH PRECISION PRINTF
19785 ----------------------------------------
19791 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19792 display them, and < 0 means obey the current buffer's value of
19793 enable_multibyte_characters.
19795 Value is the number of columns displayed. */
19798 display_string (const unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19799 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19800 int field_width
, int precision
, int max_x
, int multibyte
)
19802 int hpos_at_start
= it
->hpos
;
19803 int saved_face_id
= it
->face_id
;
19804 struct glyph_row
*row
= it
->glyph_row
;
19806 /* Initialize the iterator IT for iteration over STRING beginning
19807 with index START. */
19808 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19809 precision
, field_width
, multibyte
);
19810 if (string
&& STRINGP (lisp_string
))
19811 /* LISP_STRING is the one returned by decode_mode_spec. We should
19812 ignore its text properties. */
19813 it
->stop_charpos
= -1;
19815 /* If displaying STRING, set up the face of the iterator
19816 from LISP_STRING, if that's given. */
19817 if (STRINGP (face_string
))
19823 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19824 0, it
->region_beg_charpos
,
19825 it
->region_end_charpos
,
19826 &endptr
, it
->base_face_id
, 0);
19827 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19828 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19831 /* Set max_x to the maximum allowed X position. Don't let it go
19832 beyond the right edge of the window. */
19834 max_x
= it
->last_visible_x
;
19836 max_x
= min (max_x
, it
->last_visible_x
);
19838 /* Skip over display elements that are not visible. because IT->w is
19840 if (it
->current_x
< it
->first_visible_x
)
19841 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19842 MOVE_TO_POS
| MOVE_TO_X
);
19844 row
->ascent
= it
->max_ascent
;
19845 row
->height
= it
->max_ascent
+ it
->max_descent
;
19846 row
->phys_ascent
= it
->max_phys_ascent
;
19847 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19848 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19850 /* This condition is for the case that we are called with current_x
19851 past last_visible_x. */
19852 while (it
->current_x
< max_x
)
19854 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19856 /* Get the next display element. */
19857 if (!get_next_display_element (it
))
19860 /* Produce glyphs. */
19861 x_before
= it
->current_x
;
19862 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19863 PRODUCE_GLYPHS (it
);
19865 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19868 while (i
< nglyphs
)
19870 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19872 if (it
->line_wrap
!= TRUNCATE
19873 && x
+ glyph
->pixel_width
> max_x
)
19875 /* End of continued line or max_x reached. */
19876 if (CHAR_GLYPH_PADDING_P (*glyph
))
19878 /* A wide character is unbreakable. */
19879 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19880 it
->current_x
= x_before
;
19884 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19889 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19891 /* Glyph is at least partially visible. */
19893 if (x
< it
->first_visible_x
)
19894 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19898 /* Glyph is off the left margin of the display area.
19899 Should not happen. */
19903 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19904 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19905 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19906 row
->phys_height
= max (row
->phys_height
,
19907 it
->max_phys_ascent
+ it
->max_phys_descent
);
19908 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19909 it
->max_extra_line_spacing
);
19910 x
+= glyph
->pixel_width
;
19914 /* Stop if max_x reached. */
19918 /* Stop at line ends. */
19919 if (ITERATOR_AT_END_OF_LINE_P (it
))
19921 it
->continuation_lines_width
= 0;
19925 set_iterator_to_next (it
, 1);
19927 /* Stop if truncating at the right edge. */
19928 if (it
->line_wrap
== TRUNCATE
19929 && it
->current_x
>= it
->last_visible_x
)
19931 /* Add truncation mark, but don't do it if the line is
19932 truncated at a padding space. */
19933 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19935 if (!FRAME_WINDOW_P (it
->f
))
19939 if (it
->current_x
> it
->last_visible_x
)
19941 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19942 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19944 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19946 row
->used
[TEXT_AREA
] = i
;
19947 produce_special_glyphs (it
, IT_TRUNCATION
);
19950 produce_special_glyphs (it
, IT_TRUNCATION
);
19952 it
->glyph_row
->truncated_on_right_p
= 1;
19958 /* Maybe insert a truncation at the left. */
19959 if (it
->first_visible_x
19960 && IT_CHARPOS (*it
) > 0)
19962 if (!FRAME_WINDOW_P (it
->f
))
19963 insert_left_trunc_glyphs (it
);
19964 it
->glyph_row
->truncated_on_left_p
= 1;
19967 it
->face_id
= saved_face_id
;
19969 /* Value is number of columns displayed. */
19970 return it
->hpos
- hpos_at_start
;
19975 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19976 appears as an element of LIST or as the car of an element of LIST.
19977 If PROPVAL is a list, compare each element against LIST in that
19978 way, and return 1/2 if any element of PROPVAL is found in LIST.
19979 Otherwise return 0. This function cannot quit.
19980 The return value is 2 if the text is invisible but with an ellipsis
19981 and 1 if it's invisible and without an ellipsis. */
19984 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19986 register Lisp_Object tail
, proptail
;
19988 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19990 register Lisp_Object tem
;
19992 if (EQ (propval
, tem
))
19994 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19995 return NILP (XCDR (tem
)) ? 1 : 2;
19998 if (CONSP (propval
))
20000 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20002 Lisp_Object propelt
;
20003 propelt
= XCAR (proptail
);
20004 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20006 register Lisp_Object tem
;
20008 if (EQ (propelt
, tem
))
20010 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20011 return NILP (XCDR (tem
)) ? 1 : 2;
20019 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20020 doc
: /* Non-nil if the property makes the text invisible.
20021 POS-OR-PROP can be a marker or number, in which case it is taken to be
20022 a position in the current buffer and the value of the `invisible' property
20023 is checked; or it can be some other value, which is then presumed to be the
20024 value of the `invisible' property of the text of interest.
20025 The non-nil value returned can be t for truly invisible text or something
20026 else if the text is replaced by an ellipsis. */)
20027 (Lisp_Object pos_or_prop
)
20030 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20031 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20033 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20034 return (invis
== 0 ? Qnil
20036 : make_number (invis
));
20039 /* Calculate a width or height in pixels from a specification using
20040 the following elements:
20043 NUM - a (fractional) multiple of the default font width/height
20044 (NUM) - specifies exactly NUM pixels
20045 UNIT - a fixed number of pixels, see below.
20046 ELEMENT - size of a display element in pixels, see below.
20047 (NUM . SPEC) - equals NUM * SPEC
20048 (+ SPEC SPEC ...) - add pixel values
20049 (- SPEC SPEC ...) - subtract pixel values
20050 (- SPEC) - negate pixel value
20053 INT or FLOAT - a number constant
20054 SYMBOL - use symbol's (buffer local) variable binding.
20057 in - pixels per inch *)
20058 mm - pixels per 1/1000 meter *)
20059 cm - pixels per 1/100 meter *)
20060 width - width of current font in pixels.
20061 height - height of current font in pixels.
20063 *) using the ratio(s) defined in display-pixels-per-inch.
20067 left-fringe - left fringe width in pixels
20068 right-fringe - right fringe width in pixels
20070 left-margin - left margin width in pixels
20071 right-margin - right margin width in pixels
20073 scroll-bar - scroll-bar area width in pixels
20077 Pixels corresponding to 5 inches:
20080 Total width of non-text areas on left side of window (if scroll-bar is on left):
20081 '(space :width (+ left-fringe left-margin scroll-bar))
20083 Align to first text column (in header line):
20084 '(space :align-to 0)
20086 Align to middle of text area minus half the width of variable `my-image'
20087 containing a loaded image:
20088 '(space :align-to (0.5 . (- text my-image)))
20090 Width of left margin minus width of 1 character in the default font:
20091 '(space :width (- left-margin 1))
20093 Width of left margin minus width of 2 characters in the current font:
20094 '(space :width (- left-margin (2 . width)))
20096 Center 1 character over left-margin (in header line):
20097 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20099 Different ways to express width of left fringe plus left margin minus one pixel:
20100 '(space :width (- (+ left-fringe left-margin) (1)))
20101 '(space :width (+ left-fringe left-margin (- (1))))
20102 '(space :width (+ left-fringe left-margin (-1)))
20106 #define NUMVAL(X) \
20107 ((INTEGERP (X) || FLOATP (X)) \
20112 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20113 struct font
*font
, int width_p
, int *align_to
)
20117 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20118 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20121 return OK_PIXELS (0);
20123 xassert (FRAME_LIVE_P (it
->f
));
20125 if (SYMBOLP (prop
))
20127 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20129 char *unit
= SDATA (SYMBOL_NAME (prop
));
20131 if (unit
[0] == 'i' && unit
[1] == 'n')
20133 else if (unit
[0] == 'm' && unit
[1] == 'm')
20135 else if (unit
[0] == 'c' && unit
[1] == 'm')
20142 #ifdef HAVE_WINDOW_SYSTEM
20143 if (FRAME_WINDOW_P (it
->f
)
20145 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20146 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20148 return OK_PIXELS (ppi
/ pixels
);
20151 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20152 || (CONSP (Vdisplay_pixels_per_inch
)
20154 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20155 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20157 return OK_PIXELS (ppi
/ pixels
);
20163 #ifdef HAVE_WINDOW_SYSTEM
20164 if (EQ (prop
, Qheight
))
20165 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20166 if (EQ (prop
, Qwidth
))
20167 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20169 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20170 return OK_PIXELS (1);
20173 if (EQ (prop
, Qtext
))
20174 return OK_PIXELS (width_p
20175 ? window_box_width (it
->w
, TEXT_AREA
)
20176 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20178 if (align_to
&& *align_to
< 0)
20181 if (EQ (prop
, Qleft
))
20182 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20183 if (EQ (prop
, Qright
))
20184 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20185 if (EQ (prop
, Qcenter
))
20186 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20187 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20188 if (EQ (prop
, Qleft_fringe
))
20189 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20190 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20191 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20192 if (EQ (prop
, Qright_fringe
))
20193 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20194 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20195 : window_box_right_offset (it
->w
, TEXT_AREA
));
20196 if (EQ (prop
, Qleft_margin
))
20197 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20198 if (EQ (prop
, Qright_margin
))
20199 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20200 if (EQ (prop
, Qscroll_bar
))
20201 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20203 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20204 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20205 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20210 if (EQ (prop
, Qleft_fringe
))
20211 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20212 if (EQ (prop
, Qright_fringe
))
20213 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20214 if (EQ (prop
, Qleft_margin
))
20215 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20216 if (EQ (prop
, Qright_margin
))
20217 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20218 if (EQ (prop
, Qscroll_bar
))
20219 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20222 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20225 if (INTEGERP (prop
) || FLOATP (prop
))
20227 int base_unit
= (width_p
20228 ? FRAME_COLUMN_WIDTH (it
->f
)
20229 : FRAME_LINE_HEIGHT (it
->f
));
20230 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20235 Lisp_Object car
= XCAR (prop
);
20236 Lisp_Object cdr
= XCDR (prop
);
20240 #ifdef HAVE_WINDOW_SYSTEM
20241 if (FRAME_WINDOW_P (it
->f
)
20242 && valid_image_p (prop
))
20244 int id
= lookup_image (it
->f
, prop
);
20245 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20247 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20250 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20256 while (CONSP (cdr
))
20258 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20259 font
, width_p
, align_to
))
20262 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20267 if (EQ (car
, Qminus
))
20269 return OK_PIXELS (pixels
);
20272 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20275 if (INTEGERP (car
) || FLOATP (car
))
20278 pixels
= XFLOATINT (car
);
20280 return OK_PIXELS (pixels
);
20281 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20282 font
, width_p
, align_to
))
20283 return OK_PIXELS (pixels
* fact
);
20294 /***********************************************************************
20296 ***********************************************************************/
20298 #ifdef HAVE_WINDOW_SYSTEM
20303 dump_glyph_string (s
)
20304 struct glyph_string
*s
;
20306 fprintf (stderr
, "glyph string\n");
20307 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20308 s
->x
, s
->y
, s
->width
, s
->height
);
20309 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20310 fprintf (stderr
, " hl = %d\n", s
->hl
);
20311 fprintf (stderr
, " left overhang = %d, right = %d\n",
20312 s
->left_overhang
, s
->right_overhang
);
20313 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20314 fprintf (stderr
, " extends to end of line = %d\n",
20315 s
->extends_to_end_of_line_p
);
20316 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20317 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20320 #endif /* GLYPH_DEBUG */
20322 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20323 of XChar2b structures for S; it can't be allocated in
20324 init_glyph_string because it must be allocated via `alloca'. W
20325 is the window on which S is drawn. ROW and AREA are the glyph row
20326 and area within the row from which S is constructed. START is the
20327 index of the first glyph structure covered by S. HL is a
20328 face-override for drawing S. */
20331 #define OPTIONAL_HDC(hdc) HDC hdc,
20332 #define DECLARE_HDC(hdc) HDC hdc;
20333 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20334 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20337 #ifndef OPTIONAL_HDC
20338 #define OPTIONAL_HDC(hdc)
20339 #define DECLARE_HDC(hdc)
20340 #define ALLOCATE_HDC(hdc, f)
20341 #define RELEASE_HDC(hdc, f)
20345 init_glyph_string (struct glyph_string
*s
,
20347 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20348 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20350 memset (s
, 0, sizeof *s
);
20352 s
->f
= XFRAME (w
->frame
);
20356 s
->display
= FRAME_X_DISPLAY (s
->f
);
20357 s
->window
= FRAME_X_WINDOW (s
->f
);
20358 s
->char2b
= char2b
;
20362 s
->first_glyph
= row
->glyphs
[area
] + start
;
20363 s
->height
= row
->height
;
20364 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20365 s
->ybase
= s
->y
+ row
->ascent
;
20369 /* Append the list of glyph strings with head H and tail T to the list
20370 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20373 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20374 struct glyph_string
*h
, struct glyph_string
*t
)
20388 /* Prepend the list of glyph strings with head H and tail T to the
20389 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20393 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20394 struct glyph_string
*h
, struct glyph_string
*t
)
20408 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20409 Set *HEAD and *TAIL to the resulting list. */
20412 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20413 struct glyph_string
*s
)
20415 s
->next
= s
->prev
= NULL
;
20416 append_glyph_string_lists (head
, tail
, s
, s
);
20420 /* Get face and two-byte form of character C in face FACE_ID on frame
20421 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20422 means we want to display multibyte text. DISPLAY_P non-zero means
20423 make sure that X resources for the face returned are allocated.
20424 Value is a pointer to a realized face that is ready for display if
20425 DISPLAY_P is non-zero. */
20427 static INLINE
struct face
*
20428 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20429 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20431 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20435 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20437 if (code
!= FONT_INVALID_CODE
)
20438 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20440 STORE_XCHAR2B (char2b
, 0, 0);
20443 /* Make sure X resources of the face are allocated. */
20444 #ifdef HAVE_X_WINDOWS
20448 xassert (face
!= NULL
);
20449 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20456 /* Get face and two-byte form of character glyph GLYPH on frame F.
20457 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20458 a pointer to a realized face that is ready for display. */
20460 static INLINE
struct face
*
20461 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20462 XChar2b
*char2b
, int *two_byte_p
)
20466 xassert (glyph
->type
== CHAR_GLYPH
);
20467 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20476 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20477 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20479 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20481 if (code
!= FONT_INVALID_CODE
)
20482 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20484 STORE_XCHAR2B (char2b
, 0, 0);
20487 /* Make sure X resources of the face are allocated. */
20488 xassert (face
!= NULL
);
20489 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20494 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20495 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20498 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20502 if (CHAR_BYTE8_P (c
))
20503 code
= CHAR_TO_BYTE8 (c
);
20505 code
= font
->driver
->encode_char (font
, c
);
20507 if (code
== FONT_INVALID_CODE
)
20509 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20514 /* Fill glyph string S with composition components specified by S->cmp.
20516 BASE_FACE is the base face of the composition.
20517 S->cmp_from is the index of the first component for S.
20519 OVERLAPS non-zero means S should draw the foreground only, and use
20520 its physical height for clipping. See also draw_glyphs.
20522 Value is the index of a component not in S. */
20525 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20529 /* For all glyphs of this composition, starting at the offset
20530 S->cmp_from, until we reach the end of the definition or encounter a
20531 glyph that requires the different face, add it to S. */
20536 s
->for_overlaps
= overlaps
;
20539 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20541 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20545 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20548 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20549 s
->char2b
+ i
, 1, 1);
20555 s
->font
= s
->face
->font
;
20557 else if (s
->face
!= face
)
20565 /* All glyph strings for the same composition has the same width,
20566 i.e. the width set for the first component of the composition. */
20567 s
->width
= s
->first_glyph
->pixel_width
;
20569 /* If the specified font could not be loaded, use the frame's
20570 default font, but record the fact that we couldn't load it in
20571 the glyph string so that we can draw rectangles for the
20572 characters of the glyph string. */
20573 if (s
->font
== NULL
)
20575 s
->font_not_found_p
= 1;
20576 s
->font
= FRAME_FONT (s
->f
);
20579 /* Adjust base line for subscript/superscript text. */
20580 s
->ybase
+= s
->first_glyph
->voffset
;
20582 /* This glyph string must always be drawn with 16-bit functions. */
20589 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20590 int start
, int end
, int overlaps
)
20592 struct glyph
*glyph
, *last
;
20593 Lisp_Object lgstring
;
20596 s
->for_overlaps
= overlaps
;
20597 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20598 last
= s
->row
->glyphs
[s
->area
] + end
;
20599 s
->cmp_id
= glyph
->u
.cmp
.id
;
20600 s
->cmp_from
= glyph
->u
.cmp
.from
;
20601 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20602 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20603 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20604 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20606 while (glyph
< last
20607 && glyph
->u
.cmp
.automatic
20608 && glyph
->u
.cmp
.id
== s
->cmp_id
20609 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20610 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20612 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20614 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20615 unsigned code
= LGLYPH_CODE (lglyph
);
20617 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20619 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20620 return glyph
- s
->row
->glyphs
[s
->area
];
20624 /* Fill glyph string S from a sequence of character glyphs.
20626 FACE_ID is the face id of the string. START is the index of the
20627 first glyph to consider, END is the index of the last + 1.
20628 OVERLAPS non-zero means S should draw the foreground only, and use
20629 its physical height for clipping. See also draw_glyphs.
20631 Value is the index of the first glyph not in S. */
20634 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20635 int start
, int end
, int overlaps
)
20637 struct glyph
*glyph
, *last
;
20639 int glyph_not_available_p
;
20641 xassert (s
->f
== XFRAME (s
->w
->frame
));
20642 xassert (s
->nchars
== 0);
20643 xassert (start
>= 0 && end
> start
);
20645 s
->for_overlaps
= overlaps
;
20646 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20647 last
= s
->row
->glyphs
[s
->area
] + end
;
20648 voffset
= glyph
->voffset
;
20649 s
->padding_p
= glyph
->padding_p
;
20650 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20652 while (glyph
< last
20653 && glyph
->type
== CHAR_GLYPH
20654 && glyph
->voffset
== voffset
20655 /* Same face id implies same font, nowadays. */
20656 && glyph
->face_id
== face_id
20657 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20661 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20662 s
->char2b
+ s
->nchars
,
20664 s
->two_byte_p
= two_byte_p
;
20666 xassert (s
->nchars
<= end
- start
);
20667 s
->width
+= glyph
->pixel_width
;
20668 if (glyph
++->padding_p
!= s
->padding_p
)
20672 s
->font
= s
->face
->font
;
20674 /* If the specified font could not be loaded, use the frame's font,
20675 but record the fact that we couldn't load it in
20676 S->font_not_found_p so that we can draw rectangles for the
20677 characters of the glyph string. */
20678 if (s
->font
== NULL
|| glyph_not_available_p
)
20680 s
->font_not_found_p
= 1;
20681 s
->font
= FRAME_FONT (s
->f
);
20684 /* Adjust base line for subscript/superscript text. */
20685 s
->ybase
+= voffset
;
20687 xassert (s
->face
&& s
->face
->gc
);
20688 return glyph
- s
->row
->glyphs
[s
->area
];
20692 /* Fill glyph string S from image glyph S->first_glyph. */
20695 fill_image_glyph_string (struct glyph_string
*s
)
20697 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20698 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20700 s
->slice
= s
->first_glyph
->slice
;
20701 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20702 s
->font
= s
->face
->font
;
20703 s
->width
= s
->first_glyph
->pixel_width
;
20705 /* Adjust base line for subscript/superscript text. */
20706 s
->ybase
+= s
->first_glyph
->voffset
;
20710 /* Fill glyph string S from a sequence of stretch glyphs.
20712 ROW is the glyph row in which the glyphs are found, AREA is the
20713 area within the row. START is the index of the first glyph to
20714 consider, END is the index of the last + 1.
20716 Value is the index of the first glyph not in S. */
20719 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20720 enum glyph_row_area area
, int start
, int end
)
20722 struct glyph
*glyph
, *last
;
20723 int voffset
, face_id
;
20725 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20727 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20728 last
= s
->row
->glyphs
[s
->area
] + end
;
20729 face_id
= glyph
->face_id
;
20730 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20731 s
->font
= s
->face
->font
;
20732 s
->width
= glyph
->pixel_width
;
20734 voffset
= glyph
->voffset
;
20738 && glyph
->type
== STRETCH_GLYPH
20739 && glyph
->voffset
== voffset
20740 && glyph
->face_id
== face_id
);
20742 s
->width
+= glyph
->pixel_width
;
20744 /* Adjust base line for subscript/superscript text. */
20745 s
->ybase
+= voffset
;
20747 /* The case that face->gc == 0 is handled when drawing the glyph
20748 string by calling PREPARE_FACE_FOR_DISPLAY. */
20750 return glyph
- s
->row
->glyphs
[s
->area
];
20753 static struct font_metrics
*
20754 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20756 static struct font_metrics metrics
;
20757 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20759 if (! font
|| code
== FONT_INVALID_CODE
)
20761 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20766 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20767 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20768 assumed to be zero. */
20771 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20773 *left
= *right
= 0;
20775 if (glyph
->type
== CHAR_GLYPH
)
20779 struct font_metrics
*pcm
;
20781 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20782 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20784 if (pcm
->rbearing
> pcm
->width
)
20785 *right
= pcm
->rbearing
- pcm
->width
;
20786 if (pcm
->lbearing
< 0)
20787 *left
= -pcm
->lbearing
;
20790 else if (glyph
->type
== COMPOSITE_GLYPH
)
20792 if (! glyph
->u
.cmp
.automatic
)
20794 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20796 if (cmp
->rbearing
> cmp
->pixel_width
)
20797 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20798 if (cmp
->lbearing
< 0)
20799 *left
= - cmp
->lbearing
;
20803 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20804 struct font_metrics metrics
;
20806 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20807 glyph
->u
.cmp
.to
+ 1, &metrics
);
20808 if (metrics
.rbearing
> metrics
.width
)
20809 *right
= metrics
.rbearing
- metrics
.width
;
20810 if (metrics
.lbearing
< 0)
20811 *left
= - metrics
.lbearing
;
20817 /* Return the index of the first glyph preceding glyph string S that
20818 is overwritten by S because of S's left overhang. Value is -1
20819 if no glyphs are overwritten. */
20822 left_overwritten (struct glyph_string
*s
)
20826 if (s
->left_overhang
)
20829 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20830 int first
= s
->first_glyph
- glyphs
;
20832 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20833 x
-= glyphs
[i
].pixel_width
;
20844 /* Return the index of the first glyph preceding glyph string S that
20845 is overwriting S because of its right overhang. Value is -1 if no
20846 glyph in front of S overwrites S. */
20849 left_overwriting (struct glyph_string
*s
)
20852 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20853 int first
= s
->first_glyph
- glyphs
;
20857 for (i
= first
- 1; i
>= 0; --i
)
20860 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20863 x
-= glyphs
[i
].pixel_width
;
20870 /* Return the index of the last glyph following glyph string S that is
20871 overwritten by S because of S's right overhang. Value is -1 if
20872 no such glyph is found. */
20875 right_overwritten (struct glyph_string
*s
)
20879 if (s
->right_overhang
)
20882 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20883 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20884 int end
= s
->row
->used
[s
->area
];
20886 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20887 x
+= glyphs
[i
].pixel_width
;
20896 /* Return the index of the last glyph following glyph string S that
20897 overwrites S because of its left overhang. Value is negative
20898 if no such glyph is found. */
20901 right_overwriting (struct glyph_string
*s
)
20904 int end
= s
->row
->used
[s
->area
];
20905 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20906 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20910 for (i
= first
; i
< end
; ++i
)
20913 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20916 x
+= glyphs
[i
].pixel_width
;
20923 /* Set background width of glyph string S. START is the index of the
20924 first glyph following S. LAST_X is the right-most x-position + 1
20925 in the drawing area. */
20928 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20930 /* If the face of this glyph string has to be drawn to the end of
20931 the drawing area, set S->extends_to_end_of_line_p. */
20933 if (start
== s
->row
->used
[s
->area
]
20934 && s
->area
== TEXT_AREA
20935 && ((s
->row
->fill_line_p
20936 && (s
->hl
== DRAW_NORMAL_TEXT
20937 || s
->hl
== DRAW_IMAGE_RAISED
20938 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20939 || s
->hl
== DRAW_MOUSE_FACE
))
20940 s
->extends_to_end_of_line_p
= 1;
20942 /* If S extends its face to the end of the line, set its
20943 background_width to the distance to the right edge of the drawing
20945 if (s
->extends_to_end_of_line_p
)
20946 s
->background_width
= last_x
- s
->x
+ 1;
20948 s
->background_width
= s
->width
;
20952 /* Compute overhangs and x-positions for glyph string S and its
20953 predecessors, or successors. X is the starting x-position for S.
20954 BACKWARD_P non-zero means process predecessors. */
20957 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20963 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20964 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20974 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20975 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20985 /* The following macros are only called from draw_glyphs below.
20986 They reference the following parameters of that function directly:
20987 `w', `row', `area', and `overlap_p'
20988 as well as the following local variables:
20989 `s', `f', and `hdc' (in W32) */
20992 /* On W32, silently add local `hdc' variable to argument list of
20993 init_glyph_string. */
20994 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20995 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20997 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20998 init_glyph_string (s, char2b, w, row, area, start, hl)
21001 /* Add a glyph string for a stretch glyph to the list of strings
21002 between HEAD and TAIL. START is the index of the stretch glyph in
21003 row area AREA of glyph row ROW. END is the index of the last glyph
21004 in that glyph row area. X is the current output position assigned
21005 to the new glyph string constructed. HL overrides that face of the
21006 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21007 is the right-most x-position of the drawing area. */
21009 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21010 and below -- keep them on one line. */
21011 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21014 s = (struct glyph_string *) alloca (sizeof *s); \
21015 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21016 START = fill_stretch_glyph_string (s, row, area, START, END); \
21017 append_glyph_string (&HEAD, &TAIL, s); \
21023 /* Add a glyph string for an image glyph to the list of strings
21024 between HEAD and TAIL. START is the index of the image glyph in
21025 row area AREA of glyph row ROW. END is the index of the last glyph
21026 in that glyph row area. X is the current output position assigned
21027 to the new glyph string constructed. HL overrides that face of the
21028 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21029 is the right-most x-position of the drawing area. */
21031 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21034 s = (struct glyph_string *) alloca (sizeof *s); \
21035 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21036 fill_image_glyph_string (s); \
21037 append_glyph_string (&HEAD, &TAIL, s); \
21044 /* Add a glyph string for a sequence of character glyphs to the list
21045 of strings between HEAD and TAIL. START is the index of the first
21046 glyph in row area AREA of glyph row ROW that is part of the new
21047 glyph string. END is the index of the last glyph in that glyph row
21048 area. X is the current output position assigned to the new glyph
21049 string constructed. HL overrides that face of the glyph; e.g. it
21050 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21051 right-most x-position of the drawing area. */
21053 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21059 face_id = (row)->glyphs[area][START].face_id; \
21061 s = (struct glyph_string *) alloca (sizeof *s); \
21062 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21063 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21064 append_glyph_string (&HEAD, &TAIL, s); \
21066 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21071 /* Add a glyph string for a composite sequence to the list of strings
21072 between HEAD and TAIL. START is the index of the first glyph in
21073 row area AREA of glyph row ROW that is part of the new glyph
21074 string. END is the index of the last glyph in that glyph row area.
21075 X is the current output position assigned to the new glyph string
21076 constructed. HL overrides that face of the glyph; e.g. it is
21077 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21078 x-position of the drawing area. */
21080 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21082 int face_id = (row)->glyphs[area][START].face_id; \
21083 struct face *base_face = FACE_FROM_ID (f, face_id); \
21084 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21085 struct composition *cmp = composition_table[cmp_id]; \
21087 struct glyph_string *first_s; \
21090 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21092 /* Make glyph_strings for each glyph sequence that is drawable by \
21093 the same face, and append them to HEAD/TAIL. */ \
21094 for (n = 0; n < cmp->glyph_len;) \
21096 s = (struct glyph_string *) alloca (sizeof *s); \
21097 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21098 append_glyph_string (&(HEAD), &(TAIL), s); \
21104 n = fill_composite_glyph_string (s, base_face, overlaps); \
21112 /* Add a glyph string for a glyph-string sequence to the list of strings
21113 between HEAD and TAIL. */
21115 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21119 Lisp_Object gstring; \
21121 face_id = (row)->glyphs[area][START].face_id; \
21122 gstring = (composition_gstring_from_id \
21123 ((row)->glyphs[area][START].u.cmp.id)); \
21124 s = (struct glyph_string *) alloca (sizeof *s); \
21125 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21126 * LGSTRING_GLYPH_LEN (gstring)); \
21127 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21128 append_glyph_string (&(HEAD), &(TAIL), s); \
21130 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21134 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21135 of AREA of glyph row ROW on window W between indices START and END.
21136 HL overrides the face for drawing glyph strings, e.g. it is
21137 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21138 x-positions of the drawing area.
21140 This is an ugly monster macro construct because we must use alloca
21141 to allocate glyph strings (because draw_glyphs can be called
21142 asynchronously). */
21144 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21147 HEAD = TAIL = NULL; \
21148 while (START < END) \
21150 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21151 switch (first_glyph->type) \
21154 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21158 case COMPOSITE_GLYPH: \
21159 if (first_glyph->u.cmp.automatic) \
21160 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21163 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21167 case STRETCH_GLYPH: \
21168 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21172 case IMAGE_GLYPH: \
21173 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21183 set_glyph_string_background_width (s, START, LAST_X); \
21190 /* Draw glyphs between START and END in AREA of ROW on window W,
21191 starting at x-position X. X is relative to AREA in W. HL is a
21192 face-override with the following meaning:
21194 DRAW_NORMAL_TEXT draw normally
21195 DRAW_CURSOR draw in cursor face
21196 DRAW_MOUSE_FACE draw in mouse face.
21197 DRAW_INVERSE_VIDEO draw in mode line face
21198 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21199 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21201 If OVERLAPS is non-zero, draw only the foreground of characters and
21202 clip to the physical height of ROW. Non-zero value also defines
21203 the overlapping part to be drawn:
21205 OVERLAPS_PRED overlap with preceding rows
21206 OVERLAPS_SUCC overlap with succeeding rows
21207 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21208 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21210 Value is the x-position reached, relative to AREA of W. */
21213 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21214 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21215 enum draw_glyphs_face hl
, int overlaps
)
21217 struct glyph_string
*head
, *tail
;
21218 struct glyph_string
*s
;
21219 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21220 int i
, j
, x_reached
, last_x
, area_left
= 0;
21221 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21224 ALLOCATE_HDC (hdc
, f
);
21226 /* Let's rather be paranoid than getting a SEGV. */
21227 end
= min (end
, row
->used
[area
]);
21228 start
= max (0, start
);
21229 start
= min (end
, start
);
21231 /* Translate X to frame coordinates. Set last_x to the right
21232 end of the drawing area. */
21233 if (row
->full_width_p
)
21235 /* X is relative to the left edge of W, without scroll bars
21237 area_left
= WINDOW_LEFT_EDGE_X (w
);
21238 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21242 area_left
= window_box_left (w
, area
);
21243 last_x
= area_left
+ window_box_width (w
, area
);
21247 /* Build a doubly-linked list of glyph_string structures between
21248 head and tail from what we have to draw. Note that the macro
21249 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21250 the reason we use a separate variable `i'. */
21252 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21254 x_reached
= tail
->x
+ tail
->background_width
;
21258 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21259 the row, redraw some glyphs in front or following the glyph
21260 strings built above. */
21261 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21263 struct glyph_string
*h
, *t
;
21264 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21265 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21268 /* If mouse highlighting is on, we may need to draw adjacent
21269 glyphs using mouse-face highlighting. */
21270 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21272 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21274 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21275 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21277 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21279 check_mouse_face
= 1;
21280 mouse_beg_col
= (row
== mouse_beg_row
)
21281 ? dpyinfo
->mouse_face_beg_col
: 0;
21282 mouse_end_col
= (row
== mouse_end_row
)
21283 ? dpyinfo
->mouse_face_end_col
21284 : row
->used
[TEXT_AREA
];
21288 /* Compute overhangs for all glyph strings. */
21289 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21290 for (s
= head
; s
; s
= s
->next
)
21291 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21293 /* Prepend glyph strings for glyphs in front of the first glyph
21294 string that are overwritten because of the first glyph
21295 string's left overhang. The background of all strings
21296 prepended must be drawn because the first glyph string
21298 i
= left_overwritten (head
);
21301 enum draw_glyphs_face overlap_hl
;
21303 /* If this row contains mouse highlighting, attempt to draw
21304 the overlapped glyphs with the correct highlight. This
21305 code fails if the overlap encompasses more than one glyph
21306 and mouse-highlight spans only some of these glyphs.
21307 However, making it work perfectly involves a lot more
21308 code, and I don't know if the pathological case occurs in
21309 practice, so we'll stick to this for now. --- cyd */
21310 if (check_mouse_face
21311 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21312 overlap_hl
= DRAW_MOUSE_FACE
;
21314 overlap_hl
= DRAW_NORMAL_TEXT
;
21317 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21318 overlap_hl
, dummy_x
, last_x
);
21320 compute_overhangs_and_x (t
, head
->x
, 1);
21321 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21325 /* Prepend glyph strings for glyphs in front of the first glyph
21326 string that overwrite that glyph string because of their
21327 right overhang. For these strings, only the foreground must
21328 be drawn, because it draws over the glyph string at `head'.
21329 The background must not be drawn because this would overwrite
21330 right overhangs of preceding glyphs for which no glyph
21332 i
= left_overwriting (head
);
21335 enum draw_glyphs_face overlap_hl
;
21337 if (check_mouse_face
21338 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21339 overlap_hl
= DRAW_MOUSE_FACE
;
21341 overlap_hl
= DRAW_NORMAL_TEXT
;
21344 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21345 overlap_hl
, dummy_x
, last_x
);
21346 for (s
= h
; s
; s
= s
->next
)
21347 s
->background_filled_p
= 1;
21348 compute_overhangs_and_x (t
, head
->x
, 1);
21349 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21352 /* Append glyphs strings for glyphs following the last glyph
21353 string tail that are overwritten by tail. The background of
21354 these strings has to be drawn because tail's foreground draws
21356 i
= right_overwritten (tail
);
21359 enum draw_glyphs_face overlap_hl
;
21361 if (check_mouse_face
21362 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21363 overlap_hl
= DRAW_MOUSE_FACE
;
21365 overlap_hl
= DRAW_NORMAL_TEXT
;
21367 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21368 overlap_hl
, x
, last_x
);
21369 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21370 we don't have `end = i;' here. */
21371 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21372 append_glyph_string_lists (&head
, &tail
, h
, t
);
21376 /* Append glyph strings for glyphs following the last glyph
21377 string tail that overwrite tail. The foreground of such
21378 glyphs has to be drawn because it writes into the background
21379 of tail. The background must not be drawn because it could
21380 paint over the foreground of following glyphs. */
21381 i
= right_overwriting (tail
);
21384 enum draw_glyphs_face overlap_hl
;
21385 if (check_mouse_face
21386 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21387 overlap_hl
= DRAW_MOUSE_FACE
;
21389 overlap_hl
= DRAW_NORMAL_TEXT
;
21392 i
++; /* We must include the Ith glyph. */
21393 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21394 overlap_hl
, x
, last_x
);
21395 for (s
= h
; s
; s
= s
->next
)
21396 s
->background_filled_p
= 1;
21397 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21398 append_glyph_string_lists (&head
, &tail
, h
, t
);
21400 if (clip_head
|| clip_tail
)
21401 for (s
= head
; s
; s
= s
->next
)
21403 s
->clip_head
= clip_head
;
21404 s
->clip_tail
= clip_tail
;
21408 /* Draw all strings. */
21409 for (s
= head
; s
; s
= s
->next
)
21410 FRAME_RIF (f
)->draw_glyph_string (s
);
21413 /* When focus a sole frame and move horizontally, this sets on_p to 0
21414 causing a failure to erase prev cursor position. */
21415 if (area
== TEXT_AREA
21416 && !row
->full_width_p
21417 /* When drawing overlapping rows, only the glyph strings'
21418 foreground is drawn, which doesn't erase a cursor
21422 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21423 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21424 : (tail
? tail
->x
+ tail
->background_width
: x
));
21428 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21429 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21433 /* Value is the x-position up to which drawn, relative to AREA of W.
21434 This doesn't include parts drawn because of overhangs. */
21435 if (row
->full_width_p
)
21436 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21438 x_reached
-= area_left
;
21440 RELEASE_HDC (hdc
, f
);
21445 /* Expand row matrix if too narrow. Don't expand if area
21448 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21450 if (!fonts_changed_p \
21451 && (it->glyph_row->glyphs[area] \
21452 < it->glyph_row->glyphs[area + 1])) \
21454 it->w->ncols_scale_factor++; \
21455 fonts_changed_p = 1; \
21459 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21460 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21463 append_glyph (struct it
*it
)
21465 struct glyph
*glyph
;
21466 enum glyph_row_area area
= it
->area
;
21468 xassert (it
->glyph_row
);
21469 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21471 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21472 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21474 /* If the glyph row is reversed, we need to prepend the glyph
21475 rather than append it. */
21476 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21480 /* Make room for the additional glyph. */
21481 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21483 glyph
= it
->glyph_row
->glyphs
[area
];
21485 glyph
->charpos
= CHARPOS (it
->position
);
21486 glyph
->object
= it
->object
;
21487 if (it
->pixel_width
> 0)
21489 glyph
->pixel_width
= it
->pixel_width
;
21490 glyph
->padding_p
= 0;
21494 /* Assure at least 1-pixel width. Otherwise, cursor can't
21495 be displayed correctly. */
21496 glyph
->pixel_width
= 1;
21497 glyph
->padding_p
= 1;
21499 glyph
->ascent
= it
->ascent
;
21500 glyph
->descent
= it
->descent
;
21501 glyph
->voffset
= it
->voffset
;
21502 glyph
->type
= CHAR_GLYPH
;
21503 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21504 glyph
->multibyte_p
= it
->multibyte_p
;
21505 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21506 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21507 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21508 || it
->phys_descent
> it
->descent
);
21509 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21510 glyph
->face_id
= it
->face_id
;
21511 glyph
->u
.ch
= it
->char_to_display
;
21512 glyph
->slice
= null_glyph_slice
;
21513 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21516 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21517 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21519 glyph
->bidi_type
= it
->bidi_it
.type
;
21523 glyph
->resolved_level
= 0;
21524 glyph
->bidi_type
= UNKNOWN_BT
;
21526 ++it
->glyph_row
->used
[area
];
21529 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21532 /* Store one glyph for the composition IT->cmp_it.id in
21533 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21537 append_composite_glyph (struct it
*it
)
21539 struct glyph
*glyph
;
21540 enum glyph_row_area area
= it
->area
;
21542 xassert (it
->glyph_row
);
21544 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21545 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21547 /* If the glyph row is reversed, we need to prepend the glyph
21548 rather than append it. */
21549 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21553 /* Make room for the new glyph. */
21554 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21556 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21558 glyph
->charpos
= it
->cmp_it
.charpos
;
21559 glyph
->object
= it
->object
;
21560 glyph
->pixel_width
= it
->pixel_width
;
21561 glyph
->ascent
= it
->ascent
;
21562 glyph
->descent
= it
->descent
;
21563 glyph
->voffset
= it
->voffset
;
21564 glyph
->type
= COMPOSITE_GLYPH
;
21565 if (it
->cmp_it
.ch
< 0)
21567 glyph
->u
.cmp
.automatic
= 0;
21568 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21572 glyph
->u
.cmp
.automatic
= 1;
21573 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21574 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21575 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21577 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21578 glyph
->multibyte_p
= it
->multibyte_p
;
21579 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21580 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21581 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21582 || it
->phys_descent
> it
->descent
);
21583 glyph
->padding_p
= 0;
21584 glyph
->glyph_not_available_p
= 0;
21585 glyph
->face_id
= it
->face_id
;
21586 glyph
->slice
= null_glyph_slice
;
21587 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21590 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21591 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21593 glyph
->bidi_type
= it
->bidi_it
.type
;
21595 ++it
->glyph_row
->used
[area
];
21598 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21602 /* Change IT->ascent and IT->height according to the setting of
21606 take_vertical_position_into_account (struct it
*it
)
21610 if (it
->voffset
< 0)
21611 /* Increase the ascent so that we can display the text higher
21613 it
->ascent
-= it
->voffset
;
21615 /* Increase the descent so that we can display the text lower
21617 it
->descent
+= it
->voffset
;
21622 /* Produce glyphs/get display metrics for the image IT is loaded with.
21623 See the description of struct display_iterator in dispextern.h for
21624 an overview of struct display_iterator. */
21627 produce_image_glyph (struct it
*it
)
21631 int glyph_ascent
, crop
;
21632 struct glyph_slice slice
;
21634 xassert (it
->what
== IT_IMAGE
);
21636 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21638 /* Make sure X resources of the face is loaded. */
21639 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21641 if (it
->image_id
< 0)
21643 /* Fringe bitmap. */
21644 it
->ascent
= it
->phys_ascent
= 0;
21645 it
->descent
= it
->phys_descent
= 0;
21646 it
->pixel_width
= 0;
21651 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21653 /* Make sure X resources of the image is loaded. */
21654 prepare_image_for_display (it
->f
, img
);
21656 slice
.x
= slice
.y
= 0;
21657 slice
.width
= img
->width
;
21658 slice
.height
= img
->height
;
21660 if (INTEGERP (it
->slice
.x
))
21661 slice
.x
= XINT (it
->slice
.x
);
21662 else if (FLOATP (it
->slice
.x
))
21663 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21665 if (INTEGERP (it
->slice
.y
))
21666 slice
.y
= XINT (it
->slice
.y
);
21667 else if (FLOATP (it
->slice
.y
))
21668 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21670 if (INTEGERP (it
->slice
.width
))
21671 slice
.width
= XINT (it
->slice
.width
);
21672 else if (FLOATP (it
->slice
.width
))
21673 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21675 if (INTEGERP (it
->slice
.height
))
21676 slice
.height
= XINT (it
->slice
.height
);
21677 else if (FLOATP (it
->slice
.height
))
21678 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21680 if (slice
.x
>= img
->width
)
21681 slice
.x
= img
->width
;
21682 if (slice
.y
>= img
->height
)
21683 slice
.y
= img
->height
;
21684 if (slice
.x
+ slice
.width
>= img
->width
)
21685 slice
.width
= img
->width
- slice
.x
;
21686 if (slice
.y
+ slice
.height
> img
->height
)
21687 slice
.height
= img
->height
- slice
.y
;
21689 if (slice
.width
== 0 || slice
.height
== 0)
21692 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21694 it
->descent
= slice
.height
- glyph_ascent
;
21696 it
->descent
+= img
->vmargin
;
21697 if (slice
.y
+ slice
.height
== img
->height
)
21698 it
->descent
+= img
->vmargin
;
21699 it
->phys_descent
= it
->descent
;
21701 it
->pixel_width
= slice
.width
;
21703 it
->pixel_width
+= img
->hmargin
;
21704 if (slice
.x
+ slice
.width
== img
->width
)
21705 it
->pixel_width
+= img
->hmargin
;
21707 /* It's quite possible for images to have an ascent greater than
21708 their height, so don't get confused in that case. */
21709 if (it
->descent
< 0)
21714 if (face
->box
!= FACE_NO_BOX
)
21716 if (face
->box_line_width
> 0)
21719 it
->ascent
+= face
->box_line_width
;
21720 if (slice
.y
+ slice
.height
== img
->height
)
21721 it
->descent
+= face
->box_line_width
;
21724 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21725 it
->pixel_width
+= eabs (face
->box_line_width
);
21726 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21727 it
->pixel_width
+= eabs (face
->box_line_width
);
21730 take_vertical_position_into_account (it
);
21732 /* Automatically crop wide image glyphs at right edge so we can
21733 draw the cursor on same display row. */
21734 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21735 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21737 it
->pixel_width
-= crop
;
21738 slice
.width
-= crop
;
21743 struct glyph
*glyph
;
21744 enum glyph_row_area area
= it
->area
;
21746 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21747 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21749 glyph
->charpos
= CHARPOS (it
->position
);
21750 glyph
->object
= it
->object
;
21751 glyph
->pixel_width
= it
->pixel_width
;
21752 glyph
->ascent
= glyph_ascent
;
21753 glyph
->descent
= it
->descent
;
21754 glyph
->voffset
= it
->voffset
;
21755 glyph
->type
= IMAGE_GLYPH
;
21756 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21757 glyph
->multibyte_p
= it
->multibyte_p
;
21758 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21759 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21760 glyph
->overlaps_vertically_p
= 0;
21761 glyph
->padding_p
= 0;
21762 glyph
->glyph_not_available_p
= 0;
21763 glyph
->face_id
= it
->face_id
;
21764 glyph
->u
.img_id
= img
->id
;
21765 glyph
->slice
= slice
;
21766 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21769 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21770 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21772 glyph
->bidi_type
= it
->bidi_it
.type
;
21774 ++it
->glyph_row
->used
[area
];
21777 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21782 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21783 of the glyph, WIDTH and HEIGHT are the width and height of the
21784 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21787 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21788 int width
, int height
, int ascent
)
21790 struct glyph
*glyph
;
21791 enum glyph_row_area area
= it
->area
;
21793 xassert (ascent
>= 0 && ascent
<= height
);
21795 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21796 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21798 /* If the glyph row is reversed, we need to prepend the glyph
21799 rather than append it. */
21800 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21804 /* Make room for the additional glyph. */
21805 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21807 glyph
= it
->glyph_row
->glyphs
[area
];
21809 glyph
->charpos
= CHARPOS (it
->position
);
21810 glyph
->object
= object
;
21811 glyph
->pixel_width
= width
;
21812 glyph
->ascent
= ascent
;
21813 glyph
->descent
= height
- ascent
;
21814 glyph
->voffset
= it
->voffset
;
21815 glyph
->type
= STRETCH_GLYPH
;
21816 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21817 glyph
->multibyte_p
= it
->multibyte_p
;
21818 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21819 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21820 glyph
->overlaps_vertically_p
= 0;
21821 glyph
->padding_p
= 0;
21822 glyph
->glyph_not_available_p
= 0;
21823 glyph
->face_id
= it
->face_id
;
21824 glyph
->u
.stretch
.ascent
= ascent
;
21825 glyph
->u
.stretch
.height
= height
;
21826 glyph
->slice
= null_glyph_slice
;
21827 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21830 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21831 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21833 glyph
->bidi_type
= it
->bidi_it
.type
;
21837 glyph
->resolved_level
= 0;
21838 glyph
->bidi_type
= UNKNOWN_BT
;
21840 ++it
->glyph_row
->used
[area
];
21843 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21847 /* Produce a stretch glyph for iterator IT. IT->object is the value
21848 of the glyph property displayed. The value must be a list
21849 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21852 1. `:width WIDTH' specifies that the space should be WIDTH *
21853 canonical char width wide. WIDTH may be an integer or floating
21856 2. `:relative-width FACTOR' specifies that the width of the stretch
21857 should be computed from the width of the first character having the
21858 `glyph' property, and should be FACTOR times that width.
21860 3. `:align-to HPOS' specifies that the space should be wide enough
21861 to reach HPOS, a value in canonical character units.
21863 Exactly one of the above pairs must be present.
21865 4. `:height HEIGHT' specifies that the height of the stretch produced
21866 should be HEIGHT, measured in canonical character units.
21868 5. `:relative-height FACTOR' specifies that the height of the
21869 stretch should be FACTOR times the height of the characters having
21870 the glyph property.
21872 Either none or exactly one of 4 or 5 must be present.
21874 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21875 of the stretch should be used for the ascent of the stretch.
21876 ASCENT must be in the range 0 <= ASCENT <= 100. */
21879 produce_stretch_glyph (struct it
*it
)
21881 /* (space :width WIDTH :height HEIGHT ...) */
21882 Lisp_Object prop
, plist
;
21883 int width
= 0, height
= 0, align_to
= -1;
21884 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21887 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21888 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21890 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21892 /* List should start with `space'. */
21893 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21894 plist
= XCDR (it
->object
);
21896 /* Compute the width of the stretch. */
21897 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21898 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21900 /* Absolute width `:width WIDTH' specified and valid. */
21901 zero_width_ok_p
= 1;
21904 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21907 /* Relative width `:relative-width FACTOR' specified and valid.
21908 Compute the width of the characters having the `glyph'
21911 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21914 if (it
->multibyte_p
)
21916 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21917 - IT_BYTEPOS (*it
));
21918 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21922 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21923 if (! ASCII_CHAR_P (it2
.c
))
21924 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21927 it2
.glyph_row
= NULL
;
21928 it2
.what
= IT_CHARACTER
;
21929 x_produce_glyphs (&it2
);
21930 width
= NUMVAL (prop
) * it2
.pixel_width
;
21932 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21933 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21935 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21936 align_to
= (align_to
< 0
21938 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21939 else if (align_to
< 0)
21940 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21941 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21942 zero_width_ok_p
= 1;
21945 /* Nothing specified -> width defaults to canonical char width. */
21946 width
= FRAME_COLUMN_WIDTH (it
->f
);
21948 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21951 /* Compute height. */
21952 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21953 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21956 zero_height_ok_p
= 1;
21958 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21960 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21962 height
= FONT_HEIGHT (font
);
21964 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21967 /* Compute percentage of height used for ascent. If
21968 `:ascent ASCENT' is present and valid, use that. Otherwise,
21969 derive the ascent from the font in use. */
21970 if (prop
= Fplist_get (plist
, QCascent
),
21971 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21972 ascent
= height
* NUMVAL (prop
) / 100.0;
21973 else if (!NILP (prop
)
21974 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21975 ascent
= min (max (0, (int)tem
), height
);
21977 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21979 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21980 && it
->current_x
+ width
> it
->last_visible_x
)
21981 width
= it
->last_visible_x
- it
->current_x
- 1;
21983 if (width
> 0 && height
> 0 && it
->glyph_row
)
21985 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21986 if (!STRINGP (object
))
21987 object
= it
->w
->buffer
;
21988 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21991 it
->pixel_width
= width
;
21992 it
->ascent
= it
->phys_ascent
= ascent
;
21993 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21994 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21996 take_vertical_position_into_account (it
);
21999 /* Calculate line-height and line-spacing properties.
22000 An integer value specifies explicit pixel value.
22001 A float value specifies relative value to current face height.
22002 A cons (float . face-name) specifies relative value to
22003 height of specified face font.
22005 Returns height in pixels, or nil. */
22009 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22010 int boff
, int override
)
22012 Lisp_Object face_name
= Qnil
;
22013 int ascent
, descent
, height
;
22015 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22020 face_name
= XCAR (val
);
22022 if (!NUMBERP (val
))
22023 val
= make_number (1);
22024 if (NILP (face_name
))
22026 height
= it
->ascent
+ it
->descent
;
22031 if (NILP (face_name
))
22033 font
= FRAME_FONT (it
->f
);
22034 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22036 else if (EQ (face_name
, Qt
))
22045 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22047 return make_number (-1);
22049 face
= FACE_FROM_ID (it
->f
, face_id
);
22052 return make_number (-1);
22053 boff
= font
->baseline_offset
;
22054 if (font
->vertical_centering
)
22055 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22058 ascent
= FONT_BASE (font
) + boff
;
22059 descent
= FONT_DESCENT (font
) - boff
;
22063 it
->override_ascent
= ascent
;
22064 it
->override_descent
= descent
;
22065 it
->override_boff
= boff
;
22068 height
= ascent
+ descent
;
22072 height
= (int)(XFLOAT_DATA (val
) * height
);
22073 else if (INTEGERP (val
))
22074 height
*= XINT (val
);
22076 return make_number (height
);
22081 Produce glyphs/get display metrics for the display element IT is
22082 loaded with. See the description of struct it in dispextern.h
22083 for an overview of struct it. */
22086 x_produce_glyphs (struct it
*it
)
22088 int extra_line_spacing
= it
->extra_line_spacing
;
22090 it
->glyph_not_available_p
= 0;
22092 if (it
->what
== IT_CHARACTER
)
22095 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22096 struct font
*font
= face
->font
;
22097 int font_not_found_p
= font
== NULL
;
22098 struct font_metrics
*pcm
= NULL
;
22099 int boff
; /* baseline offset */
22101 if (font_not_found_p
)
22103 /* When no suitable font found, display an empty box based
22104 on the metrics of the font of the default face (or what
22106 struct face
*no_font_face
22107 = FACE_FROM_ID (it
->f
,
22108 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22109 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22110 font
= no_font_face
->font
;
22111 boff
= font
->baseline_offset
;
22115 boff
= font
->baseline_offset
;
22116 if (font
->vertical_centering
)
22117 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22120 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22126 if (it
->override_ascent
>= 0)
22128 it
->ascent
= it
->override_ascent
;
22129 it
->descent
= it
->override_descent
;
22130 boff
= it
->override_boff
;
22134 it
->ascent
= FONT_BASE (font
) + boff
;
22135 it
->descent
= FONT_DESCENT (font
) - boff
;
22138 if (! font_not_found_p
22139 && get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22141 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22142 if (pcm
->width
== 0
22143 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22149 it
->phys_ascent
= pcm
->ascent
+ boff
;
22150 it
->phys_descent
= pcm
->descent
- boff
;
22151 it
->pixel_width
= pcm
->width
;
22155 it
->glyph_not_available_p
= 1;
22156 it
->phys_ascent
= it
->ascent
;
22157 it
->phys_descent
= it
->descent
;
22158 it
->pixel_width
= font
->space_width
;
22161 if (it
->constrain_row_ascent_descent_p
)
22163 if (it
->descent
> it
->max_descent
)
22165 it
->ascent
+= it
->descent
- it
->max_descent
;
22166 it
->descent
= it
->max_descent
;
22168 if (it
->ascent
> it
->max_ascent
)
22170 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22171 it
->ascent
= it
->max_ascent
;
22173 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22174 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22175 extra_line_spacing
= 0;
22178 /* If this is a space inside a region of text with
22179 `space-width' property, change its width. */
22180 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22182 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22184 /* If face has a box, add the box thickness to the character
22185 height. If character has a box line to the left and/or
22186 right, add the box line width to the character's width. */
22187 if (face
->box
!= FACE_NO_BOX
)
22189 int thick
= face
->box_line_width
;
22193 it
->ascent
+= thick
;
22194 it
->descent
+= thick
;
22199 if (it
->start_of_box_run_p
)
22200 it
->pixel_width
+= thick
;
22201 if (it
->end_of_box_run_p
)
22202 it
->pixel_width
+= thick
;
22205 /* If face has an overline, add the height of the overline
22206 (1 pixel) and a 1 pixel margin to the character height. */
22207 if (face
->overline_p
)
22208 it
->ascent
+= overline_margin
;
22210 if (it
->constrain_row_ascent_descent_p
)
22212 if (it
->ascent
> it
->max_ascent
)
22213 it
->ascent
= it
->max_ascent
;
22214 if (it
->descent
> it
->max_descent
)
22215 it
->descent
= it
->max_descent
;
22218 take_vertical_position_into_account (it
);
22220 /* If we have to actually produce glyphs, do it. */
22225 /* Translate a space with a `space-width' property
22226 into a stretch glyph. */
22227 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22228 / FONT_HEIGHT (font
));
22229 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22230 it
->ascent
+ it
->descent
, ascent
);
22235 /* If characters with lbearing or rbearing are displayed
22236 in this line, record that fact in a flag of the
22237 glyph row. This is used to optimize X output code. */
22238 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22239 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22241 if (! stretched_p
&& it
->pixel_width
== 0)
22242 /* We assure that all visible glyphs have at least 1-pixel
22244 it
->pixel_width
= 1;
22246 else if (it
->char_to_display
== '\n')
22248 /* A newline has no width, but we need the height of the
22249 line. But if previous part of the line sets a height,
22250 don't increase that height */
22252 Lisp_Object height
;
22253 Lisp_Object total_height
= Qnil
;
22255 it
->override_ascent
= -1;
22256 it
->pixel_width
= 0;
22259 height
= get_it_property (it
, Qline_height
);
22260 /* Split (line-height total-height) list */
22262 && CONSP (XCDR (height
))
22263 && NILP (XCDR (XCDR (height
))))
22265 total_height
= XCAR (XCDR (height
));
22266 height
= XCAR (height
);
22268 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22270 if (it
->override_ascent
>= 0)
22272 it
->ascent
= it
->override_ascent
;
22273 it
->descent
= it
->override_descent
;
22274 boff
= it
->override_boff
;
22278 it
->ascent
= FONT_BASE (font
) + boff
;
22279 it
->descent
= FONT_DESCENT (font
) - boff
;
22282 if (EQ (height
, Qt
))
22284 if (it
->descent
> it
->max_descent
)
22286 it
->ascent
+= it
->descent
- it
->max_descent
;
22287 it
->descent
= it
->max_descent
;
22289 if (it
->ascent
> it
->max_ascent
)
22291 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22292 it
->ascent
= it
->max_ascent
;
22294 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22295 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22296 it
->constrain_row_ascent_descent_p
= 1;
22297 extra_line_spacing
= 0;
22301 Lisp_Object spacing
;
22303 it
->phys_ascent
= it
->ascent
;
22304 it
->phys_descent
= it
->descent
;
22306 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22307 && face
->box
!= FACE_NO_BOX
22308 && face
->box_line_width
> 0)
22310 it
->ascent
+= face
->box_line_width
;
22311 it
->descent
+= face
->box_line_width
;
22314 && XINT (height
) > it
->ascent
+ it
->descent
)
22315 it
->ascent
= XINT (height
) - it
->descent
;
22317 if (!NILP (total_height
))
22318 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22321 spacing
= get_it_property (it
, Qline_spacing
);
22322 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22324 if (INTEGERP (spacing
))
22326 extra_line_spacing
= XINT (spacing
);
22327 if (!NILP (total_height
))
22328 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22332 else /* i.e. (it->char_to_display == '\t') */
22334 if (font
->space_width
> 0)
22336 int tab_width
= it
->tab_width
* font
->space_width
;
22337 int x
= it
->current_x
+ it
->continuation_lines_width
;
22338 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22340 /* If the distance from the current position to the next tab
22341 stop is less than a space character width, use the
22342 tab stop after that. */
22343 if (next_tab_x
- x
< font
->space_width
)
22344 next_tab_x
+= tab_width
;
22346 it
->pixel_width
= next_tab_x
- x
;
22348 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22349 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22353 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22354 it
->ascent
+ it
->descent
, it
->ascent
);
22359 it
->pixel_width
= 0;
22364 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22366 /* A static composition.
22368 Note: A composition is represented as one glyph in the
22369 glyph matrix. There are no padding glyphs.
22371 Important note: pixel_width, ascent, and descent are the
22372 values of what is drawn by draw_glyphs (i.e. the values of
22373 the overall glyphs composed). */
22374 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22375 int boff
; /* baseline offset */
22376 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22377 int glyph_len
= cmp
->glyph_len
;
22378 struct font
*font
= face
->font
;
22382 /* If we have not yet calculated pixel size data of glyphs of
22383 the composition for the current face font, calculate them
22384 now. Theoretically, we have to check all fonts for the
22385 glyphs, but that requires much time and memory space. So,
22386 here we check only the font of the first glyph. This may
22387 lead to incorrect display, but it's very rare, and C-l
22388 (recenter-top-bottom) can correct the display anyway. */
22389 if (! cmp
->font
|| cmp
->font
!= font
)
22391 /* Ascent and descent of the font of the first character
22392 of this composition (adjusted by baseline offset).
22393 Ascent and descent of overall glyphs should not be less
22394 than these, respectively. */
22395 int font_ascent
, font_descent
, font_height
;
22396 /* Bounding box of the overall glyphs. */
22397 int leftmost
, rightmost
, lowest
, highest
;
22398 int lbearing
, rbearing
;
22399 int i
, width
, ascent
, descent
;
22400 int left_padded
= 0, right_padded
= 0;
22403 struct font_metrics
*pcm
;
22404 int font_not_found_p
;
22407 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22408 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22410 if (glyph_len
< cmp
->glyph_len
)
22412 for (i
= 0; i
< glyph_len
; i
++)
22414 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22416 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22421 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22422 : IT_CHARPOS (*it
));
22423 /* If no suitable font is found, use the default font. */
22424 font_not_found_p
= font
== NULL
;
22425 if (font_not_found_p
)
22427 face
= face
->ascii_face
;
22430 boff
= font
->baseline_offset
;
22431 if (font
->vertical_centering
)
22432 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22433 font_ascent
= FONT_BASE (font
) + boff
;
22434 font_descent
= FONT_DESCENT (font
) - boff
;
22435 font_height
= FONT_HEIGHT (font
);
22437 cmp
->font
= (void *) font
;
22440 if (! font_not_found_p
)
22442 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22443 &char2b
, it
->multibyte_p
, 0);
22444 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22447 /* Initialize the bounding box. */
22450 width
= pcm
->width
;
22451 ascent
= pcm
->ascent
;
22452 descent
= pcm
->descent
;
22453 lbearing
= pcm
->lbearing
;
22454 rbearing
= pcm
->rbearing
;
22458 width
= font
->space_width
;
22459 ascent
= FONT_BASE (font
);
22460 descent
= FONT_DESCENT (font
);
22467 lowest
= - descent
+ boff
;
22468 highest
= ascent
+ boff
;
22470 if (! font_not_found_p
22471 && font
->default_ascent
22472 && CHAR_TABLE_P (Vuse_default_ascent
)
22473 && !NILP (Faref (Vuse_default_ascent
,
22474 make_number (it
->char_to_display
))))
22475 highest
= font
->default_ascent
+ boff
;
22477 /* Draw the first glyph at the normal position. It may be
22478 shifted to right later if some other glyphs are drawn
22480 cmp
->offsets
[i
* 2] = 0;
22481 cmp
->offsets
[i
* 2 + 1] = boff
;
22482 cmp
->lbearing
= lbearing
;
22483 cmp
->rbearing
= rbearing
;
22485 /* Set cmp->offsets for the remaining glyphs. */
22486 for (i
++; i
< glyph_len
; i
++)
22488 int left
, right
, btm
, top
;
22489 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22491 struct face
*this_face
;
22496 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22497 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22498 font
= this_face
->font
;
22504 this_boff
= font
->baseline_offset
;
22505 if (font
->vertical_centering
)
22506 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22507 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22508 &char2b
, it
->multibyte_p
, 0);
22509 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22512 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22515 width
= pcm
->width
;
22516 ascent
= pcm
->ascent
;
22517 descent
= pcm
->descent
;
22518 lbearing
= pcm
->lbearing
;
22519 rbearing
= pcm
->rbearing
;
22520 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22522 /* Relative composition with or without
22523 alternate chars. */
22524 left
= (leftmost
+ rightmost
- width
) / 2;
22525 btm
= - descent
+ boff
;
22526 if (font
->relative_compose
22527 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22528 || NILP (Faref (Vignore_relative_composition
,
22529 make_number (ch
)))))
22532 if (- descent
>= font
->relative_compose
)
22533 /* One extra pixel between two glyphs. */
22535 else if (ascent
<= 0)
22536 /* One extra pixel between two glyphs. */
22537 btm
= lowest
- 1 - ascent
- descent
;
22542 /* A composition rule is specified by an integer
22543 value that encodes global and new reference
22544 points (GREF and NREF). GREF and NREF are
22545 specified by numbers as below:
22547 0---1---2 -- ascent
22551 9--10--11 -- center
22553 ---3---4---5--- baseline
22555 6---7---8 -- descent
22557 int rule
= COMPOSITION_RULE (cmp
, i
);
22558 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22560 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22561 grefx
= gref
% 3, nrefx
= nref
% 3;
22562 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22564 xoff
= font_height
* (xoff
- 128) / 256;
22566 yoff
= font_height
* (yoff
- 128) / 256;
22569 + grefx
* (rightmost
- leftmost
) / 2
22570 - nrefx
* width
/ 2
22573 btm
= ((grefy
== 0 ? highest
22575 : grefy
== 2 ? lowest
22576 : (highest
+ lowest
) / 2)
22577 - (nrefy
== 0 ? ascent
+ descent
22578 : nrefy
== 1 ? descent
- boff
22580 : (ascent
+ descent
) / 2)
22584 cmp
->offsets
[i
* 2] = left
;
22585 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22587 /* Update the bounding box of the overall glyphs. */
22590 right
= left
+ width
;
22591 if (left
< leftmost
)
22593 if (right
> rightmost
)
22596 top
= btm
+ descent
+ ascent
;
22602 if (cmp
->lbearing
> left
+ lbearing
)
22603 cmp
->lbearing
= left
+ lbearing
;
22604 if (cmp
->rbearing
< left
+ rbearing
)
22605 cmp
->rbearing
= left
+ rbearing
;
22609 /* If there are glyphs whose x-offsets are negative,
22610 shift all glyphs to the right and make all x-offsets
22614 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22615 cmp
->offsets
[i
* 2] -= leftmost
;
22616 rightmost
-= leftmost
;
22617 cmp
->lbearing
-= leftmost
;
22618 cmp
->rbearing
-= leftmost
;
22621 if (left_padded
&& cmp
->lbearing
< 0)
22623 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22624 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22625 rightmost
-= cmp
->lbearing
;
22626 cmp
->rbearing
-= cmp
->lbearing
;
22629 if (right_padded
&& rightmost
< cmp
->rbearing
)
22631 rightmost
= cmp
->rbearing
;
22634 cmp
->pixel_width
= rightmost
;
22635 cmp
->ascent
= highest
;
22636 cmp
->descent
= - lowest
;
22637 if (cmp
->ascent
< font_ascent
)
22638 cmp
->ascent
= font_ascent
;
22639 if (cmp
->descent
< font_descent
)
22640 cmp
->descent
= font_descent
;
22644 && (cmp
->lbearing
< 0
22645 || cmp
->rbearing
> cmp
->pixel_width
))
22646 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22648 it
->pixel_width
= cmp
->pixel_width
;
22649 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22650 it
->descent
= it
->phys_descent
= cmp
->descent
;
22651 if (face
->box
!= FACE_NO_BOX
)
22653 int thick
= face
->box_line_width
;
22657 it
->ascent
+= thick
;
22658 it
->descent
+= thick
;
22663 if (it
->start_of_box_run_p
)
22664 it
->pixel_width
+= thick
;
22665 if (it
->end_of_box_run_p
)
22666 it
->pixel_width
+= thick
;
22669 /* If face has an overline, add the height of the overline
22670 (1 pixel) and a 1 pixel margin to the character height. */
22671 if (face
->overline_p
)
22672 it
->ascent
+= overline_margin
;
22674 take_vertical_position_into_account (it
);
22675 if (it
->ascent
< 0)
22677 if (it
->descent
< 0)
22681 append_composite_glyph (it
);
22683 else if (it
->what
== IT_COMPOSITION
)
22685 /* A dynamic (automatic) composition. */
22686 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22687 Lisp_Object gstring
;
22688 struct font_metrics metrics
;
22690 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22692 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22695 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22696 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22697 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22698 it
->descent
= it
->phys_descent
= metrics
.descent
;
22699 if (face
->box
!= FACE_NO_BOX
)
22701 int thick
= face
->box_line_width
;
22705 it
->ascent
+= thick
;
22706 it
->descent
+= thick
;
22711 if (it
->start_of_box_run_p
)
22712 it
->pixel_width
+= thick
;
22713 if (it
->end_of_box_run_p
)
22714 it
->pixel_width
+= thick
;
22716 /* If face has an overline, add the height of the overline
22717 (1 pixel) and a 1 pixel margin to the character height. */
22718 if (face
->overline_p
)
22719 it
->ascent
+= overline_margin
;
22720 take_vertical_position_into_account (it
);
22721 if (it
->ascent
< 0)
22723 if (it
->descent
< 0)
22727 append_composite_glyph (it
);
22729 else if (it
->what
== IT_IMAGE
)
22730 produce_image_glyph (it
);
22731 else if (it
->what
== IT_STRETCH
)
22732 produce_stretch_glyph (it
);
22734 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22735 because this isn't true for images with `:ascent 100'. */
22736 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22737 if (it
->area
== TEXT_AREA
)
22738 it
->current_x
+= it
->pixel_width
;
22740 if (extra_line_spacing
> 0)
22742 it
->descent
+= extra_line_spacing
;
22743 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22744 it
->max_extra_line_spacing
= extra_line_spacing
;
22747 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22748 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22749 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22750 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22754 Output LEN glyphs starting at START at the nominal cursor position.
22755 Advance the nominal cursor over the text. The global variable
22756 updated_window contains the window being updated, updated_row is
22757 the glyph row being updated, and updated_area is the area of that
22758 row being updated. */
22761 x_write_glyphs (struct glyph
*start
, int len
)
22765 xassert (updated_window
&& updated_row
);
22768 /* Write glyphs. */
22770 hpos
= start
- updated_row
->glyphs
[updated_area
];
22771 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22772 updated_row
, updated_area
,
22774 DRAW_NORMAL_TEXT
, 0);
22776 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22777 if (updated_area
== TEXT_AREA
22778 && updated_window
->phys_cursor_on_p
22779 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22780 && updated_window
->phys_cursor
.hpos
>= hpos
22781 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22782 updated_window
->phys_cursor_on_p
= 0;
22786 /* Advance the output cursor. */
22787 output_cursor
.hpos
+= len
;
22788 output_cursor
.x
= x
;
22793 Insert LEN glyphs from START at the nominal cursor position. */
22796 x_insert_glyphs (struct glyph
*start
, int len
)
22800 int line_height
, shift_by_width
, shifted_region_width
;
22801 struct glyph_row
*row
;
22802 struct glyph
*glyph
;
22803 int frame_x
, frame_y
;
22806 xassert (updated_window
&& updated_row
);
22808 w
= updated_window
;
22809 f
= XFRAME (WINDOW_FRAME (w
));
22811 /* Get the height of the line we are in. */
22813 line_height
= row
->height
;
22815 /* Get the width of the glyphs to insert. */
22816 shift_by_width
= 0;
22817 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22818 shift_by_width
+= glyph
->pixel_width
;
22820 /* Get the width of the region to shift right. */
22821 shifted_region_width
= (window_box_width (w
, updated_area
)
22826 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22827 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22829 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22830 line_height
, shift_by_width
);
22832 /* Write the glyphs. */
22833 hpos
= start
- row
->glyphs
[updated_area
];
22834 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22836 DRAW_NORMAL_TEXT
, 0);
22838 /* Advance the output cursor. */
22839 output_cursor
.hpos
+= len
;
22840 output_cursor
.x
+= shift_by_width
;
22846 Erase the current text line from the nominal cursor position
22847 (inclusive) to pixel column TO_X (exclusive). The idea is that
22848 everything from TO_X onward is already erased.
22850 TO_X is a pixel position relative to updated_area of
22851 updated_window. TO_X == -1 means clear to the end of this area. */
22854 x_clear_end_of_line (int to_x
)
22857 struct window
*w
= updated_window
;
22858 int max_x
, min_y
, max_y
;
22859 int from_x
, from_y
, to_y
;
22861 xassert (updated_window
&& updated_row
);
22862 f
= XFRAME (w
->frame
);
22864 if (updated_row
->full_width_p
)
22865 max_x
= WINDOW_TOTAL_WIDTH (w
);
22867 max_x
= window_box_width (w
, updated_area
);
22868 max_y
= window_text_bottom_y (w
);
22870 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22871 of window. For TO_X > 0, truncate to end of drawing area. */
22877 to_x
= min (to_x
, max_x
);
22879 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22881 /* Notice if the cursor will be cleared by this operation. */
22882 if (!updated_row
->full_width_p
)
22883 notice_overwritten_cursor (w
, updated_area
,
22884 output_cursor
.x
, -1,
22886 MATRIX_ROW_BOTTOM_Y (updated_row
));
22888 from_x
= output_cursor
.x
;
22890 /* Translate to frame coordinates. */
22891 if (updated_row
->full_width_p
)
22893 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22894 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22898 int area_left
= window_box_left (w
, updated_area
);
22899 from_x
+= area_left
;
22903 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22904 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22905 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22907 /* Prevent inadvertently clearing to end of the X window. */
22908 if (to_x
> from_x
&& to_y
> from_y
)
22911 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22912 to_x
- from_x
, to_y
- from_y
);
22917 #endif /* HAVE_WINDOW_SYSTEM */
22921 /***********************************************************************
22923 ***********************************************************************/
22925 /* Value is the internal representation of the specified cursor type
22926 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22927 of the bar cursor. */
22929 static enum text_cursor_kinds
22930 get_specified_cursor_type (Lisp_Object arg
, int *width
)
22932 enum text_cursor_kinds type
;
22937 if (EQ (arg
, Qbox
))
22938 return FILLED_BOX_CURSOR
;
22940 if (EQ (arg
, Qhollow
))
22941 return HOLLOW_BOX_CURSOR
;
22943 if (EQ (arg
, Qbar
))
22950 && EQ (XCAR (arg
), Qbar
)
22951 && INTEGERP (XCDR (arg
))
22952 && XINT (XCDR (arg
)) >= 0)
22954 *width
= XINT (XCDR (arg
));
22958 if (EQ (arg
, Qhbar
))
22961 return HBAR_CURSOR
;
22965 && EQ (XCAR (arg
), Qhbar
)
22966 && INTEGERP (XCDR (arg
))
22967 && XINT (XCDR (arg
)) >= 0)
22969 *width
= XINT (XCDR (arg
));
22970 return HBAR_CURSOR
;
22973 /* Treat anything unknown as "hollow box cursor".
22974 It was bad to signal an error; people have trouble fixing
22975 .Xdefaults with Emacs, when it has something bad in it. */
22976 type
= HOLLOW_BOX_CURSOR
;
22981 /* Set the default cursor types for specified frame. */
22983 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
22988 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22989 FRAME_CURSOR_WIDTH (f
) = width
;
22991 /* By default, set up the blink-off state depending on the on-state. */
22993 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22996 FRAME_BLINK_OFF_CURSOR (f
)
22997 = get_specified_cursor_type (XCDR (tem
), &width
);
22998 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23001 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23005 /* Return the cursor we want to be displayed in window W. Return
23006 width of bar/hbar cursor through WIDTH arg. Return with
23007 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23008 (i.e. if the `system caret' should track this cursor).
23010 In a mini-buffer window, we want the cursor only to appear if we
23011 are reading input from this window. For the selected window, we
23012 want the cursor type given by the frame parameter or buffer local
23013 setting of cursor-type. If explicitly marked off, draw no cursor.
23014 In all other cases, we want a hollow box cursor. */
23016 static enum text_cursor_kinds
23017 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23018 int *active_cursor
)
23020 struct frame
*f
= XFRAME (w
->frame
);
23021 struct buffer
*b
= XBUFFER (w
->buffer
);
23022 int cursor_type
= DEFAULT_CURSOR
;
23023 Lisp_Object alt_cursor
;
23024 int non_selected
= 0;
23026 *active_cursor
= 1;
23029 if (cursor_in_echo_area
23030 && FRAME_HAS_MINIBUF_P (f
)
23031 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23033 if (w
== XWINDOW (echo_area_window
))
23035 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23037 *width
= FRAME_CURSOR_WIDTH (f
);
23038 return FRAME_DESIRED_CURSOR (f
);
23041 return get_specified_cursor_type (b
->cursor_type
, width
);
23044 *active_cursor
= 0;
23048 /* Detect a nonselected window or nonselected frame. */
23049 else if (w
!= XWINDOW (f
->selected_window
)
23050 #ifdef HAVE_WINDOW_SYSTEM
23051 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23055 *active_cursor
= 0;
23057 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23063 /* Never display a cursor in a window in which cursor-type is nil. */
23064 if (NILP (b
->cursor_type
))
23067 /* Get the normal cursor type for this window. */
23068 if (EQ (b
->cursor_type
, Qt
))
23070 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23071 *width
= FRAME_CURSOR_WIDTH (f
);
23074 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23076 /* Use cursor-in-non-selected-windows instead
23077 for non-selected window or frame. */
23080 alt_cursor
= b
->cursor_in_non_selected_windows
;
23081 if (!EQ (Qt
, alt_cursor
))
23082 return get_specified_cursor_type (alt_cursor
, width
);
23083 /* t means modify the normal cursor type. */
23084 if (cursor_type
== FILLED_BOX_CURSOR
)
23085 cursor_type
= HOLLOW_BOX_CURSOR
;
23086 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23088 return cursor_type
;
23091 /* Use normal cursor if not blinked off. */
23092 if (!w
->cursor_off_p
)
23094 #ifdef HAVE_WINDOW_SYSTEM
23095 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23097 if (cursor_type
== FILLED_BOX_CURSOR
)
23099 /* Using a block cursor on large images can be very annoying.
23100 So use a hollow cursor for "large" images.
23101 If image is not transparent (no mask), also use hollow cursor. */
23102 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23103 if (img
!= NULL
&& IMAGEP (img
->spec
))
23105 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23106 where N = size of default frame font size.
23107 This should cover most of the "tiny" icons people may use. */
23109 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23110 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23111 cursor_type
= HOLLOW_BOX_CURSOR
;
23114 else if (cursor_type
!= NO_CURSOR
)
23116 /* Display current only supports BOX and HOLLOW cursors for images.
23117 So for now, unconditionally use a HOLLOW cursor when cursor is
23118 not a solid box cursor. */
23119 cursor_type
= HOLLOW_BOX_CURSOR
;
23123 return cursor_type
;
23126 /* Cursor is blinked off, so determine how to "toggle" it. */
23128 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23129 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23130 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23132 /* Then see if frame has specified a specific blink off cursor type. */
23133 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23135 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23136 return FRAME_BLINK_OFF_CURSOR (f
);
23140 /* Some people liked having a permanently visible blinking cursor,
23141 while others had very strong opinions against it. So it was
23142 decided to remove it. KFS 2003-09-03 */
23144 /* Finally perform built-in cursor blinking:
23145 filled box <-> hollow box
23146 wide [h]bar <-> narrow [h]bar
23147 narrow [h]bar <-> no cursor
23148 other type <-> no cursor */
23150 if (cursor_type
== FILLED_BOX_CURSOR
)
23151 return HOLLOW_BOX_CURSOR
;
23153 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23156 return cursor_type
;
23164 #ifdef HAVE_WINDOW_SYSTEM
23166 /* Notice when the text cursor of window W has been completely
23167 overwritten by a drawing operation that outputs glyphs in AREA
23168 starting at X0 and ending at X1 in the line starting at Y0 and
23169 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23170 the rest of the line after X0 has been written. Y coordinates
23171 are window-relative. */
23174 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23175 int x0
, int x1
, int y0
, int y1
)
23177 int cx0
, cx1
, cy0
, cy1
;
23178 struct glyph_row
*row
;
23180 if (!w
->phys_cursor_on_p
)
23182 if (area
!= TEXT_AREA
)
23185 if (w
->phys_cursor
.vpos
< 0
23186 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23187 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23188 !(row
->enabled_p
&& row
->displays_text_p
)))
23191 if (row
->cursor_in_fringe_p
)
23193 row
->cursor_in_fringe_p
= 0;
23194 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23195 w
->phys_cursor_on_p
= 0;
23199 cx0
= w
->phys_cursor
.x
;
23200 cx1
= cx0
+ w
->phys_cursor_width
;
23201 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23204 /* The cursor image will be completely removed from the
23205 screen if the output area intersects the cursor area in
23206 y-direction. When we draw in [y0 y1[, and some part of
23207 the cursor is at y < y0, that part must have been drawn
23208 before. When scrolling, the cursor is erased before
23209 actually scrolling, so we don't come here. When not
23210 scrolling, the rows above the old cursor row must have
23211 changed, and in this case these rows must have written
23212 over the cursor image.
23214 Likewise if part of the cursor is below y1, with the
23215 exception of the cursor being in the first blank row at
23216 the buffer and window end because update_text_area
23217 doesn't draw that row. (Except when it does, but
23218 that's handled in update_text_area.) */
23220 cy0
= w
->phys_cursor
.y
;
23221 cy1
= cy0
+ w
->phys_cursor_height
;
23222 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23225 w
->phys_cursor_on_p
= 0;
23228 #endif /* HAVE_WINDOW_SYSTEM */
23231 /************************************************************************
23233 ************************************************************************/
23235 #ifdef HAVE_WINDOW_SYSTEM
23238 Fix the display of area AREA of overlapping row ROW in window W
23239 with respect to the overlapping part OVERLAPS. */
23242 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23243 enum glyph_row_area area
, int overlaps
)
23250 for (i
= 0; i
< row
->used
[area
];)
23252 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23254 int start
= i
, start_x
= x
;
23258 x
+= row
->glyphs
[area
][i
].pixel_width
;
23261 while (i
< row
->used
[area
]
23262 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23264 draw_glyphs (w
, start_x
, row
, area
,
23266 DRAW_NORMAL_TEXT
, overlaps
);
23270 x
+= row
->glyphs
[area
][i
].pixel_width
;
23280 Draw the cursor glyph of window W in glyph row ROW. See the
23281 comment of draw_glyphs for the meaning of HL. */
23284 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23285 enum draw_glyphs_face hl
)
23287 /* If cursor hpos is out of bounds, don't draw garbage. This can
23288 happen in mini-buffer windows when switching between echo area
23289 glyphs and mini-buffer. */
23290 if ((row
->reversed_p
23291 ? (w
->phys_cursor
.hpos
>= 0)
23292 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23294 int on_p
= w
->phys_cursor_on_p
;
23296 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23297 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23299 w
->phys_cursor_on_p
= on_p
;
23301 if (hl
== DRAW_CURSOR
)
23302 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23303 /* When we erase the cursor, and ROW is overlapped by other
23304 rows, make sure that these overlapping parts of other rows
23306 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23308 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23310 if (row
> w
->current_matrix
->rows
23311 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23312 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23313 OVERLAPS_ERASED_CURSOR
);
23315 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23316 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23317 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23318 OVERLAPS_ERASED_CURSOR
);
23325 Erase the image of a cursor of window W from the screen. */
23328 erase_phys_cursor (struct window
*w
)
23330 struct frame
*f
= XFRAME (w
->frame
);
23331 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23332 int hpos
= w
->phys_cursor
.hpos
;
23333 int vpos
= w
->phys_cursor
.vpos
;
23334 int mouse_face_here_p
= 0;
23335 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23336 struct glyph_row
*cursor_row
;
23337 struct glyph
*cursor_glyph
;
23338 enum draw_glyphs_face hl
;
23340 /* No cursor displayed or row invalidated => nothing to do on the
23342 if (w
->phys_cursor_type
== NO_CURSOR
)
23343 goto mark_cursor_off
;
23345 /* VPOS >= active_glyphs->nrows means that window has been resized.
23346 Don't bother to erase the cursor. */
23347 if (vpos
>= active_glyphs
->nrows
)
23348 goto mark_cursor_off
;
23350 /* If row containing cursor is marked invalid, there is nothing we
23352 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23353 if (!cursor_row
->enabled_p
)
23354 goto mark_cursor_off
;
23356 /* If line spacing is > 0, old cursor may only be partially visible in
23357 window after split-window. So adjust visible height. */
23358 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23359 window_text_bottom_y (w
) - cursor_row
->y
);
23361 /* If row is completely invisible, don't attempt to delete a cursor which
23362 isn't there. This can happen if cursor is at top of a window, and
23363 we switch to a buffer with a header line in that window. */
23364 if (cursor_row
->visible_height
<= 0)
23365 goto mark_cursor_off
;
23367 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23368 if (cursor_row
->cursor_in_fringe_p
)
23370 cursor_row
->cursor_in_fringe_p
= 0;
23371 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23372 goto mark_cursor_off
;
23375 /* This can happen when the new row is shorter than the old one.
23376 In this case, either draw_glyphs or clear_end_of_line
23377 should have cleared the cursor. Note that we wouldn't be
23378 able to erase the cursor in this case because we don't have a
23379 cursor glyph at hand. */
23380 if ((cursor_row
->reversed_p
23381 ? (w
->phys_cursor
.hpos
< 0)
23382 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23383 goto mark_cursor_off
;
23385 /* If the cursor is in the mouse face area, redisplay that when
23386 we clear the cursor. */
23387 if (! NILP (dpyinfo
->mouse_face_window
)
23388 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23389 && (vpos
> dpyinfo
->mouse_face_beg_row
23390 || (vpos
== dpyinfo
->mouse_face_beg_row
23391 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23392 && (vpos
< dpyinfo
->mouse_face_end_row
23393 || (vpos
== dpyinfo
->mouse_face_end_row
23394 && hpos
< dpyinfo
->mouse_face_end_col
))
23395 /* Don't redraw the cursor's spot in mouse face if it is at the
23396 end of a line (on a newline). The cursor appears there, but
23397 mouse highlighting does not. */
23398 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23399 mouse_face_here_p
= 1;
23401 /* Maybe clear the display under the cursor. */
23402 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23405 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23408 cursor_glyph
= get_phys_cursor_glyph (w
);
23409 if (cursor_glyph
== NULL
)
23410 goto mark_cursor_off
;
23412 width
= cursor_glyph
->pixel_width
;
23413 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23414 x
= w
->phys_cursor
.x
;
23416 width
-= left_x
- x
;
23417 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23418 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23419 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23422 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23425 /* Erase the cursor by redrawing the character underneath it. */
23426 if (mouse_face_here_p
)
23427 hl
= DRAW_MOUSE_FACE
;
23429 hl
= DRAW_NORMAL_TEXT
;
23430 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23433 w
->phys_cursor_on_p
= 0;
23434 w
->phys_cursor_type
= NO_CURSOR
;
23439 Display or clear cursor of window W. If ON is zero, clear the
23440 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23441 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23444 display_and_set_cursor (struct window
*w
, int on
,
23445 int hpos
, int vpos
, int x
, int y
)
23447 struct frame
*f
= XFRAME (w
->frame
);
23448 int new_cursor_type
;
23449 int new_cursor_width
;
23451 struct glyph_row
*glyph_row
;
23452 struct glyph
*glyph
;
23454 /* This is pointless on invisible frames, and dangerous on garbaged
23455 windows and frames; in the latter case, the frame or window may
23456 be in the midst of changing its size, and x and y may be off the
23458 if (! FRAME_VISIBLE_P (f
)
23459 || FRAME_GARBAGED_P (f
)
23460 || vpos
>= w
->current_matrix
->nrows
23461 || hpos
>= w
->current_matrix
->matrix_w
)
23464 /* If cursor is off and we want it off, return quickly. */
23465 if (!on
&& !w
->phys_cursor_on_p
)
23468 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23469 /* If cursor row is not enabled, we don't really know where to
23470 display the cursor. */
23471 if (!glyph_row
->enabled_p
)
23473 w
->phys_cursor_on_p
= 0;
23478 if (!glyph_row
->exact_window_width_line_p
23479 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23480 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23482 xassert (interrupt_input_blocked
);
23484 /* Set new_cursor_type to the cursor we want to be displayed. */
23485 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23486 &new_cursor_width
, &active_cursor
);
23488 /* If cursor is currently being shown and we don't want it to be or
23489 it is in the wrong place, or the cursor type is not what we want,
23491 if (w
->phys_cursor_on_p
23493 || w
->phys_cursor
.x
!= x
23494 || w
->phys_cursor
.y
!= y
23495 || new_cursor_type
!= w
->phys_cursor_type
23496 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23497 && new_cursor_width
!= w
->phys_cursor_width
)))
23498 erase_phys_cursor (w
);
23500 /* Don't check phys_cursor_on_p here because that flag is only set
23501 to zero in some cases where we know that the cursor has been
23502 completely erased, to avoid the extra work of erasing the cursor
23503 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23504 still not be visible, or it has only been partly erased. */
23507 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23508 w
->phys_cursor_height
= glyph_row
->height
;
23510 /* Set phys_cursor_.* before x_draw_.* is called because some
23511 of them may need the information. */
23512 w
->phys_cursor
.x
= x
;
23513 w
->phys_cursor
.y
= glyph_row
->y
;
23514 w
->phys_cursor
.hpos
= hpos
;
23515 w
->phys_cursor
.vpos
= vpos
;
23518 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23519 new_cursor_type
, new_cursor_width
,
23520 on
, active_cursor
);
23524 /* Switch the display of W's cursor on or off, according to the value
23528 update_window_cursor (struct window
*w
, int on
)
23530 /* Don't update cursor in windows whose frame is in the process
23531 of being deleted. */
23532 if (w
->current_matrix
)
23535 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23536 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23542 /* Call update_window_cursor with parameter ON_P on all leaf windows
23543 in the window tree rooted at W. */
23546 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23550 if (!NILP (w
->hchild
))
23551 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23552 else if (!NILP (w
->vchild
))
23553 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23555 update_window_cursor (w
, on_p
);
23557 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23563 Display the cursor on window W, or clear it, according to ON_P.
23564 Don't change the cursor's position. */
23567 x_update_cursor (struct frame
*f
, int on_p
)
23569 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23574 Clear the cursor of window W to background color, and mark the
23575 cursor as not shown. This is used when the text where the cursor
23576 is about to be rewritten. */
23579 x_clear_cursor (struct window
*w
)
23581 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23582 update_window_cursor (w
, 0);
23587 Display the active region described by mouse_face_* according to DRAW. */
23590 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23592 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23593 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23595 if (/* If window is in the process of being destroyed, don't bother
23597 w
->current_matrix
!= NULL
23598 /* Don't update mouse highlight if hidden */
23599 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23600 /* Recognize when we are called to operate on rows that don't exist
23601 anymore. This can happen when a window is split. */
23602 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23604 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23605 struct glyph_row
*row
, *first
, *last
;
23607 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23608 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23610 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23612 int start_hpos
, end_hpos
, start_x
;
23614 /* For all but the first row, the highlight starts at column 0. */
23617 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23618 start_x
= dpyinfo
->mouse_face_beg_x
;
23627 end_hpos
= dpyinfo
->mouse_face_end_col
;
23630 end_hpos
= row
->used
[TEXT_AREA
];
23631 if (draw
== DRAW_NORMAL_TEXT
)
23632 row
->fill_line_p
= 1; /* Clear to end of line */
23635 if (end_hpos
> start_hpos
)
23637 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23638 start_hpos
, end_hpos
,
23642 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23646 /* When we've written over the cursor, arrange for it to
23647 be displayed again. */
23648 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23651 display_and_set_cursor (w
, 1,
23652 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23653 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23658 /* Change the mouse cursor. */
23659 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23660 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23661 else if (draw
== DRAW_MOUSE_FACE
)
23662 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23664 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23668 Clear out the mouse-highlighted active region.
23669 Redraw it un-highlighted first. Value is non-zero if mouse
23670 face was actually drawn unhighlighted. */
23673 clear_mouse_face (Display_Info
*dpyinfo
)
23677 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23679 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23683 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23684 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23685 dpyinfo
->mouse_face_window
= Qnil
;
23686 dpyinfo
->mouse_face_overlay
= Qnil
;
23692 Non-zero if physical cursor of window W is within mouse face. */
23695 cursor_in_mouse_face_p (struct window
*w
)
23697 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23698 int in_mouse_face
= 0;
23700 if (WINDOWP (dpyinfo
->mouse_face_window
)
23701 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23703 int hpos
= w
->phys_cursor
.hpos
;
23704 int vpos
= w
->phys_cursor
.vpos
;
23706 if (vpos
>= dpyinfo
->mouse_face_beg_row
23707 && vpos
<= dpyinfo
->mouse_face_end_row
23708 && (vpos
> dpyinfo
->mouse_face_beg_row
23709 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23710 && (vpos
< dpyinfo
->mouse_face_end_row
23711 || hpos
< dpyinfo
->mouse_face_end_col
23712 || dpyinfo
->mouse_face_past_end
))
23716 return in_mouse_face
;
23722 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23723 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23724 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23725 for the overlay or run of text properties specifying the mouse
23726 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23727 before-string and after-string that must also be highlighted.
23728 DISPLAY_STRING, if non-nil, is a display string that may cover some
23729 or all of the highlighted text. */
23732 mouse_face_from_buffer_pos (Lisp_Object window
,
23733 Display_Info
*dpyinfo
,
23734 EMACS_INT mouse_charpos
,
23735 EMACS_INT start_charpos
,
23736 EMACS_INT end_charpos
,
23737 Lisp_Object before_string
,
23738 Lisp_Object after_string
,
23739 Lisp_Object display_string
)
23741 struct window
*w
= XWINDOW (window
);
23742 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23743 struct glyph_row
*row
;
23744 struct glyph
*glyph
, *end
;
23748 xassert (NILP (display_string
) || STRINGP (display_string
));
23749 xassert (NILP (before_string
) || STRINGP (before_string
));
23750 xassert (NILP (after_string
) || STRINGP (after_string
));
23752 /* Find the first highlighted glyph. */
23753 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23755 dpyinfo
->mouse_face_beg_col
= 0;
23756 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23757 dpyinfo
->mouse_face_beg_x
= first
->x
;
23758 dpyinfo
->mouse_face_beg_y
= first
->y
;
23762 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23764 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23766 /* If the before-string or display-string contains newlines,
23767 row_containing_pos skips to its last row. Move back. */
23768 if (!NILP (before_string
) || !NILP (display_string
))
23770 struct glyph_row
*prev
;
23771 while ((prev
= row
- 1, prev
>= first
)
23772 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23773 && prev
->used
[TEXT_AREA
] > 0)
23775 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23776 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23777 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23779 || !(EQ (glyph
->object
, before_string
)
23780 || EQ (glyph
->object
, display_string
)))
23786 glyph
= row
->glyphs
[TEXT_AREA
];
23787 end
= glyph
+ row
->used
[TEXT_AREA
];
23789 dpyinfo
->mouse_face_beg_y
= row
->y
;
23790 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23792 /* Skip truncation glyphs at the start of the glyph row. */
23793 if (row
->displays_text_p
)
23795 && INTEGERP (glyph
->object
)
23796 && glyph
->charpos
< 0;
23798 x
+= glyph
->pixel_width
;
23800 /* Scan the glyph row, stopping before BEFORE_STRING or
23801 DISPLAY_STRING or START_CHARPOS. */
23803 && !INTEGERP (glyph
->object
)
23804 && !EQ (glyph
->object
, before_string
)
23805 && !EQ (glyph
->object
, display_string
)
23806 && !(BUFFERP (glyph
->object
)
23807 && glyph
->charpos
>= start_charpos
);
23809 x
+= glyph
->pixel_width
;
23811 dpyinfo
->mouse_face_beg_x
= x
;
23812 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23815 /* Find the last highlighted glyph. */
23816 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23819 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23820 dpyinfo
->mouse_face_past_end
= 1;
23822 else if (!NILP (after_string
))
23824 /* If the after-string has newlines, advance to its last row. */
23825 struct glyph_row
*next
;
23826 struct glyph_row
*last
23827 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23829 for (next
= row
+ 1;
23831 && next
->used
[TEXT_AREA
] > 0
23832 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23837 glyph
= row
->glyphs
[TEXT_AREA
];
23838 end
= glyph
+ row
->used
[TEXT_AREA
];
23840 dpyinfo
->mouse_face_end_y
= row
->y
;
23841 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23843 /* Skip truncation glyphs at the start of the row. */
23844 if (row
->displays_text_p
)
23846 && INTEGERP (glyph
->object
)
23847 && glyph
->charpos
< 0;
23849 x
+= glyph
->pixel_width
;
23851 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23854 && !INTEGERP (glyph
->object
)
23855 && !EQ (glyph
->object
, after_string
)
23856 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23858 x
+= glyph
->pixel_width
;
23860 /* If we found AFTER_STRING, consume it and stop. */
23861 if (EQ (glyph
->object
, after_string
))
23863 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23864 x
+= glyph
->pixel_width
;
23868 /* If there's no after-string, we must check if we overshot,
23869 which might be the case if we stopped after a string glyph.
23870 That glyph may belong to a before-string or display-string
23871 associated with the end position, which must not be
23873 Lisp_Object prev_object
;
23876 while (glyph
> row
->glyphs
[TEXT_AREA
])
23878 prev_object
= (glyph
- 1)->object
;
23879 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23882 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23883 if (pos
&& pos
< end_charpos
)
23886 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23887 && EQ ((glyph
- 1)->object
, prev_object
);
23889 x
-= (glyph
- 1)->pixel_width
;
23893 dpyinfo
->mouse_face_end_x
= x
;
23894 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23895 dpyinfo
->mouse_face_window
= window
;
23896 dpyinfo
->mouse_face_face_id
23897 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23899 !dpyinfo
->mouse_face_hidden
, -1);
23900 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23904 /* Find the position of the glyph for position POS in OBJECT in
23905 window W's current matrix, and return in *X, *Y the pixel
23906 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23908 RIGHT_P non-zero means return the position of the right edge of the
23909 glyph, RIGHT_P zero means return the left edge position.
23911 If no glyph for POS exists in the matrix, return the position of
23912 the glyph with the next smaller position that is in the matrix, if
23913 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23914 exists in the matrix, return the position of the glyph with the
23915 next larger position in OBJECT.
23917 Value is non-zero if a glyph was found. */
23920 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
23921 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
23923 int yb
= window_text_bottom_y (w
);
23924 struct glyph_row
*r
;
23925 struct glyph
*best_glyph
= NULL
;
23926 struct glyph_row
*best_row
= NULL
;
23929 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23930 r
->enabled_p
&& r
->y
< yb
;
23933 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23934 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23937 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23938 if (EQ (g
->object
, object
))
23940 if (g
->charpos
== pos
)
23947 else if (best_glyph
== NULL
23948 || ((eabs (g
->charpos
- pos
)
23949 < eabs (best_glyph
->charpos
- pos
))
23952 : g
->charpos
> pos
)))
23966 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23970 *x
+= best_glyph
->pixel_width
;
23975 *vpos
= best_row
- w
->current_matrix
->rows
;
23978 return best_glyph
!= NULL
;
23982 /* See if position X, Y is within a hot-spot of an image. */
23985 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
23987 if (!CONSP (hot_spot
))
23990 if (EQ (XCAR (hot_spot
), Qrect
))
23992 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23993 Lisp_Object rect
= XCDR (hot_spot
);
23997 if (!CONSP (XCAR (rect
)))
23999 if (!CONSP (XCDR (rect
)))
24001 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24003 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24005 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24007 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24011 else if (EQ (XCAR (hot_spot
), Qcircle
))
24013 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24014 Lisp_Object circ
= XCDR (hot_spot
);
24015 Lisp_Object lr
, lx0
, ly0
;
24017 && CONSP (XCAR (circ
))
24018 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24019 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24020 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24022 double r
= XFLOATINT (lr
);
24023 double dx
= XINT (lx0
) - x
;
24024 double dy
= XINT (ly0
) - y
;
24025 return (dx
* dx
+ dy
* dy
<= r
* r
);
24028 else if (EQ (XCAR (hot_spot
), Qpoly
))
24030 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24031 if (VECTORP (XCDR (hot_spot
)))
24033 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24034 Lisp_Object
*poly
= v
->contents
;
24038 Lisp_Object lx
, ly
;
24041 /* Need an even number of coordinates, and at least 3 edges. */
24042 if (n
< 6 || n
& 1)
24045 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24046 If count is odd, we are inside polygon. Pixels on edges
24047 may or may not be included depending on actual geometry of the
24049 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24050 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24052 x0
= XINT (lx
), y0
= XINT (ly
);
24053 for (i
= 0; i
< n
; i
+= 2)
24055 int x1
= x0
, y1
= y0
;
24056 if ((lx
= poly
[i
], !INTEGERP (lx
))
24057 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24059 x0
= XINT (lx
), y0
= XINT (ly
);
24061 /* Does this segment cross the X line? */
24069 if (y
> y0
&& y
> y1
)
24071 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24081 find_hot_spot (Lisp_Object map
, int x
, int y
)
24083 while (CONSP (map
))
24085 if (CONSP (XCAR (map
))
24086 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24094 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24096 doc
: /* Lookup in image map MAP coordinates X and Y.
24097 An image map is an alist where each element has the format (AREA ID PLIST).
24098 An AREA is specified as either a rectangle, a circle, or a polygon:
24099 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24100 pixel coordinates of the upper left and bottom right corners.
24101 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24102 and the radius of the circle; r may be a float or integer.
24103 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24104 vector describes one corner in the polygon.
24105 Returns the alist element for the first matching AREA in MAP. */)
24106 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24114 return find_hot_spot (map
, XINT (x
), XINT (y
));
24118 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24120 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24122 /* Do not change cursor shape while dragging mouse. */
24123 if (!NILP (do_mouse_tracking
))
24126 if (!NILP (pointer
))
24128 if (EQ (pointer
, Qarrow
))
24129 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24130 else if (EQ (pointer
, Qhand
))
24131 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24132 else if (EQ (pointer
, Qtext
))
24133 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24134 else if (EQ (pointer
, intern ("hdrag")))
24135 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24136 #ifdef HAVE_X_WINDOWS
24137 else if (EQ (pointer
, intern ("vdrag")))
24138 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24140 else if (EQ (pointer
, intern ("hourglass")))
24141 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24142 else if (EQ (pointer
, Qmodeline
))
24143 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24145 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24148 if (cursor
!= No_Cursor
)
24149 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24152 /* Take proper action when mouse has moved to the mode or header line
24153 or marginal area AREA of window W, x-position X and y-position Y.
24154 X is relative to the start of the text display area of W, so the
24155 width of bitmap areas and scroll bars must be subtracted to get a
24156 position relative to the start of the mode line. */
24159 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24160 enum window_part area
)
24162 struct window
*w
= XWINDOW (window
);
24163 struct frame
*f
= XFRAME (w
->frame
);
24164 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24165 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24166 Lisp_Object pointer
= Qnil
;
24167 int charpos
, dx
, dy
, width
, height
;
24168 Lisp_Object string
, object
= Qnil
;
24169 Lisp_Object pos
, help
;
24171 Lisp_Object mouse_face
;
24172 int original_x_pixel
= x
;
24173 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24174 struct glyph_row
*row
;
24176 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24181 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24182 &object
, &dx
, &dy
, &width
, &height
);
24184 row
= (area
== ON_MODE_LINE
24185 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24186 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24189 if (row
->mode_line_p
&& row
->enabled_p
)
24191 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24192 end
= glyph
+ row
->used
[TEXT_AREA
];
24194 for (x0
= original_x_pixel
;
24195 glyph
< end
&& x0
>= glyph
->pixel_width
;
24197 x0
-= glyph
->pixel_width
;
24205 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24206 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24207 &object
, &dx
, &dy
, &width
, &height
);
24212 if (IMAGEP (object
))
24214 Lisp_Object image_map
, hotspot
;
24215 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24217 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24219 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24221 Lisp_Object area_id
, plist
;
24223 area_id
= XCAR (hotspot
);
24224 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24225 If so, we could look for mouse-enter, mouse-leave
24226 properties in PLIST (and do something...). */
24227 hotspot
= XCDR (hotspot
);
24228 if (CONSP (hotspot
)
24229 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24231 pointer
= Fplist_get (plist
, Qpointer
);
24232 if (NILP (pointer
))
24234 help
= Fplist_get (plist
, Qhelp_echo
);
24237 help_echo_string
= help
;
24238 /* Is this correct? ++kfs */
24239 XSETWINDOW (help_echo_window
, w
);
24240 help_echo_object
= w
->buffer
;
24241 help_echo_pos
= charpos
;
24245 if (NILP (pointer
))
24246 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24249 if (STRINGP (string
))
24251 pos
= make_number (charpos
);
24252 /* If we're on a string with `help-echo' text property, arrange
24253 for the help to be displayed. This is done by setting the
24254 global variable help_echo_string to the help string. */
24257 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24260 help_echo_string
= help
;
24261 XSETWINDOW (help_echo_window
, w
);
24262 help_echo_object
= string
;
24263 help_echo_pos
= charpos
;
24267 if (NILP (pointer
))
24268 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24270 /* Change the mouse pointer according to what is under X/Y. */
24271 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24274 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24275 if (!KEYMAPP (map
))
24276 map
= Fget_text_property (pos
, Qkeymap
, string
);
24277 if (!KEYMAPP (map
))
24278 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24281 /* Change the mouse face according to what is under X/Y. */
24282 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24283 if (!NILP (mouse_face
)
24284 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24289 struct glyph
* tmp_glyph
;
24293 int total_pixel_width
;
24298 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24299 Qmouse_face
, string
, Qnil
);
24301 b
= make_number (0);
24303 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24305 e
= make_number (SCHARS (string
));
24307 /* Calculate the position(glyph position: GPOS) of GLYPH in
24308 displayed string. GPOS is different from CHARPOS.
24310 CHARPOS is the position of glyph in internal string
24311 object. A mode line string format has structures which
24312 is converted to a flatten by emacs lisp interpreter.
24313 The internal string is an element of the structures.
24314 The displayed string is the flatten string. */
24316 if (glyph
> row_start_glyph
)
24318 tmp_glyph
= glyph
- 1;
24319 while (tmp_glyph
>= row_start_glyph
24320 && tmp_glyph
->charpos
>= XINT (b
)
24321 && EQ (tmp_glyph
->object
, glyph
->object
))
24328 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24329 displayed string holding GLYPH.
24331 GSEQ_LENGTH is different from SCHARS (STRING).
24332 SCHARS (STRING) returns the length of the internal string. */
24333 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24334 tmp_glyph
->charpos
< XINT (e
);
24335 tmp_glyph
++, gseq_length
++)
24337 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24341 total_pixel_width
= 0;
24342 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24343 total_pixel_width
+= tmp_glyph
->pixel_width
;
24345 /* Pre calculation of re-rendering position */
24347 hpos
= (area
== ON_MODE_LINE
24348 ? (w
->current_matrix
)->nrows
- 1
24351 /* If the re-rendering position is included in the last
24352 re-rendering area, we should do nothing. */
24353 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24354 && dpyinfo
->mouse_face_beg_col
<= vpos
24355 && vpos
< dpyinfo
->mouse_face_end_col
24356 && dpyinfo
->mouse_face_beg_row
== hpos
)
24359 if (clear_mouse_face (dpyinfo
))
24360 cursor
= No_Cursor
;
24362 dpyinfo
->mouse_face_beg_col
= vpos
;
24363 dpyinfo
->mouse_face_beg_row
= hpos
;
24365 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24366 dpyinfo
->mouse_face_beg_y
= 0;
24368 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24369 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24371 dpyinfo
->mouse_face_end_x
= 0;
24372 dpyinfo
->mouse_face_end_y
= 0;
24374 dpyinfo
->mouse_face_past_end
= 0;
24375 dpyinfo
->mouse_face_window
= window
;
24377 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24380 glyph
->face_id
, 1);
24381 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24383 if (NILP (pointer
))
24386 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24387 clear_mouse_face (dpyinfo
);
24389 define_frame_cursor1 (f
, cursor
, pointer
);
24394 Take proper action when the mouse has moved to position X, Y on
24395 frame F as regards highlighting characters that have mouse-face
24396 properties. Also de-highlighting chars where the mouse was before.
24397 X and Y can be negative or out of range. */
24400 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24402 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24403 enum window_part part
;
24404 Lisp_Object window
;
24406 Cursor cursor
= No_Cursor
;
24407 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24410 /* When a menu is active, don't highlight because this looks odd. */
24411 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24412 if (popup_activated ())
24416 if (NILP (Vmouse_highlight
)
24417 || !f
->glyphs_initialized_p
24418 || f
->pointer_invisible
)
24421 dpyinfo
->mouse_face_mouse_x
= x
;
24422 dpyinfo
->mouse_face_mouse_y
= y
;
24423 dpyinfo
->mouse_face_mouse_frame
= f
;
24425 if (dpyinfo
->mouse_face_defer
)
24428 if (gc_in_progress
)
24430 dpyinfo
->mouse_face_deferred_gc
= 1;
24434 /* Which window is that in? */
24435 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24437 /* If we were displaying active text in another window, clear that.
24438 Also clear if we move out of text area in same window. */
24439 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24440 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24441 && !NILP (dpyinfo
->mouse_face_window
)))
24442 clear_mouse_face (dpyinfo
);
24444 /* Not on a window -> return. */
24445 if (!WINDOWP (window
))
24448 /* Reset help_echo_string. It will get recomputed below. */
24449 help_echo_string
= Qnil
;
24451 /* Convert to window-relative pixel coordinates. */
24452 w
= XWINDOW (window
);
24453 frame_to_window_pixel_xy (w
, &x
, &y
);
24455 /* Handle tool-bar window differently since it doesn't display a
24457 if (EQ (window
, f
->tool_bar_window
))
24459 note_tool_bar_highlight (f
, x
, y
);
24463 /* Mouse is on the mode, header line or margin? */
24464 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24465 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24467 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24471 if (part
== ON_VERTICAL_BORDER
)
24473 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24474 help_echo_string
= build_string ("drag-mouse-1: resize");
24476 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24477 || part
== ON_SCROLL_BAR
)
24478 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24480 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24482 /* Are we in a window whose display is up to date?
24483 And verify the buffer's text has not changed. */
24484 b
= XBUFFER (w
->buffer
);
24485 if (part
== ON_TEXT
24486 && EQ (w
->window_end_valid
, w
->buffer
)
24487 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24488 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24490 int hpos
, vpos
, i
, dx
, dy
, area
;
24492 struct glyph
*glyph
;
24493 Lisp_Object object
;
24494 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24495 Lisp_Object
*overlay_vec
= NULL
;
24497 struct buffer
*obuf
;
24498 int obegv
, ozv
, same_region
;
24500 /* Find the glyph under X/Y. */
24501 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24503 /* Look for :pointer property on image. */
24504 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24506 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24507 if (img
!= NULL
&& IMAGEP (img
->spec
))
24509 Lisp_Object image_map
, hotspot
;
24510 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24512 && (hotspot
= find_hot_spot (image_map
,
24513 glyph
->slice
.x
+ dx
,
24514 glyph
->slice
.y
+ dy
),
24516 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24518 Lisp_Object area_id
, plist
;
24520 area_id
= XCAR (hotspot
);
24521 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24522 If so, we could look for mouse-enter, mouse-leave
24523 properties in PLIST (and do something...). */
24524 hotspot
= XCDR (hotspot
);
24525 if (CONSP (hotspot
)
24526 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24528 pointer
= Fplist_get (plist
, Qpointer
);
24529 if (NILP (pointer
))
24531 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24532 if (!NILP (help_echo_string
))
24534 help_echo_window
= window
;
24535 help_echo_object
= glyph
->object
;
24536 help_echo_pos
= glyph
->charpos
;
24540 if (NILP (pointer
))
24541 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24545 /* Clear mouse face if X/Y not over text. */
24547 || area
!= TEXT_AREA
24548 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24550 if (clear_mouse_face (dpyinfo
))
24551 cursor
= No_Cursor
;
24552 if (NILP (pointer
))
24554 if (area
!= TEXT_AREA
)
24555 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24557 pointer
= Vvoid_text_area_pointer
;
24562 pos
= glyph
->charpos
;
24563 object
= glyph
->object
;
24564 if (!STRINGP (object
) && !BUFFERP (object
))
24567 /* If we get an out-of-range value, return now; avoid an error. */
24568 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24571 /* Make the window's buffer temporarily current for
24572 overlays_at and compute_char_face. */
24573 obuf
= current_buffer
;
24574 current_buffer
= b
;
24580 /* Is this char mouse-active or does it have help-echo? */
24581 position
= make_number (pos
);
24583 if (BUFFERP (object
))
24585 /* Put all the overlays we want in a vector in overlay_vec. */
24586 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24587 /* Sort overlays into increasing priority order. */
24588 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24593 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24594 && vpos
>= dpyinfo
->mouse_face_beg_row
24595 && vpos
<= dpyinfo
->mouse_face_end_row
24596 && (vpos
> dpyinfo
->mouse_face_beg_row
24597 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24598 && (vpos
< dpyinfo
->mouse_face_end_row
24599 || hpos
< dpyinfo
->mouse_face_end_col
24600 || dpyinfo
->mouse_face_past_end
));
24603 cursor
= No_Cursor
;
24605 /* Check mouse-face highlighting. */
24607 /* If there exists an overlay with mouse-face overlapping
24608 the one we are currently highlighting, we have to
24609 check if we enter the overlapping overlay, and then
24610 highlight only that. */
24611 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24612 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24614 /* Find the highest priority overlay with a mouse-face. */
24616 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24618 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24619 if (!NILP (mouse_face
))
24620 overlay
= overlay_vec
[i
];
24623 /* If we're highlighting the same overlay as before, there's
24624 no need to do that again. */
24625 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24626 goto check_help_echo
;
24627 dpyinfo
->mouse_face_overlay
= overlay
;
24629 /* Clear the display of the old active region, if any. */
24630 if (clear_mouse_face (dpyinfo
))
24631 cursor
= No_Cursor
;
24633 /* If no overlay applies, get a text property. */
24634 if (NILP (overlay
))
24635 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24637 /* Next, compute the bounds of the mouse highlighting and
24639 if (!NILP (mouse_face
) && STRINGP (object
))
24641 /* The mouse-highlighting comes from a display string
24642 with a mouse-face. */
24646 b
= Fprevious_single_property_change
24647 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24648 e
= Fnext_single_property_change
24649 (position
, Qmouse_face
, object
, Qnil
);
24651 b
= make_number (0);
24653 e
= make_number (SCHARS (object
) - 1);
24655 fast_find_string_pos (w
, XINT (b
), object
,
24656 &dpyinfo
->mouse_face_beg_col
,
24657 &dpyinfo
->mouse_face_beg_row
,
24658 &dpyinfo
->mouse_face_beg_x
,
24659 &dpyinfo
->mouse_face_beg_y
, 0);
24660 fast_find_string_pos (w
, XINT (e
), object
,
24661 &dpyinfo
->mouse_face_end_col
,
24662 &dpyinfo
->mouse_face_end_row
,
24663 &dpyinfo
->mouse_face_end_x
,
24664 &dpyinfo
->mouse_face_end_y
, 1);
24665 dpyinfo
->mouse_face_past_end
= 0;
24666 dpyinfo
->mouse_face_window
= window
;
24667 dpyinfo
->mouse_face_face_id
24668 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24669 glyph
->face_id
, 1);
24670 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24671 cursor
= No_Cursor
;
24675 /* The mouse-highlighting, if any, comes from an overlay
24676 or text property in the buffer. */
24677 Lisp_Object buffer
, display_string
;
24679 if (STRINGP (object
))
24681 /* If we are on a display string with no mouse-face,
24682 check if the text under it has one. */
24683 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24684 int start
= MATRIX_ROW_START_CHARPOS (r
);
24685 pos
= string_buffer_position (w
, object
, start
);
24688 mouse_face
= get_char_property_and_overlay
24689 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24690 buffer
= w
->buffer
;
24691 display_string
= object
;
24697 display_string
= Qnil
;
24700 if (!NILP (mouse_face
))
24702 Lisp_Object before
, after
;
24703 Lisp_Object before_string
, after_string
;
24705 if (NILP (overlay
))
24707 /* Handle the text property case. */
24708 before
= Fprevious_single_property_change
24709 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24710 Fmarker_position (w
->start
));
24711 after
= Fnext_single_property_change
24712 (make_number (pos
), Qmouse_face
, buffer
,
24713 make_number (BUF_Z (XBUFFER (buffer
))
24714 - XFASTINT (w
->window_end_pos
)));
24715 before_string
= after_string
= Qnil
;
24719 /* Handle the overlay case. */
24720 before
= Foverlay_start (overlay
);
24721 after
= Foverlay_end (overlay
);
24722 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24723 after_string
= Foverlay_get (overlay
, Qafter_string
);
24725 if (!STRINGP (before_string
)) before_string
= Qnil
;
24726 if (!STRINGP (after_string
)) after_string
= Qnil
;
24729 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24732 before_string
, after_string
,
24734 cursor
= No_Cursor
;
24741 /* Look for a `help-echo' property. */
24742 if (NILP (help_echo_string
)) {
24743 Lisp_Object help
, overlay
;
24745 /* Check overlays first. */
24746 help
= overlay
= Qnil
;
24747 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24749 overlay
= overlay_vec
[i
];
24750 help
= Foverlay_get (overlay
, Qhelp_echo
);
24755 help_echo_string
= help
;
24756 help_echo_window
= window
;
24757 help_echo_object
= overlay
;
24758 help_echo_pos
= pos
;
24762 Lisp_Object object
= glyph
->object
;
24763 int charpos
= glyph
->charpos
;
24765 /* Try text properties. */
24766 if (STRINGP (object
)
24768 && charpos
< SCHARS (object
))
24770 help
= Fget_text_property (make_number (charpos
),
24771 Qhelp_echo
, object
);
24774 /* If the string itself doesn't specify a help-echo,
24775 see if the buffer text ``under'' it does. */
24776 struct glyph_row
*r
24777 = MATRIX_ROW (w
->current_matrix
, vpos
);
24778 int start
= MATRIX_ROW_START_CHARPOS (r
);
24779 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24782 help
= Fget_char_property (make_number (pos
),
24783 Qhelp_echo
, w
->buffer
);
24787 object
= w
->buffer
;
24792 else if (BUFFERP (object
)
24795 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24800 help_echo_string
= help
;
24801 help_echo_window
= window
;
24802 help_echo_object
= object
;
24803 help_echo_pos
= charpos
;
24808 /* Look for a `pointer' property. */
24809 if (NILP (pointer
))
24811 /* Check overlays first. */
24812 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24813 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24815 if (NILP (pointer
))
24817 Lisp_Object object
= glyph
->object
;
24818 int charpos
= glyph
->charpos
;
24820 /* Try text properties. */
24821 if (STRINGP (object
)
24823 && charpos
< SCHARS (object
))
24825 pointer
= Fget_text_property (make_number (charpos
),
24827 if (NILP (pointer
))
24829 /* If the string itself doesn't specify a pointer,
24830 see if the buffer text ``under'' it does. */
24831 struct glyph_row
*r
24832 = MATRIX_ROW (w
->current_matrix
, vpos
);
24833 int start
= MATRIX_ROW_START_CHARPOS (r
);
24834 EMACS_INT pos
= string_buffer_position (w
, object
,
24837 pointer
= Fget_char_property (make_number (pos
),
24838 Qpointer
, w
->buffer
);
24841 else if (BUFFERP (object
)
24844 pointer
= Fget_text_property (make_number (charpos
),
24851 current_buffer
= obuf
;
24856 define_frame_cursor1 (f
, cursor
, pointer
);
24861 Clear any mouse-face on window W. This function is part of the
24862 redisplay interface, and is called from try_window_id and similar
24863 functions to ensure the mouse-highlight is off. */
24866 x_clear_window_mouse_face (struct window
*w
)
24868 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24869 Lisp_Object window
;
24872 XSETWINDOW (window
, w
);
24873 if (EQ (window
, dpyinfo
->mouse_face_window
))
24874 clear_mouse_face (dpyinfo
);
24880 Just discard the mouse face information for frame F, if any.
24881 This is used when the size of F is changed. */
24884 cancel_mouse_face (struct frame
*f
)
24886 Lisp_Object window
;
24887 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24889 window
= dpyinfo
->mouse_face_window
;
24890 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24892 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24893 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24894 dpyinfo
->mouse_face_window
= Qnil
;
24899 #endif /* HAVE_WINDOW_SYSTEM */
24902 /***********************************************************************
24904 ***********************************************************************/
24906 #ifdef HAVE_WINDOW_SYSTEM
24908 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24909 which intersects rectangle R. R is in window-relative coordinates. */
24912 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
24913 enum glyph_row_area area
)
24915 struct glyph
*first
= row
->glyphs
[area
];
24916 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24917 struct glyph
*last
;
24918 int first_x
, start_x
, x
;
24920 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24921 /* If row extends face to end of line write the whole line. */
24922 draw_glyphs (w
, 0, row
, area
,
24923 0, row
->used
[area
],
24924 DRAW_NORMAL_TEXT
, 0);
24927 /* Set START_X to the window-relative start position for drawing glyphs of
24928 AREA. The first glyph of the text area can be partially visible.
24929 The first glyphs of other areas cannot. */
24930 start_x
= window_box_left_offset (w
, area
);
24932 if (area
== TEXT_AREA
)
24935 /* Find the first glyph that must be redrawn. */
24937 && x
+ first
->pixel_width
< r
->x
)
24939 x
+= first
->pixel_width
;
24943 /* Find the last one. */
24947 && x
< r
->x
+ r
->width
)
24949 x
+= last
->pixel_width
;
24955 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24956 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24957 DRAW_NORMAL_TEXT
, 0);
24962 /* Redraw the parts of the glyph row ROW on window W intersecting
24963 rectangle R. R is in window-relative coordinates. Value is
24964 non-zero if mouse-face was overwritten. */
24967 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
24969 xassert (row
->enabled_p
);
24971 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24972 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24973 0, row
->used
[TEXT_AREA
],
24974 DRAW_NORMAL_TEXT
, 0);
24977 if (row
->used
[LEFT_MARGIN_AREA
])
24978 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24979 if (row
->used
[TEXT_AREA
])
24980 expose_area (w
, row
, r
, TEXT_AREA
);
24981 if (row
->used
[RIGHT_MARGIN_AREA
])
24982 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24983 draw_row_fringe_bitmaps (w
, row
);
24986 return row
->mouse_face_p
;
24990 /* Redraw those parts of glyphs rows during expose event handling that
24991 overlap other rows. Redrawing of an exposed line writes over parts
24992 of lines overlapping that exposed line; this function fixes that.
24994 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24995 row in W's current matrix that is exposed and overlaps other rows.
24996 LAST_OVERLAPPING_ROW is the last such row. */
24999 expose_overlaps (struct window
*w
,
25000 struct glyph_row
*first_overlapping_row
,
25001 struct glyph_row
*last_overlapping_row
,
25004 struct glyph_row
*row
;
25006 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25007 if (row
->overlapping_p
)
25009 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25012 if (row
->used
[LEFT_MARGIN_AREA
])
25013 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25015 if (row
->used
[TEXT_AREA
])
25016 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25018 if (row
->used
[RIGHT_MARGIN_AREA
])
25019 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25025 /* Return non-zero if W's cursor intersects rectangle R. */
25028 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25030 XRectangle cr
, result
;
25031 struct glyph
*cursor_glyph
;
25032 struct glyph_row
*row
;
25034 if (w
->phys_cursor
.vpos
>= 0
25035 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25036 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25038 && row
->cursor_in_fringe_p
)
25040 /* Cursor is in the fringe. */
25041 cr
.x
= window_box_right_offset (w
,
25042 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25043 ? RIGHT_MARGIN_AREA
25046 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25047 cr
.height
= row
->height
;
25048 return x_intersect_rectangles (&cr
, r
, &result
);
25051 cursor_glyph
= get_phys_cursor_glyph (w
);
25054 /* r is relative to W's box, but w->phys_cursor.x is relative
25055 to left edge of W's TEXT area. Adjust it. */
25056 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25057 cr
.y
= w
->phys_cursor
.y
;
25058 cr
.width
= cursor_glyph
->pixel_width
;
25059 cr
.height
= w
->phys_cursor_height
;
25060 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25061 I assume the effect is the same -- and this is portable. */
25062 return x_intersect_rectangles (&cr
, r
, &result
);
25064 /* If we don't understand the format, pretend we're not in the hot-spot. */
25070 Draw a vertical window border to the right of window W if W doesn't
25071 have vertical scroll bars. */
25074 x_draw_vertical_border (struct window
*w
)
25076 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25078 /* We could do better, if we knew what type of scroll-bar the adjacent
25079 windows (on either side) have... But we don't :-(
25080 However, I think this works ok. ++KFS 2003-04-25 */
25082 /* Redraw borders between horizontally adjacent windows. Don't
25083 do it for frames with vertical scroll bars because either the
25084 right scroll bar of a window, or the left scroll bar of its
25085 neighbor will suffice as a border. */
25086 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25089 if (!WINDOW_RIGHTMOST_P (w
)
25090 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25092 int x0
, x1
, y0
, y1
;
25094 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25097 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25100 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25102 else if (!WINDOW_LEFTMOST_P (w
)
25103 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25105 int x0
, x1
, y0
, y1
;
25107 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25110 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25113 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25118 /* Redraw the part of window W intersection rectangle FR. Pixel
25119 coordinates in FR are frame-relative. Call this function with
25120 input blocked. Value is non-zero if the exposure overwrites
25124 expose_window (struct window
*w
, XRectangle
*fr
)
25126 struct frame
*f
= XFRAME (w
->frame
);
25128 int mouse_face_overwritten_p
= 0;
25130 /* If window is not yet fully initialized, do nothing. This can
25131 happen when toolkit scroll bars are used and a window is split.
25132 Reconfiguring the scroll bar will generate an expose for a newly
25134 if (w
->current_matrix
== NULL
)
25137 /* When we're currently updating the window, display and current
25138 matrix usually don't agree. Arrange for a thorough display
25140 if (w
== updated_window
)
25142 SET_FRAME_GARBAGED (f
);
25146 /* Frame-relative pixel rectangle of W. */
25147 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25148 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25149 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25150 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25152 if (x_intersect_rectangles (fr
, &wr
, &r
))
25154 int yb
= window_text_bottom_y (w
);
25155 struct glyph_row
*row
;
25156 int cursor_cleared_p
;
25157 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25159 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25160 r
.x
, r
.y
, r
.width
, r
.height
));
25162 /* Convert to window coordinates. */
25163 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25164 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25166 /* Turn off the cursor. */
25167 if (!w
->pseudo_window_p
25168 && phys_cursor_in_rect_p (w
, &r
))
25170 x_clear_cursor (w
);
25171 cursor_cleared_p
= 1;
25174 cursor_cleared_p
= 0;
25176 /* Update lines intersecting rectangle R. */
25177 first_overlapping_row
= last_overlapping_row
= NULL
;
25178 for (row
= w
->current_matrix
->rows
;
25183 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25185 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25186 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25187 || (r
.y
>= y0
&& r
.y
< y1
)
25188 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25190 /* A header line may be overlapping, but there is no need
25191 to fix overlapping areas for them. KFS 2005-02-12 */
25192 if (row
->overlapping_p
&& !row
->mode_line_p
)
25194 if (first_overlapping_row
== NULL
)
25195 first_overlapping_row
= row
;
25196 last_overlapping_row
= row
;
25200 if (expose_line (w
, row
, &r
))
25201 mouse_face_overwritten_p
= 1;
25204 else if (row
->overlapping_p
)
25206 /* We must redraw a row overlapping the exposed area. */
25208 ? y0
+ row
->phys_height
> r
.y
25209 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25211 if (first_overlapping_row
== NULL
)
25212 first_overlapping_row
= row
;
25213 last_overlapping_row
= row
;
25221 /* Display the mode line if there is one. */
25222 if (WINDOW_WANTS_MODELINE_P (w
)
25223 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25225 && row
->y
< r
.y
+ r
.height
)
25227 if (expose_line (w
, row
, &r
))
25228 mouse_face_overwritten_p
= 1;
25231 if (!w
->pseudo_window_p
)
25233 /* Fix the display of overlapping rows. */
25234 if (first_overlapping_row
)
25235 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25238 /* Draw border between windows. */
25239 x_draw_vertical_border (w
);
25241 /* Turn the cursor on again. */
25242 if (cursor_cleared_p
)
25243 update_window_cursor (w
, 1);
25247 return mouse_face_overwritten_p
;
25252 /* Redraw (parts) of all windows in the window tree rooted at W that
25253 intersect R. R contains frame pixel coordinates. Value is
25254 non-zero if the exposure overwrites mouse-face. */
25257 expose_window_tree (struct window
*w
, XRectangle
*r
)
25259 struct frame
*f
= XFRAME (w
->frame
);
25260 int mouse_face_overwritten_p
= 0;
25262 while (w
&& !FRAME_GARBAGED_P (f
))
25264 if (!NILP (w
->hchild
))
25265 mouse_face_overwritten_p
25266 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25267 else if (!NILP (w
->vchild
))
25268 mouse_face_overwritten_p
25269 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25271 mouse_face_overwritten_p
|= expose_window (w
, r
);
25273 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25276 return mouse_face_overwritten_p
;
25281 Redisplay an exposed area of frame F. X and Y are the upper-left
25282 corner of the exposed rectangle. W and H are width and height of
25283 the exposed area. All are pixel values. W or H zero means redraw
25284 the entire frame. */
25287 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25290 int mouse_face_overwritten_p
= 0;
25292 TRACE ((stderr
, "expose_frame "));
25294 /* No need to redraw if frame will be redrawn soon. */
25295 if (FRAME_GARBAGED_P (f
))
25297 TRACE ((stderr
, " garbaged\n"));
25301 /* If basic faces haven't been realized yet, there is no point in
25302 trying to redraw anything. This can happen when we get an expose
25303 event while Emacs is starting, e.g. by moving another window. */
25304 if (FRAME_FACE_CACHE (f
) == NULL
25305 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25307 TRACE ((stderr
, " no faces\n"));
25311 if (w
== 0 || h
== 0)
25314 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25315 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25325 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25326 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25328 if (WINDOWP (f
->tool_bar_window
))
25329 mouse_face_overwritten_p
25330 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25332 #ifdef HAVE_X_WINDOWS
25334 #ifndef USE_X_TOOLKIT
25335 if (WINDOWP (f
->menu_bar_window
))
25336 mouse_face_overwritten_p
25337 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25338 #endif /* not USE_X_TOOLKIT */
25342 /* Some window managers support a focus-follows-mouse style with
25343 delayed raising of frames. Imagine a partially obscured frame,
25344 and moving the mouse into partially obscured mouse-face on that
25345 frame. The visible part of the mouse-face will be highlighted,
25346 then the WM raises the obscured frame. With at least one WM, KDE
25347 2.1, Emacs is not getting any event for the raising of the frame
25348 (even tried with SubstructureRedirectMask), only Expose events.
25349 These expose events will draw text normally, i.e. not
25350 highlighted. Which means we must redo the highlight here.
25351 Subsume it under ``we love X''. --gerd 2001-08-15 */
25352 /* Included in Windows version because Windows most likely does not
25353 do the right thing if any third party tool offers
25354 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25355 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25357 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25358 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25360 int x
= dpyinfo
->mouse_face_mouse_x
;
25361 int y
= dpyinfo
->mouse_face_mouse_y
;
25362 clear_mouse_face (dpyinfo
);
25363 note_mouse_highlight (f
, x
, y
);
25370 Determine the intersection of two rectangles R1 and R2. Return
25371 the intersection in *RESULT. Value is non-zero if RESULT is not
25375 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25377 XRectangle
*left
, *right
;
25378 XRectangle
*upper
, *lower
;
25379 int intersection_p
= 0;
25381 /* Rearrange so that R1 is the left-most rectangle. */
25383 left
= r1
, right
= r2
;
25385 left
= r2
, right
= r1
;
25387 /* X0 of the intersection is right.x0, if this is inside R1,
25388 otherwise there is no intersection. */
25389 if (right
->x
<= left
->x
+ left
->width
)
25391 result
->x
= right
->x
;
25393 /* The right end of the intersection is the minimum of the
25394 the right ends of left and right. */
25395 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25398 /* Same game for Y. */
25400 upper
= r1
, lower
= r2
;
25402 upper
= r2
, lower
= r1
;
25404 /* The upper end of the intersection is lower.y0, if this is inside
25405 of upper. Otherwise, there is no intersection. */
25406 if (lower
->y
<= upper
->y
+ upper
->height
)
25408 result
->y
= lower
->y
;
25410 /* The lower end of the intersection is the minimum of the lower
25411 ends of upper and lower. */
25412 result
->height
= (min (lower
->y
+ lower
->height
,
25413 upper
->y
+ upper
->height
)
25415 intersection_p
= 1;
25419 return intersection_p
;
25422 #endif /* HAVE_WINDOW_SYSTEM */
25425 /***********************************************************************
25427 ***********************************************************************/
25430 syms_of_xdisp (void)
25432 Vwith_echo_area_save_vector
= Qnil
;
25433 staticpro (&Vwith_echo_area_save_vector
);
25435 Vmessage_stack
= Qnil
;
25436 staticpro (&Vmessage_stack
);
25438 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25439 staticpro (&Qinhibit_redisplay
);
25441 message_dolog_marker1
= Fmake_marker ();
25442 staticpro (&message_dolog_marker1
);
25443 message_dolog_marker2
= Fmake_marker ();
25444 staticpro (&message_dolog_marker2
);
25445 message_dolog_marker3
= Fmake_marker ();
25446 staticpro (&message_dolog_marker3
);
25449 defsubr (&Sdump_frame_glyph_matrix
);
25450 defsubr (&Sdump_glyph_matrix
);
25451 defsubr (&Sdump_glyph_row
);
25452 defsubr (&Sdump_tool_bar_row
);
25453 defsubr (&Strace_redisplay
);
25454 defsubr (&Strace_to_stderr
);
25456 #ifdef HAVE_WINDOW_SYSTEM
25457 defsubr (&Stool_bar_lines_needed
);
25458 defsubr (&Slookup_image_map
);
25460 defsubr (&Sformat_mode_line
);
25461 defsubr (&Sinvisible_p
);
25462 defsubr (&Scurrent_bidi_paragraph_direction
);
25464 staticpro (&Qmenu_bar_update_hook
);
25465 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25467 staticpro (&Qoverriding_terminal_local_map
);
25468 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25470 staticpro (&Qoverriding_local_map
);
25471 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25473 staticpro (&Qwindow_scroll_functions
);
25474 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25476 staticpro (&Qwindow_text_change_functions
);
25477 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25479 staticpro (&Qredisplay_end_trigger_functions
);
25480 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25482 staticpro (&Qinhibit_point_motion_hooks
);
25483 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25485 Qeval
= intern_c_string ("eval");
25486 staticpro (&Qeval
);
25488 QCdata
= intern_c_string (":data");
25489 staticpro (&QCdata
);
25490 Qdisplay
= intern_c_string ("display");
25491 staticpro (&Qdisplay
);
25492 Qspace_width
= intern_c_string ("space-width");
25493 staticpro (&Qspace_width
);
25494 Qraise
= intern_c_string ("raise");
25495 staticpro (&Qraise
);
25496 Qslice
= intern_c_string ("slice");
25497 staticpro (&Qslice
);
25498 Qspace
= intern_c_string ("space");
25499 staticpro (&Qspace
);
25500 Qmargin
= intern_c_string ("margin");
25501 staticpro (&Qmargin
);
25502 Qpointer
= intern_c_string ("pointer");
25503 staticpro (&Qpointer
);
25504 Qleft_margin
= intern_c_string ("left-margin");
25505 staticpro (&Qleft_margin
);
25506 Qright_margin
= intern_c_string ("right-margin");
25507 staticpro (&Qright_margin
);
25508 Qcenter
= intern_c_string ("center");
25509 staticpro (&Qcenter
);
25510 Qline_height
= intern_c_string ("line-height");
25511 staticpro (&Qline_height
);
25512 QCalign_to
= intern_c_string (":align-to");
25513 staticpro (&QCalign_to
);
25514 QCrelative_width
= intern_c_string (":relative-width");
25515 staticpro (&QCrelative_width
);
25516 QCrelative_height
= intern_c_string (":relative-height");
25517 staticpro (&QCrelative_height
);
25518 QCeval
= intern_c_string (":eval");
25519 staticpro (&QCeval
);
25520 QCpropertize
= intern_c_string (":propertize");
25521 staticpro (&QCpropertize
);
25522 QCfile
= intern_c_string (":file");
25523 staticpro (&QCfile
);
25524 Qfontified
= intern_c_string ("fontified");
25525 staticpro (&Qfontified
);
25526 Qfontification_functions
= intern_c_string ("fontification-functions");
25527 staticpro (&Qfontification_functions
);
25528 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25529 staticpro (&Qtrailing_whitespace
);
25530 Qescape_glyph
= intern_c_string ("escape-glyph");
25531 staticpro (&Qescape_glyph
);
25532 Qnobreak_space
= intern_c_string ("nobreak-space");
25533 staticpro (&Qnobreak_space
);
25534 Qimage
= intern_c_string ("image");
25535 staticpro (&Qimage
);
25536 Qtext
= intern_c_string ("text");
25537 staticpro (&Qtext
);
25538 Qboth
= intern_c_string ("both");
25539 staticpro (&Qboth
);
25540 Qboth_horiz
= intern_c_string ("both-horiz");
25541 staticpro (&Qboth_horiz
);
25542 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
25543 staticpro (&Qtext_image_horiz
);
25544 QCmap
= intern_c_string (":map");
25545 staticpro (&QCmap
);
25546 QCpointer
= intern_c_string (":pointer");
25547 staticpro (&QCpointer
);
25548 Qrect
= intern_c_string ("rect");
25549 staticpro (&Qrect
);
25550 Qcircle
= intern_c_string ("circle");
25551 staticpro (&Qcircle
);
25552 Qpoly
= intern_c_string ("poly");
25553 staticpro (&Qpoly
);
25554 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25555 staticpro (&Qmessage_truncate_lines
);
25556 Qgrow_only
= intern_c_string ("grow-only");
25557 staticpro (&Qgrow_only
);
25558 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25559 staticpro (&Qinhibit_menubar_update
);
25560 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25561 staticpro (&Qinhibit_eval_during_redisplay
);
25562 Qposition
= intern_c_string ("position");
25563 staticpro (&Qposition
);
25564 Qbuffer_position
= intern_c_string ("buffer-position");
25565 staticpro (&Qbuffer_position
);
25566 Qobject
= intern_c_string ("object");
25567 staticpro (&Qobject
);
25568 Qbar
= intern_c_string ("bar");
25570 Qhbar
= intern_c_string ("hbar");
25571 staticpro (&Qhbar
);
25572 Qbox
= intern_c_string ("box");
25574 Qhollow
= intern_c_string ("hollow");
25575 staticpro (&Qhollow
);
25576 Qhand
= intern_c_string ("hand");
25577 staticpro (&Qhand
);
25578 Qarrow
= intern_c_string ("arrow");
25579 staticpro (&Qarrow
);
25580 Qtext
= intern_c_string ("text");
25581 staticpro (&Qtext
);
25582 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25583 staticpro (&Qrisky_local_variable
);
25584 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25585 staticpro (&Qinhibit_free_realized_faces
);
25587 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25588 Fcons (intern_c_string ("void-variable"), Qnil
)),
25590 staticpro (&list_of_error
);
25592 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25593 staticpro (&Qlast_arrow_position
);
25594 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25595 staticpro (&Qlast_arrow_string
);
25597 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25598 staticpro (&Qoverlay_arrow_string
);
25599 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25600 staticpro (&Qoverlay_arrow_bitmap
);
25602 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25603 staticpro (&echo_buffer
[0]);
25604 staticpro (&echo_buffer
[1]);
25606 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25607 staticpro (&echo_area_buffer
[0]);
25608 staticpro (&echo_area_buffer
[1]);
25610 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25611 staticpro (&Vmessages_buffer_name
);
25613 mode_line_proptrans_alist
= Qnil
;
25614 staticpro (&mode_line_proptrans_alist
);
25615 mode_line_string_list
= Qnil
;
25616 staticpro (&mode_line_string_list
);
25617 mode_line_string_face
= Qnil
;
25618 staticpro (&mode_line_string_face
);
25619 mode_line_string_face_prop
= Qnil
;
25620 staticpro (&mode_line_string_face_prop
);
25621 Vmode_line_unwind_vector
= Qnil
;
25622 staticpro (&Vmode_line_unwind_vector
);
25624 help_echo_string
= Qnil
;
25625 staticpro (&help_echo_string
);
25626 help_echo_object
= Qnil
;
25627 staticpro (&help_echo_object
);
25628 help_echo_window
= Qnil
;
25629 staticpro (&help_echo_window
);
25630 previous_help_echo_string
= Qnil
;
25631 staticpro (&previous_help_echo_string
);
25632 help_echo_pos
= -1;
25634 Qright_to_left
= intern_c_string ("right-to-left");
25635 staticpro (&Qright_to_left
);
25636 Qleft_to_right
= intern_c_string ("left-to-right");
25637 staticpro (&Qleft_to_right
);
25639 #ifdef HAVE_WINDOW_SYSTEM
25640 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25641 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25642 For example, if a block cursor is over a tab, it will be drawn as
25643 wide as that tab on the display. */);
25644 x_stretch_cursor_p
= 0;
25647 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25648 doc
: /* *Non-nil means highlight trailing whitespace.
25649 The face used for trailing whitespace is `trailing-whitespace'. */);
25650 Vshow_trailing_whitespace
= Qnil
;
25652 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25653 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25654 A value of t means highlight the character itself (for nobreak space,
25655 use face `nobreak-space').
25656 A value of nil means no highlighting.
25657 Other values mean display the escape glyph followed by an ordinary
25658 space or ordinary hyphen. */);
25659 Vnobreak_char_display
= Qt
;
25661 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25662 doc
: /* *The pointer shape to show in void text areas.
25663 A value of nil means to show the text pointer. Other options are `arrow',
25664 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25665 Vvoid_text_area_pointer
= Qarrow
;
25667 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25668 doc
: /* Non-nil means don't actually do any redisplay.
25669 This is used for internal purposes. */);
25670 Vinhibit_redisplay
= Qnil
;
25672 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25673 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25674 Vglobal_mode_string
= Qnil
;
25676 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25677 doc
: /* Marker for where to display an arrow on top of the buffer text.
25678 This must be the beginning of a line in order to work.
25679 See also `overlay-arrow-string'. */);
25680 Voverlay_arrow_position
= Qnil
;
25682 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25683 doc
: /* String to display as an arrow in non-window frames.
25684 See also `overlay-arrow-position'. */);
25685 Voverlay_arrow_string
= make_pure_c_string ("=>");
25687 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25688 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25689 The symbols on this list are examined during redisplay to determine
25690 where to display overlay arrows. */);
25691 Voverlay_arrow_variable_list
25692 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25694 DEFVAR_INT ("scroll-step", &scroll_step
,
25695 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25696 If that fails to bring point back on frame, point is centered instead.
25697 If this is zero, point is always centered after it moves off frame.
25698 If you want scrolling to always be a line at a time, you should set
25699 `scroll-conservatively' to a large value rather than set this to 1. */);
25701 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25702 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25703 If point moves off-screen, redisplay will scroll by up to
25704 `scroll-conservatively' lines in order to bring point just barely
25705 onto the screen again. If that cannot be done, then redisplay
25706 recenters point as usual.
25708 A value of zero means always recenter point if it moves off screen. */);
25709 scroll_conservatively
= 0;
25711 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25712 doc
: /* *Number of lines of margin at the top and bottom of a window.
25713 Recenter the window whenever point gets within this many lines
25714 of the top or bottom of the window. */);
25717 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25718 doc
: /* Pixels per inch value for non-window system displays.
25719 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25720 Vdisplay_pixels_per_inch
= make_float (72.0);
25723 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25726 DEFVAR_LISP ("truncate-partial-width-windows",
25727 &Vtruncate_partial_width_windows
,
25728 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25729 For an integer value, truncate lines in each window narrower than the
25730 full frame width, provided the window width is less than that integer;
25731 otherwise, respect the value of `truncate-lines'.
25733 For any other non-nil value, truncate lines in all windows that do
25734 not span the full frame width.
25736 A value of nil means to respect the value of `truncate-lines'.
25738 If `word-wrap' is enabled, you might want to reduce this. */);
25739 Vtruncate_partial_width_windows
= make_number (50);
25741 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25742 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25743 Any other value means to use the appropriate face, `mode-line',
25744 `header-line', or `menu' respectively. */);
25745 mode_line_inverse_video
= 1;
25747 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25748 doc
: /* *Maximum buffer size for which line number should be displayed.
25749 If the buffer is bigger than this, the line number does not appear
25750 in the mode line. A value of nil means no limit. */);
25751 Vline_number_display_limit
= Qnil
;
25753 DEFVAR_INT ("line-number-display-limit-width",
25754 &line_number_display_limit_width
,
25755 doc
: /* *Maximum line width (in characters) for line number display.
25756 If the average length of the lines near point is bigger than this, then the
25757 line number may be omitted from the mode line. */);
25758 line_number_display_limit_width
= 200;
25760 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25761 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25762 highlight_nonselected_windows
= 0;
25764 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25765 doc
: /* Non-nil if more than one frame is visible on this display.
25766 Minibuffer-only frames don't count, but iconified frames do.
25767 This variable is not guaranteed to be accurate except while processing
25768 `frame-title-format' and `icon-title-format'. */);
25770 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25771 doc
: /* Template for displaying the title bar of visible frames.
25772 \(Assuming the window manager supports this feature.)
25774 This variable has the same structure as `mode-line-format', except that
25775 the %c and %l constructs are ignored. It is used only on frames for
25776 which no explicit name has been set \(see `modify-frame-parameters'). */);
25778 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25779 doc
: /* Template for displaying the title bar of an iconified frame.
25780 \(Assuming the window manager supports this feature.)
25781 This variable has the same structure as `mode-line-format' (which see),
25782 and is used only on frames for which no explicit name has been set
25783 \(see `modify-frame-parameters'). */);
25785 = Vframe_title_format
25786 = pure_cons (intern_c_string ("multiple-frames"),
25787 pure_cons (make_pure_c_string ("%b"),
25788 pure_cons (pure_cons (empty_unibyte_string
,
25789 pure_cons (intern_c_string ("invocation-name"),
25790 pure_cons (make_pure_c_string ("@"),
25791 pure_cons (intern_c_string ("system-name"),
25795 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25796 doc
: /* Maximum number of lines to keep in the message log buffer.
25797 If nil, disable message logging. If t, log messages but don't truncate
25798 the buffer when it becomes large. */);
25799 Vmessage_log_max
= make_number (100);
25801 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25802 doc
: /* Functions called before redisplay, if window sizes have changed.
25803 The value should be a list of functions that take one argument.
25804 Just before redisplay, for each frame, if any of its windows have changed
25805 size since the last redisplay, or have been split or deleted,
25806 all the functions in the list are called, with the frame as argument. */);
25807 Vwindow_size_change_functions
= Qnil
;
25809 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25810 doc
: /* List of functions to call before redisplaying a window with scrolling.
25811 Each function is called with two arguments, the window and its new
25812 display-start position. Note that these functions are also called by
25813 `set-window-buffer'. Also note that the value of `window-end' is not
25814 valid when these functions are called. */);
25815 Vwindow_scroll_functions
= Qnil
;
25817 DEFVAR_LISP ("window-text-change-functions",
25818 &Vwindow_text_change_functions
,
25819 doc
: /* Functions to call in redisplay when text in the window might change. */);
25820 Vwindow_text_change_functions
= Qnil
;
25822 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25823 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25824 Each function is called with two arguments, the window and the end trigger value.
25825 See `set-window-redisplay-end-trigger'. */);
25826 Vredisplay_end_trigger_functions
= Qnil
;
25828 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25829 doc
: /* *Non-nil means autoselect window with mouse pointer.
25830 If nil, do not autoselect windows.
25831 A positive number means delay autoselection by that many seconds: a
25832 window is autoselected only after the mouse has remained in that
25833 window for the duration of the delay.
25834 A negative number has a similar effect, but causes windows to be
25835 autoselected only after the mouse has stopped moving. \(Because of
25836 the way Emacs compares mouse events, you will occasionally wait twice
25837 that time before the window gets selected.\)
25838 Any other value means to autoselect window instantaneously when the
25839 mouse pointer enters it.
25841 Autoselection selects the minibuffer only if it is active, and never
25842 unselects the minibuffer if it is active.
25844 When customizing this variable make sure that the actual value of
25845 `focus-follows-mouse' matches the behavior of your window manager. */);
25846 Vmouse_autoselect_window
= Qnil
;
25848 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25849 doc
: /* *Non-nil means automatically resize tool-bars.
25850 This dynamically changes the tool-bar's height to the minimum height
25851 that is needed to make all tool-bar items visible.
25852 If value is `grow-only', the tool-bar's height is only increased
25853 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25854 Vauto_resize_tool_bars
= Qt
;
25856 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25857 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25858 auto_raise_tool_bar_buttons_p
= 1;
25860 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25861 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25862 make_cursor_line_fully_visible_p
= 1;
25864 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25865 doc
: /* *Border below tool-bar in pixels.
25866 If an integer, use it as the height of the border.
25867 If it is one of `internal-border-width' or `border-width', use the
25868 value of the corresponding frame parameter.
25869 Otherwise, no border is added below the tool-bar. */);
25870 Vtool_bar_border
= Qinternal_border_width
;
25872 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25873 doc
: /* *Margin around tool-bar buttons in pixels.
25874 If an integer, use that for both horizontal and vertical margins.
25875 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25876 HORZ specifying the horizontal margin, and VERT specifying the
25877 vertical margin. */);
25878 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25880 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25881 doc
: /* *Relief thickness of tool-bar buttons. */);
25882 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25884 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25885 doc
: /* *Tool bar style to use.
25887 image - show images only
25888 text - show text only
25889 both - show both, text below image
25890 both-horiz - show text to the right of the image
25891 text-image-horiz - show text to the left of the image
25892 any other - use system default or image if no system default. */);
25893 Vtool_bar_style
= Qnil
;
25895 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25896 doc
: /* *Maximum number of characters a label can have to be shown.
25897 The tool bar style must also show labels for this to have any effect, see
25898 `tool-bar-style'. */);
25899 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
25901 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25902 doc
: /* List of functions to call to fontify regions of text.
25903 Each function is called with one argument POS. Functions must
25904 fontify a region starting at POS in the current buffer, and give
25905 fontified regions the property `fontified'. */);
25906 Vfontification_functions
= Qnil
;
25907 Fmake_variable_buffer_local (Qfontification_functions
);
25909 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25910 &unibyte_display_via_language_environment
,
25911 doc
: /* *Non-nil means display unibyte text according to language environment.
25912 Specifically, this means that raw bytes in the range 160-255 decimal
25913 are displayed by converting them to the equivalent multibyte characters
25914 according to the current language environment. As a result, they are
25915 displayed according to the current fontset.
25917 Note that this variable affects only how these bytes are displayed,
25918 but does not change the fact they are interpreted as raw bytes. */);
25919 unibyte_display_via_language_environment
= 0;
25921 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25922 doc
: /* *Maximum height for resizing mini-windows.
25923 If a float, it specifies a fraction of the mini-window frame's height.
25924 If an integer, it specifies a number of lines. */);
25925 Vmax_mini_window_height
= make_float (0.25);
25927 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25928 doc
: /* *How to resize mini-windows.
25929 A value of nil means don't automatically resize mini-windows.
25930 A value of t means resize them to fit the text displayed in them.
25931 A value of `grow-only', the default, means let mini-windows grow
25932 only, until their display becomes empty, at which point the windows
25933 go back to their normal size. */);
25934 Vresize_mini_windows
= Qgrow_only
;
25936 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25937 doc
: /* Alist specifying how to blink the cursor off.
25938 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25939 `cursor-type' frame-parameter or variable equals ON-STATE,
25940 comparing using `equal', Emacs uses OFF-STATE to specify
25941 how to blink it off. ON-STATE and OFF-STATE are values for
25942 the `cursor-type' frame parameter.
25944 If a frame's ON-STATE has no entry in this list,
25945 the frame's other specifications determine how to blink the cursor off. */);
25946 Vblink_cursor_alist
= Qnil
;
25948 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25949 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25950 automatic_hscrolling_p
= 1;
25951 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25952 staticpro (&Qauto_hscroll_mode
);
25954 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25955 doc
: /* *How many columns away from the window edge point is allowed to get
25956 before automatic hscrolling will horizontally scroll the window. */);
25957 hscroll_margin
= 5;
25959 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25960 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25961 When point is less than `hscroll-margin' columns from the window
25962 edge, automatic hscrolling will scroll the window by the amount of columns
25963 determined by this variable. If its value is a positive integer, scroll that
25964 many columns. If it's a positive floating-point number, it specifies the
25965 fraction of the window's width to scroll. If it's nil or zero, point will be
25966 centered horizontally after the scroll. Any other value, including negative
25967 numbers, are treated as if the value were zero.
25969 Automatic hscrolling always moves point outside the scroll margin, so if
25970 point was more than scroll step columns inside the margin, the window will
25971 scroll more than the value given by the scroll step.
25973 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25974 and `scroll-right' overrides this variable's effect. */);
25975 Vhscroll_step
= make_number (0);
25977 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25978 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25979 Bind this around calls to `message' to let it take effect. */);
25980 message_truncate_lines
= 0;
25982 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25983 doc
: /* Normal hook run to update the menu bar definitions.
25984 Redisplay runs this hook before it redisplays the menu bar.
25985 This is used to update submenus such as Buffers,
25986 whose contents depend on various data. */);
25987 Vmenu_bar_update_hook
= Qnil
;
25989 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25990 doc
: /* Frame for which we are updating a menu.
25991 The enable predicate for a menu binding should check this variable. */);
25992 Vmenu_updating_frame
= Qnil
;
25994 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25995 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25996 inhibit_menubar_update
= 0;
25998 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25999 doc
: /* Prefix prepended to all continuation lines at display time.
26000 The value may be a string, an image, or a stretch-glyph; it is
26001 interpreted in the same way as the value of a `display' text property.
26003 This variable is overridden by any `wrap-prefix' text or overlay
26006 To add a prefix to non-continuation lines, use `line-prefix'. */);
26007 Vwrap_prefix
= Qnil
;
26008 staticpro (&Qwrap_prefix
);
26009 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26010 Fmake_variable_buffer_local (Qwrap_prefix
);
26012 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26013 doc
: /* Prefix prepended to all non-continuation lines at display time.
26014 The value may be a string, an image, or a stretch-glyph; it is
26015 interpreted in the same way as the value of a `display' text property.
26017 This variable is overridden by any `line-prefix' text or overlay
26020 To add a prefix to continuation lines, use `wrap-prefix'. */);
26021 Vline_prefix
= Qnil
;
26022 staticpro (&Qline_prefix
);
26023 Qline_prefix
= intern_c_string ("line-prefix");
26024 Fmake_variable_buffer_local (Qline_prefix
);
26026 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26027 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26028 inhibit_eval_during_redisplay
= 0;
26030 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26031 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26032 inhibit_free_realized_faces
= 0;
26035 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26036 doc
: /* Inhibit try_window_id display optimization. */);
26037 inhibit_try_window_id
= 0;
26039 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26040 doc
: /* Inhibit try_window_reusing display optimization. */);
26041 inhibit_try_window_reusing
= 0;
26043 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26044 doc
: /* Inhibit try_cursor_movement display optimization. */);
26045 inhibit_try_cursor_movement
= 0;
26046 #endif /* GLYPH_DEBUG */
26048 DEFVAR_INT ("overline-margin", &overline_margin
,
26049 doc
: /* *Space between overline and text, in pixels.
26050 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26051 margin to the caracter height. */);
26052 overline_margin
= 2;
26054 DEFVAR_INT ("underline-minimum-offset",
26055 &underline_minimum_offset
,
26056 doc
: /* Minimum distance between baseline and underline.
26057 This can improve legibility of underlined text at small font sizes,
26058 particularly when using variable `x-use-underline-position-properties'
26059 with fonts that specify an UNDERLINE_POSITION relatively close to the
26060 baseline. The default value is 1. */);
26061 underline_minimum_offset
= 1;
26063 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26064 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26065 display_hourglass_p
= 1;
26067 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26068 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26069 Value must be an integer or float. */);
26070 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26072 hourglass_atimer
= NULL
;
26073 hourglass_shown_p
= 0;
26077 /* Initialize this module when Emacs starts. */
26082 Lisp_Object root_window
;
26083 struct window
*mini_w
;
26085 current_header_line_height
= current_mode_line_height
= -1;
26087 CHARPOS (this_line_start_pos
) = 0;
26089 mini_w
= XWINDOW (minibuf_window
);
26090 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26092 if (!noninteractive
)
26094 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26097 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26098 set_window_height (root_window
,
26099 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26101 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26102 set_window_height (minibuf_window
, 1, 0);
26104 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26105 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26107 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26108 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26109 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26111 /* The default ellipsis glyphs `...'. */
26112 for (i
= 0; i
< 3; ++i
)
26113 default_invis_vector
[i
] = make_number ('.');
26117 /* Allocate the buffer for frame titles.
26118 Also used for `format-mode-line'. */
26120 mode_line_noprop_buf
= (char *) xmalloc (size
);
26121 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26122 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26123 mode_line_target
= MODE_LINE_DISPLAY
;
26126 help_echo_showing_p
= 0;
26129 /* Since w32 does not support atimers, it defines its own implementation of
26130 the following three functions in w32fns.c. */
26133 /* Platform-independent portion of hourglass implementation. */
26135 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26137 hourglass_started (void)
26139 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26142 /* Cancel a currently active hourglass timer, and start a new one. */
26144 start_hourglass (void)
26146 #if defined (HAVE_WINDOW_SYSTEM)
26148 int secs
, usecs
= 0;
26150 cancel_hourglass ();
26152 if (INTEGERP (Vhourglass_delay
)
26153 && XINT (Vhourglass_delay
) > 0)
26154 secs
= XFASTINT (Vhourglass_delay
);
26155 else if (FLOATP (Vhourglass_delay
)
26156 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26159 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26160 secs
= XFASTINT (tem
);
26161 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26164 secs
= DEFAULT_HOURGLASS_DELAY
;
26166 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26167 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26168 show_hourglass
, NULL
);
26173 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26176 cancel_hourglass (void)
26178 #if defined (HAVE_WINDOW_SYSTEM)
26179 if (hourglass_atimer
)
26181 cancel_atimer (hourglass_atimer
);
26182 hourglass_atimer
= NULL
;
26185 if (hourglass_shown_p
)
26189 #endif /* ! WINDOWSNT */
26191 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26192 (do not change this comment) */