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
;
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
->cmp_it
.id
< 0)
3272 EMACS_INT stoppos
= it
->end_charpos
;
3274 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3276 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3277 stoppos
, it
->string
);
3280 xassert (STRINGP (it
->string
)
3281 || (it
->stop_charpos
>= BEGV
3282 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3286 /* Return the position of the next overlay change after POS in
3287 current_buffer. Value is point-max if no overlay change
3288 follows. This is like `next-overlay-change' but doesn't use
3292 next_overlay_change (EMACS_INT pos
)
3296 Lisp_Object
*overlays
;
3299 /* Get all overlays at the given position. */
3300 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3302 /* If any of these overlays ends before endpos,
3303 use its ending point instead. */
3304 for (i
= 0; i
< noverlays
; ++i
)
3309 oend
= OVERLAY_END (overlays
[i
]);
3310 oendpos
= OVERLAY_POSITION (oend
);
3311 endpos
= min (endpos
, oendpos
);
3319 /***********************************************************************
3321 ***********************************************************************/
3323 /* Handle changes in the `fontified' property of the current buffer by
3324 calling hook functions from Qfontification_functions to fontify
3327 static enum prop_handled
3328 handle_fontified_prop (struct it
*it
)
3330 Lisp_Object prop
, pos
;
3331 enum prop_handled handled
= HANDLED_NORMALLY
;
3333 if (!NILP (Vmemory_full
))
3336 /* Get the value of the `fontified' property at IT's current buffer
3337 position. (The `fontified' property doesn't have a special
3338 meaning in strings.) If the value is nil, call functions from
3339 Qfontification_functions. */
3340 if (!STRINGP (it
->string
)
3342 && !NILP (Vfontification_functions
)
3343 && !NILP (Vrun_hooks
)
3344 && (pos
= make_number (IT_CHARPOS (*it
)),
3345 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3346 /* Ignore the special cased nil value always present at EOB since
3347 no amount of fontifying will be able to change it. */
3348 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3350 int count
= SPECPDL_INDEX ();
3353 val
= Vfontification_functions
;
3354 specbind (Qfontification_functions
, Qnil
);
3356 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3357 safe_call1 (val
, pos
);
3360 Lisp_Object globals
, fn
;
3361 struct gcpro gcpro1
, gcpro2
;
3364 GCPRO2 (val
, globals
);
3366 for (; CONSP (val
); val
= XCDR (val
))
3372 /* A value of t indicates this hook has a local
3373 binding; it means to run the global binding too.
3374 In a global value, t should not occur. If it
3375 does, we must ignore it to avoid an endless
3377 for (globals
= Fdefault_value (Qfontification_functions
);
3379 globals
= XCDR (globals
))
3381 fn
= XCAR (globals
);
3383 safe_call1 (fn
, pos
);
3387 safe_call1 (fn
, pos
);
3393 unbind_to (count
, Qnil
);
3395 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3396 something. This avoids an endless loop if they failed to
3397 fontify the text for which reason ever. */
3398 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3399 handled
= HANDLED_RECOMPUTE_PROPS
;
3407 /***********************************************************************
3409 ***********************************************************************/
3411 /* Set up iterator IT from face properties at its current position.
3412 Called from handle_stop. */
3414 static enum prop_handled
3415 handle_face_prop (struct it
*it
)
3418 EMACS_INT next_stop
;
3420 if (!STRINGP (it
->string
))
3423 = face_at_buffer_position (it
->w
,
3425 it
->region_beg_charpos
,
3426 it
->region_end_charpos
,
3429 + TEXT_PROP_DISTANCE_LIMIT
),
3430 0, it
->base_face_id
);
3432 /* Is this a start of a run of characters with box face?
3433 Caveat: this can be called for a freshly initialized
3434 iterator; face_id is -1 in this case. We know that the new
3435 face will not change until limit, i.e. if the new face has a
3436 box, all characters up to limit will have one. But, as
3437 usual, we don't know whether limit is really the end. */
3438 if (new_face_id
!= it
->face_id
)
3440 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3442 /* If new face has a box but old face has not, this is
3443 the start of a run of characters with box, i.e. it has
3444 a shadow on the left side. The value of face_id of the
3445 iterator will be -1 if this is the initial call that gets
3446 the face. In this case, we have to look in front of IT's
3447 position and see whether there is a face != new_face_id. */
3448 it
->start_of_box_run_p
3449 = (new_face
->box
!= FACE_NO_BOX
3450 && (it
->face_id
>= 0
3451 || IT_CHARPOS (*it
) == BEG
3452 || new_face_id
!= face_before_it_pos (it
)));
3453 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3458 int base_face_id
, bufpos
;
3460 Lisp_Object from_overlay
3461 = (it
->current
.overlay_string_index
>= 0
3462 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3465 /* See if we got to this string directly or indirectly from
3466 an overlay property. That includes the before-string or
3467 after-string of an overlay, strings in display properties
3468 provided by an overlay, their text properties, etc.
3470 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3471 if (! NILP (from_overlay
))
3472 for (i
= it
->sp
- 1; i
>= 0; i
--)
3474 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3476 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3477 else if (! NILP (it
->stack
[i
].from_overlay
))
3478 from_overlay
= it
->stack
[i
].from_overlay
;
3480 if (!NILP (from_overlay
))
3484 if (! NILP (from_overlay
))
3486 bufpos
= IT_CHARPOS (*it
);
3487 /* For a string from an overlay, the base face depends
3488 only on text properties and ignores overlays. */
3490 = face_for_overlay_string (it
->w
,
3492 it
->region_beg_charpos
,
3493 it
->region_end_charpos
,
3496 + TEXT_PROP_DISTANCE_LIMIT
),
3504 /* For strings from a `display' property, use the face at
3505 IT's current buffer position as the base face to merge
3506 with, so that overlay strings appear in the same face as
3507 surrounding text, unless they specify their own
3509 base_face_id
= underlying_face_id (it
);
3512 new_face_id
= face_at_string_position (it
->w
,
3514 IT_STRING_CHARPOS (*it
),
3516 it
->region_beg_charpos
,
3517 it
->region_end_charpos
,
3521 /* Is this a start of a run of characters with box? Caveat:
3522 this can be called for a freshly allocated iterator; face_id
3523 is -1 is this case. We know that the new face will not
3524 change until the next check pos, i.e. if the new face has a
3525 box, all characters up to that position will have a
3526 box. But, as usual, we don't know whether that position
3527 is really the end. */
3528 if (new_face_id
!= it
->face_id
)
3530 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3531 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3533 /* If new face has a box but old face hasn't, this is the
3534 start of a run of characters with box, i.e. it has a
3535 shadow on the left side. */
3536 it
->start_of_box_run_p
3537 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3538 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3542 it
->face_id
= new_face_id
;
3543 return HANDLED_NORMALLY
;
3547 /* Return the ID of the face ``underlying'' IT's current position,
3548 which is in a string. If the iterator is associated with a
3549 buffer, return the face at IT's current buffer position.
3550 Otherwise, use the iterator's base_face_id. */
3553 underlying_face_id (struct it
*it
)
3555 int face_id
= it
->base_face_id
, i
;
3557 xassert (STRINGP (it
->string
));
3559 for (i
= it
->sp
- 1; i
>= 0; --i
)
3560 if (NILP (it
->stack
[i
].string
))
3561 face_id
= it
->stack
[i
].face_id
;
3567 /* Compute the face one character before or after the current position
3568 of IT. BEFORE_P non-zero means get the face in front of IT's
3569 position. Value is the id of the face. */
3572 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3575 EMACS_INT next_check_charpos
;
3576 struct text_pos pos
;
3578 xassert (it
->s
== NULL
);
3580 if (STRINGP (it
->string
))
3582 int bufpos
, base_face_id
;
3584 /* No face change past the end of the string (for the case
3585 we are padding with spaces). No face change before the
3587 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3588 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3591 /* Set pos to the position before or after IT's current position. */
3593 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3595 /* For composition, we must check the character after the
3597 pos
= (it
->what
== IT_COMPOSITION
3598 ? string_pos (IT_STRING_CHARPOS (*it
)
3599 + it
->cmp_it
.nchars
, it
->string
)
3600 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3602 if (it
->current
.overlay_string_index
>= 0)
3603 bufpos
= IT_CHARPOS (*it
);
3607 base_face_id
= underlying_face_id (it
);
3609 /* Get the face for ASCII, or unibyte. */
3610 face_id
= face_at_string_position (it
->w
,
3614 it
->region_beg_charpos
,
3615 it
->region_end_charpos
,
3616 &next_check_charpos
,
3619 /* Correct the face for charsets different from ASCII. Do it
3620 for the multibyte case only. The face returned above is
3621 suitable for unibyte text if IT->string is unibyte. */
3622 if (STRING_MULTIBYTE (it
->string
))
3624 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3625 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3627 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3629 c
= string_char_and_length (p
, &len
);
3630 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3635 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3636 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3639 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3640 pos
= it
->current
.pos
;
3643 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3646 if (it
->what
== IT_COMPOSITION
)
3647 /* For composition, we must check the position after the
3649 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3651 INC_TEXT_POS (pos
, it
->multibyte_p
);
3654 /* Determine face for CHARSET_ASCII, or unibyte. */
3655 face_id
= face_at_buffer_position (it
->w
,
3657 it
->region_beg_charpos
,
3658 it
->region_end_charpos
,
3659 &next_check_charpos
,
3662 /* Correct the face for charsets different from ASCII. Do it
3663 for the multibyte case only. The face returned above is
3664 suitable for unibyte text if current_buffer is unibyte. */
3665 if (it
->multibyte_p
)
3667 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3668 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3669 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3678 /***********************************************************************
3680 ***********************************************************************/
3682 /* Set up iterator IT from invisible properties at its current
3683 position. Called from handle_stop. */
3685 static enum prop_handled
3686 handle_invisible_prop (struct it
*it
)
3688 enum prop_handled handled
= HANDLED_NORMALLY
;
3690 if (STRINGP (it
->string
))
3692 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3694 /* Get the value of the invisible text property at the
3695 current position. Value will be nil if there is no such
3697 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3698 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3701 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3703 handled
= HANDLED_RECOMPUTE_PROPS
;
3705 /* Get the position at which the next change of the
3706 invisible text property can be found in IT->string.
3707 Value will be nil if the property value is the same for
3708 all the rest of IT->string. */
3709 XSETINT (limit
, SCHARS (it
->string
));
3710 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3713 /* Text at current position is invisible. The next
3714 change in the property is at position end_charpos.
3715 Move IT's current position to that position. */
3716 if (INTEGERP (end_charpos
)
3717 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3719 struct text_pos old
;
3720 old
= it
->current
.string_pos
;
3721 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3722 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3726 /* The rest of the string is invisible. If this is an
3727 overlay string, proceed with the next overlay string
3728 or whatever comes and return a character from there. */
3729 if (it
->current
.overlay_string_index
>= 0)
3731 next_overlay_string (it
);
3732 /* Don't check for overlay strings when we just
3733 finished processing them. */
3734 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3738 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3739 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3747 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3748 Lisp_Object pos
, prop
, overlay
;
3750 /* First of all, is there invisible text at this position? */
3751 tem
= start_charpos
= IT_CHARPOS (*it
);
3752 pos
= make_number (tem
);
3753 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3755 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3757 /* If we are on invisible text, skip over it. */
3758 if (invis_p
&& start_charpos
< it
->end_charpos
)
3760 /* Record whether we have to display an ellipsis for the
3762 int display_ellipsis_p
= invis_p
== 2;
3764 handled
= HANDLED_RECOMPUTE_PROPS
;
3766 /* Loop skipping over invisible text. The loop is left at
3767 ZV or with IT on the first char being visible again. */
3770 /* Try to skip some invisible text. Return value is the
3771 position reached which can be equal to where we start
3772 if there is nothing invisible there. This skips both
3773 over invisible text properties and overlays with
3774 invisible property. */
3775 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3777 /* If we skipped nothing at all we weren't at invisible
3778 text in the first place. If everything to the end of
3779 the buffer was skipped, end the loop. */
3780 if (newpos
== tem
|| newpos
>= ZV
)
3784 /* We skipped some characters but not necessarily
3785 all there are. Check if we ended up on visible
3786 text. Fget_char_property returns the property of
3787 the char before the given position, i.e. if we
3788 get invis_p = 0, this means that the char at
3789 newpos is visible. */
3790 pos
= make_number (newpos
);
3791 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3792 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3795 /* If we ended up on invisible text, proceed to
3796 skip starting with next_stop. */
3800 /* If there are adjacent invisible texts, don't lose the
3801 second one's ellipsis. */
3803 display_ellipsis_p
= 1;
3807 /* The position newpos is now either ZV or on visible text. */
3808 if (it
->bidi_p
&& newpos
< ZV
)
3810 /* With bidi iteration, the region of invisible text
3811 could start and/or end in the middle of a non-base
3812 embedding level. Therefore, we need to skip
3813 invisible text using the bidi iterator, starting at
3814 IT's current position, until we find ourselves
3815 outside the invisible text. Skipping invisible text
3816 _after_ bidi iteration avoids affecting the visual
3817 order of the displayed text when invisible properties
3818 are added or removed. */
3819 if (it
->bidi_it
.first_elt
)
3821 /* If we were `reseat'ed to a new paragraph,
3822 determine the paragraph base direction. We need
3823 to do it now because next_element_from_buffer may
3824 not have a chance to do it, if we are going to
3825 skip any text at the beginning, which resets the
3827 bidi_paragraph_init (it
->paragraph_embedding
,
3832 bidi_move_to_visually_next (&it
->bidi_it
);
3834 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3835 && it
->bidi_it
.charpos
< newpos
);
3836 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3837 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3838 /* If we overstepped NEWPOS, record its position in the
3839 iterator, so that we skip invisible text if later the
3840 bidi iteration lands us in the invisible region
3842 if (IT_CHARPOS (*it
) >= newpos
)
3843 it
->prev_stop
= newpos
;
3847 IT_CHARPOS (*it
) = newpos
;
3848 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3851 /* If there are before-strings at the start of invisible
3852 text, and the text is invisible because of a text
3853 property, arrange to show before-strings because 20.x did
3854 it that way. (If the text is invisible because of an
3855 overlay property instead of a text property, this is
3856 already handled in the overlay code.) */
3858 && get_overlay_strings (it
, it
->stop_charpos
))
3860 handled
= HANDLED_RECOMPUTE_PROPS
;
3861 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3863 else if (display_ellipsis_p
)
3865 /* Make sure that the glyphs of the ellipsis will get
3866 correct `charpos' values. If we would not update
3867 it->position here, the glyphs would belong to the
3868 last visible character _before_ the invisible
3869 text, which confuses `set_cursor_from_row'.
3871 We use the last invisible position instead of the
3872 first because this way the cursor is always drawn on
3873 the first "." of the ellipsis, whenever PT is inside
3874 the invisible text. Otherwise the cursor would be
3875 placed _after_ the ellipsis when the point is after the
3876 first invisible character. */
3877 if (!STRINGP (it
->object
))
3879 it
->position
.charpos
= newpos
- 1;
3880 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3883 /* Let the ellipsis display before
3884 considering any properties of the following char.
3885 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3886 handled
= HANDLED_RETURN
;
3895 /* Make iterator IT return `...' next.
3896 Replaces LEN characters from buffer. */
3899 setup_for_ellipsis (struct it
*it
, int len
)
3901 /* Use the display table definition for `...'. Invalid glyphs
3902 will be handled by the method returning elements from dpvec. */
3903 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3905 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3906 it
->dpvec
= v
->contents
;
3907 it
->dpend
= v
->contents
+ v
->size
;
3911 /* Default `...'. */
3912 it
->dpvec
= default_invis_vector
;
3913 it
->dpend
= default_invis_vector
+ 3;
3916 it
->dpvec_char_len
= len
;
3917 it
->current
.dpvec_index
= 0;
3918 it
->dpvec_face_id
= -1;
3920 /* Remember the current face id in case glyphs specify faces.
3921 IT's face is restored in set_iterator_to_next.
3922 saved_face_id was set to preceding char's face in handle_stop. */
3923 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3924 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3926 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3932 /***********************************************************************
3934 ***********************************************************************/
3936 /* Set up iterator IT from `display' property at its current position.
3937 Called from handle_stop.
3938 We return HANDLED_RETURN if some part of the display property
3939 overrides the display of the buffer text itself.
3940 Otherwise we return HANDLED_NORMALLY. */
3942 static enum prop_handled
3943 handle_display_prop (struct it
*it
)
3945 Lisp_Object prop
, object
, overlay
;
3946 struct text_pos
*position
;
3947 /* Nonzero if some property replaces the display of the text itself. */
3948 int display_replaced_p
= 0;
3950 if (STRINGP (it
->string
))
3952 object
= it
->string
;
3953 position
= &it
->current
.string_pos
;
3957 XSETWINDOW (object
, it
->w
);
3958 position
= &it
->current
.pos
;
3961 /* Reset those iterator values set from display property values. */
3962 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3963 it
->space_width
= Qnil
;
3964 it
->font_height
= Qnil
;
3967 /* We don't support recursive `display' properties, i.e. string
3968 values that have a string `display' property, that have a string
3969 `display' property etc. */
3970 if (!it
->string_from_display_prop_p
)
3971 it
->area
= TEXT_AREA
;
3973 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3974 Qdisplay
, object
, &overlay
);
3976 return HANDLED_NORMALLY
;
3977 /* Now OVERLAY is the overlay that gave us this property, or nil
3978 if it was a text property. */
3980 if (!STRINGP (it
->string
))
3981 object
= it
->w
->buffer
;
3984 /* Simple properties. */
3985 && !EQ (XCAR (prop
), Qimage
)
3986 && !EQ (XCAR (prop
), Qspace
)
3987 && !EQ (XCAR (prop
), Qwhen
)
3988 && !EQ (XCAR (prop
), Qslice
)
3989 && !EQ (XCAR (prop
), Qspace_width
)
3990 && !EQ (XCAR (prop
), Qheight
)
3991 && !EQ (XCAR (prop
), Qraise
)
3992 /* Marginal area specifications. */
3993 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3994 && !EQ (XCAR (prop
), Qleft_fringe
)
3995 && !EQ (XCAR (prop
), Qright_fringe
)
3996 && !NILP (XCAR (prop
)))
3998 for (; CONSP (prop
); prop
= XCDR (prop
))
4000 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4001 position
, display_replaced_p
))
4003 display_replaced_p
= 1;
4004 /* If some text in a string is replaced, `position' no
4005 longer points to the position of `object'. */
4006 if (STRINGP (object
))
4011 else if (VECTORP (prop
))
4014 for (i
= 0; i
< ASIZE (prop
); ++i
)
4015 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4016 position
, display_replaced_p
))
4018 display_replaced_p
= 1;
4019 /* If some text in a string is replaced, `position' no
4020 longer points to the position of `object'. */
4021 if (STRINGP (object
))
4027 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4029 display_replaced_p
= 1;
4032 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4036 /* Value is the position of the end of the `display' property starting
4037 at START_POS in OBJECT. */
4039 static struct text_pos
4040 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4043 struct text_pos end_pos
;
4045 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4046 Qdisplay
, object
, Qnil
);
4047 CHARPOS (end_pos
) = XFASTINT (end
);
4048 if (STRINGP (object
))
4049 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4051 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4057 /* Set up IT from a single `display' specification PROP. OBJECT
4058 is the object in which the `display' property was found. *POSITION
4059 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4060 means that we previously saw a display specification which already
4061 replaced text display with something else, for example an image;
4062 we ignore such properties after the first one has been processed.
4064 OVERLAY is the overlay this `display' property came from,
4065 or nil if it was a text property.
4067 If PROP is a `space' or `image' specification, and in some other
4068 cases too, set *POSITION to the position where the `display'
4071 Value is non-zero if something was found which replaces the display
4072 of buffer or string text. */
4075 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4076 Lisp_Object overlay
, struct text_pos
*position
,
4077 int display_replaced_before_p
)
4080 Lisp_Object location
, value
;
4081 struct text_pos start_pos
, save_pos
;
4084 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4085 If the result is non-nil, use VALUE instead of SPEC. */
4087 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4096 if (!NILP (form
) && !EQ (form
, Qt
))
4098 int count
= SPECPDL_INDEX ();
4099 struct gcpro gcpro1
;
4101 /* Bind `object' to the object having the `display' property, a
4102 buffer or string. Bind `position' to the position in the
4103 object where the property was found, and `buffer-position'
4104 to the current position in the buffer. */
4105 specbind (Qobject
, object
);
4106 specbind (Qposition
, make_number (CHARPOS (*position
)));
4107 specbind (Qbuffer_position
,
4108 make_number (STRINGP (object
)
4109 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4111 form
= safe_eval (form
);
4113 unbind_to (count
, Qnil
);
4119 /* Handle `(height HEIGHT)' specifications. */
4121 && EQ (XCAR (spec
), Qheight
)
4122 && CONSP (XCDR (spec
)))
4124 if (!FRAME_WINDOW_P (it
->f
))
4127 it
->font_height
= XCAR (XCDR (spec
));
4128 if (!NILP (it
->font_height
))
4130 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4131 int new_height
= -1;
4133 if (CONSP (it
->font_height
)
4134 && (EQ (XCAR (it
->font_height
), Qplus
)
4135 || EQ (XCAR (it
->font_height
), Qminus
))
4136 && CONSP (XCDR (it
->font_height
))
4137 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4139 /* `(+ N)' or `(- N)' where N is an integer. */
4140 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4141 if (EQ (XCAR (it
->font_height
), Qplus
))
4143 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4145 else if (FUNCTIONP (it
->font_height
))
4147 /* Call function with current height as argument.
4148 Value is the new height. */
4150 height
= safe_call1 (it
->font_height
,
4151 face
->lface
[LFACE_HEIGHT_INDEX
]);
4152 if (NUMBERP (height
))
4153 new_height
= XFLOATINT (height
);
4155 else if (NUMBERP (it
->font_height
))
4157 /* Value is a multiple of the canonical char height. */
4160 face
= FACE_FROM_ID (it
->f
,
4161 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4162 new_height
= (XFLOATINT (it
->font_height
)
4163 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4167 /* Evaluate IT->font_height with `height' bound to the
4168 current specified height to get the new height. */
4169 int count
= SPECPDL_INDEX ();
4171 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4172 value
= safe_eval (it
->font_height
);
4173 unbind_to (count
, Qnil
);
4175 if (NUMBERP (value
))
4176 new_height
= XFLOATINT (value
);
4180 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4186 /* Handle `(space-width WIDTH)'. */
4188 && EQ (XCAR (spec
), Qspace_width
)
4189 && CONSP (XCDR (spec
)))
4191 if (!FRAME_WINDOW_P (it
->f
))
4194 value
= XCAR (XCDR (spec
));
4195 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4196 it
->space_width
= value
;
4201 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4203 && EQ (XCAR (spec
), Qslice
))
4207 if (!FRAME_WINDOW_P (it
->f
))
4210 if (tem
= XCDR (spec
), CONSP (tem
))
4212 it
->slice
.x
= XCAR (tem
);
4213 if (tem
= XCDR (tem
), CONSP (tem
))
4215 it
->slice
.y
= XCAR (tem
);
4216 if (tem
= XCDR (tem
), CONSP (tem
))
4218 it
->slice
.width
= XCAR (tem
);
4219 if (tem
= XCDR (tem
), CONSP (tem
))
4220 it
->slice
.height
= XCAR (tem
);
4228 /* Handle `(raise FACTOR)'. */
4230 && EQ (XCAR (spec
), Qraise
)
4231 && CONSP (XCDR (spec
)))
4233 if (!FRAME_WINDOW_P (it
->f
))
4236 #ifdef HAVE_WINDOW_SYSTEM
4237 value
= XCAR (XCDR (spec
));
4238 if (NUMBERP (value
))
4240 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4241 it
->voffset
= - (XFLOATINT (value
)
4242 * (FONT_HEIGHT (face
->font
)));
4244 #endif /* HAVE_WINDOW_SYSTEM */
4249 /* Don't handle the other kinds of display specifications
4250 inside a string that we got from a `display' property. */
4251 if (it
->string_from_display_prop_p
)
4254 /* Characters having this form of property are not displayed, so
4255 we have to find the end of the property. */
4256 start_pos
= *position
;
4257 *position
= display_prop_end (it
, object
, start_pos
);
4260 /* Stop the scan at that end position--we assume that all
4261 text properties change there. */
4262 it
->stop_charpos
= position
->charpos
;
4264 /* Handle `(left-fringe BITMAP [FACE])'
4265 and `(right-fringe BITMAP [FACE])'. */
4267 && (EQ (XCAR (spec
), Qleft_fringe
)
4268 || EQ (XCAR (spec
), Qright_fringe
))
4269 && CONSP (XCDR (spec
)))
4271 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4274 if (!FRAME_WINDOW_P (it
->f
))
4275 /* If we return here, POSITION has been advanced
4276 across the text with this property. */
4279 #ifdef HAVE_WINDOW_SYSTEM
4280 value
= XCAR (XCDR (spec
));
4281 if (!SYMBOLP (value
)
4282 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4283 /* If we return here, POSITION has been advanced
4284 across the text with this property. */
4287 if (CONSP (XCDR (XCDR (spec
))))
4289 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4290 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4296 /* Save current settings of IT so that we can restore them
4297 when we are finished with the glyph property value. */
4299 save_pos
= it
->position
;
4300 it
->position
= *position
;
4302 it
->position
= save_pos
;
4304 it
->area
= TEXT_AREA
;
4305 it
->what
= IT_IMAGE
;
4306 it
->image_id
= -1; /* no image */
4307 it
->position
= start_pos
;
4308 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4309 it
->method
= GET_FROM_IMAGE
;
4310 it
->from_overlay
= Qnil
;
4311 it
->face_id
= face_id
;
4313 /* Say that we haven't consumed the characters with
4314 `display' property yet. The call to pop_it in
4315 set_iterator_to_next will clean this up. */
4316 *position
= start_pos
;
4318 if (EQ (XCAR (spec
), Qleft_fringe
))
4320 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4321 it
->left_user_fringe_face_id
= face_id
;
4325 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4326 it
->right_user_fringe_face_id
= face_id
;
4328 #endif /* HAVE_WINDOW_SYSTEM */
4332 /* Prepare to handle `((margin left-margin) ...)',
4333 `((margin right-margin) ...)' and `((margin nil) ...)'
4334 prefixes for display specifications. */
4335 location
= Qunbound
;
4336 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4340 value
= XCDR (spec
);
4342 value
= XCAR (value
);
4345 if (EQ (XCAR (tem
), Qmargin
)
4346 && (tem
= XCDR (tem
),
4347 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4349 || EQ (tem
, Qleft_margin
)
4350 || EQ (tem
, Qright_margin
))))
4354 if (EQ (location
, Qunbound
))
4360 /* After this point, VALUE is the property after any
4361 margin prefix has been stripped. It must be a string,
4362 an image specification, or `(space ...)'.
4364 LOCATION specifies where to display: `left-margin',
4365 `right-margin' or nil. */
4367 valid_p
= (STRINGP (value
)
4368 #ifdef HAVE_WINDOW_SYSTEM
4369 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4370 #endif /* not HAVE_WINDOW_SYSTEM */
4371 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4373 if (valid_p
&& !display_replaced_before_p
)
4375 /* Save current settings of IT so that we can restore them
4376 when we are finished with the glyph property value. */
4377 save_pos
= it
->position
;
4378 it
->position
= *position
;
4380 it
->position
= save_pos
;
4381 it
->from_overlay
= overlay
;
4383 if (NILP (location
))
4384 it
->area
= TEXT_AREA
;
4385 else if (EQ (location
, Qleft_margin
))
4386 it
->area
= LEFT_MARGIN_AREA
;
4388 it
->area
= RIGHT_MARGIN_AREA
;
4390 if (STRINGP (value
))
4393 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4394 it
->current
.overlay_string_index
= -1;
4395 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4396 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4397 it
->method
= GET_FROM_STRING
;
4398 it
->stop_charpos
= 0;
4399 it
->string_from_display_prop_p
= 1;
4400 /* Say that we haven't consumed the characters with
4401 `display' property yet. The call to pop_it in
4402 set_iterator_to_next will clean this up. */
4403 if (BUFFERP (object
))
4404 *position
= start_pos
;
4406 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4408 it
->method
= GET_FROM_STRETCH
;
4410 *position
= it
->position
= start_pos
;
4412 #ifdef HAVE_WINDOW_SYSTEM
4415 it
->what
= IT_IMAGE
;
4416 it
->image_id
= lookup_image (it
->f
, value
);
4417 it
->position
= start_pos
;
4418 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4419 it
->method
= GET_FROM_IMAGE
;
4421 /* Say that we haven't consumed the characters with
4422 `display' property yet. The call to pop_it in
4423 set_iterator_to_next will clean this up. */
4424 *position
= start_pos
;
4426 #endif /* HAVE_WINDOW_SYSTEM */
4431 /* Invalid property or property not supported. Restore
4432 POSITION to what it was before. */
4433 *position
= start_pos
;
4438 /* Check if SPEC is a display sub-property value whose text should be
4439 treated as intangible. */
4442 single_display_spec_intangible_p (Lisp_Object prop
)
4444 /* Skip over `when FORM'. */
4445 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4459 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4460 we don't need to treat text as intangible. */
4461 if (EQ (XCAR (prop
), Qmargin
))
4469 || EQ (XCAR (prop
), Qleft_margin
)
4470 || EQ (XCAR (prop
), Qright_margin
))
4474 return (CONSP (prop
)
4475 && (EQ (XCAR (prop
), Qimage
)
4476 || EQ (XCAR (prop
), Qspace
)));
4480 /* Check if PROP is a display property value whose text should be
4481 treated as intangible. */
4484 display_prop_intangible_p (Lisp_Object prop
)
4487 && CONSP (XCAR (prop
))
4488 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4490 /* A list of sub-properties. */
4491 while (CONSP (prop
))
4493 if (single_display_spec_intangible_p (XCAR (prop
)))
4498 else if (VECTORP (prop
))
4500 /* A vector of sub-properties. */
4502 for (i
= 0; i
< ASIZE (prop
); ++i
)
4503 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4507 return single_display_spec_intangible_p (prop
);
4513 /* Return 1 if PROP is a display sub-property value containing STRING. */
4516 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4518 if (EQ (string
, prop
))
4521 /* Skip over `when FORM'. */
4522 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4531 /* Skip over `margin LOCATION'. */
4532 if (EQ (XCAR (prop
), Qmargin
))
4543 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4547 /* Return 1 if STRING appears in the `display' property PROP. */
4550 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4553 && CONSP (XCAR (prop
))
4554 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4556 /* A list of sub-properties. */
4557 while (CONSP (prop
))
4559 if (single_display_spec_string_p (XCAR (prop
), string
))
4564 else if (VECTORP (prop
))
4566 /* A vector of sub-properties. */
4568 for (i
= 0; i
< ASIZE (prop
); ++i
)
4569 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4573 return single_display_spec_string_p (prop
, string
);
4578 /* Look for STRING in overlays and text properties in W's buffer,
4579 between character positions FROM and TO (excluding TO).
4580 BACK_P non-zero means look back (in this case, TO is supposed to be
4582 Value is the first character position where STRING was found, or
4583 zero if it wasn't found before hitting TO.
4585 W's buffer must be current.
4587 This function may only use code that doesn't eval because it is
4588 called asynchronously from note_mouse_highlight. */
4591 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4592 EMACS_INT from
, EMACS_INT to
, int back_p
)
4594 Lisp_Object limit
, prop
, pos
;
4597 pos
= make_number (from
);
4599 if (!back_p
) /* looking forward */
4601 limit
= make_number (min (to
, ZV
));
4602 while (!found
&& !EQ (pos
, limit
))
4604 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4605 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4608 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4612 else /* looking back */
4614 limit
= make_number (max (to
, BEGV
));
4615 while (!found
&& !EQ (pos
, limit
))
4617 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4618 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4621 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4626 return found
? XINT (pos
) : 0;
4629 /* Determine which buffer position in W's buffer STRING comes from.
4630 AROUND_CHARPOS is an approximate position where it could come from.
4631 Value is the buffer position or 0 if it couldn't be determined.
4633 W's buffer must be current.
4635 This function is necessary because we don't record buffer positions
4636 in glyphs generated from strings (to keep struct glyph small).
4637 This function may only use code that doesn't eval because it is
4638 called asynchronously from note_mouse_highlight. */
4641 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4643 Lisp_Object limit
, prop
, pos
;
4644 const int MAX_DISTANCE
= 1000;
4645 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4646 around_charpos
+ MAX_DISTANCE
,
4650 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4651 around_charpos
- MAX_DISTANCE
, 1);
4657 /***********************************************************************
4658 `composition' property
4659 ***********************************************************************/
4661 /* Set up iterator IT from `composition' property at its current
4662 position. Called from handle_stop. */
4664 static enum prop_handled
4665 handle_composition_prop (struct it
*it
)
4667 Lisp_Object prop
, string
;
4668 EMACS_INT pos
, pos_byte
, start
, end
;
4670 if (STRINGP (it
->string
))
4674 pos
= IT_STRING_CHARPOS (*it
);
4675 pos_byte
= IT_STRING_BYTEPOS (*it
);
4676 string
= it
->string
;
4677 s
= SDATA (string
) + pos_byte
;
4678 it
->c
= STRING_CHAR (s
);
4682 pos
= IT_CHARPOS (*it
);
4683 pos_byte
= IT_BYTEPOS (*it
);
4685 it
->c
= FETCH_CHAR (pos_byte
);
4688 /* If there's a valid composition and point is not inside of the
4689 composition (in the case that the composition is from the current
4690 buffer), draw a glyph composed from the composition components. */
4691 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4692 && COMPOSITION_VALID_P (start
, end
, prop
)
4693 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4697 if (STRINGP (it
->string
))
4698 pos_byte
= string_char_to_byte (it
->string
, start
);
4700 pos_byte
= CHAR_TO_BYTE (start
);
4702 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4705 if (it
->cmp_it
.id
>= 0)
4708 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4709 it
->cmp_it
.nglyphs
= -1;
4713 return HANDLED_NORMALLY
;
4718 /***********************************************************************
4720 ***********************************************************************/
4722 /* The following structure is used to record overlay strings for
4723 later sorting in load_overlay_strings. */
4725 struct overlay_entry
4727 Lisp_Object overlay
;
4734 /* Set up iterator IT from overlay strings at its current position.
4735 Called from handle_stop. */
4737 static enum prop_handled
4738 handle_overlay_change (struct it
*it
)
4740 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4741 return HANDLED_RECOMPUTE_PROPS
;
4743 return HANDLED_NORMALLY
;
4747 /* Set up the next overlay string for delivery by IT, if there is an
4748 overlay string to deliver. Called by set_iterator_to_next when the
4749 end of the current overlay string is reached. If there are more
4750 overlay strings to display, IT->string and
4751 IT->current.overlay_string_index are set appropriately here.
4752 Otherwise IT->string is set to nil. */
4755 next_overlay_string (struct it
*it
)
4757 ++it
->current
.overlay_string_index
;
4758 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4760 /* No more overlay strings. Restore IT's settings to what
4761 they were before overlay strings were processed, and
4762 continue to deliver from current_buffer. */
4764 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4767 || (NILP (it
->string
)
4768 && it
->method
== GET_FROM_BUFFER
4769 && it
->stop_charpos
>= BEGV
4770 && it
->stop_charpos
<= it
->end_charpos
));
4771 it
->current
.overlay_string_index
= -1;
4772 it
->n_overlay_strings
= 0;
4774 /* If we're at the end of the buffer, record that we have
4775 processed the overlay strings there already, so that
4776 next_element_from_buffer doesn't try it again. */
4777 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4778 it
->overlay_strings_at_end_processed_p
= 1;
4782 /* There are more overlay strings to process. If
4783 IT->current.overlay_string_index has advanced to a position
4784 where we must load IT->overlay_strings with more strings, do
4786 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4788 if (it
->current
.overlay_string_index
&& i
== 0)
4789 load_overlay_strings (it
, 0);
4791 /* Initialize IT to deliver display elements from the overlay
4793 it
->string
= it
->overlay_strings
[i
];
4794 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4795 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4796 it
->method
= GET_FROM_STRING
;
4797 it
->stop_charpos
= 0;
4798 if (it
->cmp_it
.stop_pos
>= 0)
4799 it
->cmp_it
.stop_pos
= 0;
4806 /* Compare two overlay_entry structures E1 and E2. Used as a
4807 comparison function for qsort in load_overlay_strings. Overlay
4808 strings for the same position are sorted so that
4810 1. All after-strings come in front of before-strings, except
4811 when they come from the same overlay.
4813 2. Within after-strings, strings are sorted so that overlay strings
4814 from overlays with higher priorities come first.
4816 2. Within before-strings, strings are sorted so that overlay
4817 strings from overlays with higher priorities come last.
4819 Value is analogous to strcmp. */
4823 compare_overlay_entries (const void *e1
, const void *e2
)
4825 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4826 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4829 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4831 /* Let after-strings appear in front of before-strings if
4832 they come from different overlays. */
4833 if (EQ (entry1
->overlay
, entry2
->overlay
))
4834 result
= entry1
->after_string_p
? 1 : -1;
4836 result
= entry1
->after_string_p
? -1 : 1;
4838 else if (entry1
->after_string_p
)
4839 /* After-strings sorted in order of decreasing priority. */
4840 result
= entry2
->priority
- entry1
->priority
;
4842 /* Before-strings sorted in order of increasing priority. */
4843 result
= entry1
->priority
- entry2
->priority
;
4849 /* Load the vector IT->overlay_strings with overlay strings from IT's
4850 current buffer position, or from CHARPOS if that is > 0. Set
4851 IT->n_overlays to the total number of overlay strings found.
4853 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4854 a time. On entry into load_overlay_strings,
4855 IT->current.overlay_string_index gives the number of overlay
4856 strings that have already been loaded by previous calls to this
4859 IT->add_overlay_start contains an additional overlay start
4860 position to consider for taking overlay strings from, if non-zero.
4861 This position comes into play when the overlay has an `invisible'
4862 property, and both before and after-strings. When we've skipped to
4863 the end of the overlay, because of its `invisible' property, we
4864 nevertheless want its before-string to appear.
4865 IT->add_overlay_start will contain the overlay start position
4868 Overlay strings are sorted so that after-string strings come in
4869 front of before-string strings. Within before and after-strings,
4870 strings are sorted by overlay priority. See also function
4871 compare_overlay_entries. */
4874 load_overlay_strings (struct it
*it
, int charpos
)
4876 Lisp_Object overlay
, window
, str
, invisible
;
4877 struct Lisp_Overlay
*ov
;
4880 int n
= 0, i
, j
, invis_p
;
4881 struct overlay_entry
*entries
4882 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4885 charpos
= IT_CHARPOS (*it
);
4887 /* Append the overlay string STRING of overlay OVERLAY to vector
4888 `entries' which has size `size' and currently contains `n'
4889 elements. AFTER_P non-zero means STRING is an after-string of
4891 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4894 Lisp_Object priority; \
4898 int new_size = 2 * size; \
4899 struct overlay_entry *old = entries; \
4901 (struct overlay_entry *) alloca (new_size \
4902 * sizeof *entries); \
4903 memcpy (entries, old, size * sizeof *entries); \
4907 entries[n].string = (STRING); \
4908 entries[n].overlay = (OVERLAY); \
4909 priority = Foverlay_get ((OVERLAY), Qpriority); \
4910 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4911 entries[n].after_string_p = (AFTER_P); \
4916 /* Process overlay before the overlay center. */
4917 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4919 XSETMISC (overlay
, ov
);
4920 xassert (OVERLAYP (overlay
));
4921 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4922 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4927 /* Skip this overlay if it doesn't start or end at IT's current
4929 if (end
!= charpos
&& start
!= charpos
)
4932 /* Skip this overlay if it doesn't apply to IT->w. */
4933 window
= Foverlay_get (overlay
, Qwindow
);
4934 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4937 /* If the text ``under'' the overlay is invisible, both before-
4938 and after-strings from this overlay are visible; start and
4939 end position are indistinguishable. */
4940 invisible
= Foverlay_get (overlay
, Qinvisible
);
4941 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4943 /* If overlay has a non-empty before-string, record it. */
4944 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4945 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4947 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4949 /* If overlay has a non-empty after-string, record it. */
4950 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4951 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4953 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4956 /* Process overlays after the overlay center. */
4957 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4959 XSETMISC (overlay
, ov
);
4960 xassert (OVERLAYP (overlay
));
4961 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4962 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4964 if (start
> charpos
)
4967 /* Skip this overlay if it doesn't start or end at IT's current
4969 if (end
!= charpos
&& start
!= charpos
)
4972 /* Skip this overlay if it doesn't apply to IT->w. */
4973 window
= Foverlay_get (overlay
, Qwindow
);
4974 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4977 /* If the text ``under'' the overlay is invisible, it has a zero
4978 dimension, and both before- and after-strings apply. */
4979 invisible
= Foverlay_get (overlay
, Qinvisible
);
4980 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4982 /* If overlay has a non-empty before-string, record it. */
4983 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4984 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4986 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4988 /* If overlay has a non-empty after-string, record it. */
4989 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4990 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4992 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4995 #undef RECORD_OVERLAY_STRING
4999 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5001 /* Record the total number of strings to process. */
5002 it
->n_overlay_strings
= n
;
5004 /* IT->current.overlay_string_index is the number of overlay strings
5005 that have already been consumed by IT. Copy some of the
5006 remaining overlay strings to IT->overlay_strings. */
5008 j
= it
->current
.overlay_string_index
;
5009 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5011 it
->overlay_strings
[i
] = entries
[j
].string
;
5012 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5019 /* Get the first chunk of overlay strings at IT's current buffer
5020 position, or at CHARPOS if that is > 0. Value is non-zero if at
5021 least one overlay string was found. */
5024 get_overlay_strings_1 (struct it
*it
, int charpos
, int compute_stop_p
)
5026 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5027 process. This fills IT->overlay_strings with strings, and sets
5028 IT->n_overlay_strings to the total number of strings to process.
5029 IT->pos.overlay_string_index has to be set temporarily to zero
5030 because load_overlay_strings needs this; it must be set to -1
5031 when no overlay strings are found because a zero value would
5032 indicate a position in the first overlay string. */
5033 it
->current
.overlay_string_index
= 0;
5034 load_overlay_strings (it
, charpos
);
5036 /* If we found overlay strings, set up IT to deliver display
5037 elements from the first one. Otherwise set up IT to deliver
5038 from current_buffer. */
5039 if (it
->n_overlay_strings
)
5041 /* Make sure we know settings in current_buffer, so that we can
5042 restore meaningful values when we're done with the overlay
5045 compute_stop_pos (it
);
5046 xassert (it
->face_id
>= 0);
5048 /* Save IT's settings. They are restored after all overlay
5049 strings have been processed. */
5050 xassert (!compute_stop_p
|| it
->sp
== 0);
5052 /* When called from handle_stop, there might be an empty display
5053 string loaded. In that case, don't bother saving it. */
5054 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5057 /* Set up IT to deliver display elements from the first overlay
5059 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5060 it
->string
= it
->overlay_strings
[0];
5061 it
->from_overlay
= Qnil
;
5062 it
->stop_charpos
= 0;
5063 xassert (STRINGP (it
->string
));
5064 it
->end_charpos
= SCHARS (it
->string
);
5065 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5066 it
->method
= GET_FROM_STRING
;
5070 it
->current
.overlay_string_index
= -1;
5075 get_overlay_strings (struct it
*it
, int charpos
)
5078 it
->method
= GET_FROM_BUFFER
;
5080 (void) get_overlay_strings_1 (it
, charpos
, 1);
5084 /* Value is non-zero if we found at least one overlay string. */
5085 return STRINGP (it
->string
);
5090 /***********************************************************************
5091 Saving and restoring state
5092 ***********************************************************************/
5094 /* Save current settings of IT on IT->stack. Called, for example,
5095 before setting up IT for an overlay string, to be able to restore
5096 IT's settings to what they were after the overlay string has been
5100 push_it (struct it
*it
)
5102 struct iterator_stack_entry
*p
;
5104 xassert (it
->sp
< IT_STACK_SIZE
);
5105 p
= it
->stack
+ it
->sp
;
5107 p
->stop_charpos
= it
->stop_charpos
;
5108 p
->prev_stop
= it
->prev_stop
;
5109 p
->base_level_stop
= it
->base_level_stop
;
5110 p
->cmp_it
= it
->cmp_it
;
5111 xassert (it
->face_id
>= 0);
5112 p
->face_id
= it
->face_id
;
5113 p
->string
= it
->string
;
5114 p
->method
= it
->method
;
5115 p
->from_overlay
= it
->from_overlay
;
5118 case GET_FROM_IMAGE
:
5119 p
->u
.image
.object
= it
->object
;
5120 p
->u
.image
.image_id
= it
->image_id
;
5121 p
->u
.image
.slice
= it
->slice
;
5123 case GET_FROM_STRETCH
:
5124 p
->u
.stretch
.object
= it
->object
;
5127 p
->position
= it
->position
;
5128 p
->current
= it
->current
;
5129 p
->end_charpos
= it
->end_charpos
;
5130 p
->string_nchars
= it
->string_nchars
;
5132 p
->multibyte_p
= it
->multibyte_p
;
5133 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5134 p
->space_width
= it
->space_width
;
5135 p
->font_height
= it
->font_height
;
5136 p
->voffset
= it
->voffset
;
5137 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5138 p
->display_ellipsis_p
= 0;
5139 p
->line_wrap
= it
->line_wrap
;
5144 iterate_out_of_display_property (struct it
*it
)
5146 /* Maybe initialize paragraph direction. If we are at the beginning
5147 of a new paragraph, next_element_from_buffer may not have a
5148 chance to do that. */
5149 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5150 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
5151 /* prev_stop can be zero, so check against BEGV as well. */
5152 while (it
->bidi_it
.charpos
>= BEGV
5153 && it
->prev_stop
<= it
->bidi_it
.charpos
5154 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5155 bidi_move_to_visually_next (&it
->bidi_it
);
5156 /* Record the stop_pos we just crossed, for when we cross it
5158 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5159 it
->prev_stop
= CHARPOS (it
->position
);
5160 /* If we ended up not where pop_it put us, resync IT's
5161 positional members with the bidi iterator. */
5162 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5164 SET_TEXT_POS (it
->position
,
5165 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5166 it
->current
.pos
= it
->position
;
5170 /* Restore IT's settings from IT->stack. Called, for example, when no
5171 more overlay strings must be processed, and we return to delivering
5172 display elements from a buffer, or when the end of a string from a
5173 `display' property is reached and we return to delivering display
5174 elements from an overlay string, or from a buffer. */
5177 pop_it (struct it
*it
)
5179 struct iterator_stack_entry
*p
;
5181 xassert (it
->sp
> 0);
5183 p
= it
->stack
+ it
->sp
;
5184 it
->stop_charpos
= p
->stop_charpos
;
5185 it
->prev_stop
= p
->prev_stop
;
5186 it
->base_level_stop
= p
->base_level_stop
;
5187 it
->cmp_it
= p
->cmp_it
;
5188 it
->face_id
= p
->face_id
;
5189 it
->current
= p
->current
;
5190 it
->position
= p
->position
;
5191 it
->string
= p
->string
;
5192 it
->from_overlay
= p
->from_overlay
;
5193 if (NILP (it
->string
))
5194 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5195 it
->method
= p
->method
;
5198 case GET_FROM_IMAGE
:
5199 it
->image_id
= p
->u
.image
.image_id
;
5200 it
->object
= p
->u
.image
.object
;
5201 it
->slice
= p
->u
.image
.slice
;
5203 case GET_FROM_STRETCH
:
5204 it
->object
= p
->u
.comp
.object
;
5206 case GET_FROM_BUFFER
:
5207 it
->object
= it
->w
->buffer
;
5210 /* Bidi-iterate until we get out of the portion of text, if
5211 any, covered by a `display' text property or an overlay
5212 with `display' property. (We cannot just jump there,
5213 because the internal coherency of the bidi iterator state
5214 can not be preserved across such jumps.) We also must
5215 determine the paragraph base direction if the overlay we
5216 just processed is at the beginning of a new
5218 iterate_out_of_display_property (it
);
5221 case GET_FROM_STRING
:
5222 it
->object
= it
->string
;
5224 case GET_FROM_DISPLAY_VECTOR
:
5226 it
->method
= GET_FROM_C_STRING
;
5227 else if (STRINGP (it
->string
))
5228 it
->method
= GET_FROM_STRING
;
5231 it
->method
= GET_FROM_BUFFER
;
5232 it
->object
= it
->w
->buffer
;
5235 it
->end_charpos
= p
->end_charpos
;
5236 it
->string_nchars
= p
->string_nchars
;
5238 it
->multibyte_p
= p
->multibyte_p
;
5239 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5240 it
->space_width
= p
->space_width
;
5241 it
->font_height
= p
->font_height
;
5242 it
->voffset
= p
->voffset
;
5243 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5244 it
->line_wrap
= p
->line_wrap
;
5249 /***********************************************************************
5251 ***********************************************************************/
5253 /* Set IT's current position to the previous line start. */
5256 back_to_previous_line_start (struct it
*it
)
5258 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5259 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5263 /* Move IT to the next line start.
5265 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5266 we skipped over part of the text (as opposed to moving the iterator
5267 continuously over the text). Otherwise, don't change the value
5270 Newlines may come from buffer text, overlay strings, or strings
5271 displayed via the `display' property. That's the reason we can't
5272 simply use find_next_newline_no_quit.
5274 Note that this function may not skip over invisible text that is so
5275 because of text properties and immediately follows a newline. If
5276 it would, function reseat_at_next_visible_line_start, when called
5277 from set_iterator_to_next, would effectively make invisible
5278 characters following a newline part of the wrong glyph row, which
5279 leads to wrong cursor motion. */
5282 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5284 int old_selective
, newline_found_p
, n
;
5285 const int MAX_NEWLINE_DISTANCE
= 500;
5287 /* If already on a newline, just consume it to avoid unintended
5288 skipping over invisible text below. */
5289 if (it
->what
== IT_CHARACTER
5291 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5293 set_iterator_to_next (it
, 0);
5298 /* Don't handle selective display in the following. It's (a)
5299 unnecessary because it's done by the caller, and (b) leads to an
5300 infinite recursion because next_element_from_ellipsis indirectly
5301 calls this function. */
5302 old_selective
= it
->selective
;
5305 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5306 from buffer text. */
5307 for (n
= newline_found_p
= 0;
5308 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5309 n
+= STRINGP (it
->string
) ? 0 : 1)
5311 if (!get_next_display_element (it
))
5313 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5314 set_iterator_to_next (it
, 0);
5317 /* If we didn't find a newline near enough, see if we can use a
5319 if (!newline_found_p
)
5321 int start
= IT_CHARPOS (*it
);
5322 int limit
= find_next_newline_no_quit (start
, 1);
5325 xassert (!STRINGP (it
->string
));
5327 /* If there isn't any `display' property in sight, and no
5328 overlays, we can just use the position of the newline in
5330 if (it
->stop_charpos
>= limit
5331 || ((pos
= Fnext_single_property_change (make_number (start
),
5333 Qnil
, make_number (limit
)),
5335 && next_overlay_change (start
) == ZV
))
5337 IT_CHARPOS (*it
) = limit
;
5338 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5339 *skipped_p
= newline_found_p
= 1;
5343 while (get_next_display_element (it
)
5344 && !newline_found_p
)
5346 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5347 set_iterator_to_next (it
, 0);
5352 it
->selective
= old_selective
;
5353 return newline_found_p
;
5357 /* Set IT's current position to the previous visible line start. Skip
5358 invisible text that is so either due to text properties or due to
5359 selective display. Caution: this does not change IT->current_x and
5363 back_to_previous_visible_line_start (struct it
*it
)
5365 while (IT_CHARPOS (*it
) > BEGV
)
5367 back_to_previous_line_start (it
);
5369 if (IT_CHARPOS (*it
) <= BEGV
)
5372 /* If selective > 0, then lines indented more than its value are
5374 if (it
->selective
> 0
5375 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5376 (double) it
->selective
)) /* iftc */
5379 /* Check the newline before point for invisibility. */
5382 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5383 Qinvisible
, it
->window
);
5384 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5388 if (IT_CHARPOS (*it
) <= BEGV
)
5395 Lisp_Object val
, overlay
;
5397 /* If newline is part of a composition, continue from start of composition */
5398 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5399 && beg
< IT_CHARPOS (*it
))
5402 /* If newline is replaced by a display property, find start of overlay
5403 or interval and continue search from that point. */
5405 pos
= --IT_CHARPOS (it2
);
5408 it2
.string_from_display_prop_p
= 0;
5409 if (handle_display_prop (&it2
) == HANDLED_RETURN
5410 && !NILP (val
= get_char_property_and_overlay
5411 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5412 && (OVERLAYP (overlay
)
5413 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5414 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5417 /* Newline is not replaced by anything -- so we are done. */
5423 IT_CHARPOS (*it
) = beg
;
5424 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5428 it
->continuation_lines_width
= 0;
5430 xassert (IT_CHARPOS (*it
) >= BEGV
);
5431 xassert (IT_CHARPOS (*it
) == BEGV
5432 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5437 /* Reseat iterator IT at the previous visible line start. Skip
5438 invisible text that is so either due to text properties or due to
5439 selective display. At the end, update IT's overlay information,
5440 face information etc. */
5443 reseat_at_previous_visible_line_start (struct it
*it
)
5445 back_to_previous_visible_line_start (it
);
5446 reseat (it
, it
->current
.pos
, 1);
5451 /* Reseat iterator IT on the next visible line start in the current
5452 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5453 preceding the line start. Skip over invisible text that is so
5454 because of selective display. Compute faces, overlays etc at the
5455 new position. Note that this function does not skip over text that
5456 is invisible because of text properties. */
5459 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5461 int newline_found_p
, skipped_p
= 0;
5463 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5465 /* Skip over lines that are invisible because they are indented
5466 more than the value of IT->selective. */
5467 if (it
->selective
> 0)
5468 while (IT_CHARPOS (*it
) < ZV
5469 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5470 (double) it
->selective
)) /* iftc */
5472 xassert (IT_BYTEPOS (*it
) == BEGV
5473 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5474 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5477 /* Position on the newline if that's what's requested. */
5478 if (on_newline_p
&& newline_found_p
)
5480 if (STRINGP (it
->string
))
5482 if (IT_STRING_CHARPOS (*it
) > 0)
5484 --IT_STRING_CHARPOS (*it
);
5485 --IT_STRING_BYTEPOS (*it
);
5488 else if (IT_CHARPOS (*it
) > BEGV
)
5492 reseat (it
, it
->current
.pos
, 0);
5496 reseat (it
, it
->current
.pos
, 0);
5503 /***********************************************************************
5504 Changing an iterator's position
5505 ***********************************************************************/
5507 /* Change IT's current position to POS in current_buffer. If FORCE_P
5508 is non-zero, always check for text properties at the new position.
5509 Otherwise, text properties are only looked up if POS >=
5510 IT->check_charpos of a property. */
5513 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5515 int original_pos
= IT_CHARPOS (*it
);
5517 reseat_1 (it
, pos
, 0);
5519 /* Determine where to check text properties. Avoid doing it
5520 where possible because text property lookup is very expensive. */
5522 || CHARPOS (pos
) > it
->stop_charpos
5523 || CHARPOS (pos
) < original_pos
)
5527 /* For bidi iteration, we need to prime prev_stop and
5528 base_level_stop with our best estimations. */
5529 if (CHARPOS (pos
) < it
->prev_stop
)
5531 handle_stop_backwards (it
, BEGV
);
5532 if (CHARPOS (pos
) < it
->base_level_stop
)
5533 it
->base_level_stop
= 0;
5535 else if (CHARPOS (pos
) > it
->stop_charpos
5536 && it
->stop_charpos
>= BEGV
)
5537 handle_stop_backwards (it
, it
->stop_charpos
);
5544 it
->prev_stop
= it
->base_level_stop
= 0;
5553 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5554 IT->stop_pos to POS, also. */
5557 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5559 /* Don't call this function when scanning a C string. */
5560 xassert (it
->s
== NULL
);
5562 /* POS must be a reasonable value. */
5563 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5565 it
->current
.pos
= it
->position
= pos
;
5566 it
->end_charpos
= ZV
;
5568 it
->current
.dpvec_index
= -1;
5569 it
->current
.overlay_string_index
= -1;
5570 IT_STRING_CHARPOS (*it
) = -1;
5571 IT_STRING_BYTEPOS (*it
) = -1;
5573 it
->string_from_display_prop_p
= 0;
5574 it
->method
= GET_FROM_BUFFER
;
5575 it
->object
= it
->w
->buffer
;
5576 it
->area
= TEXT_AREA
;
5577 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5579 it
->string_from_display_prop_p
= 0;
5580 it
->face_before_selective_p
= 0;
5582 it
->bidi_it
.first_elt
= 1;
5586 it
->stop_charpos
= CHARPOS (pos
);
5587 it
->base_level_stop
= CHARPOS (pos
);
5592 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5593 If S is non-null, it is a C string to iterate over. Otherwise,
5594 STRING gives a Lisp string to iterate over.
5596 If PRECISION > 0, don't return more then PRECISION number of
5597 characters from the string.
5599 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5600 characters have been returned. FIELD_WIDTH < 0 means an infinite
5603 MULTIBYTE = 0 means disable processing of multibyte characters,
5604 MULTIBYTE > 0 means enable it,
5605 MULTIBYTE < 0 means use IT->multibyte_p.
5607 IT must be initialized via a prior call to init_iterator before
5608 calling this function. */
5611 reseat_to_string (struct it
*it
, const unsigned char *s
, Lisp_Object string
,
5612 int charpos
, int precision
, int field_width
, int multibyte
)
5614 /* No region in strings. */
5615 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5617 /* No text property checks performed by default, but see below. */
5618 it
->stop_charpos
= -1;
5620 /* Set iterator position and end position. */
5621 memset (&it
->current
, 0, sizeof it
->current
);
5622 it
->current
.overlay_string_index
= -1;
5623 it
->current
.dpvec_index
= -1;
5624 xassert (charpos
>= 0);
5626 /* If STRING is specified, use its multibyteness, otherwise use the
5627 setting of MULTIBYTE, if specified. */
5629 it
->multibyte_p
= multibyte
> 0;
5633 xassert (STRINGP (string
));
5634 it
->string
= string
;
5636 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5637 it
->method
= GET_FROM_STRING
;
5638 it
->current
.string_pos
= string_pos (charpos
, string
);
5645 /* Note that we use IT->current.pos, not it->current.string_pos,
5646 for displaying C strings. */
5647 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5648 if (it
->multibyte_p
)
5650 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5651 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5655 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5656 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5659 it
->method
= GET_FROM_C_STRING
;
5662 /* PRECISION > 0 means don't return more than PRECISION characters
5664 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5665 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5667 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5668 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5669 FIELD_WIDTH < 0 means infinite field width. This is useful for
5670 padding with `-' at the end of a mode line. */
5671 if (field_width
< 0)
5672 field_width
= INFINITY
;
5673 if (field_width
> it
->end_charpos
- charpos
)
5674 it
->end_charpos
= charpos
+ field_width
;
5676 /* Use the standard display table for displaying strings. */
5677 if (DISP_TABLE_P (Vstandard_display_table
))
5678 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5680 it
->stop_charpos
= charpos
;
5681 if (s
== NULL
&& it
->multibyte_p
)
5683 EMACS_INT endpos
= SCHARS (it
->string
);
5684 if (endpos
> it
->end_charpos
)
5685 endpos
= it
->end_charpos
;
5686 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5694 /***********************************************************************
5696 ***********************************************************************/
5698 /* Map enum it_method value to corresponding next_element_from_* function. */
5700 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5702 next_element_from_buffer
,
5703 next_element_from_display_vector
,
5704 next_element_from_string
,
5705 next_element_from_c_string
,
5706 next_element_from_image
,
5707 next_element_from_stretch
5710 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5713 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5714 (possibly with the following characters). */
5716 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5717 ((IT)->cmp_it.id >= 0 \
5718 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5719 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5720 END_CHARPOS, (IT)->w, \
5721 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5725 /* Load IT's display element fields with information about the next
5726 display element from the current position of IT. Value is zero if
5727 end of buffer (or C string) is reached. */
5729 static struct frame
*last_escape_glyph_frame
= NULL
;
5730 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5731 static int last_escape_glyph_merged_face_id
= 0;
5734 get_next_display_element (struct it
*it
)
5736 /* Non-zero means that we found a display element. Zero means that
5737 we hit the end of what we iterate over. Performance note: the
5738 function pointer `method' used here turns out to be faster than
5739 using a sequence of if-statements. */
5743 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5745 if (it
->what
== IT_CHARACTER
)
5747 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5748 and only if (a) the resolved directionality of that character
5750 /* FIXME: Do we need an exception for characters from display
5752 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5753 it
->c
= bidi_mirror_char (it
->c
);
5754 /* Map via display table or translate control characters.
5755 IT->c, IT->len etc. have been set to the next character by
5756 the function call above. If we have a display table, and it
5757 contains an entry for IT->c, translate it. Don't do this if
5758 IT->c itself comes from a display table, otherwise we could
5759 end up in an infinite recursion. (An alternative could be to
5760 count the recursion depth of this function and signal an
5761 error when a certain maximum depth is reached.) Is it worth
5763 if (success_p
&& it
->dpvec
== NULL
)
5766 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5767 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5768 nbsp_or_shy
= char_is_other
;
5769 int c
= it
->c
; /* This is the character to display. */
5771 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5773 xassert (SINGLE_BYTE_CHAR_P (c
));
5774 if (unibyte_display_via_language_environment
)
5776 c
= DECODE_CHAR (unibyte
, c
);
5778 c
= BYTE8_TO_CHAR (it
->c
);
5781 c
= BYTE8_TO_CHAR (it
->c
);
5785 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5788 struct Lisp_Vector
*v
= XVECTOR (dv
);
5790 /* Return the first character from the display table
5791 entry, if not empty. If empty, don't display the
5792 current character. */
5795 it
->dpvec_char_len
= it
->len
;
5796 it
->dpvec
= v
->contents
;
5797 it
->dpend
= v
->contents
+ v
->size
;
5798 it
->current
.dpvec_index
= 0;
5799 it
->dpvec_face_id
= -1;
5800 it
->saved_face_id
= it
->face_id
;
5801 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5806 set_iterator_to_next (it
, 0);
5811 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5812 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5813 : c
== 0xAD ? char_is_soft_hyphen
5816 /* Translate control characters into `\003' or `^C' form.
5817 Control characters coming from a display table entry are
5818 currently not translated because we use IT->dpvec to hold
5819 the translation. This could easily be changed but I
5820 don't believe that it is worth doing.
5822 NBSP and SOFT-HYPEN are property translated too.
5824 Non-printable characters and raw-byte characters are also
5825 translated to octal form. */
5826 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5827 ? (it
->area
!= TEXT_AREA
5828 /* In mode line, treat \n, \t like other crl chars. */
5831 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5832 || (c
!= '\n' && c
!= '\t'))
5835 || ! CHAR_PRINTABLE_P (c
))))
5837 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5838 or a non-printable character which must be displayed
5839 either as '\003' or as `^C' where the '\\' and '^'
5840 can be defined in the display table. Fill
5841 IT->ctl_chars with glyphs for what we have to
5842 display. Then, set IT->dpvec to these glyphs. */
5845 int face_id
, lface_id
= 0 ;
5848 /* Handle control characters with ^. */
5850 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5854 g
= '^'; /* default glyph for Control */
5855 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5857 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5858 && GLYPH_CODE_CHAR_VALID_P (gc
))
5860 g
= GLYPH_CODE_CHAR (gc
);
5861 lface_id
= GLYPH_CODE_FACE (gc
);
5865 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5867 else if (it
->f
== last_escape_glyph_frame
5868 && it
->face_id
== last_escape_glyph_face_id
)
5870 face_id
= last_escape_glyph_merged_face_id
;
5874 /* Merge the escape-glyph face into the current face. */
5875 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5877 last_escape_glyph_frame
= it
->f
;
5878 last_escape_glyph_face_id
= it
->face_id
;
5879 last_escape_glyph_merged_face_id
= face_id
;
5882 XSETINT (it
->ctl_chars
[0], g
);
5883 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5885 goto display_control
;
5888 /* Handle non-break space in the mode where it only gets
5891 if (EQ (Vnobreak_char_display
, Qt
)
5892 && nbsp_or_shy
== char_is_nbsp
)
5894 /* Merge the no-break-space face into the current face. */
5895 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5899 XSETINT (it
->ctl_chars
[0], ' ');
5901 goto display_control
;
5904 /* Handle sequences that start with the "escape glyph". */
5906 /* the default escape glyph is \. */
5907 escape_glyph
= '\\';
5910 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5911 && GLYPH_CODE_CHAR_VALID_P (gc
))
5913 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5914 lface_id
= GLYPH_CODE_FACE (gc
);
5918 /* The display table specified a face.
5919 Merge it into face_id and also into escape_glyph. */
5920 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5923 else if (it
->f
== last_escape_glyph_frame
5924 && it
->face_id
== last_escape_glyph_face_id
)
5926 face_id
= last_escape_glyph_merged_face_id
;
5930 /* Merge the escape-glyph face into the current face. */
5931 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5933 last_escape_glyph_frame
= it
->f
;
5934 last_escape_glyph_face_id
= it
->face_id
;
5935 last_escape_glyph_merged_face_id
= face_id
;
5938 /* Handle soft hyphens in the mode where they only get
5941 if (EQ (Vnobreak_char_display
, Qt
)
5942 && nbsp_or_shy
== char_is_soft_hyphen
)
5944 XSETINT (it
->ctl_chars
[0], '-');
5946 goto display_control
;
5949 /* Handle non-break space and soft hyphen
5950 with the escape glyph. */
5954 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5955 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5956 XSETINT (it
->ctl_chars
[1], c
);
5958 goto display_control
;
5965 if (CHAR_BYTE8_P (c
))
5966 /* Display \200 instead of \17777600. */
5967 c
= CHAR_TO_BYTE8 (c
);
5968 len
= sprintf (str
, "%03o", c
);
5970 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5971 for (i
= 0; i
< len
; i
++)
5972 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5977 /* Set up IT->dpvec and return first character from it. */
5978 it
->dpvec_char_len
= it
->len
;
5979 it
->dpvec
= it
->ctl_chars
;
5980 it
->dpend
= it
->dpvec
+ ctl_len
;
5981 it
->current
.dpvec_index
= 0;
5982 it
->dpvec_face_id
= face_id
;
5983 it
->saved_face_id
= it
->face_id
;
5984 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5988 it
->char_to_display
= c
;
5992 it
->char_to_display
= it
->c
;
5996 #ifdef HAVE_WINDOW_SYSTEM
5997 /* Adjust face id for a multibyte character. There are no multibyte
5998 character in unibyte text. */
5999 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6002 && FRAME_WINDOW_P (it
->f
))
6004 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6006 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6008 /* Automatic composition with glyph-string. */
6009 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6011 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6015 int pos
= (it
->s
? -1
6016 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6017 : IT_CHARPOS (*it
));
6019 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6025 /* Is this character the last one of a run of characters with
6026 box? If yes, set IT->end_of_box_run_p to 1. */
6030 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6032 int face_id
= underlying_face_id (it
);
6033 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6037 if (face
->box
== FACE_NO_BOX
)
6039 /* If the box comes from face properties in a
6040 display string, check faces in that string. */
6041 int string_face_id
= face_after_it_pos (it
);
6042 it
->end_of_box_run_p
6043 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6046 /* Otherwise, the box comes from the underlying face.
6047 If this is the last string character displayed, check
6048 the next buffer location. */
6049 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6050 && (it
->current
.overlay_string_index
6051 == it
->n_overlay_strings
- 1))
6055 struct text_pos pos
= it
->current
.pos
;
6056 INC_TEXT_POS (pos
, it
->multibyte_p
);
6058 next_face_id
= face_at_buffer_position
6059 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6060 it
->region_end_charpos
, &ignore
,
6061 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6063 it
->end_of_box_run_p
6064 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6071 int face_id
= face_after_it_pos (it
);
6072 it
->end_of_box_run_p
6073 = (face_id
!= it
->face_id
6074 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6078 /* Value is 0 if end of buffer or string reached. */
6083 /* Move IT to the next display element.
6085 RESEAT_P non-zero means if called on a newline in buffer text,
6086 skip to the next visible line start.
6088 Functions get_next_display_element and set_iterator_to_next are
6089 separate because I find this arrangement easier to handle than a
6090 get_next_display_element function that also increments IT's
6091 position. The way it is we can first look at an iterator's current
6092 display element, decide whether it fits on a line, and if it does,
6093 increment the iterator position. The other way around we probably
6094 would either need a flag indicating whether the iterator has to be
6095 incremented the next time, or we would have to implement a
6096 decrement position function which would not be easy to write. */
6099 set_iterator_to_next (struct it
*it
, int reseat_p
)
6101 /* Reset flags indicating start and end of a sequence of characters
6102 with box. Reset them at the start of this function because
6103 moving the iterator to a new position might set them. */
6104 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6108 case GET_FROM_BUFFER
:
6109 /* The current display element of IT is a character from
6110 current_buffer. Advance in the buffer, and maybe skip over
6111 invisible lines that are so because of selective display. */
6112 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6113 reseat_at_next_visible_line_start (it
, 0);
6114 else if (it
->cmp_it
.id
>= 0)
6116 /* We are currently getting glyphs from a composition. */
6121 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6122 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6123 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6125 it
->cmp_it
.from
= it
->cmp_it
.to
;
6130 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6132 it
->end_charpos
, Qnil
);
6135 else if (! it
->cmp_it
.reversed_p
)
6137 /* Composition created while scanning forward. */
6138 /* Update IT's char/byte positions to point to the first
6139 character of the next grapheme cluster, or to the
6140 character visually after the current composition. */
6141 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6142 bidi_move_to_visually_next (&it
->bidi_it
);
6143 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6144 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6146 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6148 /* Proceed to the next grapheme cluster. */
6149 it
->cmp_it
.from
= it
->cmp_it
.to
;
6153 /* No more grapheme clusters in this composition.
6154 Find the next stop position. */
6155 EMACS_INT stop
= it
->end_charpos
;
6156 if (it
->bidi_it
.scan_dir
< 0)
6157 /* Now we are scanning backward and don't know
6160 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6161 IT_BYTEPOS (*it
), stop
, Qnil
);
6166 /* Composition created while scanning backward. */
6167 /* Update IT's char/byte positions to point to the last
6168 character of the previous grapheme cluster, or the
6169 character visually after the current composition. */
6170 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6171 bidi_move_to_visually_next (&it
->bidi_it
);
6172 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6173 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6174 if (it
->cmp_it
.from
> 0)
6176 /* Proceed to the previous grapheme cluster. */
6177 it
->cmp_it
.to
= it
->cmp_it
.from
;
6181 /* No more grapheme clusters in this composition.
6182 Find the next stop position. */
6183 EMACS_INT stop
= it
->end_charpos
;
6184 if (it
->bidi_it
.scan_dir
< 0)
6185 /* Now we are scanning backward and don't know
6188 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6189 IT_BYTEPOS (*it
), stop
, Qnil
);
6195 xassert (it
->len
!= 0);
6199 IT_BYTEPOS (*it
) += it
->len
;
6200 IT_CHARPOS (*it
) += 1;
6204 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6205 /* If this is a new paragraph, determine its base
6206 direction (a.k.a. its base embedding level). */
6207 if (it
->bidi_it
.new_paragraph
)
6208 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6209 bidi_move_to_visually_next (&it
->bidi_it
);
6210 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6211 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6212 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6214 /* As the scan direction was changed, we must
6215 re-compute the stop position for composition. */
6216 EMACS_INT stop
= it
->end_charpos
;
6217 if (it
->bidi_it
.scan_dir
< 0)
6219 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6220 IT_BYTEPOS (*it
), stop
, Qnil
);
6223 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6227 case GET_FROM_C_STRING
:
6228 /* Current display element of IT is from a C string. */
6229 IT_BYTEPOS (*it
) += it
->len
;
6230 IT_CHARPOS (*it
) += 1;
6233 case GET_FROM_DISPLAY_VECTOR
:
6234 /* Current display element of IT is from a display table entry.
6235 Advance in the display table definition. Reset it to null if
6236 end reached, and continue with characters from buffers/
6238 ++it
->current
.dpvec_index
;
6240 /* Restore face of the iterator to what they were before the
6241 display vector entry (these entries may contain faces). */
6242 it
->face_id
= it
->saved_face_id
;
6244 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6246 int recheck_faces
= it
->ellipsis_p
;
6249 it
->method
= GET_FROM_C_STRING
;
6250 else if (STRINGP (it
->string
))
6251 it
->method
= GET_FROM_STRING
;
6254 it
->method
= GET_FROM_BUFFER
;
6255 it
->object
= it
->w
->buffer
;
6259 it
->current
.dpvec_index
= -1;
6261 /* Skip over characters which were displayed via IT->dpvec. */
6262 if (it
->dpvec_char_len
< 0)
6263 reseat_at_next_visible_line_start (it
, 1);
6264 else if (it
->dpvec_char_len
> 0)
6266 if (it
->method
== GET_FROM_STRING
6267 && it
->n_overlay_strings
> 0)
6268 it
->ignore_overlay_strings_at_pos_p
= 1;
6269 it
->len
= it
->dpvec_char_len
;
6270 set_iterator_to_next (it
, reseat_p
);
6273 /* Maybe recheck faces after display vector */
6275 it
->stop_charpos
= IT_CHARPOS (*it
);
6279 case GET_FROM_STRING
:
6280 /* Current display element is a character from a Lisp string. */
6281 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6282 if (it
->cmp_it
.id
>= 0)
6284 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6285 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6286 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6287 it
->cmp_it
.from
= it
->cmp_it
.to
;
6291 composition_compute_stop_pos (&it
->cmp_it
,
6292 IT_STRING_CHARPOS (*it
),
6293 IT_STRING_BYTEPOS (*it
),
6294 it
->end_charpos
, it
->string
);
6299 IT_STRING_BYTEPOS (*it
) += it
->len
;
6300 IT_STRING_CHARPOS (*it
) += 1;
6303 consider_string_end
:
6305 if (it
->current
.overlay_string_index
>= 0)
6307 /* IT->string is an overlay string. Advance to the
6308 next, if there is one. */
6309 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6312 next_overlay_string (it
);
6314 setup_for_ellipsis (it
, 0);
6319 /* IT->string is not an overlay string. If we reached
6320 its end, and there is something on IT->stack, proceed
6321 with what is on the stack. This can be either another
6322 string, this time an overlay string, or a buffer. */
6323 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6327 if (it
->method
== GET_FROM_STRING
)
6328 goto consider_string_end
;
6333 case GET_FROM_IMAGE
:
6334 case GET_FROM_STRETCH
:
6335 /* The position etc with which we have to proceed are on
6336 the stack. The position may be at the end of a string,
6337 if the `display' property takes up the whole string. */
6338 xassert (it
->sp
> 0);
6340 if (it
->method
== GET_FROM_STRING
)
6341 goto consider_string_end
;
6345 /* There are no other methods defined, so this should be a bug. */
6349 xassert (it
->method
!= GET_FROM_STRING
6350 || (STRINGP (it
->string
)
6351 && IT_STRING_CHARPOS (*it
) >= 0));
6354 /* Load IT's display element fields with information about the next
6355 display element which comes from a display table entry or from the
6356 result of translating a control character to one of the forms `^C'
6359 IT->dpvec holds the glyphs to return as characters.
6360 IT->saved_face_id holds the face id before the display vector--it
6361 is restored into IT->face_id in set_iterator_to_next. */
6364 next_element_from_display_vector (struct it
*it
)
6369 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6371 it
->face_id
= it
->saved_face_id
;
6373 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6374 That seemed totally bogus - so I changed it... */
6375 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6377 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6379 it
->c
= GLYPH_CODE_CHAR (gc
);
6380 it
->len
= CHAR_BYTES (it
->c
);
6382 /* The entry may contain a face id to use. Such a face id is
6383 the id of a Lisp face, not a realized face. A face id of
6384 zero means no face is specified. */
6385 if (it
->dpvec_face_id
>= 0)
6386 it
->face_id
= it
->dpvec_face_id
;
6389 int lface_id
= GLYPH_CODE_FACE (gc
);
6391 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6396 /* Display table entry is invalid. Return a space. */
6397 it
->c
= ' ', it
->len
= 1;
6399 /* Don't change position and object of the iterator here. They are
6400 still the values of the character that had this display table
6401 entry or was translated, and that's what we want. */
6402 it
->what
= IT_CHARACTER
;
6407 /* Load IT with the next display element from Lisp string IT->string.
6408 IT->current.string_pos is the current position within the string.
6409 If IT->current.overlay_string_index >= 0, the Lisp string is an
6413 next_element_from_string (struct it
*it
)
6415 struct text_pos position
;
6417 xassert (STRINGP (it
->string
));
6418 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6419 position
= it
->current
.string_pos
;
6421 /* Time to check for invisible text? */
6422 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6423 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6427 /* Since a handler may have changed IT->method, we must
6429 return GET_NEXT_DISPLAY_ELEMENT (it
);
6432 if (it
->current
.overlay_string_index
>= 0)
6434 /* Get the next character from an overlay string. In overlay
6435 strings, There is no field width or padding with spaces to
6437 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6442 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6443 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6444 && next_element_from_composition (it
))
6448 else if (STRING_MULTIBYTE (it
->string
))
6450 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6451 const unsigned char *s
= (SDATA (it
->string
)
6452 + IT_STRING_BYTEPOS (*it
));
6453 it
->c
= string_char_and_length (s
, &it
->len
);
6457 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6463 /* Get the next character from a Lisp string that is not an
6464 overlay string. Such strings come from the mode line, for
6465 example. We may have to pad with spaces, or truncate the
6466 string. See also next_element_from_c_string. */
6467 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6472 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6474 /* Pad with spaces. */
6475 it
->c
= ' ', it
->len
= 1;
6476 CHARPOS (position
) = BYTEPOS (position
) = -1;
6478 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6479 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6480 && next_element_from_composition (it
))
6484 else if (STRING_MULTIBYTE (it
->string
))
6486 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6487 const unsigned char *s
= (SDATA (it
->string
)
6488 + IT_STRING_BYTEPOS (*it
));
6489 it
->c
= string_char_and_length (s
, &it
->len
);
6493 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6498 /* Record what we have and where it came from. */
6499 it
->what
= IT_CHARACTER
;
6500 it
->object
= it
->string
;
6501 it
->position
= position
;
6506 /* Load IT with next display element from C string IT->s.
6507 IT->string_nchars is the maximum number of characters to return
6508 from the string. IT->end_charpos may be greater than
6509 IT->string_nchars when this function is called, in which case we
6510 may have to return padding spaces. Value is zero if end of string
6511 reached, including padding spaces. */
6514 next_element_from_c_string (struct it
*it
)
6519 it
->what
= IT_CHARACTER
;
6520 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6523 /* IT's position can be greater IT->string_nchars in case a field
6524 width or precision has been specified when the iterator was
6526 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6528 /* End of the game. */
6532 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6534 /* Pad with spaces. */
6535 it
->c
= ' ', it
->len
= 1;
6536 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6538 else if (it
->multibyte_p
)
6540 /* Implementation note: The calls to strlen apparently aren't a
6541 performance problem because there is no noticeable performance
6542 difference between Emacs running in unibyte or multibyte mode. */
6543 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6544 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6547 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6553 /* Set up IT to return characters from an ellipsis, if appropriate.
6554 The definition of the ellipsis glyphs may come from a display table
6555 entry. This function fills IT with the first glyph from the
6556 ellipsis if an ellipsis is to be displayed. */
6559 next_element_from_ellipsis (struct it
*it
)
6561 if (it
->selective_display_ellipsis_p
)
6562 setup_for_ellipsis (it
, it
->len
);
6565 /* The face at the current position may be different from the
6566 face we find after the invisible text. Remember what it
6567 was in IT->saved_face_id, and signal that it's there by
6568 setting face_before_selective_p. */
6569 it
->saved_face_id
= it
->face_id
;
6570 it
->method
= GET_FROM_BUFFER
;
6571 it
->object
= it
->w
->buffer
;
6572 reseat_at_next_visible_line_start (it
, 1);
6573 it
->face_before_selective_p
= 1;
6576 return GET_NEXT_DISPLAY_ELEMENT (it
);
6580 /* Deliver an image display element. The iterator IT is already
6581 filled with image information (done in handle_display_prop). Value
6586 next_element_from_image (struct it
*it
)
6588 it
->what
= IT_IMAGE
;
6589 it
->ignore_overlay_strings_at_pos_p
= 0;
6594 /* Fill iterator IT with next display element from a stretch glyph
6595 property. IT->object is the value of the text property. Value is
6599 next_element_from_stretch (struct it
*it
)
6601 it
->what
= IT_STRETCH
;
6605 /* Scan forward from CHARPOS in the current buffer, until we find a
6606 stop position > current IT's position. Then handle the stop
6607 position before that. This is called when we bump into a stop
6608 position while reordering bidirectional text. CHARPOS should be
6609 the last previously processed stop_pos (or BEGV, if none were
6610 processed yet) whose position is less that IT's current
6614 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6616 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6617 struct display_pos save_current
= it
->current
;
6618 struct text_pos save_position
= it
->position
;
6619 struct text_pos pos1
;
6620 EMACS_INT next_stop
;
6622 /* Scan in strict logical order. */
6626 it
->prev_stop
= charpos
;
6627 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6628 reseat_1 (it
, pos1
, 0);
6629 compute_stop_pos (it
);
6630 /* We must advance forward, right? */
6631 if (it
->stop_charpos
<= it
->prev_stop
)
6633 charpos
= it
->stop_charpos
;
6635 while (charpos
<= where_we_are
);
6637 next_stop
= it
->stop_charpos
;
6638 it
->stop_charpos
= it
->prev_stop
;
6640 it
->current
= save_current
;
6641 it
->position
= save_position
;
6643 it
->stop_charpos
= next_stop
;
6646 /* Load IT with the next display element from current_buffer. Value
6647 is zero if end of buffer reached. IT->stop_charpos is the next
6648 position at which to stop and check for text properties or buffer
6652 next_element_from_buffer (struct it
*it
)
6656 xassert (IT_CHARPOS (*it
) >= BEGV
);
6658 /* With bidi reordering, the character to display might not be the
6659 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6660 we were reseat()ed to a new buffer position, which is potentially
6661 a different paragraph. */
6662 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6664 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6665 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6666 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6668 /* Nothing to do, but reset the FIRST_ELT flag, like
6669 bidi_paragraph_init does, because we are not going to
6671 it
->bidi_it
.first_elt
= 0;
6673 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6674 /* FIXME: Should support all Unicode line separators. */
6675 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6676 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6678 /* If we are at the beginning of a line, we can produce the
6679 next element right away. */
6680 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6681 bidi_move_to_visually_next (&it
->bidi_it
);
6685 int orig_bytepos
= IT_BYTEPOS (*it
);
6687 /* We need to prime the bidi iterator starting at the line's
6688 beginning, before we will be able to produce the next
6690 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6691 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6692 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6693 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6694 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6697 /* Now return to buffer position where we were asked to
6698 get the next display element, and produce that. */
6699 bidi_move_to_visually_next (&it
->bidi_it
);
6701 while (it
->bidi_it
.bytepos
!= orig_bytepos
6702 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6705 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6706 /* Adjust IT's position information to where we ended up. */
6707 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6708 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6709 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6711 EMACS_INT stop
= it
->end_charpos
;
6712 if (it
->bidi_it
.scan_dir
< 0)
6714 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6715 IT_BYTEPOS (*it
), stop
, Qnil
);
6719 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6721 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6723 int overlay_strings_follow_p
;
6725 /* End of the game, except when overlay strings follow that
6726 haven't been returned yet. */
6727 if (it
->overlay_strings_at_end_processed_p
)
6728 overlay_strings_follow_p
= 0;
6731 it
->overlay_strings_at_end_processed_p
= 1;
6732 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6735 if (overlay_strings_follow_p
)
6736 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6740 it
->position
= it
->current
.pos
;
6744 else if (!(!it
->bidi_p
6745 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6746 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6748 /* With bidi non-linear iteration, we could find ourselves
6749 far beyond the last computed stop_charpos, with several
6750 other stop positions in between that we missed. Scan
6751 them all now, in buffer's logical order, until we find
6752 and handle the last stop_charpos that precedes our
6753 current position. */
6754 handle_stop_backwards (it
, it
->stop_charpos
);
6755 return GET_NEXT_DISPLAY_ELEMENT (it
);
6761 /* Take note of the stop position we just moved across,
6762 for when we will move back across it. */
6763 it
->prev_stop
= it
->stop_charpos
;
6764 /* If we are at base paragraph embedding level, take
6765 note of the last stop position seen at this
6767 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6768 it
->base_level_stop
= it
->stop_charpos
;
6771 return GET_NEXT_DISPLAY_ELEMENT (it
);
6775 /* We can sometimes back up for reasons that have nothing
6776 to do with bidi reordering. E.g., compositions. The
6777 code below is only needed when we are above the base
6778 embedding level, so test for that explicitly. */
6779 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6780 && IT_CHARPOS (*it
) < it
->prev_stop
)
6782 if (it
->base_level_stop
<= 0)
6783 it
->base_level_stop
= BEGV
;
6784 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6786 handle_stop_backwards (it
, it
->base_level_stop
);
6787 return GET_NEXT_DISPLAY_ELEMENT (it
);
6791 /* No face changes, overlays etc. in sight, so just return a
6792 character from current_buffer. */
6796 /* Maybe run the redisplay end trigger hook. Performance note:
6797 This doesn't seem to cost measurable time. */
6798 if (it
->redisplay_end_trigger_charpos
6800 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6801 run_redisplay_end_trigger_hook (it
);
6803 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6804 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6806 && next_element_from_composition (it
))
6811 /* Get the next character, maybe multibyte. */
6812 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6813 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6814 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6816 it
->c
= *p
, it
->len
= 1;
6818 /* Record what we have and where it came from. */
6819 it
->what
= IT_CHARACTER
;
6820 it
->object
= it
->w
->buffer
;
6821 it
->position
= it
->current
.pos
;
6823 /* Normally we return the character found above, except when we
6824 really want to return an ellipsis for selective display. */
6829 /* A value of selective > 0 means hide lines indented more
6830 than that number of columns. */
6831 if (it
->selective
> 0
6832 && IT_CHARPOS (*it
) + 1 < ZV
6833 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6834 IT_BYTEPOS (*it
) + 1,
6835 (double) it
->selective
)) /* iftc */
6837 success_p
= next_element_from_ellipsis (it
);
6838 it
->dpvec_char_len
= -1;
6841 else if (it
->c
== '\r' && it
->selective
== -1)
6843 /* A value of selective == -1 means that everything from the
6844 CR to the end of the line is invisible, with maybe an
6845 ellipsis displayed for it. */
6846 success_p
= next_element_from_ellipsis (it
);
6847 it
->dpvec_char_len
= -1;
6852 /* Value is zero if end of buffer reached. */
6853 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6858 /* Run the redisplay end trigger hook for IT. */
6861 run_redisplay_end_trigger_hook (struct it
*it
)
6863 Lisp_Object args
[3];
6865 /* IT->glyph_row should be non-null, i.e. we should be actually
6866 displaying something, or otherwise we should not run the hook. */
6867 xassert (it
->glyph_row
);
6869 /* Set up hook arguments. */
6870 args
[0] = Qredisplay_end_trigger_functions
;
6871 args
[1] = it
->window
;
6872 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6873 it
->redisplay_end_trigger_charpos
= 0;
6875 /* Since we are *trying* to run these functions, don't try to run
6876 them again, even if they get an error. */
6877 it
->w
->redisplay_end_trigger
= Qnil
;
6878 Frun_hook_with_args (3, args
);
6880 /* Notice if it changed the face of the character we are on. */
6881 handle_face_prop (it
);
6885 /* Deliver a composition display element. Unlike the other
6886 next_element_from_XXX, this function is not registered in the array
6887 get_next_element[]. It is called from next_element_from_buffer and
6888 next_element_from_string when necessary. */
6891 next_element_from_composition (struct it
*it
)
6893 it
->what
= IT_COMPOSITION
;
6894 it
->len
= it
->cmp_it
.nbytes
;
6895 if (STRINGP (it
->string
))
6899 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6900 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6903 it
->position
= it
->current
.string_pos
;
6904 it
->object
= it
->string
;
6905 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6906 IT_STRING_BYTEPOS (*it
), it
->string
);
6912 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6913 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6916 if (it
->bidi_it
.new_paragraph
)
6917 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6918 /* Resync the bidi iterator with IT's new position.
6919 FIXME: this doesn't support bidirectional text. */
6920 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6921 bidi_move_to_visually_next (&it
->bidi_it
);
6925 it
->position
= it
->current
.pos
;
6926 it
->object
= it
->w
->buffer
;
6927 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6928 IT_BYTEPOS (*it
), Qnil
);
6935 /***********************************************************************
6936 Moving an iterator without producing glyphs
6937 ***********************************************************************/
6939 /* Check if iterator is at a position corresponding to a valid buffer
6940 position after some move_it_ call. */
6942 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6943 ((it)->method == GET_FROM_STRING \
6944 ? IT_STRING_CHARPOS (*it) == 0 \
6948 /* Move iterator IT to a specified buffer or X position within one
6949 line on the display without producing glyphs.
6951 OP should be a bit mask including some or all of these bits:
6952 MOVE_TO_X: Stop upon reaching x-position TO_X.
6953 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6954 Regardless of OP's value, stop upon reaching the end of the display line.
6956 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6957 This means, in particular, that TO_X includes window's horizontal
6960 The return value has several possible values that
6961 say what condition caused the scan to stop:
6963 MOVE_POS_MATCH_OR_ZV
6964 - when TO_POS or ZV was reached.
6967 -when TO_X was reached before TO_POS or ZV were reached.
6970 - when we reached the end of the display area and the line must
6974 - when we reached the end of the display area and the line is
6978 - when we stopped at a line end, i.e. a newline or a CR and selective
6981 static enum move_it_result
6982 move_it_in_display_line_to (struct it
*it
,
6983 EMACS_INT to_charpos
, int to_x
,
6984 enum move_operation_enum op
)
6986 enum move_it_result result
= MOVE_UNDEFINED
;
6987 struct glyph_row
*saved_glyph_row
;
6988 struct it wrap_it
, atpos_it
, atx_it
;
6990 enum it_method prev_method
= it
->method
;
6991 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6993 /* Don't produce glyphs in produce_glyphs. */
6994 saved_glyph_row
= it
->glyph_row
;
6995 it
->glyph_row
= NULL
;
6997 /* Use wrap_it to save a copy of IT wherever a word wrap could
6998 occur. Use atpos_it to save a copy of IT at the desired buffer
6999 position, if found, so that we can scan ahead and check if the
7000 word later overshoots the window edge. Use atx_it similarly, for
7006 #define BUFFER_POS_REACHED_P() \
7007 ((op & MOVE_TO_POS) != 0 \
7008 && BUFFERP (it->object) \
7009 && (IT_CHARPOS (*it) == to_charpos \
7010 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7011 && (it->method == GET_FROM_BUFFER \
7012 || (it->method == GET_FROM_DISPLAY_VECTOR \
7013 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7015 /* If there's a line-/wrap-prefix, handle it. */
7016 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7017 && it
->current_y
< it
->last_visible_y
)
7018 handle_line_prefix (it
);
7022 int x
, i
, ascent
= 0, descent
= 0;
7024 /* Utility macro to reset an iterator with x, ascent, and descent. */
7025 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7026 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7027 (IT)->max_descent = descent)
7029 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7031 if ((op
& MOVE_TO_POS
) != 0
7032 && BUFFERP (it
->object
)
7033 && it
->method
== GET_FROM_BUFFER
7034 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7036 && (prev_method
== GET_FROM_IMAGE
7037 || prev_method
== GET_FROM_STRETCH
)
7038 /* Passed TO_CHARPOS from left to right. */
7039 && ((prev_pos
< to_charpos
7040 && IT_CHARPOS (*it
) > to_charpos
)
7041 /* Passed TO_CHARPOS from right to left. */
7042 || (prev_pos
> to_charpos
7043 && IT_CHARPOS (*it
) < to_charpos
)))))
7045 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7047 result
= MOVE_POS_MATCH_OR_ZV
;
7050 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7051 /* If wrap_it is valid, the current position might be in a
7052 word that is wrapped. So, save the iterator in
7053 atpos_it and continue to see if wrapping happens. */
7057 prev_method
= it
->method
;
7058 if (it
->method
== GET_FROM_BUFFER
)
7059 prev_pos
= IT_CHARPOS (*it
);
7060 /* Stop when ZV reached.
7061 We used to stop here when TO_CHARPOS reached as well, but that is
7062 too soon if this glyph does not fit on this line. So we handle it
7063 explicitly below. */
7064 if (!get_next_display_element (it
))
7066 result
= MOVE_POS_MATCH_OR_ZV
;
7070 if (it
->line_wrap
== TRUNCATE
)
7072 if (BUFFER_POS_REACHED_P ())
7074 result
= MOVE_POS_MATCH_OR_ZV
;
7080 if (it
->line_wrap
== WORD_WRAP
)
7082 if (IT_DISPLAYING_WHITESPACE (it
))
7086 /* We have reached a glyph that follows one or more
7087 whitespace characters. If the position is
7088 already found, we are done. */
7089 if (atpos_it
.sp
>= 0)
7092 result
= MOVE_POS_MATCH_OR_ZV
;
7098 result
= MOVE_X_REACHED
;
7101 /* Otherwise, we can wrap here. */
7108 /* Remember the line height for the current line, in case
7109 the next element doesn't fit on the line. */
7110 ascent
= it
->max_ascent
;
7111 descent
= it
->max_descent
;
7113 /* The call to produce_glyphs will get the metrics of the
7114 display element IT is loaded with. Record the x-position
7115 before this display element, in case it doesn't fit on the
7119 PRODUCE_GLYPHS (it
);
7121 if (it
->area
!= TEXT_AREA
)
7123 set_iterator_to_next (it
, 1);
7127 /* The number of glyphs we get back in IT->nglyphs will normally
7128 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7129 character on a terminal frame, or (iii) a line end. For the
7130 second case, IT->nglyphs - 1 padding glyphs will be present.
7131 (On X frames, there is only one glyph produced for a
7132 composite character.)
7134 The behavior implemented below means, for continuation lines,
7135 that as many spaces of a TAB as fit on the current line are
7136 displayed there. For terminal frames, as many glyphs of a
7137 multi-glyph character are displayed in the current line, too.
7138 This is what the old redisplay code did, and we keep it that
7139 way. Under X, the whole shape of a complex character must
7140 fit on the line or it will be completely displayed in the
7143 Note that both for tabs and padding glyphs, all glyphs have
7147 /* More than one glyph or glyph doesn't fit on line. All
7148 glyphs have the same width. */
7149 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7151 int x_before_this_char
= x
;
7152 int hpos_before_this_char
= it
->hpos
;
7154 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7156 new_x
= x
+ single_glyph_width
;
7158 /* We want to leave anything reaching TO_X to the caller. */
7159 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7161 if (BUFFER_POS_REACHED_P ())
7163 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7164 goto buffer_pos_reached
;
7165 if (atpos_it
.sp
< 0)
7168 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7173 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7176 result
= MOVE_X_REACHED
;
7182 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7187 if (/* Lines are continued. */
7188 it
->line_wrap
!= TRUNCATE
7189 && (/* And glyph doesn't fit on the line. */
7190 new_x
> it
->last_visible_x
7191 /* Or it fits exactly and we're on a window
7193 || (new_x
== it
->last_visible_x
7194 && FRAME_WINDOW_P (it
->f
))))
7196 if (/* IT->hpos == 0 means the very first glyph
7197 doesn't fit on the line, e.g. a wide image. */
7199 || (new_x
== it
->last_visible_x
7200 && FRAME_WINDOW_P (it
->f
)))
7203 it
->current_x
= new_x
;
7205 /* The character's last glyph just barely fits
7207 if (i
== it
->nglyphs
- 1)
7209 /* If this is the destination position,
7210 return a position *before* it in this row,
7211 now that we know it fits in this row. */
7212 if (BUFFER_POS_REACHED_P ())
7214 if (it
->line_wrap
!= WORD_WRAP
7217 it
->hpos
= hpos_before_this_char
;
7218 it
->current_x
= x_before_this_char
;
7219 result
= MOVE_POS_MATCH_OR_ZV
;
7222 if (it
->line_wrap
== WORD_WRAP
7226 atpos_it
.current_x
= x_before_this_char
;
7227 atpos_it
.hpos
= hpos_before_this_char
;
7231 set_iterator_to_next (it
, 1);
7232 /* On graphical terminals, newlines may
7233 "overflow" into the fringe if
7234 overflow-newline-into-fringe is non-nil.
7235 On text-only terminals, newlines may
7236 overflow into the last glyph on the
7238 if (!FRAME_WINDOW_P (it
->f
)
7239 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7241 if (!get_next_display_element (it
))
7243 result
= MOVE_POS_MATCH_OR_ZV
;
7246 if (BUFFER_POS_REACHED_P ())
7248 if (ITERATOR_AT_END_OF_LINE_P (it
))
7249 result
= MOVE_POS_MATCH_OR_ZV
;
7251 result
= MOVE_LINE_CONTINUED
;
7254 if (ITERATOR_AT_END_OF_LINE_P (it
))
7256 result
= MOVE_NEWLINE_OR_CR
;
7263 IT_RESET_X_ASCENT_DESCENT (it
);
7265 if (wrap_it
.sp
>= 0)
7272 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7274 result
= MOVE_LINE_CONTINUED
;
7278 if (BUFFER_POS_REACHED_P ())
7280 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7281 goto buffer_pos_reached
;
7282 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7285 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7289 if (new_x
> it
->first_visible_x
)
7291 /* Glyph is visible. Increment number of glyphs that
7292 would be displayed. */
7297 if (result
!= MOVE_UNDEFINED
)
7300 else if (BUFFER_POS_REACHED_P ())
7303 IT_RESET_X_ASCENT_DESCENT (it
);
7304 result
= MOVE_POS_MATCH_OR_ZV
;
7307 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7309 /* Stop when TO_X specified and reached. This check is
7310 necessary here because of lines consisting of a line end,
7311 only. The line end will not produce any glyphs and we
7312 would never get MOVE_X_REACHED. */
7313 xassert (it
->nglyphs
== 0);
7314 result
= MOVE_X_REACHED
;
7318 /* Is this a line end? If yes, we're done. */
7319 if (ITERATOR_AT_END_OF_LINE_P (it
))
7321 result
= MOVE_NEWLINE_OR_CR
;
7325 if (it
->method
== GET_FROM_BUFFER
)
7326 prev_pos
= IT_CHARPOS (*it
);
7327 /* The current display element has been consumed. Advance
7329 set_iterator_to_next (it
, 1);
7331 /* Stop if lines are truncated and IT's current x-position is
7332 past the right edge of the window now. */
7333 if (it
->line_wrap
== TRUNCATE
7334 && it
->current_x
>= it
->last_visible_x
)
7336 if (!FRAME_WINDOW_P (it
->f
)
7337 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7339 if (!get_next_display_element (it
)
7340 || BUFFER_POS_REACHED_P ())
7342 result
= MOVE_POS_MATCH_OR_ZV
;
7345 if (ITERATOR_AT_END_OF_LINE_P (it
))
7347 result
= MOVE_NEWLINE_OR_CR
;
7351 result
= MOVE_LINE_TRUNCATED
;
7354 #undef IT_RESET_X_ASCENT_DESCENT
7357 #undef BUFFER_POS_REACHED_P
7359 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7360 restore the saved iterator. */
7361 if (atpos_it
.sp
>= 0)
7363 else if (atx_it
.sp
>= 0)
7368 /* Restore the iterator settings altered at the beginning of this
7370 it
->glyph_row
= saved_glyph_row
;
7374 /* For external use. */
7376 move_it_in_display_line (struct it
*it
,
7377 EMACS_INT to_charpos
, int to_x
,
7378 enum move_operation_enum op
)
7380 if (it
->line_wrap
== WORD_WRAP
7381 && (op
& MOVE_TO_X
))
7383 struct it save_it
= *it
;
7384 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7385 /* When word-wrap is on, TO_X may lie past the end
7386 of a wrapped line. Then it->current is the
7387 character on the next line, so backtrack to the
7388 space before the wrap point. */
7389 if (skip
== MOVE_LINE_CONTINUED
)
7391 int prev_x
= max (it
->current_x
- 1, 0);
7393 move_it_in_display_line_to
7394 (it
, -1, prev_x
, MOVE_TO_X
);
7398 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7402 /* Move IT forward until it satisfies one or more of the criteria in
7403 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7405 OP is a bit-mask that specifies where to stop, and in particular,
7406 which of those four position arguments makes a difference. See the
7407 description of enum move_operation_enum.
7409 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7410 screen line, this function will set IT to the next position >
7414 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7416 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7417 int line_height
, line_start_x
= 0, reached
= 0;
7421 if (op
& MOVE_TO_VPOS
)
7423 /* If no TO_CHARPOS and no TO_X specified, stop at the
7424 start of the line TO_VPOS. */
7425 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7427 if (it
->vpos
== to_vpos
)
7433 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7437 /* TO_VPOS >= 0 means stop at TO_X in the line at
7438 TO_VPOS, or at TO_POS, whichever comes first. */
7439 if (it
->vpos
== to_vpos
)
7445 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7447 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7452 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7454 /* We have reached TO_X but not in the line we want. */
7455 skip
= move_it_in_display_line_to (it
, to_charpos
,
7457 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7465 else if (op
& MOVE_TO_Y
)
7467 struct it it_backup
;
7469 if (it
->line_wrap
== WORD_WRAP
)
7472 /* TO_Y specified means stop at TO_X in the line containing
7473 TO_Y---or at TO_CHARPOS if this is reached first. The
7474 problem is that we can't really tell whether the line
7475 contains TO_Y before we have completely scanned it, and
7476 this may skip past TO_X. What we do is to first scan to
7479 If TO_X is not specified, use a TO_X of zero. The reason
7480 is to make the outcome of this function more predictable.
7481 If we didn't use TO_X == 0, we would stop at the end of
7482 the line which is probably not what a caller would expect
7484 skip
= move_it_in_display_line_to
7485 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7486 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7488 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7489 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7491 else if (skip
== MOVE_X_REACHED
)
7493 /* If TO_X was reached, we want to know whether TO_Y is
7494 in the line. We know this is the case if the already
7495 scanned glyphs make the line tall enough. Otherwise,
7496 we must check by scanning the rest of the line. */
7497 line_height
= it
->max_ascent
+ it
->max_descent
;
7498 if (to_y
>= it
->current_y
7499 && to_y
< it
->current_y
+ line_height
)
7505 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7506 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7508 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7509 line_height
= it
->max_ascent
+ it
->max_descent
;
7510 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7512 if (to_y
>= it
->current_y
7513 && to_y
< it
->current_y
+ line_height
)
7515 /* If TO_Y is in this line and TO_X was reached
7516 above, we scanned too far. We have to restore
7517 IT's settings to the ones before skipping. */
7524 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7530 /* Check whether TO_Y is in this line. */
7531 line_height
= it
->max_ascent
+ it
->max_descent
;
7532 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7534 if (to_y
>= it
->current_y
7535 && to_y
< it
->current_y
+ line_height
)
7537 /* When word-wrap is on, TO_X may lie past the end
7538 of a wrapped line. Then it->current is the
7539 character on the next line, so backtrack to the
7540 space before the wrap point. */
7541 if (skip
== MOVE_LINE_CONTINUED
7542 && it
->line_wrap
== WORD_WRAP
)
7544 int prev_x
= max (it
->current_x
- 1, 0);
7546 skip
= move_it_in_display_line_to
7547 (it
, -1, prev_x
, MOVE_TO_X
);
7556 else if (BUFFERP (it
->object
)
7557 && (it
->method
== GET_FROM_BUFFER
7558 || it
->method
== GET_FROM_STRETCH
)
7559 && IT_CHARPOS (*it
) >= to_charpos
)
7560 skip
= MOVE_POS_MATCH_OR_ZV
;
7562 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7566 case MOVE_POS_MATCH_OR_ZV
:
7570 case MOVE_NEWLINE_OR_CR
:
7571 set_iterator_to_next (it
, 1);
7572 it
->continuation_lines_width
= 0;
7575 case MOVE_LINE_TRUNCATED
:
7576 it
->continuation_lines_width
= 0;
7577 reseat_at_next_visible_line_start (it
, 0);
7578 if ((op
& MOVE_TO_POS
) != 0
7579 && IT_CHARPOS (*it
) > to_charpos
)
7586 case MOVE_LINE_CONTINUED
:
7587 /* For continued lines ending in a tab, some of the glyphs
7588 associated with the tab are displayed on the current
7589 line. Since it->current_x does not include these glyphs,
7590 we use it->last_visible_x instead. */
7593 it
->continuation_lines_width
+= it
->last_visible_x
;
7594 /* When moving by vpos, ensure that the iterator really
7595 advances to the next line (bug#847, bug#969). Fixme:
7596 do we need to do this in other circumstances? */
7597 if (it
->current_x
!= it
->last_visible_x
7598 && (op
& MOVE_TO_VPOS
)
7599 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7601 line_start_x
= it
->current_x
+ it
->pixel_width
7602 - it
->last_visible_x
;
7603 set_iterator_to_next (it
, 0);
7607 it
->continuation_lines_width
+= it
->current_x
;
7614 /* Reset/increment for the next run. */
7615 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7616 it
->current_x
= line_start_x
;
7619 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7621 last_height
= it
->max_ascent
+ it
->max_descent
;
7622 last_max_ascent
= it
->max_ascent
;
7623 it
->max_ascent
= it
->max_descent
= 0;
7628 /* On text terminals, we may stop at the end of a line in the middle
7629 of a multi-character glyph. If the glyph itself is continued,
7630 i.e. it is actually displayed on the next line, don't treat this
7631 stopping point as valid; move to the next line instead (unless
7632 that brings us offscreen). */
7633 if (!FRAME_WINDOW_P (it
->f
)
7635 && IT_CHARPOS (*it
) == to_charpos
7636 && it
->what
== IT_CHARACTER
7638 && it
->line_wrap
== WINDOW_WRAP
7639 && it
->current_x
== it
->last_visible_x
- 1
7642 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7644 it
->continuation_lines_width
+= it
->current_x
;
7645 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7646 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7648 last_height
= it
->max_ascent
+ it
->max_descent
;
7649 last_max_ascent
= it
->max_ascent
;
7652 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7656 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7658 If DY > 0, move IT backward at least that many pixels. DY = 0
7659 means move IT backward to the preceding line start or BEGV. This
7660 function may move over more than DY pixels if IT->current_y - DY
7661 ends up in the middle of a line; in this case IT->current_y will be
7662 set to the top of the line moved to. */
7665 move_it_vertically_backward (struct it
*it
, int dy
)
7674 start_pos
= IT_CHARPOS (*it
);
7676 /* Estimate how many newlines we must move back. */
7677 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7679 /* Set the iterator's position that many lines back. */
7680 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7681 back_to_previous_visible_line_start (it
);
7683 /* Reseat the iterator here. When moving backward, we don't want
7684 reseat to skip forward over invisible text, set up the iterator
7685 to deliver from overlay strings at the new position etc. So,
7686 use reseat_1 here. */
7687 reseat_1 (it
, it
->current
.pos
, 1);
7689 /* We are now surely at a line start. */
7690 it
->current_x
= it
->hpos
= 0;
7691 it
->continuation_lines_width
= 0;
7693 /* Move forward and see what y-distance we moved. First move to the
7694 start of the next line so that we get its height. We need this
7695 height to be able to tell whether we reached the specified
7698 it2
.max_ascent
= it2
.max_descent
= 0;
7701 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7702 MOVE_TO_POS
| MOVE_TO_VPOS
);
7704 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7705 xassert (IT_CHARPOS (*it
) >= BEGV
);
7708 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7709 xassert (IT_CHARPOS (*it
) >= BEGV
);
7710 /* H is the actual vertical distance from the position in *IT
7711 and the starting position. */
7712 h
= it2
.current_y
- it
->current_y
;
7713 /* NLINES is the distance in number of lines. */
7714 nlines
= it2
.vpos
- it
->vpos
;
7716 /* Correct IT's y and vpos position
7717 so that they are relative to the starting point. */
7723 /* DY == 0 means move to the start of the screen line. The
7724 value of nlines is > 0 if continuation lines were involved. */
7726 move_it_by_lines (it
, nlines
, 1);
7730 /* The y-position we try to reach, relative to *IT.
7731 Note that H has been subtracted in front of the if-statement. */
7732 int target_y
= it
->current_y
+ h
- dy
;
7733 int y0
= it3
.current_y
;
7734 int y1
= line_bottom_y (&it3
);
7735 int line_height
= y1
- y0
;
7737 /* If we did not reach target_y, try to move further backward if
7738 we can. If we moved too far backward, try to move forward. */
7739 if (target_y
< it
->current_y
7740 /* This is heuristic. In a window that's 3 lines high, with
7741 a line height of 13 pixels each, recentering with point
7742 on the bottom line will try to move -39/2 = 19 pixels
7743 backward. Try to avoid moving into the first line. */
7744 && (it
->current_y
- target_y
7745 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7746 && IT_CHARPOS (*it
) > BEGV
)
7748 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7749 target_y
- it
->current_y
));
7750 dy
= it
->current_y
- target_y
;
7751 goto move_further_back
;
7753 else if (target_y
>= it
->current_y
+ line_height
7754 && IT_CHARPOS (*it
) < ZV
)
7756 /* Should move forward by at least one line, maybe more.
7758 Note: Calling move_it_by_lines can be expensive on
7759 terminal frames, where compute_motion is used (via
7760 vmotion) to do the job, when there are very long lines
7761 and truncate-lines is nil. That's the reason for
7762 treating terminal frames specially here. */
7764 if (!FRAME_WINDOW_P (it
->f
))
7765 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7770 move_it_by_lines (it
, 1, 1);
7772 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7779 /* Move IT by a specified amount of pixel lines DY. DY negative means
7780 move backwards. DY = 0 means move to start of screen line. At the
7781 end, IT will be on the start of a screen line. */
7784 move_it_vertically (struct it
*it
, int dy
)
7787 move_it_vertically_backward (it
, -dy
);
7790 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7791 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7792 MOVE_TO_POS
| MOVE_TO_Y
);
7793 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7795 /* If buffer ends in ZV without a newline, move to the start of
7796 the line to satisfy the post-condition. */
7797 if (IT_CHARPOS (*it
) == ZV
7799 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7800 move_it_by_lines (it
, 0, 0);
7805 /* Move iterator IT past the end of the text line it is in. */
7808 move_it_past_eol (struct it
*it
)
7810 enum move_it_result rc
;
7812 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7813 if (rc
== MOVE_NEWLINE_OR_CR
)
7814 set_iterator_to_next (it
, 0);
7818 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7819 negative means move up. DVPOS == 0 means move to the start of the
7820 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7821 NEED_Y_P is zero, IT->current_y will be left unchanged.
7823 Further optimization ideas: If we would know that IT->f doesn't use
7824 a face with proportional font, we could be faster for
7825 truncate-lines nil. */
7828 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7830 struct position pos
;
7832 /* The commented-out optimization uses vmotion on terminals. This
7833 gives bad results, because elements like it->what, on which
7834 callers such as pos_visible_p rely, aren't updated. */
7835 /* if (!FRAME_WINDOW_P (it->f))
7837 struct text_pos textpos;
7839 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7840 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7841 reseat (it, textpos, 1);
7842 it->vpos += pos.vpos;
7843 it->current_y += pos.vpos;
7849 /* DVPOS == 0 means move to the start of the screen line. */
7850 move_it_vertically_backward (it
, 0);
7851 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7852 /* Let next call to line_bottom_y calculate real line height */
7857 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7858 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7859 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7864 int start_charpos
, i
;
7866 /* Start at the beginning of the screen line containing IT's
7867 position. This may actually move vertically backwards,
7868 in case of overlays, so adjust dvpos accordingly. */
7870 move_it_vertically_backward (it
, 0);
7873 /* Go back -DVPOS visible lines and reseat the iterator there. */
7874 start_charpos
= IT_CHARPOS (*it
);
7875 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7876 back_to_previous_visible_line_start (it
);
7877 reseat (it
, it
->current
.pos
, 1);
7879 /* Move further back if we end up in a string or an image. */
7880 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7882 /* First try to move to start of display line. */
7884 move_it_vertically_backward (it
, 0);
7886 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7888 /* If start of line is still in string or image,
7889 move further back. */
7890 back_to_previous_visible_line_start (it
);
7891 reseat (it
, it
->current
.pos
, 1);
7895 it
->current_x
= it
->hpos
= 0;
7897 /* Above call may have moved too far if continuation lines
7898 are involved. Scan forward and see if it did. */
7900 it2
.vpos
= it2
.current_y
= 0;
7901 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7902 it
->vpos
-= it2
.vpos
;
7903 it
->current_y
-= it2
.current_y
;
7904 it
->current_x
= it
->hpos
= 0;
7906 /* If we moved too far back, move IT some lines forward. */
7907 if (it2
.vpos
> -dvpos
)
7909 int delta
= it2
.vpos
+ dvpos
;
7911 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7912 /* Move back again if we got too far ahead. */
7913 if (IT_CHARPOS (*it
) >= start_charpos
)
7919 /* Return 1 if IT points into the middle of a display vector. */
7922 in_display_vector_p (struct it
*it
)
7924 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7925 && it
->current
.dpvec_index
> 0
7926 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7930 /***********************************************************************
7932 ***********************************************************************/
7935 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7939 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7941 Lisp_Object args
[3];
7942 Lisp_Object msg
, fmt
;
7945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7948 /* Do nothing if called asynchronously. Inserting text into
7949 a buffer may call after-change-functions and alike and
7950 that would means running Lisp asynchronously. */
7951 if (handling_signal
)
7955 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7957 args
[0] = fmt
= build_string (format
);
7960 msg
= Fformat (3, args
);
7962 len
= SBYTES (msg
) + 1;
7963 SAFE_ALLOCA (buffer
, char *, len
);
7964 memcpy (buffer
, SDATA (msg
), len
);
7966 message_dolog (buffer
, len
- 1, 1, 0);
7973 /* Output a newline in the *Messages* buffer if "needs" one. */
7976 message_log_maybe_newline (void)
7978 if (message_log_need_newline
)
7979 message_dolog ("", 0, 1, 0);
7983 /* Add a string M of length NBYTES to the message log, optionally
7984 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7985 nonzero, means interpret the contents of M as multibyte. This
7986 function calls low-level routines in order to bypass text property
7987 hooks, etc. which might not be safe to run.
7989 This may GC (insert may run before/after change hooks),
7990 so the buffer M must NOT point to a Lisp string. */
7993 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
7995 if (!NILP (Vmemory_full
))
7998 if (!NILP (Vmessage_log_max
))
8000 struct buffer
*oldbuf
;
8001 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8002 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8003 int point_at_end
= 0;
8005 Lisp_Object old_deactivate_mark
, tem
;
8006 struct gcpro gcpro1
;
8008 old_deactivate_mark
= Vdeactivate_mark
;
8009 oldbuf
= current_buffer
;
8010 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8011 current_buffer
->undo_list
= Qt
;
8013 oldpoint
= message_dolog_marker1
;
8014 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8015 oldbegv
= message_dolog_marker2
;
8016 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8017 oldzv
= message_dolog_marker3
;
8018 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8019 GCPRO1 (old_deactivate_mark
);
8027 BEGV_BYTE
= BEG_BYTE
;
8030 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8032 /* Insert the string--maybe converting multibyte to single byte
8033 or vice versa, so that all the text fits the buffer. */
8035 && NILP (current_buffer
->enable_multibyte_characters
))
8037 int i
, c
, char_bytes
;
8038 unsigned char work
[1];
8040 /* Convert a multibyte string to single-byte
8041 for the *Message* buffer. */
8042 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8044 c
= string_char_and_length (m
+ i
, &char_bytes
);
8045 work
[0] = (ASCII_CHAR_P (c
)
8047 : multibyte_char_to_unibyte (c
, Qnil
));
8048 insert_1_both (work
, 1, 1, 1, 0, 0);
8051 else if (! multibyte
8052 && ! NILP (current_buffer
->enable_multibyte_characters
))
8054 int i
, c
, char_bytes
;
8055 unsigned char *msg
= (unsigned char *) m
;
8056 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8057 /* Convert a single-byte string to multibyte
8058 for the *Message* buffer. */
8059 for (i
= 0; i
< nbytes
; i
++)
8062 MAKE_CHAR_MULTIBYTE (c
);
8063 char_bytes
= CHAR_STRING (c
, str
);
8064 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8068 insert_1 (m
, nbytes
, 1, 0, 0);
8072 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8073 insert_1 ("\n", 1, 1, 0, 0);
8075 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8077 this_bol_byte
= PT_BYTE
;
8079 /* See if this line duplicates the previous one.
8080 If so, combine duplicates. */
8083 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8085 prev_bol_byte
= PT_BYTE
;
8087 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8088 this_bol
, this_bol_byte
);
8091 del_range_both (prev_bol
, prev_bol_byte
,
8092 this_bol
, this_bol_byte
, 0);
8098 /* If you change this format, don't forget to also
8099 change message_log_check_duplicate. */
8100 sprintf (dupstr
, " [%d times]", dup
);
8101 duplen
= strlen (dupstr
);
8102 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8103 insert_1 (dupstr
, duplen
, 1, 0, 1);
8108 /* If we have more than the desired maximum number of lines
8109 in the *Messages* buffer now, delete the oldest ones.
8110 This is safe because we don't have undo in this buffer. */
8112 if (NATNUMP (Vmessage_log_max
))
8114 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8115 -XFASTINT (Vmessage_log_max
) - 1, 0);
8116 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8119 BEGV
= XMARKER (oldbegv
)->charpos
;
8120 BEGV_BYTE
= marker_byte_position (oldbegv
);
8129 ZV
= XMARKER (oldzv
)->charpos
;
8130 ZV_BYTE
= marker_byte_position (oldzv
);
8134 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8136 /* We can't do Fgoto_char (oldpoint) because it will run some
8138 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8139 XMARKER (oldpoint
)->bytepos
);
8142 unchain_marker (XMARKER (oldpoint
));
8143 unchain_marker (XMARKER (oldbegv
));
8144 unchain_marker (XMARKER (oldzv
));
8146 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8147 set_buffer_internal (oldbuf
);
8149 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8150 message_log_need_newline
= !nlflag
;
8151 Vdeactivate_mark
= old_deactivate_mark
;
8156 /* We are at the end of the buffer after just having inserted a newline.
8157 (Note: We depend on the fact we won't be crossing the gap.)
8158 Check to see if the most recent message looks a lot like the previous one.
8159 Return 0 if different, 1 if the new one should just replace it, or a
8160 value N > 1 if we should also append " [N times]". */
8163 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8164 int this_bol
, int this_bol_byte
)
8167 int len
= Z_BYTE
- 1 - this_bol_byte
;
8169 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8170 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8172 for (i
= 0; i
< len
; i
++)
8174 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8182 if (*p1
++ == ' ' && *p1
++ == '[')
8185 while (*p1
>= '0' && *p1
<= '9')
8186 n
= n
* 10 + *p1
++ - '0';
8187 if (strncmp (p1
, " times]\n", 8) == 0)
8194 /* Display an echo area message M with a specified length of NBYTES
8195 bytes. The string may include null characters. If M is 0, clear
8196 out any existing message, and let the mini-buffer text show
8199 This may GC, so the buffer M must NOT point to a Lisp string. */
8202 message2 (const char *m
, int nbytes
, int multibyte
)
8204 /* First flush out any partial line written with print. */
8205 message_log_maybe_newline ();
8207 message_dolog (m
, nbytes
, 1, multibyte
);
8208 message2_nolog (m
, nbytes
, multibyte
);
8212 /* The non-logging counterpart of message2. */
8215 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8217 struct frame
*sf
= SELECTED_FRAME ();
8218 message_enable_multibyte
= multibyte
;
8220 if (FRAME_INITIAL_P (sf
))
8222 if (noninteractive_need_newline
)
8223 putc ('\n', stderr
);
8224 noninteractive_need_newline
= 0;
8226 fwrite (m
, nbytes
, 1, stderr
);
8227 if (cursor_in_echo_area
== 0)
8228 fprintf (stderr
, "\n");
8231 /* A null message buffer means that the frame hasn't really been
8232 initialized yet. Error messages get reported properly by
8233 cmd_error, so this must be just an informative message; toss it. */
8234 else if (INTERACTIVE
8235 && sf
->glyphs_initialized_p
8236 && FRAME_MESSAGE_BUF (sf
))
8238 Lisp_Object mini_window
;
8241 /* Get the frame containing the mini-buffer
8242 that the selected frame is using. */
8243 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8244 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8246 FRAME_SAMPLE_VISIBILITY (f
);
8247 if (FRAME_VISIBLE_P (sf
)
8248 && ! FRAME_VISIBLE_P (f
))
8249 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8253 set_message (m
, Qnil
, nbytes
, multibyte
);
8254 if (minibuffer_auto_raise
)
8255 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8258 clear_message (1, 1);
8260 do_pending_window_change (0);
8261 echo_area_display (1);
8262 do_pending_window_change (0);
8263 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8264 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8269 /* Display an echo area message M with a specified length of NBYTES
8270 bytes. The string may include null characters. If M is not a
8271 string, clear out any existing message, and let the mini-buffer
8274 This function cancels echoing. */
8277 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8279 struct gcpro gcpro1
;
8282 clear_message (1,1);
8285 /* First flush out any partial line written with print. */
8286 message_log_maybe_newline ();
8292 SAFE_ALLOCA (buffer
, char *, nbytes
);
8293 memcpy (buffer
, SDATA (m
), nbytes
);
8294 message_dolog (buffer
, nbytes
, 1, multibyte
);
8297 message3_nolog (m
, nbytes
, multibyte
);
8303 /* The non-logging version of message3.
8304 This does not cancel echoing, because it is used for echoing.
8305 Perhaps we need to make a separate function for echoing
8306 and make this cancel echoing. */
8309 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8311 struct frame
*sf
= SELECTED_FRAME ();
8312 message_enable_multibyte
= multibyte
;
8314 if (FRAME_INITIAL_P (sf
))
8316 if (noninteractive_need_newline
)
8317 putc ('\n', stderr
);
8318 noninteractive_need_newline
= 0;
8320 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8321 if (cursor_in_echo_area
== 0)
8322 fprintf (stderr
, "\n");
8325 /* A null message buffer means that the frame hasn't really been
8326 initialized yet. Error messages get reported properly by
8327 cmd_error, so this must be just an informative message; toss it. */
8328 else if (INTERACTIVE
8329 && sf
->glyphs_initialized_p
8330 && FRAME_MESSAGE_BUF (sf
))
8332 Lisp_Object mini_window
;
8336 /* Get the frame containing the mini-buffer
8337 that the selected frame is using. */
8338 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8339 frame
= XWINDOW (mini_window
)->frame
;
8342 FRAME_SAMPLE_VISIBILITY (f
);
8343 if (FRAME_VISIBLE_P (sf
)
8344 && !FRAME_VISIBLE_P (f
))
8345 Fmake_frame_visible (frame
);
8347 if (STRINGP (m
) && SCHARS (m
) > 0)
8349 set_message (NULL
, m
, nbytes
, multibyte
);
8350 if (minibuffer_auto_raise
)
8351 Fraise_frame (frame
);
8352 /* Assume we are not echoing.
8353 (If we are, echo_now will override this.) */
8354 echo_message_buffer
= Qnil
;
8357 clear_message (1, 1);
8359 do_pending_window_change (0);
8360 echo_area_display (1);
8361 do_pending_window_change (0);
8362 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8363 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8368 /* Display a null-terminated echo area message M. If M is 0, clear
8369 out any existing message, and let the mini-buffer text show through.
8371 The buffer M must continue to exist until after the echo area gets
8372 cleared or some other message gets displayed there. Do not pass
8373 text that is stored in a Lisp string. Do not pass text in a buffer
8374 that was alloca'd. */
8377 message1 (const char *m
)
8379 message2 (m
, (m
? strlen (m
) : 0), 0);
8383 /* The non-logging counterpart of message1. */
8386 message1_nolog (const char *m
)
8388 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8391 /* Display a message M which contains a single %s
8392 which gets replaced with STRING. */
8395 message_with_string (const char *m
, Lisp_Object string
, int log
)
8397 CHECK_STRING (string
);
8403 if (noninteractive_need_newline
)
8404 putc ('\n', stderr
);
8405 noninteractive_need_newline
= 0;
8406 fprintf (stderr
, m
, SDATA (string
));
8407 if (!cursor_in_echo_area
)
8408 fprintf (stderr
, "\n");
8412 else if (INTERACTIVE
)
8414 /* The frame whose minibuffer we're going to display the message on.
8415 It may be larger than the selected frame, so we need
8416 to use its buffer, not the selected frame's buffer. */
8417 Lisp_Object mini_window
;
8418 struct frame
*f
, *sf
= SELECTED_FRAME ();
8420 /* Get the frame containing the minibuffer
8421 that the selected frame is using. */
8422 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8423 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8425 /* A null message buffer means that the frame hasn't really been
8426 initialized yet. Error messages get reported properly by
8427 cmd_error, so this must be just an informative message; toss it. */
8428 if (FRAME_MESSAGE_BUF (f
))
8430 Lisp_Object args
[2], message
;
8431 struct gcpro gcpro1
, gcpro2
;
8433 args
[0] = build_string (m
);
8434 args
[1] = message
= string
;
8435 GCPRO2 (args
[0], message
);
8438 message
= Fformat (2, args
);
8441 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8443 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8447 /* Print should start at the beginning of the message
8448 buffer next time. */
8449 message_buf_print
= 0;
8455 /* Dump an informative message to the minibuf. If M is 0, clear out
8456 any existing message, and let the mini-buffer text show through. */
8459 vmessage (const char *m
, va_list ap
)
8465 if (noninteractive_need_newline
)
8466 putc ('\n', stderr
);
8467 noninteractive_need_newline
= 0;
8468 vfprintf (stderr
, m
, ap
);
8469 if (cursor_in_echo_area
== 0)
8470 fprintf (stderr
, "\n");
8474 else if (INTERACTIVE
)
8476 /* The frame whose mini-buffer we're going to display the message
8477 on. It may be larger than the selected frame, so we need to
8478 use its buffer, not the selected frame's buffer. */
8479 Lisp_Object mini_window
;
8480 struct frame
*f
, *sf
= SELECTED_FRAME ();
8482 /* Get the frame containing the mini-buffer
8483 that the selected frame is using. */
8484 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8485 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8487 /* A null message buffer means that the frame hasn't really been
8488 initialized yet. Error messages get reported properly by
8489 cmd_error, so this must be just an informative message; toss
8491 if (FRAME_MESSAGE_BUF (f
))
8497 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8498 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8500 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8505 /* Print should start at the beginning of the message
8506 buffer next time. */
8507 message_buf_print
= 0;
8513 message (const char *m
, ...)
8522 /* The non-logging version of message. */
8525 message_nolog (const char *m
, ...)
8527 Lisp_Object old_log_max
;
8530 old_log_max
= Vmessage_log_max
;
8531 Vmessage_log_max
= Qnil
;
8533 Vmessage_log_max
= old_log_max
;
8538 /* Display the current message in the current mini-buffer. This is
8539 only called from error handlers in process.c, and is not time
8543 update_echo_area (void)
8545 if (!NILP (echo_area_buffer
[0]))
8548 string
= Fcurrent_message ();
8549 message3 (string
, SBYTES (string
),
8550 !NILP (current_buffer
->enable_multibyte_characters
));
8555 /* Make sure echo area buffers in `echo_buffers' are live.
8556 If they aren't, make new ones. */
8559 ensure_echo_area_buffers (void)
8563 for (i
= 0; i
< 2; ++i
)
8564 if (!BUFFERP (echo_buffer
[i
])
8565 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8568 Lisp_Object old_buffer
;
8571 old_buffer
= echo_buffer
[i
];
8572 sprintf (name
, " *Echo Area %d*", i
);
8573 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8574 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8575 /* to force word wrap in echo area -
8576 it was decided to postpone this*/
8577 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8579 for (j
= 0; j
< 2; ++j
)
8580 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8581 echo_area_buffer
[j
] = echo_buffer
[i
];
8586 /* Call FN with args A1..A4 with either the current or last displayed
8587 echo_area_buffer as current buffer.
8589 WHICH zero means use the current message buffer
8590 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8591 from echo_buffer[] and clear it.
8593 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8594 suitable buffer from echo_buffer[] and clear it.
8596 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8597 that the current message becomes the last displayed one, make
8598 choose a suitable buffer for echo_area_buffer[0], and clear it.
8600 Value is what FN returns. */
8603 with_echo_area_buffer (struct window
*w
, int which
,
8604 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8605 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8608 int this_one
, the_other
, clear_buffer_p
, rc
;
8609 int count
= SPECPDL_INDEX ();
8611 /* If buffers aren't live, make new ones. */
8612 ensure_echo_area_buffers ();
8617 this_one
= 0, the_other
= 1;
8619 this_one
= 1, the_other
= 0;
8622 this_one
= 0, the_other
= 1;
8625 /* We need a fresh one in case the current echo buffer equals
8626 the one containing the last displayed echo area message. */
8627 if (!NILP (echo_area_buffer
[this_one
])
8628 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8629 echo_area_buffer
[this_one
] = Qnil
;
8632 /* Choose a suitable buffer from echo_buffer[] is we don't
8634 if (NILP (echo_area_buffer
[this_one
]))
8636 echo_area_buffer
[this_one
]
8637 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8638 ? echo_buffer
[the_other
]
8639 : echo_buffer
[this_one
]);
8643 buffer
= echo_area_buffer
[this_one
];
8645 /* Don't get confused by reusing the buffer used for echoing
8646 for a different purpose. */
8647 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8650 record_unwind_protect (unwind_with_echo_area_buffer
,
8651 with_echo_area_buffer_unwind_data (w
));
8653 /* Make the echo area buffer current. Note that for display
8654 purposes, it is not necessary that the displayed window's buffer
8655 == current_buffer, except for text property lookup. So, let's
8656 only set that buffer temporarily here without doing a full
8657 Fset_window_buffer. We must also change w->pointm, though,
8658 because otherwise an assertions in unshow_buffer fails, and Emacs
8660 set_buffer_internal_1 (XBUFFER (buffer
));
8664 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8667 current_buffer
->undo_list
= Qt
;
8668 current_buffer
->read_only
= Qnil
;
8669 specbind (Qinhibit_read_only
, Qt
);
8670 specbind (Qinhibit_modification_hooks
, Qt
);
8672 if (clear_buffer_p
&& Z
> BEG
)
8675 xassert (BEGV
>= BEG
);
8676 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8678 rc
= fn (a1
, a2
, a3
, a4
);
8680 xassert (BEGV
>= BEG
);
8681 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8683 unbind_to (count
, Qnil
);
8688 /* Save state that should be preserved around the call to the function
8689 FN called in with_echo_area_buffer. */
8692 with_echo_area_buffer_unwind_data (struct window
*w
)
8695 Lisp_Object vector
, tmp
;
8697 /* Reduce consing by keeping one vector in
8698 Vwith_echo_area_save_vector. */
8699 vector
= Vwith_echo_area_save_vector
;
8700 Vwith_echo_area_save_vector
= Qnil
;
8703 vector
= Fmake_vector (make_number (7), Qnil
);
8705 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8706 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8707 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8711 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8712 ASET (vector
, i
, w
->buffer
); ++i
;
8713 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8714 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8719 for (; i
< end
; ++i
)
8720 ASET (vector
, i
, Qnil
);
8723 xassert (i
== ASIZE (vector
));
8728 /* Restore global state from VECTOR which was created by
8729 with_echo_area_buffer_unwind_data. */
8732 unwind_with_echo_area_buffer (Lisp_Object vector
)
8734 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8735 Vdeactivate_mark
= AREF (vector
, 1);
8736 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8738 if (WINDOWP (AREF (vector
, 3)))
8741 Lisp_Object buffer
, charpos
, bytepos
;
8743 w
= XWINDOW (AREF (vector
, 3));
8744 buffer
= AREF (vector
, 4);
8745 charpos
= AREF (vector
, 5);
8746 bytepos
= AREF (vector
, 6);
8749 set_marker_both (w
->pointm
, buffer
,
8750 XFASTINT (charpos
), XFASTINT (bytepos
));
8753 Vwith_echo_area_save_vector
= vector
;
8758 /* Set up the echo area for use by print functions. MULTIBYTE_P
8759 non-zero means we will print multibyte. */
8762 setup_echo_area_for_printing (int multibyte_p
)
8764 /* If we can't find an echo area any more, exit. */
8765 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8768 ensure_echo_area_buffers ();
8770 if (!message_buf_print
)
8772 /* A message has been output since the last time we printed.
8773 Choose a fresh echo area buffer. */
8774 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8775 echo_area_buffer
[0] = echo_buffer
[1];
8777 echo_area_buffer
[0] = echo_buffer
[0];
8779 /* Switch to that buffer and clear it. */
8780 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8781 current_buffer
->truncate_lines
= Qnil
;
8785 int count
= SPECPDL_INDEX ();
8786 specbind (Qinhibit_read_only
, Qt
);
8787 /* Note that undo recording is always disabled. */
8789 unbind_to (count
, Qnil
);
8791 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8793 /* Set up the buffer for the multibyteness we need. */
8795 != !NILP (current_buffer
->enable_multibyte_characters
))
8796 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8798 /* Raise the frame containing the echo area. */
8799 if (minibuffer_auto_raise
)
8801 struct frame
*sf
= SELECTED_FRAME ();
8802 Lisp_Object mini_window
;
8803 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8804 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8807 message_log_maybe_newline ();
8808 message_buf_print
= 1;
8812 if (NILP (echo_area_buffer
[0]))
8814 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8815 echo_area_buffer
[0] = echo_buffer
[1];
8817 echo_area_buffer
[0] = echo_buffer
[0];
8820 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8822 /* Someone switched buffers between print requests. */
8823 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8824 current_buffer
->truncate_lines
= Qnil
;
8830 /* Display an echo area message in window W. Value is non-zero if W's
8831 height is changed. If display_last_displayed_message_p is
8832 non-zero, display the message that was last displayed, otherwise
8833 display the current message. */
8836 display_echo_area (struct window
*w
)
8838 int i
, no_message_p
, window_height_changed_p
, count
;
8840 /* Temporarily disable garbage collections while displaying the echo
8841 area. This is done because a GC can print a message itself.
8842 That message would modify the echo area buffer's contents while a
8843 redisplay of the buffer is going on, and seriously confuse
8845 count
= inhibit_garbage_collection ();
8847 /* If there is no message, we must call display_echo_area_1
8848 nevertheless because it resizes the window. But we will have to
8849 reset the echo_area_buffer in question to nil at the end because
8850 with_echo_area_buffer will sets it to an empty buffer. */
8851 i
= display_last_displayed_message_p
? 1 : 0;
8852 no_message_p
= NILP (echo_area_buffer
[i
]);
8854 window_height_changed_p
8855 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8856 display_echo_area_1
,
8857 (EMACS_INT
) w
, Qnil
, 0, 0);
8860 echo_area_buffer
[i
] = Qnil
;
8862 unbind_to (count
, Qnil
);
8863 return window_height_changed_p
;
8867 /* Helper for display_echo_area. Display the current buffer which
8868 contains the current echo area message in window W, a mini-window,
8869 a pointer to which is passed in A1. A2..A4 are currently not used.
8870 Change the height of W so that all of the message is displayed.
8871 Value is non-zero if height of W was changed. */
8874 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8876 struct window
*w
= (struct window
*) a1
;
8878 struct text_pos start
;
8879 int window_height_changed_p
= 0;
8881 /* Do this before displaying, so that we have a large enough glyph
8882 matrix for the display. If we can't get enough space for the
8883 whole text, display the last N lines. That works by setting w->start. */
8884 window_height_changed_p
= resize_mini_window (w
, 0);
8886 /* Use the starting position chosen by resize_mini_window. */
8887 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8890 clear_glyph_matrix (w
->desired_matrix
);
8891 XSETWINDOW (window
, w
);
8892 try_window (window
, start
, 0);
8894 return window_height_changed_p
;
8898 /* Resize the echo area window to exactly the size needed for the
8899 currently displayed message, if there is one. If a mini-buffer
8900 is active, don't shrink it. */
8903 resize_echo_area_exactly (void)
8905 if (BUFFERP (echo_area_buffer
[0])
8906 && WINDOWP (echo_area_window
))
8908 struct window
*w
= XWINDOW (echo_area_window
);
8910 Lisp_Object resize_exactly
;
8912 if (minibuf_level
== 0)
8913 resize_exactly
= Qt
;
8915 resize_exactly
= Qnil
;
8917 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8918 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8921 ++windows_or_buffers_changed
;
8922 ++update_mode_lines
;
8923 redisplay_internal (0);
8929 /* Callback function for with_echo_area_buffer, when used from
8930 resize_echo_area_exactly. A1 contains a pointer to the window to
8931 resize, EXACTLY non-nil means resize the mini-window exactly to the
8932 size of the text displayed. A3 and A4 are not used. Value is what
8933 resize_mini_window returns. */
8936 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8938 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8942 /* Resize mini-window W to fit the size of its contents. EXACT_P
8943 means size the window exactly to the size needed. Otherwise, it's
8944 only enlarged until W's buffer is empty.
8946 Set W->start to the right place to begin display. If the whole
8947 contents fit, start at the beginning. Otherwise, start so as
8948 to make the end of the contents appear. This is particularly
8949 important for y-or-n-p, but seems desirable generally.
8951 Value is non-zero if the window height has been changed. */
8954 resize_mini_window (struct window
*w
, int exact_p
)
8956 struct frame
*f
= XFRAME (w
->frame
);
8957 int window_height_changed_p
= 0;
8959 xassert (MINI_WINDOW_P (w
));
8961 /* By default, start display at the beginning. */
8962 set_marker_both (w
->start
, w
->buffer
,
8963 BUF_BEGV (XBUFFER (w
->buffer
)),
8964 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8966 /* Don't resize windows while redisplaying a window; it would
8967 confuse redisplay functions when the size of the window they are
8968 displaying changes from under them. Such a resizing can happen,
8969 for instance, when which-func prints a long message while
8970 we are running fontification-functions. We're running these
8971 functions with safe_call which binds inhibit-redisplay to t. */
8972 if (!NILP (Vinhibit_redisplay
))
8975 /* Nil means don't try to resize. */
8976 if (NILP (Vresize_mini_windows
)
8977 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8980 if (!FRAME_MINIBUF_ONLY_P (f
))
8983 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8984 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8985 int height
, max_height
;
8986 int unit
= FRAME_LINE_HEIGHT (f
);
8987 struct text_pos start
;
8988 struct buffer
*old_current_buffer
= NULL
;
8990 if (current_buffer
!= XBUFFER (w
->buffer
))
8992 old_current_buffer
= current_buffer
;
8993 set_buffer_internal (XBUFFER (w
->buffer
));
8996 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8998 /* Compute the max. number of lines specified by the user. */
8999 if (FLOATP (Vmax_mini_window_height
))
9000 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9001 else if (INTEGERP (Vmax_mini_window_height
))
9002 max_height
= XINT (Vmax_mini_window_height
);
9004 max_height
= total_height
/ 4;
9006 /* Correct that max. height if it's bogus. */
9007 max_height
= max (1, max_height
);
9008 max_height
= min (total_height
, max_height
);
9010 /* Find out the height of the text in the window. */
9011 if (it
.line_wrap
== TRUNCATE
)
9016 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9017 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9018 height
= it
.current_y
+ last_height
;
9020 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9021 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9022 height
= (height
+ unit
- 1) / unit
;
9025 /* Compute a suitable window start. */
9026 if (height
> max_height
)
9028 height
= max_height
;
9029 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9030 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9031 start
= it
.current
.pos
;
9034 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9035 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9037 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9039 /* Let it grow only, until we display an empty message, in which
9040 case the window shrinks again. */
9041 if (height
> WINDOW_TOTAL_LINES (w
))
9043 int old_height
= WINDOW_TOTAL_LINES (w
);
9044 freeze_window_starts (f
, 1);
9045 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9046 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9048 else if (height
< WINDOW_TOTAL_LINES (w
)
9049 && (exact_p
|| BEGV
== ZV
))
9051 int old_height
= WINDOW_TOTAL_LINES (w
);
9052 freeze_window_starts (f
, 0);
9053 shrink_mini_window (w
);
9054 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9059 /* Always resize to exact size needed. */
9060 if (height
> WINDOW_TOTAL_LINES (w
))
9062 int old_height
= WINDOW_TOTAL_LINES (w
);
9063 freeze_window_starts (f
, 1);
9064 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9065 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9067 else if (height
< WINDOW_TOTAL_LINES (w
))
9069 int old_height
= WINDOW_TOTAL_LINES (w
);
9070 freeze_window_starts (f
, 0);
9071 shrink_mini_window (w
);
9075 freeze_window_starts (f
, 1);
9076 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9079 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9083 if (old_current_buffer
)
9084 set_buffer_internal (old_current_buffer
);
9087 return window_height_changed_p
;
9091 /* Value is the current message, a string, or nil if there is no
9095 current_message (void)
9099 if (!BUFFERP (echo_area_buffer
[0]))
9103 with_echo_area_buffer (0, 0, current_message_1
,
9104 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9106 echo_area_buffer
[0] = Qnil
;
9114 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9116 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9119 *msg
= make_buffer_string (BEG
, Z
, 1);
9126 /* Push the current message on Vmessage_stack for later restauration
9127 by restore_message. Value is non-zero if the current message isn't
9128 empty. This is a relatively infrequent operation, so it's not
9129 worth optimizing. */
9135 msg
= current_message ();
9136 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9137 return STRINGP (msg
);
9141 /* Restore message display from the top of Vmessage_stack. */
9144 restore_message (void)
9148 xassert (CONSP (Vmessage_stack
));
9149 msg
= XCAR (Vmessage_stack
);
9151 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9153 message3_nolog (msg
, 0, 0);
9157 /* Handler for record_unwind_protect calling pop_message. */
9160 pop_message_unwind (Lisp_Object dummy
)
9166 /* Pop the top-most entry off Vmessage_stack. */
9171 xassert (CONSP (Vmessage_stack
));
9172 Vmessage_stack
= XCDR (Vmessage_stack
);
9176 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9177 exits. If the stack is not empty, we have a missing pop_message
9181 check_message_stack (void)
9183 if (!NILP (Vmessage_stack
))
9188 /* Truncate to NCHARS what will be displayed in the echo area the next
9189 time we display it---but don't redisplay it now. */
9192 truncate_echo_area (int nchars
)
9195 echo_area_buffer
[0] = Qnil
;
9196 /* A null message buffer means that the frame hasn't really been
9197 initialized yet. Error messages get reported properly by
9198 cmd_error, so this must be just an informative message; toss it. */
9199 else if (!noninteractive
9201 && !NILP (echo_area_buffer
[0]))
9203 struct frame
*sf
= SELECTED_FRAME ();
9204 if (FRAME_MESSAGE_BUF (sf
))
9205 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9210 /* Helper function for truncate_echo_area. Truncate the current
9211 message to at most NCHARS characters. */
9214 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9216 if (BEG
+ nchars
< Z
)
9217 del_range (BEG
+ nchars
, Z
);
9219 echo_area_buffer
[0] = Qnil
;
9224 /* Set the current message to a substring of S or STRING.
9226 If STRING is a Lisp string, set the message to the first NBYTES
9227 bytes from STRING. NBYTES zero means use the whole string. If
9228 STRING is multibyte, the message will be displayed multibyte.
9230 If S is not null, set the message to the first LEN bytes of S. LEN
9231 zero means use the whole string. MULTIBYTE_P non-zero means S is
9232 multibyte. Display the message multibyte in that case.
9234 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9235 to t before calling set_message_1 (which calls insert).
9239 set_message (const char *s
, Lisp_Object string
, int nbytes
, int multibyte_p
)
9241 message_enable_multibyte
9242 = ((s
&& multibyte_p
)
9243 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9245 with_echo_area_buffer (0, -1, set_message_1
,
9246 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9247 message_buf_print
= 0;
9248 help_echo_showing_p
= 0;
9252 /* Helper function for set_message. Arguments have the same meaning
9253 as there, with A1 corresponding to S and A2 corresponding to STRING
9254 This function is called with the echo area buffer being
9258 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9260 const char *s
= (const char *) a1
;
9261 Lisp_Object string
= a2
;
9263 /* Change multibyteness of the echo buffer appropriately. */
9264 if (message_enable_multibyte
9265 != !NILP (current_buffer
->enable_multibyte_characters
))
9266 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9268 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9270 /* Insert new message at BEG. */
9271 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9273 if (STRINGP (string
))
9278 nbytes
= SBYTES (string
);
9279 nchars
= string_byte_to_char (string
, nbytes
);
9281 /* This function takes care of single/multibyte conversion. We
9282 just have to ensure that the echo area buffer has the right
9283 setting of enable_multibyte_characters. */
9284 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9289 nbytes
= strlen (s
);
9291 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9293 /* Convert from multi-byte to single-byte. */
9295 unsigned char work
[1];
9297 /* Convert a multibyte string to single-byte. */
9298 for (i
= 0; i
< nbytes
; i
+= n
)
9300 c
= string_char_and_length (s
+ i
, &n
);
9301 work
[0] = (ASCII_CHAR_P (c
)
9303 : multibyte_char_to_unibyte (c
, Qnil
));
9304 insert_1_both (work
, 1, 1, 1, 0, 0);
9307 else if (!multibyte_p
9308 && !NILP (current_buffer
->enable_multibyte_characters
))
9310 /* Convert from single-byte to multi-byte. */
9312 const unsigned char *msg
= (const unsigned char *) s
;
9313 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9315 /* Convert a single-byte string to multibyte. */
9316 for (i
= 0; i
< nbytes
; i
++)
9319 MAKE_CHAR_MULTIBYTE (c
);
9320 n
= CHAR_STRING (c
, str
);
9321 insert_1_both (str
, 1, n
, 1, 0, 0);
9325 insert_1 (s
, nbytes
, 1, 0, 0);
9332 /* Clear messages. CURRENT_P non-zero means clear the current
9333 message. LAST_DISPLAYED_P non-zero means clear the message
9337 clear_message (int current_p
, int last_displayed_p
)
9341 echo_area_buffer
[0] = Qnil
;
9342 message_cleared_p
= 1;
9345 if (last_displayed_p
)
9346 echo_area_buffer
[1] = Qnil
;
9348 message_buf_print
= 0;
9351 /* Clear garbaged frames.
9353 This function is used where the old redisplay called
9354 redraw_garbaged_frames which in turn called redraw_frame which in
9355 turn called clear_frame. The call to clear_frame was a source of
9356 flickering. I believe a clear_frame is not necessary. It should
9357 suffice in the new redisplay to invalidate all current matrices,
9358 and ensure a complete redisplay of all windows. */
9361 clear_garbaged_frames (void)
9365 Lisp_Object tail
, frame
;
9366 int changed_count
= 0;
9368 FOR_EACH_FRAME (tail
, frame
)
9370 struct frame
*f
= XFRAME (frame
);
9372 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9376 Fredraw_frame (frame
);
9377 f
->force_flush_display_p
= 1;
9379 clear_current_matrices (f
);
9388 ++windows_or_buffers_changed
;
9393 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9394 is non-zero update selected_frame. Value is non-zero if the
9395 mini-windows height has been changed. */
9398 echo_area_display (int update_frame_p
)
9400 Lisp_Object mini_window
;
9403 int window_height_changed_p
= 0;
9404 struct frame
*sf
= SELECTED_FRAME ();
9406 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9407 w
= XWINDOW (mini_window
);
9408 f
= XFRAME (WINDOW_FRAME (w
));
9410 /* Don't display if frame is invisible or not yet initialized. */
9411 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9414 #ifdef HAVE_WINDOW_SYSTEM
9415 /* When Emacs starts, selected_frame may be the initial terminal
9416 frame. If we let this through, a message would be displayed on
9418 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9420 #endif /* HAVE_WINDOW_SYSTEM */
9422 /* Redraw garbaged frames. */
9424 clear_garbaged_frames ();
9426 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9428 echo_area_window
= mini_window
;
9429 window_height_changed_p
= display_echo_area (w
);
9430 w
->must_be_updated_p
= 1;
9432 /* Update the display, unless called from redisplay_internal.
9433 Also don't update the screen during redisplay itself. The
9434 update will happen at the end of redisplay, and an update
9435 here could cause confusion. */
9436 if (update_frame_p
&& !redisplaying_p
)
9440 /* If the display update has been interrupted by pending
9441 input, update mode lines in the frame. Due to the
9442 pending input, it might have been that redisplay hasn't
9443 been called, so that mode lines above the echo area are
9444 garbaged. This looks odd, so we prevent it here. */
9445 if (!display_completed
)
9446 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9448 if (window_height_changed_p
9449 /* Don't do this if Emacs is shutting down. Redisplay
9450 needs to run hooks. */
9451 && !NILP (Vrun_hooks
))
9453 /* Must update other windows. Likewise as in other
9454 cases, don't let this update be interrupted by
9456 int count
= SPECPDL_INDEX ();
9457 specbind (Qredisplay_dont_pause
, Qt
);
9458 windows_or_buffers_changed
= 1;
9459 redisplay_internal (0);
9460 unbind_to (count
, Qnil
);
9462 else if (FRAME_WINDOW_P (f
) && n
== 0)
9464 /* Window configuration is the same as before.
9465 Can do with a display update of the echo area,
9466 unless we displayed some mode lines. */
9467 update_single_window (w
, 1);
9468 FRAME_RIF (f
)->flush_display (f
);
9471 update_frame (f
, 1, 1);
9473 /* If cursor is in the echo area, make sure that the next
9474 redisplay displays the minibuffer, so that the cursor will
9475 be replaced with what the minibuffer wants. */
9476 if (cursor_in_echo_area
)
9477 ++windows_or_buffers_changed
;
9480 else if (!EQ (mini_window
, selected_window
))
9481 windows_or_buffers_changed
++;
9483 /* Last displayed message is now the current message. */
9484 echo_area_buffer
[1] = echo_area_buffer
[0];
9485 /* Inform read_char that we're not echoing. */
9486 echo_message_buffer
= Qnil
;
9488 /* Prevent redisplay optimization in redisplay_internal by resetting
9489 this_line_start_pos. This is done because the mini-buffer now
9490 displays the message instead of its buffer text. */
9491 if (EQ (mini_window
, selected_window
))
9492 CHARPOS (this_line_start_pos
) = 0;
9494 return window_height_changed_p
;
9499 /***********************************************************************
9500 Mode Lines and Frame Titles
9501 ***********************************************************************/
9503 /* A buffer for constructing non-propertized mode-line strings and
9504 frame titles in it; allocated from the heap in init_xdisp and
9505 resized as needed in store_mode_line_noprop_char. */
9507 static char *mode_line_noprop_buf
;
9509 /* The buffer's end, and a current output position in it. */
9511 static char *mode_line_noprop_buf_end
;
9512 static char *mode_line_noprop_ptr
;
9514 #define MODE_LINE_NOPROP_LEN(start) \
9515 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9518 MODE_LINE_DISPLAY
= 0,
9524 /* Alist that caches the results of :propertize.
9525 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9526 static Lisp_Object mode_line_proptrans_alist
;
9528 /* List of strings making up the mode-line. */
9529 static Lisp_Object mode_line_string_list
;
9531 /* Base face property when building propertized mode line string. */
9532 static Lisp_Object mode_line_string_face
;
9533 static Lisp_Object mode_line_string_face_prop
;
9536 /* Unwind data for mode line strings */
9538 static Lisp_Object Vmode_line_unwind_vector
;
9541 format_mode_line_unwind_data (struct buffer
*obuf
,
9545 Lisp_Object vector
, tmp
;
9547 /* Reduce consing by keeping one vector in
9548 Vwith_echo_area_save_vector. */
9549 vector
= Vmode_line_unwind_vector
;
9550 Vmode_line_unwind_vector
= Qnil
;
9553 vector
= Fmake_vector (make_number (8), Qnil
);
9555 ASET (vector
, 0, make_number (mode_line_target
));
9556 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9557 ASET (vector
, 2, mode_line_string_list
);
9558 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9559 ASET (vector
, 4, mode_line_string_face
);
9560 ASET (vector
, 5, mode_line_string_face_prop
);
9563 XSETBUFFER (tmp
, obuf
);
9566 ASET (vector
, 6, tmp
);
9567 ASET (vector
, 7, owin
);
9573 unwind_format_mode_line (Lisp_Object vector
)
9575 mode_line_target
= XINT (AREF (vector
, 0));
9576 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9577 mode_line_string_list
= AREF (vector
, 2);
9578 if (! EQ (AREF (vector
, 3), Qt
))
9579 mode_line_proptrans_alist
= AREF (vector
, 3);
9580 mode_line_string_face
= AREF (vector
, 4);
9581 mode_line_string_face_prop
= AREF (vector
, 5);
9583 if (!NILP (AREF (vector
, 7)))
9584 /* Select window before buffer, since it may change the buffer. */
9585 Fselect_window (AREF (vector
, 7), Qt
);
9587 if (!NILP (AREF (vector
, 6)))
9589 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9590 ASET (vector
, 6, Qnil
);
9593 Vmode_line_unwind_vector
= vector
;
9598 /* Store a single character C for the frame title in mode_line_noprop_buf.
9599 Re-allocate mode_line_noprop_buf if necessary. */
9602 store_mode_line_noprop_char (char c
)
9604 /* If output position has reached the end of the allocated buffer,
9605 double the buffer's size. */
9606 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9608 int len
= MODE_LINE_NOPROP_LEN (0);
9609 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9610 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9611 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9612 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9615 *mode_line_noprop_ptr
++ = c
;
9619 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9620 mode_line_noprop_ptr. STR is the string to store. Do not copy
9621 characters that yield more columns than PRECISION; PRECISION <= 0
9622 means copy the whole string. Pad with spaces until FIELD_WIDTH
9623 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9624 pad. Called from display_mode_element when it is used to build a
9628 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9633 /* Copy at most PRECISION chars from STR. */
9634 nbytes
= strlen (str
);
9635 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9637 store_mode_line_noprop_char (*str
++);
9639 /* Fill up with spaces until FIELD_WIDTH reached. */
9640 while (field_width
> 0
9643 store_mode_line_noprop_char (' ');
9650 /***********************************************************************
9652 ***********************************************************************/
9654 #ifdef HAVE_WINDOW_SYSTEM
9656 /* Set the title of FRAME, if it has changed. The title format is
9657 Vicon_title_format if FRAME is iconified, otherwise it is
9658 frame_title_format. */
9661 x_consider_frame_title (Lisp_Object frame
)
9663 struct frame
*f
= XFRAME (frame
);
9665 if (FRAME_WINDOW_P (f
)
9666 || FRAME_MINIBUF_ONLY_P (f
)
9667 || f
->explicit_name
)
9669 /* Do we have more than one visible frame on this X display? */
9676 int count
= SPECPDL_INDEX ();
9678 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9680 Lisp_Object other_frame
= XCAR (tail
);
9681 struct frame
*tf
= XFRAME (other_frame
);
9684 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9685 && !FRAME_MINIBUF_ONLY_P (tf
)
9686 && !EQ (other_frame
, tip_frame
)
9687 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9691 /* Set global variable indicating that multiple frames exist. */
9692 multiple_frames
= CONSP (tail
);
9694 /* Switch to the buffer of selected window of the frame. Set up
9695 mode_line_target so that display_mode_element will output into
9696 mode_line_noprop_buf; then display the title. */
9697 record_unwind_protect (unwind_format_mode_line
,
9698 format_mode_line_unwind_data
9699 (current_buffer
, selected_window
, 0));
9701 Fselect_window (f
->selected_window
, Qt
);
9702 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9703 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9705 mode_line_target
= MODE_LINE_TITLE
;
9706 title_start
= MODE_LINE_NOPROP_LEN (0);
9707 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9708 NULL
, DEFAULT_FACE_ID
);
9709 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9710 len
= MODE_LINE_NOPROP_LEN (title_start
);
9711 title
= mode_line_noprop_buf
+ title_start
;
9712 unbind_to (count
, Qnil
);
9714 /* Set the title only if it's changed. This avoids consing in
9715 the common case where it hasn't. (If it turns out that we've
9716 already wasted too much time by walking through the list with
9717 display_mode_element, then we might need to optimize at a
9718 higher level than this.) */
9719 if (! STRINGP (f
->name
)
9720 || SBYTES (f
->name
) != len
9721 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9722 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9726 #endif /* not HAVE_WINDOW_SYSTEM */
9731 /***********************************************************************
9733 ***********************************************************************/
9736 /* Prepare for redisplay by updating menu-bar item lists when
9737 appropriate. This can call eval. */
9740 prepare_menu_bars (void)
9743 struct gcpro gcpro1
, gcpro2
;
9745 Lisp_Object tooltip_frame
;
9747 #ifdef HAVE_WINDOW_SYSTEM
9748 tooltip_frame
= tip_frame
;
9750 tooltip_frame
= Qnil
;
9753 /* Update all frame titles based on their buffer names, etc. We do
9754 this before the menu bars so that the buffer-menu will show the
9755 up-to-date frame titles. */
9756 #ifdef HAVE_WINDOW_SYSTEM
9757 if (windows_or_buffers_changed
|| update_mode_lines
)
9759 Lisp_Object tail
, frame
;
9761 FOR_EACH_FRAME (tail
, frame
)
9764 if (!EQ (frame
, tooltip_frame
)
9765 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9766 x_consider_frame_title (frame
);
9769 #endif /* HAVE_WINDOW_SYSTEM */
9771 /* Update the menu bar item lists, if appropriate. This has to be
9772 done before any actual redisplay or generation of display lines. */
9773 all_windows
= (update_mode_lines
9774 || buffer_shared
> 1
9775 || windows_or_buffers_changed
);
9778 Lisp_Object tail
, frame
;
9779 int count
= SPECPDL_INDEX ();
9780 /* 1 means that update_menu_bar has run its hooks
9781 so any further calls to update_menu_bar shouldn't do so again. */
9782 int menu_bar_hooks_run
= 0;
9784 record_unwind_save_match_data ();
9786 FOR_EACH_FRAME (tail
, frame
)
9790 /* Ignore tooltip frame. */
9791 if (EQ (frame
, tooltip_frame
))
9794 /* If a window on this frame changed size, report that to
9795 the user and clear the size-change flag. */
9796 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9798 Lisp_Object functions
;
9800 /* Clear flag first in case we get an error below. */
9801 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9802 functions
= Vwindow_size_change_functions
;
9803 GCPRO2 (tail
, functions
);
9805 while (CONSP (functions
))
9807 if (!EQ (XCAR (functions
), Qt
))
9808 call1 (XCAR (functions
), frame
);
9809 functions
= XCDR (functions
);
9815 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9816 #ifdef HAVE_WINDOW_SYSTEM
9817 update_tool_bar (f
, 0);
9820 if (windows_or_buffers_changed
9822 ns_set_doc_edited (f
, Fbuffer_modified_p
9823 (XWINDOW (f
->selected_window
)->buffer
));
9828 unbind_to (count
, Qnil
);
9832 struct frame
*sf
= SELECTED_FRAME ();
9833 update_menu_bar (sf
, 1, 0);
9834 #ifdef HAVE_WINDOW_SYSTEM
9835 update_tool_bar (sf
, 1);
9841 /* Update the menu bar item list for frame F. This has to be done
9842 before we start to fill in any display lines, because it can call
9845 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9847 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9848 already ran the menu bar hooks for this redisplay, so there
9849 is no need to run them again. The return value is the
9850 updated value of this flag, to pass to the next call. */
9853 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9856 register struct window
*w
;
9858 /* If called recursively during a menu update, do nothing. This can
9859 happen when, for instance, an activate-menubar-hook causes a
9861 if (inhibit_menubar_update
)
9864 window
= FRAME_SELECTED_WINDOW (f
);
9865 w
= XWINDOW (window
);
9867 if (FRAME_WINDOW_P (f
)
9869 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9870 || defined (HAVE_NS) || defined (USE_GTK)
9871 FRAME_EXTERNAL_MENU_BAR (f
)
9873 FRAME_MENU_BAR_LINES (f
) > 0
9875 : FRAME_MENU_BAR_LINES (f
) > 0)
9877 /* If the user has switched buffers or windows, we need to
9878 recompute to reflect the new bindings. But we'll
9879 recompute when update_mode_lines is set too; that means
9880 that people can use force-mode-line-update to request
9881 that the menu bar be recomputed. The adverse effect on
9882 the rest of the redisplay algorithm is about the same as
9883 windows_or_buffers_changed anyway. */
9884 if (windows_or_buffers_changed
9885 /* This used to test w->update_mode_line, but we believe
9886 there is no need to recompute the menu in that case. */
9887 || update_mode_lines
9888 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9889 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9890 != !NILP (w
->last_had_star
))
9891 || ((!NILP (Vtransient_mark_mode
)
9892 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9893 != !NILP (w
->region_showing
)))
9895 struct buffer
*prev
= current_buffer
;
9896 int count
= SPECPDL_INDEX ();
9898 specbind (Qinhibit_menubar_update
, Qt
);
9900 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9901 if (save_match_data
)
9902 record_unwind_save_match_data ();
9903 if (NILP (Voverriding_local_map_menu_flag
))
9905 specbind (Qoverriding_terminal_local_map
, Qnil
);
9906 specbind (Qoverriding_local_map
, Qnil
);
9911 /* Run the Lucid hook. */
9912 safe_run_hooks (Qactivate_menubar_hook
);
9914 /* If it has changed current-menubar from previous value,
9915 really recompute the menu-bar from the value. */
9916 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9917 call0 (Qrecompute_lucid_menubar
);
9919 safe_run_hooks (Qmenu_bar_update_hook
);
9924 XSETFRAME (Vmenu_updating_frame
, f
);
9925 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9927 /* Redisplay the menu bar in case we changed it. */
9928 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9929 || defined (HAVE_NS) || defined (USE_GTK)
9930 if (FRAME_WINDOW_P (f
))
9932 #if defined (HAVE_NS)
9933 /* All frames on Mac OS share the same menubar. So only
9934 the selected frame should be allowed to set it. */
9935 if (f
== SELECTED_FRAME ())
9937 set_frame_menubar (f
, 0, 0);
9940 /* On a terminal screen, the menu bar is an ordinary screen
9941 line, and this makes it get updated. */
9942 w
->update_mode_line
= Qt
;
9943 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9944 /* In the non-toolkit version, the menu bar is an ordinary screen
9945 line, and this makes it get updated. */
9946 w
->update_mode_line
= Qt
;
9947 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9949 unbind_to (count
, Qnil
);
9950 set_buffer_internal_1 (prev
);
9959 /***********************************************************************
9961 ***********************************************************************/
9963 #ifdef HAVE_WINDOW_SYSTEM
9966 Nominal cursor position -- where to draw output.
9967 HPOS and VPOS are window relative glyph matrix coordinates.
9968 X and Y are window relative pixel coordinates. */
9970 struct cursor_pos output_cursor
;
9974 Set the global variable output_cursor to CURSOR. All cursor
9975 positions are relative to updated_window. */
9978 set_output_cursor (struct cursor_pos
*cursor
)
9980 output_cursor
.hpos
= cursor
->hpos
;
9981 output_cursor
.vpos
= cursor
->vpos
;
9982 output_cursor
.x
= cursor
->x
;
9983 output_cursor
.y
= cursor
->y
;
9988 Set a nominal cursor position.
9990 HPOS and VPOS are column/row positions in a window glyph matrix. X
9991 and Y are window text area relative pixel positions.
9993 If this is done during an update, updated_window will contain the
9994 window that is being updated and the position is the future output
9995 cursor position for that window. If updated_window is null, use
9996 selected_window and display the cursor at the given position. */
9999 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10003 /* If updated_window is not set, work on selected_window. */
10004 if (updated_window
)
10005 w
= updated_window
;
10007 w
= XWINDOW (selected_window
);
10009 /* Set the output cursor. */
10010 output_cursor
.hpos
= hpos
;
10011 output_cursor
.vpos
= vpos
;
10012 output_cursor
.x
= x
;
10013 output_cursor
.y
= y
;
10015 /* If not called as part of an update, really display the cursor.
10016 This will also set the cursor position of W. */
10017 if (updated_window
== NULL
)
10020 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10021 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10022 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10027 #endif /* HAVE_WINDOW_SYSTEM */
10030 /***********************************************************************
10032 ***********************************************************************/
10034 #ifdef HAVE_WINDOW_SYSTEM
10036 /* Where the mouse was last time we reported a mouse event. */
10038 FRAME_PTR last_mouse_frame
;
10040 /* Tool-bar item index of the item on which a mouse button was pressed
10043 int last_tool_bar_item
;
10047 update_tool_bar_unwind (Lisp_Object frame
)
10049 selected_frame
= frame
;
10053 /* Update the tool-bar item list for frame F. This has to be done
10054 before we start to fill in any display lines. Called from
10055 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10056 and restore it here. */
10059 update_tool_bar (struct frame
*f
, int save_match_data
)
10061 #if defined (USE_GTK) || defined (HAVE_NS)
10062 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10064 int do_update
= WINDOWP (f
->tool_bar_window
)
10065 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10070 Lisp_Object window
;
10073 window
= FRAME_SELECTED_WINDOW (f
);
10074 w
= XWINDOW (window
);
10076 /* If the user has switched buffers or windows, we need to
10077 recompute to reflect the new bindings. But we'll
10078 recompute when update_mode_lines is set too; that means
10079 that people can use force-mode-line-update to request
10080 that the menu bar be recomputed. The adverse effect on
10081 the rest of the redisplay algorithm is about the same as
10082 windows_or_buffers_changed anyway. */
10083 if (windows_or_buffers_changed
10084 || !NILP (w
->update_mode_line
)
10085 || update_mode_lines
10086 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10087 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10088 != !NILP (w
->last_had_star
))
10089 || ((!NILP (Vtransient_mark_mode
)
10090 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10091 != !NILP (w
->region_showing
)))
10093 struct buffer
*prev
= current_buffer
;
10094 int count
= SPECPDL_INDEX ();
10095 Lisp_Object frame
, new_tool_bar
;
10096 int new_n_tool_bar
;
10097 struct gcpro gcpro1
;
10099 /* Set current_buffer to the buffer of the selected
10100 window of the frame, so that we get the right local
10102 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10104 /* Save match data, if we must. */
10105 if (save_match_data
)
10106 record_unwind_save_match_data ();
10108 /* Make sure that we don't accidentally use bogus keymaps. */
10109 if (NILP (Voverriding_local_map_menu_flag
))
10111 specbind (Qoverriding_terminal_local_map
, Qnil
);
10112 specbind (Qoverriding_local_map
, Qnil
);
10115 GCPRO1 (new_tool_bar
);
10117 /* We must temporarily set the selected frame to this frame
10118 before calling tool_bar_items, because the calculation of
10119 the tool-bar keymap uses the selected frame (see
10120 `tool-bar-make-keymap' in tool-bar.el). */
10121 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10122 XSETFRAME (frame
, f
);
10123 selected_frame
= frame
;
10125 /* Build desired tool-bar items from keymaps. */
10126 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10129 /* Redisplay the tool-bar if we changed it. */
10130 if (new_n_tool_bar
!= f
->n_tool_bar_items
10131 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10133 /* Redisplay that happens asynchronously due to an expose event
10134 may access f->tool_bar_items. Make sure we update both
10135 variables within BLOCK_INPUT so no such event interrupts. */
10137 f
->tool_bar_items
= new_tool_bar
;
10138 f
->n_tool_bar_items
= new_n_tool_bar
;
10139 w
->update_mode_line
= Qt
;
10145 unbind_to (count
, Qnil
);
10146 set_buffer_internal_1 (prev
);
10152 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10153 F's desired tool-bar contents. F->tool_bar_items must have
10154 been set up previously by calling prepare_menu_bars. */
10157 build_desired_tool_bar_string (struct frame
*f
)
10159 int i
, size
, size_needed
;
10160 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10161 Lisp_Object image
, plist
, props
;
10163 image
= plist
= props
= Qnil
;
10164 GCPRO3 (image
, plist
, props
);
10166 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10167 Otherwise, make a new string. */
10169 /* The size of the string we might be able to reuse. */
10170 size
= (STRINGP (f
->desired_tool_bar_string
)
10171 ? SCHARS (f
->desired_tool_bar_string
)
10174 /* We need one space in the string for each image. */
10175 size_needed
= f
->n_tool_bar_items
;
10177 /* Reuse f->desired_tool_bar_string, if possible. */
10178 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10179 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10180 make_number (' '));
10183 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10184 Fremove_text_properties (make_number (0), make_number (size
),
10185 props
, f
->desired_tool_bar_string
);
10188 /* Put a `display' property on the string for the images to display,
10189 put a `menu_item' property on tool-bar items with a value that
10190 is the index of the item in F's tool-bar item vector. */
10191 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10193 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10195 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10196 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10197 int hmargin
, vmargin
, relief
, idx
, end
;
10199 /* If image is a vector, choose the image according to the
10201 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10202 if (VECTORP (image
))
10206 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10207 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10210 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10211 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10213 xassert (ASIZE (image
) >= idx
);
10214 image
= AREF (image
, idx
);
10219 /* Ignore invalid image specifications. */
10220 if (!valid_image_p (image
))
10223 /* Display the tool-bar button pressed, or depressed. */
10224 plist
= Fcopy_sequence (XCDR (image
));
10226 /* Compute margin and relief to draw. */
10227 relief
= (tool_bar_button_relief
>= 0
10228 ? tool_bar_button_relief
10229 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10230 hmargin
= vmargin
= relief
;
10232 if (INTEGERP (Vtool_bar_button_margin
)
10233 && XINT (Vtool_bar_button_margin
) > 0)
10235 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10236 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10238 else if (CONSP (Vtool_bar_button_margin
))
10240 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10241 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10242 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10244 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10245 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10246 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10249 if (auto_raise_tool_bar_buttons_p
)
10251 /* Add a `:relief' property to the image spec if the item is
10255 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10262 /* If image is selected, display it pressed, i.e. with a
10263 negative relief. If it's not selected, display it with a
10265 plist
= Fplist_put (plist
, QCrelief
,
10267 ? make_number (-relief
)
10268 : make_number (relief
)));
10273 /* Put a margin around the image. */
10274 if (hmargin
|| vmargin
)
10276 if (hmargin
== vmargin
)
10277 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10279 plist
= Fplist_put (plist
, QCmargin
,
10280 Fcons (make_number (hmargin
),
10281 make_number (vmargin
)));
10284 /* If button is not enabled, and we don't have special images
10285 for the disabled state, make the image appear disabled by
10286 applying an appropriate algorithm to it. */
10287 if (!enabled_p
&& idx
< 0)
10288 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10290 /* Put a `display' text property on the string for the image to
10291 display. Put a `menu-item' property on the string that gives
10292 the start of this item's properties in the tool-bar items
10294 image
= Fcons (Qimage
, plist
);
10295 props
= list4 (Qdisplay
, image
,
10296 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10298 /* Let the last image hide all remaining spaces in the tool bar
10299 string. The string can be longer than needed when we reuse a
10300 previous string. */
10301 if (i
+ 1 == f
->n_tool_bar_items
)
10302 end
= SCHARS (f
->desired_tool_bar_string
);
10305 Fadd_text_properties (make_number (i
), make_number (end
),
10306 props
, f
->desired_tool_bar_string
);
10314 /* Display one line of the tool-bar of frame IT->f.
10316 HEIGHT specifies the desired height of the tool-bar line.
10317 If the actual height of the glyph row is less than HEIGHT, the
10318 row's height is increased to HEIGHT, and the icons are centered
10319 vertically in the new height.
10321 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10322 count a final empty row in case the tool-bar width exactly matches
10327 display_tool_bar_line (struct it
*it
, int height
)
10329 struct glyph_row
*row
= it
->glyph_row
;
10330 int max_x
= it
->last_visible_x
;
10331 struct glyph
*last
;
10333 prepare_desired_row (row
);
10334 row
->y
= it
->current_y
;
10336 /* Note that this isn't made use of if the face hasn't a box,
10337 so there's no need to check the face here. */
10338 it
->start_of_box_run_p
= 1;
10340 while (it
->current_x
< max_x
)
10342 int x
, n_glyphs_before
, i
, nglyphs
;
10343 struct it it_before
;
10345 /* Get the next display element. */
10346 if (!get_next_display_element (it
))
10348 /* Don't count empty row if we are counting needed tool-bar lines. */
10349 if (height
< 0 && !it
->hpos
)
10354 /* Produce glyphs. */
10355 n_glyphs_before
= row
->used
[TEXT_AREA
];
10358 PRODUCE_GLYPHS (it
);
10360 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10362 x
= it_before
.current_x
;
10363 while (i
< nglyphs
)
10365 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10367 if (x
+ glyph
->pixel_width
> max_x
)
10369 /* Glyph doesn't fit on line. Backtrack. */
10370 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10372 /* If this is the only glyph on this line, it will never fit on the
10373 toolbar, so skip it. But ensure there is at least one glyph,
10374 so we don't accidentally disable the tool-bar. */
10375 if (n_glyphs_before
== 0
10376 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10382 x
+= glyph
->pixel_width
;
10386 /* Stop at line ends. */
10387 if (ITERATOR_AT_END_OF_LINE_P (it
))
10390 set_iterator_to_next (it
, 1);
10395 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10397 /* Use default face for the border below the tool bar.
10399 FIXME: When auto-resize-tool-bars is grow-only, there is
10400 no additional border below the possibly empty tool-bar lines.
10401 So to make the extra empty lines look "normal", we have to
10402 use the tool-bar face for the border too. */
10403 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10404 it
->face_id
= DEFAULT_FACE_ID
;
10406 extend_face_to_end_of_line (it
);
10407 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10408 last
->right_box_line_p
= 1;
10409 if (last
== row
->glyphs
[TEXT_AREA
])
10410 last
->left_box_line_p
= 1;
10412 /* Make line the desired height and center it vertically. */
10413 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10415 /* Don't add more than one line height. */
10416 height
%= FRAME_LINE_HEIGHT (it
->f
);
10417 it
->max_ascent
+= height
/ 2;
10418 it
->max_descent
+= (height
+ 1) / 2;
10421 compute_line_metrics (it
);
10423 /* If line is empty, make it occupy the rest of the tool-bar. */
10424 if (!row
->displays_text_p
)
10426 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10427 row
->visible_height
= row
->height
;
10428 row
->ascent
= row
->phys_ascent
= 0;
10429 row
->extra_line_spacing
= 0;
10432 row
->full_width_p
= 1;
10433 row
->continued_p
= 0;
10434 row
->truncated_on_left_p
= 0;
10435 row
->truncated_on_right_p
= 0;
10437 it
->current_x
= it
->hpos
= 0;
10438 it
->current_y
+= row
->height
;
10444 /* Max tool-bar height. */
10446 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10447 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10449 /* Value is the number of screen lines needed to make all tool-bar
10450 items of frame F visible. The number of actual rows needed is
10451 returned in *N_ROWS if non-NULL. */
10454 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10456 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10458 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10459 the desired matrix, so use (unused) mode-line row as temporary row to
10460 avoid destroying the first tool-bar row. */
10461 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10463 /* Initialize an iterator for iteration over
10464 F->desired_tool_bar_string in the tool-bar window of frame F. */
10465 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10466 it
.first_visible_x
= 0;
10467 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10468 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10470 while (!ITERATOR_AT_END_P (&it
))
10472 clear_glyph_row (temp_row
);
10473 it
.glyph_row
= temp_row
;
10474 display_tool_bar_line (&it
, -1);
10476 clear_glyph_row (temp_row
);
10478 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10480 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10482 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10486 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10488 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10489 (Lisp_Object frame
)
10496 frame
= selected_frame
;
10498 CHECK_FRAME (frame
);
10499 f
= XFRAME (frame
);
10501 if (WINDOWP (f
->tool_bar_window
)
10502 || (w
= XWINDOW (f
->tool_bar_window
),
10503 WINDOW_TOTAL_LINES (w
) > 0))
10505 update_tool_bar (f
, 1);
10506 if (f
->n_tool_bar_items
)
10508 build_desired_tool_bar_string (f
);
10509 nlines
= tool_bar_lines_needed (f
, NULL
);
10513 return make_number (nlines
);
10517 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10518 height should be changed. */
10521 redisplay_tool_bar (struct frame
*f
)
10525 struct glyph_row
*row
;
10527 #if defined (USE_GTK) || defined (HAVE_NS)
10528 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10529 update_frame_tool_bar (f
);
10533 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10534 do anything. This means you must start with tool-bar-lines
10535 non-zero to get the auto-sizing effect. Or in other words, you
10536 can turn off tool-bars by specifying tool-bar-lines zero. */
10537 if (!WINDOWP (f
->tool_bar_window
)
10538 || (w
= XWINDOW (f
->tool_bar_window
),
10539 WINDOW_TOTAL_LINES (w
) == 0))
10542 /* Set up an iterator for the tool-bar window. */
10543 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10544 it
.first_visible_x
= 0;
10545 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10546 row
= it
.glyph_row
;
10548 /* Build a string that represents the contents of the tool-bar. */
10549 build_desired_tool_bar_string (f
);
10550 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10552 if (f
->n_tool_bar_rows
== 0)
10556 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10557 nlines
!= WINDOW_TOTAL_LINES (w
)))
10560 int old_height
= WINDOW_TOTAL_LINES (w
);
10562 XSETFRAME (frame
, f
);
10563 Fmodify_frame_parameters (frame
,
10564 Fcons (Fcons (Qtool_bar_lines
,
10565 make_number (nlines
)),
10567 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10569 clear_glyph_matrix (w
->desired_matrix
);
10570 fonts_changed_p
= 1;
10576 /* Display as many lines as needed to display all tool-bar items. */
10578 if (f
->n_tool_bar_rows
> 0)
10580 int border
, rows
, height
, extra
;
10582 if (INTEGERP (Vtool_bar_border
))
10583 border
= XINT (Vtool_bar_border
);
10584 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10585 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10586 else if (EQ (Vtool_bar_border
, Qborder_width
))
10587 border
= f
->border_width
;
10593 rows
= f
->n_tool_bar_rows
;
10594 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10595 extra
= it
.last_visible_y
- border
- height
* rows
;
10597 while (it
.current_y
< it
.last_visible_y
)
10600 if (extra
> 0 && rows
-- > 0)
10602 h
= (extra
+ rows
- 1) / rows
;
10605 display_tool_bar_line (&it
, height
+ h
);
10610 while (it
.current_y
< it
.last_visible_y
)
10611 display_tool_bar_line (&it
, 0);
10614 /* It doesn't make much sense to try scrolling in the tool-bar
10615 window, so don't do it. */
10616 w
->desired_matrix
->no_scrolling_p
= 1;
10617 w
->must_be_updated_p
= 1;
10619 if (!NILP (Vauto_resize_tool_bars
))
10621 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10622 int change_height_p
= 0;
10624 /* If we couldn't display everything, change the tool-bar's
10625 height if there is room for more. */
10626 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10627 && it
.current_y
< max_tool_bar_height
)
10628 change_height_p
= 1;
10630 row
= it
.glyph_row
- 1;
10632 /* If there are blank lines at the end, except for a partially
10633 visible blank line at the end that is smaller than
10634 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10635 if (!row
->displays_text_p
10636 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10637 change_height_p
= 1;
10639 /* If row displays tool-bar items, but is partially visible,
10640 change the tool-bar's height. */
10641 if (row
->displays_text_p
10642 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10643 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10644 change_height_p
= 1;
10646 /* Resize windows as needed by changing the `tool-bar-lines'
10647 frame parameter. */
10648 if (change_height_p
)
10651 int old_height
= WINDOW_TOTAL_LINES (w
);
10653 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10655 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10656 && !f
->minimize_tool_bar_window_p
)
10657 ? (nlines
> old_height
)
10658 : (nlines
!= old_height
));
10659 f
->minimize_tool_bar_window_p
= 0;
10661 if (change_height_p
)
10663 XSETFRAME (frame
, f
);
10664 Fmodify_frame_parameters (frame
,
10665 Fcons (Fcons (Qtool_bar_lines
,
10666 make_number (nlines
)),
10668 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10670 clear_glyph_matrix (w
->desired_matrix
);
10671 f
->n_tool_bar_rows
= nrows
;
10672 fonts_changed_p
= 1;
10679 f
->minimize_tool_bar_window_p
= 0;
10684 /* Get information about the tool-bar item which is displayed in GLYPH
10685 on frame F. Return in *PROP_IDX the index where tool-bar item
10686 properties start in F->tool_bar_items. Value is zero if
10687 GLYPH doesn't display a tool-bar item. */
10690 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10696 /* This function can be called asynchronously, which means we must
10697 exclude any possibility that Fget_text_property signals an
10699 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10700 charpos
= max (0, charpos
);
10702 /* Get the text property `menu-item' at pos. The value of that
10703 property is the start index of this item's properties in
10704 F->tool_bar_items. */
10705 prop
= Fget_text_property (make_number (charpos
),
10706 Qmenu_item
, f
->current_tool_bar_string
);
10707 if (INTEGERP (prop
))
10709 *prop_idx
= XINT (prop
);
10719 /* Get information about the tool-bar item at position X/Y on frame F.
10720 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10721 the current matrix of the tool-bar window of F, or NULL if not
10722 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10723 item in F->tool_bar_items. Value is
10725 -1 if X/Y is not on a tool-bar item
10726 0 if X/Y is on the same item that was highlighted before.
10730 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10731 int *hpos
, int *vpos
, int *prop_idx
)
10733 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10734 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10737 /* Find the glyph under X/Y. */
10738 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10739 if (*glyph
== NULL
)
10742 /* Get the start of this tool-bar item's properties in
10743 f->tool_bar_items. */
10744 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10747 /* Is mouse on the highlighted item? */
10748 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10749 && *vpos
>= dpyinfo
->mouse_face_beg_row
10750 && *vpos
<= dpyinfo
->mouse_face_end_row
10751 && (*vpos
> dpyinfo
->mouse_face_beg_row
10752 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10753 && (*vpos
< dpyinfo
->mouse_face_end_row
10754 || *hpos
< dpyinfo
->mouse_face_end_col
10755 || dpyinfo
->mouse_face_past_end
))
10763 Handle mouse button event on the tool-bar of frame F, at
10764 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10765 0 for button release. MODIFIERS is event modifiers for button
10769 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10770 unsigned int modifiers
)
10772 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10773 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10774 int hpos
, vpos
, prop_idx
;
10775 struct glyph
*glyph
;
10776 Lisp_Object enabled_p
;
10778 /* If not on the highlighted tool-bar item, return. */
10779 frame_to_window_pixel_xy (w
, &x
, &y
);
10780 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10783 /* If item is disabled, do nothing. */
10784 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10785 if (NILP (enabled_p
))
10790 /* Show item in pressed state. */
10791 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10792 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10793 last_tool_bar_item
= prop_idx
;
10797 Lisp_Object key
, frame
;
10798 struct input_event event
;
10799 EVENT_INIT (event
);
10801 /* Show item in released state. */
10802 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10803 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10805 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10807 XSETFRAME (frame
, f
);
10808 event
.kind
= TOOL_BAR_EVENT
;
10809 event
.frame_or_window
= frame
;
10811 kbd_buffer_store_event (&event
);
10813 event
.kind
= TOOL_BAR_EVENT
;
10814 event
.frame_or_window
= frame
;
10816 event
.modifiers
= modifiers
;
10817 kbd_buffer_store_event (&event
);
10818 last_tool_bar_item
= -1;
10823 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10824 tool-bar window-relative coordinates X/Y. Called from
10825 note_mouse_highlight. */
10828 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10830 Lisp_Object window
= f
->tool_bar_window
;
10831 struct window
*w
= XWINDOW (window
);
10832 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10834 struct glyph
*glyph
;
10835 struct glyph_row
*row
;
10837 Lisp_Object enabled_p
;
10839 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10840 int mouse_down_p
, rc
;
10842 /* Function note_mouse_highlight is called with negative X/Y
10843 values when mouse moves outside of the frame. */
10844 if (x
<= 0 || y
<= 0)
10846 clear_mouse_face (dpyinfo
);
10850 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10853 /* Not on tool-bar item. */
10854 clear_mouse_face (dpyinfo
);
10858 /* On same tool-bar item as before. */
10859 goto set_help_echo
;
10861 clear_mouse_face (dpyinfo
);
10863 /* Mouse is down, but on different tool-bar item? */
10864 mouse_down_p
= (dpyinfo
->grabbed
10865 && f
== last_mouse_frame
10866 && FRAME_LIVE_P (f
));
10868 && last_tool_bar_item
!= prop_idx
)
10871 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10872 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10874 /* If tool-bar item is not enabled, don't highlight it. */
10875 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10876 if (!NILP (enabled_p
))
10878 /* Compute the x-position of the glyph. In front and past the
10879 image is a space. We include this in the highlighted area. */
10880 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10881 for (i
= x
= 0; i
< hpos
; ++i
)
10882 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10884 /* Record this as the current active region. */
10885 dpyinfo
->mouse_face_beg_col
= hpos
;
10886 dpyinfo
->mouse_face_beg_row
= vpos
;
10887 dpyinfo
->mouse_face_beg_x
= x
;
10888 dpyinfo
->mouse_face_beg_y
= row
->y
;
10889 dpyinfo
->mouse_face_past_end
= 0;
10891 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10892 dpyinfo
->mouse_face_end_row
= vpos
;
10893 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10894 dpyinfo
->mouse_face_end_y
= row
->y
;
10895 dpyinfo
->mouse_face_window
= window
;
10896 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10898 /* Display it as active. */
10899 show_mouse_face (dpyinfo
, draw
);
10900 dpyinfo
->mouse_face_image_state
= draw
;
10905 /* Set help_echo_string to a help string to display for this tool-bar item.
10906 XTread_socket does the rest. */
10907 help_echo_object
= help_echo_window
= Qnil
;
10908 help_echo_pos
= -1;
10909 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10910 if (NILP (help_echo_string
))
10911 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10914 #endif /* HAVE_WINDOW_SYSTEM */
10918 /************************************************************************
10919 Horizontal scrolling
10920 ************************************************************************/
10922 static int hscroll_window_tree (Lisp_Object
);
10923 static int hscroll_windows (Lisp_Object
);
10925 /* For all leaf windows in the window tree rooted at WINDOW, set their
10926 hscroll value so that PT is (i) visible in the window, and (ii) so
10927 that it is not within a certain margin at the window's left and
10928 right border. Value is non-zero if any window's hscroll has been
10932 hscroll_window_tree (Lisp_Object window
)
10934 int hscrolled_p
= 0;
10935 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10936 int hscroll_step_abs
= 0;
10937 double hscroll_step_rel
= 0;
10939 if (hscroll_relative_p
)
10941 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10942 if (hscroll_step_rel
< 0)
10944 hscroll_relative_p
= 0;
10945 hscroll_step_abs
= 0;
10948 else if (INTEGERP (Vhscroll_step
))
10950 hscroll_step_abs
= XINT (Vhscroll_step
);
10951 if (hscroll_step_abs
< 0)
10952 hscroll_step_abs
= 0;
10955 hscroll_step_abs
= 0;
10957 while (WINDOWP (window
))
10959 struct window
*w
= XWINDOW (window
);
10961 if (WINDOWP (w
->hchild
))
10962 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10963 else if (WINDOWP (w
->vchild
))
10964 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10965 else if (w
->cursor
.vpos
>= 0)
10968 int text_area_width
;
10969 struct glyph_row
*current_cursor_row
10970 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10971 struct glyph_row
*desired_cursor_row
10972 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10973 struct glyph_row
*cursor_row
10974 = (desired_cursor_row
->enabled_p
10975 ? desired_cursor_row
10976 : current_cursor_row
);
10978 text_area_width
= window_box_width (w
, TEXT_AREA
);
10980 /* Scroll when cursor is inside this scroll margin. */
10981 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10983 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10984 && ((XFASTINT (w
->hscroll
)
10985 && w
->cursor
.x
<= h_margin
)
10986 || (cursor_row
->enabled_p
10987 && cursor_row
->truncated_on_right_p
10988 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10992 struct buffer
*saved_current_buffer
;
10996 /* Find point in a display of infinite width. */
10997 saved_current_buffer
= current_buffer
;
10998 current_buffer
= XBUFFER (w
->buffer
);
11000 if (w
== XWINDOW (selected_window
))
11001 pt
= BUF_PT (current_buffer
);
11004 pt
= marker_position (w
->pointm
);
11005 pt
= max (BEGV
, pt
);
11009 /* Move iterator to pt starting at cursor_row->start in
11010 a line with infinite width. */
11011 init_to_row_start (&it
, w
, cursor_row
);
11012 it
.last_visible_x
= INFINITY
;
11013 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11014 current_buffer
= saved_current_buffer
;
11016 /* Position cursor in window. */
11017 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11018 hscroll
= max (0, (it
.current_x
11019 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11020 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11021 : (text_area_width
/ 2))))
11022 / FRAME_COLUMN_WIDTH (it
.f
);
11023 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11025 if (hscroll_relative_p
)
11026 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11029 wanted_x
= text_area_width
11030 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11033 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11037 if (hscroll_relative_p
)
11038 wanted_x
= text_area_width
* hscroll_step_rel
11041 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11044 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11046 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11048 /* Don't call Fset_window_hscroll if value hasn't
11049 changed because it will prevent redisplay
11051 if (XFASTINT (w
->hscroll
) != hscroll
)
11053 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11054 w
->hscroll
= make_number (hscroll
);
11063 /* Value is non-zero if hscroll of any leaf window has been changed. */
11064 return hscrolled_p
;
11068 /* Set hscroll so that cursor is visible and not inside horizontal
11069 scroll margins for all windows in the tree rooted at WINDOW. See
11070 also hscroll_window_tree above. Value is non-zero if any window's
11071 hscroll has been changed. If it has, desired matrices on the frame
11072 of WINDOW are cleared. */
11075 hscroll_windows (Lisp_Object window
)
11077 int hscrolled_p
= hscroll_window_tree (window
);
11079 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11080 return hscrolled_p
;
11085 /************************************************************************
11087 ************************************************************************/
11089 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11090 to a non-zero value. This is sometimes handy to have in a debugger
11095 /* First and last unchanged row for try_window_id. */
11097 int debug_first_unchanged_at_end_vpos
;
11098 int debug_last_unchanged_at_beg_vpos
;
11100 /* Delta vpos and y. */
11102 int debug_dvpos
, debug_dy
;
11104 /* Delta in characters and bytes for try_window_id. */
11106 int debug_delta
, debug_delta_bytes
;
11108 /* Values of window_end_pos and window_end_vpos at the end of
11111 EMACS_INT debug_end_pos
, debug_end_vpos
;
11113 /* Append a string to W->desired_matrix->method. FMT is a printf
11114 format string. A1...A9 are a supplement for a variable-length
11115 argument list. If trace_redisplay_p is non-zero also printf the
11116 resulting string to stderr. */
11119 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11122 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11125 char *method
= w
->desired_matrix
->method
;
11126 int len
= strlen (method
);
11127 int size
= sizeof w
->desired_matrix
->method
;
11128 int remaining
= size
- len
- 1;
11130 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11131 if (len
&& remaining
)
11134 --remaining
, ++len
;
11137 strncpy (method
+ len
, buffer
, remaining
);
11139 if (trace_redisplay_p
)
11140 fprintf (stderr
, "%p (%s): %s\n",
11142 ((BUFFERP (w
->buffer
)
11143 && STRINGP (XBUFFER (w
->buffer
)->name
))
11144 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11149 #endif /* GLYPH_DEBUG */
11152 /* Value is non-zero if all changes in window W, which displays
11153 current_buffer, are in the text between START and END. START is a
11154 buffer position, END is given as a distance from Z. Used in
11155 redisplay_internal for display optimization. */
11158 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11160 int unchanged_p
= 1;
11162 /* If text or overlays have changed, see where. */
11163 if (XFASTINT (w
->last_modified
) < MODIFF
11164 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11166 /* Gap in the line? */
11167 if (GPT
< start
|| Z
- GPT
< end
)
11170 /* Changes start in front of the line, or end after it? */
11172 && (BEG_UNCHANGED
< start
- 1
11173 || END_UNCHANGED
< end
))
11176 /* If selective display, can't optimize if changes start at the
11177 beginning of the line. */
11179 && INTEGERP (current_buffer
->selective_display
)
11180 && XINT (current_buffer
->selective_display
) > 0
11181 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11184 /* If there are overlays at the start or end of the line, these
11185 may have overlay strings with newlines in them. A change at
11186 START, for instance, may actually concern the display of such
11187 overlay strings as well, and they are displayed on different
11188 lines. So, quickly rule out this case. (For the future, it
11189 might be desirable to implement something more telling than
11190 just BEG/END_UNCHANGED.) */
11193 if (BEG
+ BEG_UNCHANGED
== start
11194 && overlay_touches_p (start
))
11196 if (END_UNCHANGED
== end
11197 && overlay_touches_p (Z
- end
))
11201 /* Under bidi reordering, adding or deleting a character in the
11202 beginning of a paragraph, before the first strong directional
11203 character, can change the base direction of the paragraph (unless
11204 the buffer specifies a fixed paragraph direction), which will
11205 require to redisplay the whole paragraph. It might be worthwhile
11206 to find the paragraph limits and widen the range of redisplayed
11207 lines to that, but for now just give up this optimization. */
11208 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11209 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11213 return unchanged_p
;
11217 /* Do a frame update, taking possible shortcuts into account. This is
11218 the main external entry point for redisplay.
11220 If the last redisplay displayed an echo area message and that message
11221 is no longer requested, we clear the echo area or bring back the
11222 mini-buffer if that is in use. */
11227 redisplay_internal (0);
11232 overlay_arrow_string_or_property (Lisp_Object var
)
11236 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11239 return Voverlay_arrow_string
;
11242 /* Return 1 if there are any overlay-arrows in current_buffer. */
11244 overlay_arrow_in_current_buffer_p (void)
11248 for (vlist
= Voverlay_arrow_variable_list
;
11250 vlist
= XCDR (vlist
))
11252 Lisp_Object var
= XCAR (vlist
);
11255 if (!SYMBOLP (var
))
11257 val
= find_symbol_value (var
);
11259 && current_buffer
== XMARKER (val
)->buffer
)
11266 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11270 overlay_arrows_changed_p (void)
11274 for (vlist
= Voverlay_arrow_variable_list
;
11276 vlist
= XCDR (vlist
))
11278 Lisp_Object var
= XCAR (vlist
);
11279 Lisp_Object val
, pstr
;
11281 if (!SYMBOLP (var
))
11283 val
= find_symbol_value (var
);
11284 if (!MARKERP (val
))
11286 if (! EQ (COERCE_MARKER (val
),
11287 Fget (var
, Qlast_arrow_position
))
11288 || ! (pstr
= overlay_arrow_string_or_property (var
),
11289 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11295 /* Mark overlay arrows to be updated on next redisplay. */
11298 update_overlay_arrows (int up_to_date
)
11302 for (vlist
= Voverlay_arrow_variable_list
;
11304 vlist
= XCDR (vlist
))
11306 Lisp_Object var
= XCAR (vlist
);
11308 if (!SYMBOLP (var
))
11311 if (up_to_date
> 0)
11313 Lisp_Object val
= find_symbol_value (var
);
11314 Fput (var
, Qlast_arrow_position
,
11315 COERCE_MARKER (val
));
11316 Fput (var
, Qlast_arrow_string
,
11317 overlay_arrow_string_or_property (var
));
11319 else if (up_to_date
< 0
11320 || !NILP (Fget (var
, Qlast_arrow_position
)))
11322 Fput (var
, Qlast_arrow_position
, Qt
);
11323 Fput (var
, Qlast_arrow_string
, Qt
);
11329 /* Return overlay arrow string to display at row.
11330 Return integer (bitmap number) for arrow bitmap in left fringe.
11331 Return nil if no overlay arrow. */
11334 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11338 for (vlist
= Voverlay_arrow_variable_list
;
11340 vlist
= XCDR (vlist
))
11342 Lisp_Object var
= XCAR (vlist
);
11345 if (!SYMBOLP (var
))
11348 val
= find_symbol_value (var
);
11351 && current_buffer
== XMARKER (val
)->buffer
11352 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11354 if (FRAME_WINDOW_P (it
->f
)
11355 /* FIXME: if ROW->reversed_p is set, this should test
11356 the right fringe, not the left one. */
11357 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11359 #ifdef HAVE_WINDOW_SYSTEM
11360 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11363 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11364 return make_number (fringe_bitmap
);
11367 return make_number (-1); /* Use default arrow bitmap */
11369 return overlay_arrow_string_or_property (var
);
11376 /* Return 1 if point moved out of or into a composition. Otherwise
11377 return 0. PREV_BUF and PREV_PT are the last point buffer and
11378 position. BUF and PT are the current point buffer and position. */
11381 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11382 struct buffer
*buf
, int pt
)
11384 EMACS_INT start
, end
;
11386 Lisp_Object buffer
;
11388 XSETBUFFER (buffer
, buf
);
11389 /* Check a composition at the last point if point moved within the
11391 if (prev_buf
== buf
)
11394 /* Point didn't move. */
11397 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11398 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11399 && COMPOSITION_VALID_P (start
, end
, prop
)
11400 && start
< prev_pt
&& end
> prev_pt
)
11401 /* The last point was within the composition. Return 1 iff
11402 point moved out of the composition. */
11403 return (pt
<= start
|| pt
>= end
);
11406 /* Check a composition at the current point. */
11407 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11408 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11409 && COMPOSITION_VALID_P (start
, end
, prop
)
11410 && start
< pt
&& end
> pt
);
11414 /* Reconsider the setting of B->clip_changed which is displayed
11418 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11420 if (b
->clip_changed
11421 && !NILP (w
->window_end_valid
)
11422 && w
->current_matrix
->buffer
== b
11423 && w
->current_matrix
->zv
== BUF_ZV (b
)
11424 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11425 b
->clip_changed
= 0;
11427 /* If display wasn't paused, and W is not a tool bar window, see if
11428 point has been moved into or out of a composition. In that case,
11429 we set b->clip_changed to 1 to force updating the screen. If
11430 b->clip_changed has already been set to 1, we can skip this
11432 if (!b
->clip_changed
11433 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11437 if (w
== XWINDOW (selected_window
))
11438 pt
= BUF_PT (current_buffer
);
11440 pt
= marker_position (w
->pointm
);
11442 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11443 || pt
!= XINT (w
->last_point
))
11444 && check_point_in_composition (w
->current_matrix
->buffer
,
11445 XINT (w
->last_point
),
11446 XBUFFER (w
->buffer
), pt
))
11447 b
->clip_changed
= 1;
11452 /* Select FRAME to forward the values of frame-local variables into C
11453 variables so that the redisplay routines can access those values
11457 select_frame_for_redisplay (Lisp_Object frame
)
11459 Lisp_Object tail
, tem
;
11460 Lisp_Object old
= selected_frame
;
11461 struct Lisp_Symbol
*sym
;
11463 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11465 selected_frame
= frame
;
11468 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11469 if (CONSP (XCAR (tail
))
11470 && (tem
= XCAR (XCAR (tail
)),
11472 && (sym
= indirect_variable (XSYMBOL (tem
)),
11473 sym
->redirect
== SYMBOL_LOCALIZED
)
11474 && sym
->val
.blv
->frame_local
)
11475 /* Use find_symbol_value rather than Fsymbol_value
11476 to avoid an error if it is void. */
11477 find_symbol_value (tem
);
11478 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11482 #define STOP_POLLING \
11483 do { if (! polling_stopped_here) stop_polling (); \
11484 polling_stopped_here = 1; } while (0)
11486 #define RESUME_POLLING \
11487 do { if (polling_stopped_here) start_polling (); \
11488 polling_stopped_here = 0; } while (0)
11491 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11492 response to any user action; therefore, we should preserve the echo
11493 area. (Actually, our caller does that job.) Perhaps in the future
11494 avoid recentering windows if it is not necessary; currently that
11495 causes some problems. */
11498 redisplay_internal (int preserve_echo_area
)
11500 struct window
*w
= XWINDOW (selected_window
);
11503 int must_finish
= 0;
11504 struct text_pos tlbufpos
, tlendpos
;
11505 int number_of_visible_frames
;
11508 int polling_stopped_here
= 0;
11509 Lisp_Object old_frame
= selected_frame
;
11511 /* Non-zero means redisplay has to consider all windows on all
11512 frames. Zero means, only selected_window is considered. */
11513 int consider_all_windows_p
;
11515 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11517 /* No redisplay if running in batch mode or frame is not yet fully
11518 initialized, or redisplay is explicitly turned off by setting
11519 Vinhibit_redisplay. */
11520 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11521 || !NILP (Vinhibit_redisplay
))
11524 /* Don't examine these until after testing Vinhibit_redisplay.
11525 When Emacs is shutting down, perhaps because its connection to
11526 X has dropped, we should not look at them at all. */
11527 f
= XFRAME (w
->frame
);
11528 sf
= SELECTED_FRAME ();
11530 if (!f
->glyphs_initialized_p
)
11533 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11534 if (popup_activated ())
11538 /* I don't think this happens but let's be paranoid. */
11539 if (redisplaying_p
)
11542 /* Record a function that resets redisplaying_p to its old value
11543 when we leave this function. */
11544 count
= SPECPDL_INDEX ();
11545 record_unwind_protect (unwind_redisplay
,
11546 Fcons (make_number (redisplaying_p
), selected_frame
));
11548 specbind (Qinhibit_free_realized_faces
, Qnil
);
11551 Lisp_Object tail
, frame
;
11553 FOR_EACH_FRAME (tail
, frame
)
11555 struct frame
*f
= XFRAME (frame
);
11556 f
->already_hscrolled_p
= 0;
11561 if (!EQ (old_frame
, selected_frame
)
11562 && FRAME_LIVE_P (XFRAME (old_frame
)))
11563 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11564 selected_frame and selected_window to be temporarily out-of-sync so
11565 when we come back here via `goto retry', we need to resync because we
11566 may need to run Elisp code (via prepare_menu_bars). */
11567 select_frame_for_redisplay (old_frame
);
11570 reconsider_clip_changes (w
, current_buffer
);
11571 last_escape_glyph_frame
= NULL
;
11572 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11574 /* If new fonts have been loaded that make a glyph matrix adjustment
11575 necessary, do it. */
11576 if (fonts_changed_p
)
11578 adjust_glyphs (NULL
);
11579 ++windows_or_buffers_changed
;
11580 fonts_changed_p
= 0;
11583 /* If face_change_count is non-zero, init_iterator will free all
11584 realized faces, which includes the faces referenced from current
11585 matrices. So, we can't reuse current matrices in this case. */
11586 if (face_change_count
)
11587 ++windows_or_buffers_changed
;
11589 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11590 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11592 /* Since frames on a single ASCII terminal share the same
11593 display area, displaying a different frame means redisplay
11594 the whole thing. */
11595 windows_or_buffers_changed
++;
11596 SET_FRAME_GARBAGED (sf
);
11598 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11600 FRAME_TTY (sf
)->previous_frame
= sf
;
11603 /* Set the visible flags for all frames. Do this before checking
11604 for resized or garbaged frames; they want to know if their frames
11605 are visible. See the comment in frame.h for
11606 FRAME_SAMPLE_VISIBILITY. */
11608 Lisp_Object tail
, frame
;
11610 number_of_visible_frames
= 0;
11612 FOR_EACH_FRAME (tail
, frame
)
11614 struct frame
*f
= XFRAME (frame
);
11616 FRAME_SAMPLE_VISIBILITY (f
);
11617 if (FRAME_VISIBLE_P (f
))
11618 ++number_of_visible_frames
;
11619 clear_desired_matrices (f
);
11623 /* Notice any pending interrupt request to change frame size. */
11624 do_pending_window_change (1);
11626 /* Clear frames marked as garbaged. */
11627 if (frame_garbaged
)
11628 clear_garbaged_frames ();
11630 /* Build menubar and tool-bar items. */
11631 if (NILP (Vmemory_full
))
11632 prepare_menu_bars ();
11634 if (windows_or_buffers_changed
)
11635 update_mode_lines
++;
11637 /* Detect case that we need to write or remove a star in the mode line. */
11638 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11640 w
->update_mode_line
= Qt
;
11641 if (buffer_shared
> 1)
11642 update_mode_lines
++;
11645 /* Avoid invocation of point motion hooks by `current_column' below. */
11646 count1
= SPECPDL_INDEX ();
11647 specbind (Qinhibit_point_motion_hooks
, Qt
);
11649 /* If %c is in the mode line, update it if needed. */
11650 if (!NILP (w
->column_number_displayed
)
11651 /* This alternative quickly identifies a common case
11652 where no change is needed. */
11653 && !(PT
== XFASTINT (w
->last_point
)
11654 && XFASTINT (w
->last_modified
) >= MODIFF
11655 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11656 && (XFASTINT (w
->column_number_displayed
)
11657 != (int) current_column ())) /* iftc */
11658 w
->update_mode_line
= Qt
;
11660 unbind_to (count1
, Qnil
);
11662 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11664 /* The variable buffer_shared is set in redisplay_window and
11665 indicates that we redisplay a buffer in different windows. See
11667 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11668 || cursor_type_changed
);
11670 /* If specs for an arrow have changed, do thorough redisplay
11671 to ensure we remove any arrow that should no longer exist. */
11672 if (overlay_arrows_changed_p ())
11673 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11675 /* Normally the message* functions will have already displayed and
11676 updated the echo area, but the frame may have been trashed, or
11677 the update may have been preempted, so display the echo area
11678 again here. Checking message_cleared_p captures the case that
11679 the echo area should be cleared. */
11680 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11681 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11682 || (message_cleared_p
11683 && minibuf_level
== 0
11684 /* If the mini-window is currently selected, this means the
11685 echo-area doesn't show through. */
11686 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11688 int window_height_changed_p
= echo_area_display (0);
11691 /* If we don't display the current message, don't clear the
11692 message_cleared_p flag, because, if we did, we wouldn't clear
11693 the echo area in the next redisplay which doesn't preserve
11695 if (!display_last_displayed_message_p
)
11696 message_cleared_p
= 0;
11698 if (fonts_changed_p
)
11700 else if (window_height_changed_p
)
11702 consider_all_windows_p
= 1;
11703 ++update_mode_lines
;
11704 ++windows_or_buffers_changed
;
11706 /* If window configuration was changed, frames may have been
11707 marked garbaged. Clear them or we will experience
11708 surprises wrt scrolling. */
11709 if (frame_garbaged
)
11710 clear_garbaged_frames ();
11713 else if (EQ (selected_window
, minibuf_window
)
11714 && (current_buffer
->clip_changed
11715 || XFASTINT (w
->last_modified
) < MODIFF
11716 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11717 && resize_mini_window (w
, 0))
11719 /* Resized active mini-window to fit the size of what it is
11720 showing if its contents might have changed. */
11722 /* FIXME: this causes all frames to be updated, which seems unnecessary
11723 since only the current frame needs to be considered. This function needs
11724 to be rewritten with two variables, consider_all_windows and
11725 consider_all_frames. */
11726 consider_all_windows_p
= 1;
11727 ++windows_or_buffers_changed
;
11728 ++update_mode_lines
;
11730 /* If window configuration was changed, frames may have been
11731 marked garbaged. Clear them or we will experience
11732 surprises wrt scrolling. */
11733 if (frame_garbaged
)
11734 clear_garbaged_frames ();
11738 /* If showing the region, and mark has changed, we must redisplay
11739 the whole window. The assignment to this_line_start_pos prevents
11740 the optimization directly below this if-statement. */
11741 if (((!NILP (Vtransient_mark_mode
)
11742 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11743 != !NILP (w
->region_showing
))
11744 || (!NILP (w
->region_showing
)
11745 && !EQ (w
->region_showing
,
11746 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11747 CHARPOS (this_line_start_pos
) = 0;
11749 /* Optimize the case that only the line containing the cursor in the
11750 selected window has changed. Variables starting with this_ are
11751 set in display_line and record information about the line
11752 containing the cursor. */
11753 tlbufpos
= this_line_start_pos
;
11754 tlendpos
= this_line_end_pos
;
11755 if (!consider_all_windows_p
11756 && CHARPOS (tlbufpos
) > 0
11757 && NILP (w
->update_mode_line
)
11758 && !current_buffer
->clip_changed
11759 && !current_buffer
->prevent_redisplay_optimizations_p
11760 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11761 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11762 /* Make sure recorded data applies to current buffer, etc. */
11763 && this_line_buffer
== current_buffer
11764 && current_buffer
== XBUFFER (w
->buffer
)
11765 && NILP (w
->force_start
)
11766 && NILP (w
->optional_new_start
)
11767 /* Point must be on the line that we have info recorded about. */
11768 && PT
>= CHARPOS (tlbufpos
)
11769 && PT
<= Z
- CHARPOS (tlendpos
)
11770 /* All text outside that line, including its final newline,
11771 must be unchanged. */
11772 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11773 CHARPOS (tlendpos
)))
11775 if (CHARPOS (tlbufpos
) > BEGV
11776 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11777 && (CHARPOS (tlbufpos
) == ZV
11778 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11779 /* Former continuation line has disappeared by becoming empty. */
11781 else if (XFASTINT (w
->last_modified
) < MODIFF
11782 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11783 || MINI_WINDOW_P (w
))
11785 /* We have to handle the case of continuation around a
11786 wide-column character (see the comment in indent.c around
11789 For instance, in the following case:
11791 -------- Insert --------
11792 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11793 J_I_ ==> J_I_ `^^' are cursors.
11797 As we have to redraw the line above, we cannot use this
11801 int line_height_before
= this_line_pixel_height
;
11803 /* Note that start_display will handle the case that the
11804 line starting at tlbufpos is a continuation line. */
11805 start_display (&it
, w
, tlbufpos
);
11807 /* Implementation note: It this still necessary? */
11808 if (it
.current_x
!= this_line_start_x
)
11811 TRACE ((stderr
, "trying display optimization 1\n"));
11812 w
->cursor
.vpos
= -1;
11813 overlay_arrow_seen
= 0;
11814 it
.vpos
= this_line_vpos
;
11815 it
.current_y
= this_line_y
;
11816 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11817 display_line (&it
);
11819 /* If line contains point, is not continued,
11820 and ends at same distance from eob as before, we win. */
11821 if (w
->cursor
.vpos
>= 0
11822 /* Line is not continued, otherwise this_line_start_pos
11823 would have been set to 0 in display_line. */
11824 && CHARPOS (this_line_start_pos
)
11825 /* Line ends as before. */
11826 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11827 /* Line has same height as before. Otherwise other lines
11828 would have to be shifted up or down. */
11829 && this_line_pixel_height
== line_height_before
)
11831 /* If this is not the window's last line, we must adjust
11832 the charstarts of the lines below. */
11833 if (it
.current_y
< it
.last_visible_y
)
11835 struct glyph_row
*row
11836 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11837 int delta
, delta_bytes
;
11839 /* We used to distinguish between two cases here,
11840 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11841 when the line ends in a newline or the end of the
11842 buffer's accessible portion. But both cases did
11843 the same, so they were collapsed. */
11845 - CHARPOS (tlendpos
)
11846 - MATRIX_ROW_START_CHARPOS (row
));
11847 delta_bytes
= (Z_BYTE
11848 - BYTEPOS (tlendpos
)
11849 - MATRIX_ROW_START_BYTEPOS (row
));
11851 increment_matrix_positions (w
->current_matrix
,
11852 this_line_vpos
+ 1,
11853 w
->current_matrix
->nrows
,
11854 delta
, delta_bytes
);
11857 /* If this row displays text now but previously didn't,
11858 or vice versa, w->window_end_vpos may have to be
11860 if ((it
.glyph_row
- 1)->displays_text_p
)
11862 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11863 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11865 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11866 && this_line_vpos
> 0)
11867 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11868 w
->window_end_valid
= Qnil
;
11870 /* Update hint: No need to try to scroll in update_window. */
11871 w
->desired_matrix
->no_scrolling_p
= 1;
11874 *w
->desired_matrix
->method
= 0;
11875 debug_method_add (w
, "optimization 1");
11877 #ifdef HAVE_WINDOW_SYSTEM
11878 update_window_fringes (w
, 0);
11885 else if (/* Cursor position hasn't changed. */
11886 PT
== XFASTINT (w
->last_point
)
11887 /* Make sure the cursor was last displayed
11888 in this window. Otherwise we have to reposition it. */
11889 && 0 <= w
->cursor
.vpos
11890 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11894 do_pending_window_change (1);
11896 /* We used to always goto end_of_redisplay here, but this
11897 isn't enough if we have a blinking cursor. */
11898 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11899 goto end_of_redisplay
;
11903 /* If highlighting the region, or if the cursor is in the echo area,
11904 then we can't just move the cursor. */
11905 else if (! (!NILP (Vtransient_mark_mode
)
11906 && !NILP (current_buffer
->mark_active
))
11907 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11908 || highlight_nonselected_windows
)
11909 && NILP (w
->region_showing
)
11910 && NILP (Vshow_trailing_whitespace
)
11911 && !cursor_in_echo_area
)
11914 struct glyph_row
*row
;
11916 /* Skip from tlbufpos to PT and see where it is. Note that
11917 PT may be in invisible text. If so, we will end at the
11918 next visible position. */
11919 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11920 NULL
, DEFAULT_FACE_ID
);
11921 it
.current_x
= this_line_start_x
;
11922 it
.current_y
= this_line_y
;
11923 it
.vpos
= this_line_vpos
;
11925 /* The call to move_it_to stops in front of PT, but
11926 moves over before-strings. */
11927 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11929 if (it
.vpos
== this_line_vpos
11930 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11933 xassert (this_line_vpos
== it
.vpos
);
11934 xassert (this_line_y
== it
.current_y
);
11935 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11937 *w
->desired_matrix
->method
= 0;
11938 debug_method_add (w
, "optimization 3");
11947 /* Text changed drastically or point moved off of line. */
11948 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11951 CHARPOS (this_line_start_pos
) = 0;
11952 consider_all_windows_p
|= buffer_shared
> 1;
11953 ++clear_face_cache_count
;
11954 #ifdef HAVE_WINDOW_SYSTEM
11955 ++clear_image_cache_count
;
11958 /* Build desired matrices, and update the display. If
11959 consider_all_windows_p is non-zero, do it for all windows on all
11960 frames. Otherwise do it for selected_window, only. */
11962 if (consider_all_windows_p
)
11964 Lisp_Object tail
, frame
;
11966 FOR_EACH_FRAME (tail
, frame
)
11967 XFRAME (frame
)->updated_p
= 0;
11969 /* Recompute # windows showing selected buffer. This will be
11970 incremented each time such a window is displayed. */
11973 FOR_EACH_FRAME (tail
, frame
)
11975 struct frame
*f
= XFRAME (frame
);
11977 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11979 if (! EQ (frame
, selected_frame
))
11980 /* Select the frame, for the sake of frame-local
11982 select_frame_for_redisplay (frame
);
11984 /* Mark all the scroll bars to be removed; we'll redeem
11985 the ones we want when we redisplay their windows. */
11986 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11987 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11989 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11990 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11992 /* The X error handler may have deleted that frame. */
11993 if (!FRAME_LIVE_P (f
))
11996 /* Any scroll bars which redisplay_windows should have
11997 nuked should now go away. */
11998 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11999 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12001 /* If fonts changed, display again. */
12002 /* ??? rms: I suspect it is a mistake to jump all the way
12003 back to retry here. It should just retry this frame. */
12004 if (fonts_changed_p
)
12007 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12009 /* See if we have to hscroll. */
12010 if (!f
->already_hscrolled_p
)
12012 f
->already_hscrolled_p
= 1;
12013 if (hscroll_windows (f
->root_window
))
12017 /* Prevent various kinds of signals during display
12018 update. stdio is not robust about handling
12019 signals, which can cause an apparent I/O
12021 if (interrupt_input
)
12022 unrequest_sigio ();
12025 /* Update the display. */
12026 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12027 pause
|= update_frame (f
, 0, 0);
12033 if (!EQ (old_frame
, selected_frame
)
12034 && FRAME_LIVE_P (XFRAME (old_frame
)))
12035 /* We played a bit fast-and-loose above and allowed selected_frame
12036 and selected_window to be temporarily out-of-sync but let's make
12037 sure this stays contained. */
12038 select_frame_for_redisplay (old_frame
);
12039 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12043 /* Do the mark_window_display_accurate after all windows have
12044 been redisplayed because this call resets flags in buffers
12045 which are needed for proper redisplay. */
12046 FOR_EACH_FRAME (tail
, frame
)
12048 struct frame
*f
= XFRAME (frame
);
12051 mark_window_display_accurate (f
->root_window
, 1);
12052 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12053 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12058 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12060 Lisp_Object mini_window
;
12061 struct frame
*mini_frame
;
12063 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12064 /* Use list_of_error, not Qerror, so that
12065 we catch only errors and don't run the debugger. */
12066 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12068 redisplay_window_error
);
12070 /* Compare desired and current matrices, perform output. */
12073 /* If fonts changed, display again. */
12074 if (fonts_changed_p
)
12077 /* Prevent various kinds of signals during display update.
12078 stdio is not robust about handling signals,
12079 which can cause an apparent I/O error. */
12080 if (interrupt_input
)
12081 unrequest_sigio ();
12084 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12086 if (hscroll_windows (selected_window
))
12089 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12090 pause
= update_frame (sf
, 0, 0);
12093 /* We may have called echo_area_display at the top of this
12094 function. If the echo area is on another frame, that may
12095 have put text on a frame other than the selected one, so the
12096 above call to update_frame would not have caught it. Catch
12098 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12099 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12101 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12103 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12104 pause
|= update_frame (mini_frame
, 0, 0);
12105 if (!pause
&& hscroll_windows (mini_window
))
12110 /* If display was paused because of pending input, make sure we do a
12111 thorough update the next time. */
12114 /* Prevent the optimization at the beginning of
12115 redisplay_internal that tries a single-line update of the
12116 line containing the cursor in the selected window. */
12117 CHARPOS (this_line_start_pos
) = 0;
12119 /* Let the overlay arrow be updated the next time. */
12120 update_overlay_arrows (0);
12122 /* If we pause after scrolling, some rows in the current
12123 matrices of some windows are not valid. */
12124 if (!WINDOW_FULL_WIDTH_P (w
)
12125 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12126 update_mode_lines
= 1;
12130 if (!consider_all_windows_p
)
12132 /* This has already been done above if
12133 consider_all_windows_p is set. */
12134 mark_window_display_accurate_1 (w
, 1);
12136 /* Say overlay arrows are up to date. */
12137 update_overlay_arrows (1);
12139 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12140 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12143 update_mode_lines
= 0;
12144 windows_or_buffers_changed
= 0;
12145 cursor_type_changed
= 0;
12148 /* Start SIGIO interrupts coming again. Having them off during the
12149 code above makes it less likely one will discard output, but not
12150 impossible, since there might be stuff in the system buffer here.
12151 But it is much hairier to try to do anything about that. */
12152 if (interrupt_input
)
12156 /* If a frame has become visible which was not before, redisplay
12157 again, so that we display it. Expose events for such a frame
12158 (which it gets when becoming visible) don't call the parts of
12159 redisplay constructing glyphs, so simply exposing a frame won't
12160 display anything in this case. So, we have to display these
12161 frames here explicitly. */
12164 Lisp_Object tail
, frame
;
12167 FOR_EACH_FRAME (tail
, frame
)
12169 int this_is_visible
= 0;
12171 if (XFRAME (frame
)->visible
)
12172 this_is_visible
= 1;
12173 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12174 if (XFRAME (frame
)->visible
)
12175 this_is_visible
= 1;
12177 if (this_is_visible
)
12181 if (new_count
!= number_of_visible_frames
)
12182 windows_or_buffers_changed
++;
12185 /* Change frame size now if a change is pending. */
12186 do_pending_window_change (1);
12188 /* If we just did a pending size change, or have additional
12189 visible frames, redisplay again. */
12190 if (windows_or_buffers_changed
&& !pause
)
12193 /* Clear the face and image caches.
12195 We used to do this only if consider_all_windows_p. But the cache
12196 needs to be cleared if a timer creates images in the current
12197 buffer (e.g. the test case in Bug#6230). */
12199 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12201 clear_face_cache (0);
12202 clear_face_cache_count
= 0;
12205 #ifdef HAVE_WINDOW_SYSTEM
12206 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12208 clear_image_caches (Qnil
);
12209 clear_image_cache_count
= 0;
12211 #endif /* HAVE_WINDOW_SYSTEM */
12214 unbind_to (count
, Qnil
);
12219 /* Redisplay, but leave alone any recent echo area message unless
12220 another message has been requested in its place.
12222 This is useful in situations where you need to redisplay but no
12223 user action has occurred, making it inappropriate for the message
12224 area to be cleared. See tracking_off and
12225 wait_reading_process_output for examples of these situations.
12227 FROM_WHERE is an integer saying from where this function was
12228 called. This is useful for debugging. */
12231 redisplay_preserve_echo_area (int from_where
)
12233 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12235 if (!NILP (echo_area_buffer
[1]))
12237 /* We have a previously displayed message, but no current
12238 message. Redisplay the previous message. */
12239 display_last_displayed_message_p
= 1;
12240 redisplay_internal (1);
12241 display_last_displayed_message_p
= 0;
12244 redisplay_internal (1);
12246 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12247 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12248 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12252 /* Function registered with record_unwind_protect in
12253 redisplay_internal. Reset redisplaying_p to the value it had
12254 before redisplay_internal was called, and clear
12255 prevent_freeing_realized_faces_p. It also selects the previously
12256 selected frame, unless it has been deleted (by an X connection
12257 failure during redisplay, for example). */
12260 unwind_redisplay (Lisp_Object val
)
12262 Lisp_Object old_redisplaying_p
, old_frame
;
12264 old_redisplaying_p
= XCAR (val
);
12265 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12266 old_frame
= XCDR (val
);
12267 if (! EQ (old_frame
, selected_frame
)
12268 && FRAME_LIVE_P (XFRAME (old_frame
)))
12269 select_frame_for_redisplay (old_frame
);
12274 /* Mark the display of window W as accurate or inaccurate. If
12275 ACCURATE_P is non-zero mark display of W as accurate. If
12276 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12277 redisplay_internal is called. */
12280 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12282 if (BUFFERP (w
->buffer
))
12284 struct buffer
*b
= XBUFFER (w
->buffer
);
12287 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12288 w
->last_overlay_modified
12289 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12291 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12295 b
->clip_changed
= 0;
12296 b
->prevent_redisplay_optimizations_p
= 0;
12298 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12299 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12300 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12301 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12303 w
->current_matrix
->buffer
= b
;
12304 w
->current_matrix
->begv
= BUF_BEGV (b
);
12305 w
->current_matrix
->zv
= BUF_ZV (b
);
12307 w
->last_cursor
= w
->cursor
;
12308 w
->last_cursor_off_p
= w
->cursor_off_p
;
12310 if (w
== XWINDOW (selected_window
))
12311 w
->last_point
= make_number (BUF_PT (b
));
12313 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12319 w
->window_end_valid
= w
->buffer
;
12320 w
->update_mode_line
= Qnil
;
12325 /* Mark the display of windows in the window tree rooted at WINDOW as
12326 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12327 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12328 be redisplayed the next time redisplay_internal is called. */
12331 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12335 for (; !NILP (window
); window
= w
->next
)
12337 w
= XWINDOW (window
);
12338 mark_window_display_accurate_1 (w
, accurate_p
);
12340 if (!NILP (w
->vchild
))
12341 mark_window_display_accurate (w
->vchild
, accurate_p
);
12342 if (!NILP (w
->hchild
))
12343 mark_window_display_accurate (w
->hchild
, accurate_p
);
12348 update_overlay_arrows (1);
12352 /* Force a thorough redisplay the next time by setting
12353 last_arrow_position and last_arrow_string to t, which is
12354 unequal to any useful value of Voverlay_arrow_... */
12355 update_overlay_arrows (-1);
12360 /* Return value in display table DP (Lisp_Char_Table *) for character
12361 C. Since a display table doesn't have any parent, we don't have to
12362 follow parent. Do not call this function directly but use the
12363 macro DISP_CHAR_VECTOR. */
12366 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12370 if (ASCII_CHAR_P (c
))
12373 if (SUB_CHAR_TABLE_P (val
))
12374 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12380 XSETCHAR_TABLE (table
, dp
);
12381 val
= char_table_ref (table
, c
);
12390 /***********************************************************************
12392 ***********************************************************************/
12394 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12397 redisplay_windows (Lisp_Object window
)
12399 while (!NILP (window
))
12401 struct window
*w
= XWINDOW (window
);
12403 if (!NILP (w
->hchild
))
12404 redisplay_windows (w
->hchild
);
12405 else if (!NILP (w
->vchild
))
12406 redisplay_windows (w
->vchild
);
12407 else if (!NILP (w
->buffer
))
12409 displayed_buffer
= XBUFFER (w
->buffer
);
12410 /* Use list_of_error, not Qerror, so that
12411 we catch only errors and don't run the debugger. */
12412 internal_condition_case_1 (redisplay_window_0
, window
,
12414 redisplay_window_error
);
12422 redisplay_window_error (Lisp_Object ignore
)
12424 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12429 redisplay_window_0 (Lisp_Object window
)
12431 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12432 redisplay_window (window
, 0);
12437 redisplay_window_1 (Lisp_Object window
)
12439 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12440 redisplay_window (window
, 1);
12445 /* Increment GLYPH until it reaches END or CONDITION fails while
12446 adding (GLYPH)->pixel_width to X. */
12448 #define SKIP_GLYPHS(glyph, end, x, condition) \
12451 (x) += (glyph)->pixel_width; \
12454 while ((glyph) < (end) && (condition))
12457 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12458 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12459 which positions recorded in ROW differ from current buffer
12462 Return 0 if cursor is not on this row, 1 otherwise. */
12465 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12466 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12469 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12470 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12471 struct glyph
*cursor
= NULL
;
12472 /* The last known character position in row. */
12473 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12475 EMACS_INT pt_old
= PT
- delta
;
12476 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12477 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12478 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12479 /* A glyph beyond the edge of TEXT_AREA which we should never
12481 struct glyph
*glyphs_end
= end
;
12482 /* Non-zero means we've found a match for cursor position, but that
12483 glyph has the avoid_cursor_p flag set. */
12484 int match_with_avoid_cursor
= 0;
12485 /* Non-zero means we've seen at least one glyph that came from a
12487 int string_seen
= 0;
12488 /* Largest buffer position seen so far during scan of glyph row. */
12489 EMACS_INT bpos_max
= last_pos
;
12490 /* Last buffer position covered by an overlay string with an integer
12491 `cursor' property. */
12492 EMACS_INT bpos_covered
= 0;
12494 /* Skip over glyphs not having an object at the start and the end of
12495 the row. These are special glyphs like truncation marks on
12496 terminal frames. */
12497 if (row
->displays_text_p
)
12499 if (!row
->reversed_p
)
12502 && INTEGERP (glyph
->object
)
12503 && glyph
->charpos
< 0)
12505 x
+= glyph
->pixel_width
;
12509 && INTEGERP ((end
- 1)->object
)
12510 /* CHARPOS is zero for blanks and stretch glyphs
12511 inserted by extend_face_to_end_of_line. */
12512 && (end
- 1)->charpos
<= 0)
12514 glyph_before
= glyph
- 1;
12521 /* If the glyph row is reversed, we need to process it from back
12522 to front, so swap the edge pointers. */
12523 glyphs_end
= end
= glyph
- 1;
12524 glyph
+= row
->used
[TEXT_AREA
] - 1;
12526 while (glyph
> end
+ 1
12527 && INTEGERP (glyph
->object
)
12528 && glyph
->charpos
< 0)
12531 x
-= glyph
->pixel_width
;
12533 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12535 /* By default, in reversed rows we put the cursor on the
12536 rightmost (first in the reading order) glyph. */
12537 for (g
= end
+ 1; g
< glyph
; g
++)
12538 x
+= g
->pixel_width
;
12540 && INTEGERP ((end
+ 1)->object
)
12541 && (end
+ 1)->charpos
<= 0)
12543 glyph_before
= glyph
+ 1;
12547 else if (row
->reversed_p
)
12549 /* In R2L rows that don't display text, put the cursor on the
12550 rightmost glyph. Case in point: an empty last line that is
12551 part of an R2L paragraph. */
12553 /* Avoid placing the cursor on the last glyph of the row, where
12554 on terminal frames we hold the vertical border between
12555 adjacent windows. */
12556 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12557 && !WINDOW_RIGHTMOST_P (w
)
12558 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12560 x
= -1; /* will be computed below, at label compute_x */
12563 /* Step 1: Try to find the glyph whose character position
12564 corresponds to point. If that's not possible, find 2 glyphs
12565 whose character positions are the closest to point, one before
12566 point, the other after it. */
12567 if (!row
->reversed_p
)
12568 while (/* not marched to end of glyph row */
12570 /* glyph was not inserted by redisplay for internal purposes */
12571 && !INTEGERP (glyph
->object
))
12573 if (BUFFERP (glyph
->object
))
12575 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12577 if (glyph
->charpos
> bpos_max
)
12578 bpos_max
= glyph
->charpos
;
12579 if (!glyph
->avoid_cursor_p
)
12581 /* If we hit point, we've found the glyph on which to
12582 display the cursor. */
12585 match_with_avoid_cursor
= 0;
12588 /* See if we've found a better approximation to
12589 POS_BEFORE or to POS_AFTER. Note that we want the
12590 first (leftmost) glyph of all those that are the
12591 closest from below, and the last (rightmost) of all
12592 those from above. */
12593 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12595 pos_before
= glyph
->charpos
;
12596 glyph_before
= glyph
;
12598 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12600 pos_after
= glyph
->charpos
;
12601 glyph_after
= glyph
;
12604 else if (dpos
== 0)
12605 match_with_avoid_cursor
= 1;
12607 else if (STRINGP (glyph
->object
))
12609 Lisp_Object chprop
;
12610 int glyph_pos
= glyph
->charpos
;
12612 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12614 if (INTEGERP (chprop
))
12616 bpos_covered
= bpos_max
+ XINT (chprop
);
12617 /* If the `cursor' property covers buffer positions up
12618 to and including point, we should display cursor on
12619 this glyph. Note that overlays and text properties
12620 with string values stop bidi reordering, so every
12621 buffer position to the left of the string is always
12622 smaller than any position to the right of the
12623 string. Therefore, if a `cursor' property on one
12624 of the string's characters has an integer value, we
12625 will break out of the loop below _before_ we get to
12626 the position match above. IOW, integer values of
12627 the `cursor' property override the "exact match for
12628 point" strategy of positioning the cursor. */
12629 /* Implementation note: bpos_max == pt_old when, e.g.,
12630 we are in an empty line, where bpos_max is set to
12631 MATRIX_ROW_START_CHARPOS, see above. */
12632 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12641 x
+= glyph
->pixel_width
;
12644 else if (glyph
> end
) /* row is reversed */
12645 while (!INTEGERP (glyph
->object
))
12647 if (BUFFERP (glyph
->object
))
12649 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12651 if (glyph
->charpos
> bpos_max
)
12652 bpos_max
= glyph
->charpos
;
12653 if (!glyph
->avoid_cursor_p
)
12657 match_with_avoid_cursor
= 0;
12660 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12662 pos_before
= glyph
->charpos
;
12663 glyph_before
= glyph
;
12665 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12667 pos_after
= glyph
->charpos
;
12668 glyph_after
= glyph
;
12671 else if (dpos
== 0)
12672 match_with_avoid_cursor
= 1;
12674 else if (STRINGP (glyph
->object
))
12676 Lisp_Object chprop
;
12677 int glyph_pos
= glyph
->charpos
;
12679 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12681 if (INTEGERP (chprop
))
12683 bpos_covered
= bpos_max
+ XINT (chprop
);
12684 /* If the `cursor' property covers buffer positions up
12685 to and including point, we should display cursor on
12687 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12696 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12698 x
--; /* can't use any pixel_width */
12701 x
-= glyph
->pixel_width
;
12704 /* Step 2: If we didn't find an exact match for point, we need to
12705 look for a proper place to put the cursor among glyphs between
12706 GLYPH_BEFORE and GLYPH_AFTER. */
12707 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12708 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12709 && bpos_covered
< pt_old
)
12711 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12713 EMACS_INT ellipsis_pos
;
12715 /* Scan back over the ellipsis glyphs. */
12716 if (!row
->reversed_p
)
12718 ellipsis_pos
= (glyph
- 1)->charpos
;
12719 while (glyph
> row
->glyphs
[TEXT_AREA
]
12720 && (glyph
- 1)->charpos
== ellipsis_pos
)
12721 glyph
--, x
-= glyph
->pixel_width
;
12722 /* That loop always goes one position too far, including
12723 the glyph before the ellipsis. So scan forward over
12725 x
+= glyph
->pixel_width
;
12728 else /* row is reversed */
12730 ellipsis_pos
= (glyph
+ 1)->charpos
;
12731 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12732 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12733 glyph
++, x
+= glyph
->pixel_width
;
12734 x
-= glyph
->pixel_width
;
12738 else if (match_with_avoid_cursor
12739 /* zero-width characters produce no glyphs */
12740 || ((row
->reversed_p
12741 ? glyph_after
> glyphs_end
12742 : glyph_after
< glyphs_end
)
12743 && eabs (glyph_after
- glyph_before
) == 1))
12745 cursor
= glyph_after
;
12748 else if (string_seen
)
12750 int incr
= row
->reversed_p
? -1 : +1;
12752 /* Need to find the glyph that came out of a string which is
12753 present at point. That glyph is somewhere between
12754 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12755 positioned between POS_BEFORE and POS_AFTER in the
12757 struct glyph
*stop
= glyph_after
;
12758 EMACS_INT pos
= pos_before
;
12761 for (glyph
= glyph_before
+ incr
;
12762 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12765 /* Any glyphs that come from the buffer are here because
12766 of bidi reordering. Skip them, and only pay
12767 attention to glyphs that came from some string. */
12768 if (STRINGP (glyph
->object
))
12773 str
= glyph
->object
;
12774 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12775 if (tem
== 0 /* from overlay */
12778 /* If the string from which this glyph came is
12779 found in the buffer at point, then we've
12780 found the glyph we've been looking for. If
12781 it comes from an overlay (tem == 0), and it
12782 has the `cursor' property on one of its
12783 glyphs, record that glyph as a candidate for
12784 displaying the cursor. (As in the
12785 unidirectional version, we will display the
12786 cursor on the last candidate we find.) */
12787 if (tem
== 0 || tem
== pt_old
)
12789 /* The glyphs from this string could have
12790 been reordered. Find the one with the
12791 smallest string position. Or there could
12792 be a character in the string with the
12793 `cursor' property, which means display
12794 cursor on that character's glyph. */
12795 int strpos
= glyph
->charpos
;
12798 for (glyph
+= incr
;
12799 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12800 && EQ (glyph
->object
, str
);
12804 int gpos
= glyph
->charpos
;
12806 cprop
= Fget_char_property (make_number (gpos
),
12814 if (glyph
->charpos
< strpos
)
12816 strpos
= glyph
->charpos
;
12825 pos
= tem
+ 1; /* don't find previous instances */
12827 /* This string is not what we want; skip all of the
12828 glyphs that came from it. */
12831 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12832 && EQ (glyph
->object
, str
));
12838 /* If we reached the end of the line, and END was from a string,
12839 the cursor is not on this line. */
12841 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12842 && STRINGP (end
->object
)
12843 && row
->continued_p
)
12849 if (cursor
!= NULL
)
12855 /* Need to compute x that corresponds to GLYPH. */
12856 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12858 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12860 x
+= g
->pixel_width
;
12864 /* ROW could be part of a continued line, which, under bidi
12865 reordering, might have other rows whose start and end charpos
12866 occlude point. Only set w->cursor if we found a better
12867 approximation to the cursor position than we have from previously
12868 examined candidate rows belonging to the same continued line. */
12869 if (/* we already have a candidate row */
12870 w
->cursor
.vpos
>= 0
12871 /* that candidate is not the row we are processing */
12872 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12873 /* the row we are processing is part of a continued line */
12874 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12875 /* Make sure cursor.vpos specifies a row whose start and end
12876 charpos occlude point. This is because some callers of this
12877 function leave cursor.vpos at the row where the cursor was
12878 displayed during the last redisplay cycle. */
12879 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12880 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12883 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12885 /* Don't consider glyphs that are outside TEXT_AREA. */
12886 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12888 /* Keep the candidate whose buffer position is the closest to
12890 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12891 w
->cursor
.hpos
>= 0
12892 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12893 && BUFFERP (g1
->object
)
12894 && (g1
->charpos
== pt_old
/* an exact match always wins */
12895 || (BUFFERP (glyph
->object
)
12896 && eabs (g1
->charpos
- pt_old
)
12897 < eabs (glyph
->charpos
- pt_old
))))
12899 /* If this candidate gives an exact match, use that. */
12900 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12901 /* Otherwise, keep the candidate that comes from a row
12902 spanning less buffer positions. This may win when one or
12903 both candidate positions are on glyphs that came from
12904 display strings, for which we cannot compare buffer
12906 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12907 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12908 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12911 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12913 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12914 w
->cursor
.y
= row
->y
+ dy
;
12916 if (w
== XWINDOW (selected_window
))
12918 if (!row
->continued_p
12919 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12922 this_line_buffer
= XBUFFER (w
->buffer
);
12924 CHARPOS (this_line_start_pos
)
12925 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12926 BYTEPOS (this_line_start_pos
)
12927 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12929 CHARPOS (this_line_end_pos
)
12930 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12931 BYTEPOS (this_line_end_pos
)
12932 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12934 this_line_y
= w
->cursor
.y
;
12935 this_line_pixel_height
= row
->height
;
12936 this_line_vpos
= w
->cursor
.vpos
;
12937 this_line_start_x
= row
->x
;
12940 CHARPOS (this_line_start_pos
) = 0;
12947 /* Run window scroll functions, if any, for WINDOW with new window
12948 start STARTP. Sets the window start of WINDOW to that position.
12950 We assume that the window's buffer is really current. */
12952 static INLINE
struct text_pos
12953 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12955 struct window
*w
= XWINDOW (window
);
12956 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12958 if (current_buffer
!= XBUFFER (w
->buffer
))
12961 if (!NILP (Vwindow_scroll_functions
))
12963 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12964 make_number (CHARPOS (startp
)));
12965 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12966 /* In case the hook functions switch buffers. */
12967 if (current_buffer
!= XBUFFER (w
->buffer
))
12968 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12975 /* Make sure the line containing the cursor is fully visible.
12976 A value of 1 means there is nothing to be done.
12977 (Either the line is fully visible, or it cannot be made so,
12978 or we cannot tell.)
12980 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12981 is higher than window.
12983 A value of 0 means the caller should do scrolling
12984 as if point had gone off the screen. */
12987 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12989 struct glyph_matrix
*matrix
;
12990 struct glyph_row
*row
;
12993 if (!make_cursor_line_fully_visible_p
)
12996 /* It's not always possible to find the cursor, e.g, when a window
12997 is full of overlay strings. Don't do anything in that case. */
12998 if (w
->cursor
.vpos
< 0)
13001 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13002 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13004 /* If the cursor row is not partially visible, there's nothing to do. */
13005 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13008 /* If the row the cursor is in is taller than the window's height,
13009 it's not clear what to do, so do nothing. */
13010 window_height
= window_box_height (w
);
13011 if (row
->height
>= window_height
)
13013 if (!force_p
|| MINI_WINDOW_P (w
)
13014 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13021 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13022 non-zero means only WINDOW is redisplayed in redisplay_internal.
13023 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13024 in redisplay_window to bring a partially visible line into view in
13025 the case that only the cursor has moved.
13027 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13028 last screen line's vertical height extends past the end of the screen.
13032 1 if scrolling succeeded
13034 0 if scrolling didn't find point.
13036 -1 if new fonts have been loaded so that we must interrupt
13037 redisplay, adjust glyph matrices, and try again. */
13043 SCROLLING_NEED_LARGER_MATRICES
13047 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13048 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13049 int temp_scroll_step
, int last_line_misfit
)
13051 struct window
*w
= XWINDOW (window
);
13052 struct frame
*f
= XFRAME (w
->frame
);
13053 struct text_pos pos
, startp
;
13055 int this_scroll_margin
, scroll_max
, rc
, height
;
13056 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13057 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13058 Lisp_Object aggressive
;
13059 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13062 debug_method_add (w
, "try_scrolling");
13065 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13067 /* Compute scroll margin height in pixels. We scroll when point is
13068 within this distance from the top or bottom of the window. */
13069 if (scroll_margin
> 0)
13070 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13071 * FRAME_LINE_HEIGHT (f
);
13073 this_scroll_margin
= 0;
13075 /* Force scroll_conservatively to have a reasonable value, to avoid
13076 overflow while computing how much to scroll. Note that the user
13077 can supply scroll-conservatively equal to `most-positive-fixnum',
13078 which can be larger than INT_MAX. */
13079 if (scroll_conservatively
> scroll_limit
)
13081 scroll_conservatively
= scroll_limit
;
13082 scroll_max
= INT_MAX
;
13084 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13085 /* Compute how much we should try to scroll maximally to bring
13086 point into view. */
13087 scroll_max
= (max (scroll_step
,
13088 max (scroll_conservatively
, temp_scroll_step
))
13089 * FRAME_LINE_HEIGHT (f
));
13090 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13091 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13092 /* We're trying to scroll because of aggressive scrolling but no
13093 scroll_step is set. Choose an arbitrary one. */
13094 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13100 /* Decide whether to scroll down. */
13101 if (PT
> CHARPOS (startp
))
13103 int scroll_margin_y
;
13105 /* Compute the pixel ypos of the scroll margin, then move it to
13106 either that ypos or PT, whichever comes first. */
13107 start_display (&it
, w
, startp
);
13108 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13109 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13110 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13111 (MOVE_TO_POS
| MOVE_TO_Y
));
13113 if (PT
> CHARPOS (it
.current
.pos
))
13115 int y0
= line_bottom_y (&it
);
13116 /* Compute how many pixels below window bottom to stop searching
13117 for PT. This avoids costly search for PT that is far away if
13118 the user limited scrolling by a small number of lines, but
13119 always finds PT if scroll_conservatively is set to a large
13120 number, such as most-positive-fixnum. */
13121 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13123 slack
>= INT_MAX
- it
.last_visible_y
13125 : it
.last_visible_y
+ slack
;
13127 /* Compute the distance from the scroll margin to PT or to
13128 the scroll limit, whichever comes first. This should
13129 include the height of the cursor line, to make that line
13131 move_it_to (&it
, PT
, -1, y_to_move
,
13132 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13133 dy
= line_bottom_y (&it
) - y0
;
13135 if (dy
> scroll_max
)
13136 return SCROLLING_FAILED
;
13144 /* Point is in or below the bottom scroll margin, so move the
13145 window start down. If scrolling conservatively, move it just
13146 enough down to make point visible. If scroll_step is set,
13147 move it down by scroll_step. */
13148 if (scroll_conservatively
)
13150 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13151 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13152 else if (scroll_step
|| temp_scroll_step
)
13153 amount_to_scroll
= scroll_max
;
13156 aggressive
= current_buffer
->scroll_up_aggressively
;
13157 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13158 if (NUMBERP (aggressive
))
13160 double float_amount
= XFLOATINT (aggressive
) * height
;
13161 amount_to_scroll
= float_amount
;
13162 if (amount_to_scroll
== 0 && float_amount
> 0)
13163 amount_to_scroll
= 1;
13167 if (amount_to_scroll
<= 0)
13168 return SCROLLING_FAILED
;
13170 start_display (&it
, w
, startp
);
13171 if (scroll_max
< INT_MAX
)
13172 move_it_vertically (&it
, amount_to_scroll
);
13175 /* Extra precision for users who set scroll-conservatively
13176 to most-positive-fixnum: make sure the amount we scroll
13177 the window start is never less than amount_to_scroll,
13178 which was computed as distance from window bottom to
13179 point. This matters when lines at window top and lines
13180 below window bottom have different height. */
13181 struct it it1
= it
;
13182 /* We use a temporary it1 because line_bottom_y can modify
13183 its argument, if it moves one line down; see there. */
13184 int start_y
= line_bottom_y (&it1
);
13187 move_it_by_lines (&it
, 1, 1);
13189 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13192 /* If STARTP is unchanged, move it down another screen line. */
13193 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13194 move_it_by_lines (&it
, 1, 1);
13195 startp
= it
.current
.pos
;
13199 struct text_pos scroll_margin_pos
= startp
;
13201 /* See if point is inside the scroll margin at the top of the
13203 if (this_scroll_margin
)
13205 start_display (&it
, w
, startp
);
13206 move_it_vertically (&it
, this_scroll_margin
);
13207 scroll_margin_pos
= it
.current
.pos
;
13210 if (PT
< CHARPOS (scroll_margin_pos
))
13212 /* Point is in the scroll margin at the top of the window or
13213 above what is displayed in the window. */
13216 /* Compute the vertical distance from PT to the scroll
13217 margin position. Give up if distance is greater than
13219 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13220 start_display (&it
, w
, pos
);
13222 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13223 it
.last_visible_y
, -1,
13224 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13225 dy
= it
.current_y
- y0
;
13226 if (dy
> scroll_max
)
13227 return SCROLLING_FAILED
;
13229 /* Compute new window start. */
13230 start_display (&it
, w
, startp
);
13232 if (scroll_conservatively
)
13234 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13235 else if (scroll_step
|| temp_scroll_step
)
13236 amount_to_scroll
= scroll_max
;
13239 aggressive
= current_buffer
->scroll_down_aggressively
;
13240 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13241 if (NUMBERP (aggressive
))
13243 double float_amount
= XFLOATINT (aggressive
) * height
;
13244 amount_to_scroll
= float_amount
;
13245 if (amount_to_scroll
== 0 && float_amount
> 0)
13246 amount_to_scroll
= 1;
13250 if (amount_to_scroll
<= 0)
13251 return SCROLLING_FAILED
;
13253 move_it_vertically_backward (&it
, amount_to_scroll
);
13254 startp
= it
.current
.pos
;
13258 /* Run window scroll functions. */
13259 startp
= run_window_scroll_functions (window
, startp
);
13261 /* Display the window. Give up if new fonts are loaded, or if point
13263 if (!try_window (window
, startp
, 0))
13264 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13265 else if (w
->cursor
.vpos
< 0)
13267 clear_glyph_matrix (w
->desired_matrix
);
13268 rc
= SCROLLING_FAILED
;
13272 /* Maybe forget recorded base line for line number display. */
13273 if (!just_this_one_p
13274 || current_buffer
->clip_changed
13275 || BEG_UNCHANGED
< CHARPOS (startp
))
13276 w
->base_line_number
= Qnil
;
13278 /* If cursor ends up on a partially visible line,
13279 treat that as being off the bottom of the screen. */
13280 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13282 clear_glyph_matrix (w
->desired_matrix
);
13283 ++extra_scroll_margin_lines
;
13286 rc
= SCROLLING_SUCCESS
;
13293 /* Compute a suitable window start for window W if display of W starts
13294 on a continuation line. Value is non-zero if a new window start
13297 The new window start will be computed, based on W's width, starting
13298 from the start of the continued line. It is the start of the
13299 screen line with the minimum distance from the old start W->start. */
13302 compute_window_start_on_continuation_line (struct window
*w
)
13304 struct text_pos pos
, start_pos
;
13305 int window_start_changed_p
= 0;
13307 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13309 /* If window start is on a continuation line... Window start may be
13310 < BEGV in case there's invisible text at the start of the
13311 buffer (M-x rmail, for example). */
13312 if (CHARPOS (start_pos
) > BEGV
13313 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13316 struct glyph_row
*row
;
13318 /* Handle the case that the window start is out of range. */
13319 if (CHARPOS (start_pos
) < BEGV
)
13320 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13321 else if (CHARPOS (start_pos
) > ZV
)
13322 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13324 /* Find the start of the continued line. This should be fast
13325 because scan_buffer is fast (newline cache). */
13326 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13327 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13328 row
, DEFAULT_FACE_ID
);
13329 reseat_at_previous_visible_line_start (&it
);
13331 /* If the line start is "too far" away from the window start,
13332 say it takes too much time to compute a new window start. */
13333 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13334 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13336 int min_distance
, distance
;
13338 /* Move forward by display lines to find the new window
13339 start. If window width was enlarged, the new start can
13340 be expected to be > the old start. If window width was
13341 decreased, the new window start will be < the old start.
13342 So, we're looking for the display line start with the
13343 minimum distance from the old window start. */
13344 pos
= it
.current
.pos
;
13345 min_distance
= INFINITY
;
13346 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13347 distance
< min_distance
)
13349 min_distance
= distance
;
13350 pos
= it
.current
.pos
;
13351 move_it_by_lines (&it
, 1, 0);
13354 /* Set the window start there. */
13355 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13356 window_start_changed_p
= 1;
13360 return window_start_changed_p
;
13364 /* Try cursor movement in case text has not changed in window WINDOW,
13365 with window start STARTP. Value is
13367 CURSOR_MOVEMENT_SUCCESS if successful
13369 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13371 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13372 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13373 we want to scroll as if scroll-step were set to 1. See the code.
13375 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13376 which case we have to abort this redisplay, and adjust matrices
13381 CURSOR_MOVEMENT_SUCCESS
,
13382 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13383 CURSOR_MOVEMENT_MUST_SCROLL
,
13384 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13388 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13390 struct window
*w
= XWINDOW (window
);
13391 struct frame
*f
= XFRAME (w
->frame
);
13392 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13395 if (inhibit_try_cursor_movement
)
13399 /* Handle case where text has not changed, only point, and it has
13400 not moved off the frame. */
13401 if (/* Point may be in this window. */
13402 PT
>= CHARPOS (startp
)
13403 /* Selective display hasn't changed. */
13404 && !current_buffer
->clip_changed
13405 /* Function force-mode-line-update is used to force a thorough
13406 redisplay. It sets either windows_or_buffers_changed or
13407 update_mode_lines. So don't take a shortcut here for these
13409 && !update_mode_lines
13410 && !windows_or_buffers_changed
13411 && !cursor_type_changed
13412 /* Can't use this case if highlighting a region. When a
13413 region exists, cursor movement has to do more than just
13415 && !(!NILP (Vtransient_mark_mode
)
13416 && !NILP (current_buffer
->mark_active
))
13417 && NILP (w
->region_showing
)
13418 && NILP (Vshow_trailing_whitespace
)
13419 /* Right after splitting windows, last_point may be nil. */
13420 && INTEGERP (w
->last_point
)
13421 /* This code is not used for mini-buffer for the sake of the case
13422 of redisplaying to replace an echo area message; since in
13423 that case the mini-buffer contents per se are usually
13424 unchanged. This code is of no real use in the mini-buffer
13425 since the handling of this_line_start_pos, etc., in redisplay
13426 handles the same cases. */
13427 && !EQ (window
, minibuf_window
)
13428 /* When splitting windows or for new windows, it happens that
13429 redisplay is called with a nil window_end_vpos or one being
13430 larger than the window. This should really be fixed in
13431 window.c. I don't have this on my list, now, so we do
13432 approximately the same as the old redisplay code. --gerd. */
13433 && INTEGERP (w
->window_end_vpos
)
13434 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13435 && (FRAME_WINDOW_P (f
)
13436 || !overlay_arrow_in_current_buffer_p ()))
13438 int this_scroll_margin
, top_scroll_margin
;
13439 struct glyph_row
*row
= NULL
;
13442 debug_method_add (w
, "cursor movement");
13445 /* Scroll if point within this distance from the top or bottom
13446 of the window. This is a pixel value. */
13447 if (scroll_margin
> 0)
13449 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13450 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13453 this_scroll_margin
= 0;
13455 top_scroll_margin
= this_scroll_margin
;
13456 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13457 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13459 /* Start with the row the cursor was displayed during the last
13460 not paused redisplay. Give up if that row is not valid. */
13461 if (w
->last_cursor
.vpos
< 0
13462 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13463 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13466 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13467 if (row
->mode_line_p
)
13469 if (!row
->enabled_p
)
13470 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13473 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13475 int scroll_p
= 0, must_scroll
= 0;
13476 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13478 if (PT
> XFASTINT (w
->last_point
))
13480 /* Point has moved forward. */
13481 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13482 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13484 xassert (row
->enabled_p
);
13488 /* If the end position of a row equals the start
13489 position of the next row, and PT is at that position,
13490 we would rather display cursor in the next line. */
13491 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13492 && MATRIX_ROW_END_CHARPOS (row
) == PT
13493 && row
< w
->current_matrix
->rows
13494 + w
->current_matrix
->nrows
- 1
13495 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13496 && !cursor_row_p (w
, row
))
13499 /* If within the scroll margin, scroll. Note that
13500 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13501 the next line would be drawn, and that
13502 this_scroll_margin can be zero. */
13503 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13504 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13505 /* Line is completely visible last line in window
13506 and PT is to be set in the next line. */
13507 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13508 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13509 && !row
->ends_at_zv_p
13510 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13513 else if (PT
< XFASTINT (w
->last_point
))
13515 /* Cursor has to be moved backward. Note that PT >=
13516 CHARPOS (startp) because of the outer if-statement. */
13517 while (!row
->mode_line_p
13518 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13519 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13520 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13521 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13522 row
> w
->current_matrix
->rows
13523 && (row
-1)->ends_in_newline_from_string_p
))))
13524 && (row
->y
> top_scroll_margin
13525 || CHARPOS (startp
) == BEGV
))
13527 xassert (row
->enabled_p
);
13531 /* Consider the following case: Window starts at BEGV,
13532 there is invisible, intangible text at BEGV, so that
13533 display starts at some point START > BEGV. It can
13534 happen that we are called with PT somewhere between
13535 BEGV and START. Try to handle that case. */
13536 if (row
< w
->current_matrix
->rows
13537 || row
->mode_line_p
)
13539 row
= w
->current_matrix
->rows
;
13540 if (row
->mode_line_p
)
13544 /* Due to newlines in overlay strings, we may have to
13545 skip forward over overlay strings. */
13546 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13547 && MATRIX_ROW_END_CHARPOS (row
) == PT
13548 && !cursor_row_p (w
, row
))
13551 /* If within the scroll margin, scroll. */
13552 if (row
->y
< top_scroll_margin
13553 && CHARPOS (startp
) != BEGV
)
13558 /* Cursor did not move. So don't scroll even if cursor line
13559 is partially visible, as it was so before. */
13560 rc
= CURSOR_MOVEMENT_SUCCESS
;
13563 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13564 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13566 /* if PT is not in the glyph row, give up. */
13567 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13570 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13571 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13573 /* If rows are bidi-reordered and point moved, back up
13574 until we find a row that does not belong to a
13575 continuation line. This is because we must consider
13576 all rows of a continued line as candidates for the
13577 new cursor positioning, since row start and end
13578 positions change non-linearly with vertical position
13580 /* FIXME: Revisit this when glyph ``spilling'' in
13581 continuation lines' rows is implemented for
13582 bidi-reordered rows. */
13583 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13585 xassert (row
->enabled_p
);
13587 /* If we hit the beginning of the displayed portion
13588 without finding the first row of a continued
13590 if (row
<= w
->current_matrix
->rows
)
13592 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13600 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13601 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13602 && make_cursor_line_fully_visible_p
)
13604 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13605 && !row
->ends_at_zv_p
13606 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13607 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13608 else if (row
->height
> window_box_height (w
))
13610 /* If we end up in a partially visible line, let's
13611 make it fully visible, except when it's taller
13612 than the window, in which case we can't do much
13615 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13619 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13620 if (!cursor_row_fully_visible_p (w
, 0, 1))
13621 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13623 rc
= CURSOR_MOVEMENT_SUCCESS
;
13627 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13628 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13629 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13631 /* With bidi-reordered rows, there could be more than
13632 one candidate row whose start and end positions
13633 occlude point. We need to let set_cursor_from_row
13634 find the best candidate. */
13635 /* FIXME: Revisit this when glyph ``spilling'' in
13636 continuation lines' rows is implemented for
13637 bidi-reordered rows. */
13642 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13643 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13644 && cursor_row_p (w
, row
))
13645 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13647 /* As soon as we've found the first suitable row
13648 whose ends_at_zv_p flag is set, we are done. */
13650 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13652 rc
= CURSOR_MOVEMENT_SUCCESS
;
13657 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13658 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13659 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13660 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13661 /* If we didn't find any candidate rows, or exited the
13662 loop before all the candidates were examined, signal
13663 to the caller that this method failed. */
13664 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13665 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13666 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13668 rc
= CURSOR_MOVEMENT_SUCCESS
;
13674 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13676 rc
= CURSOR_MOVEMENT_SUCCESS
;
13681 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13682 && MATRIX_ROW_START_CHARPOS (row
) == PT
13683 && cursor_row_p (w
, row
));
13692 set_vertical_scroll_bar (struct window
*w
)
13694 int start
, end
, whole
;
13696 /* Calculate the start and end positions for the current window.
13697 At some point, it would be nice to choose between scrollbars
13698 which reflect the whole buffer size, with special markers
13699 indicating narrowing, and scrollbars which reflect only the
13702 Note that mini-buffers sometimes aren't displaying any text. */
13703 if (!MINI_WINDOW_P (w
)
13704 || (w
== XWINDOW (minibuf_window
)
13705 && NILP (echo_area_buffer
[0])))
13707 struct buffer
*buf
= XBUFFER (w
->buffer
);
13708 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13709 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13710 /* I don't think this is guaranteed to be right. For the
13711 moment, we'll pretend it is. */
13712 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13716 if (whole
< (end
- start
))
13717 whole
= end
- start
;
13720 start
= end
= whole
= 0;
13722 /* Indicate what this scroll bar ought to be displaying now. */
13723 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13724 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13725 (w
, end
- start
, whole
, start
);
13729 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13730 selected_window is redisplayed.
13732 We can return without actually redisplaying the window if
13733 fonts_changed_p is nonzero. In that case, redisplay_internal will
13737 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13739 struct window
*w
= XWINDOW (window
);
13740 struct frame
*f
= XFRAME (w
->frame
);
13741 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13742 struct buffer
*old
= current_buffer
;
13743 struct text_pos lpoint
, opoint
, startp
;
13744 int update_mode_line
;
13747 /* Record it now because it's overwritten. */
13748 int current_matrix_up_to_date_p
= 0;
13749 int used_current_matrix_p
= 0;
13750 /* This is less strict than current_matrix_up_to_date_p.
13751 It indictes that the buffer contents and narrowing are unchanged. */
13752 int buffer_unchanged_p
= 0;
13753 int temp_scroll_step
= 0;
13754 int count
= SPECPDL_INDEX ();
13756 int centering_position
= -1;
13757 int last_line_misfit
= 0;
13758 int beg_unchanged
, end_unchanged
;
13760 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13763 /* W must be a leaf window here. */
13764 xassert (!NILP (w
->buffer
));
13766 *w
->desired_matrix
->method
= 0;
13770 reconsider_clip_changes (w
, buffer
);
13772 /* Has the mode line to be updated? */
13773 update_mode_line
= (!NILP (w
->update_mode_line
)
13774 || update_mode_lines
13775 || buffer
->clip_changed
13776 || buffer
->prevent_redisplay_optimizations_p
);
13778 if (MINI_WINDOW_P (w
))
13780 if (w
== XWINDOW (echo_area_window
)
13781 && !NILP (echo_area_buffer
[0]))
13783 if (update_mode_line
)
13784 /* We may have to update a tty frame's menu bar or a
13785 tool-bar. Example `M-x C-h C-h C-g'. */
13786 goto finish_menu_bars
;
13788 /* We've already displayed the echo area glyphs in this window. */
13789 goto finish_scroll_bars
;
13791 else if ((w
!= XWINDOW (minibuf_window
)
13792 || minibuf_level
== 0)
13793 /* When buffer is nonempty, redisplay window normally. */
13794 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13795 /* Quail displays non-mini buffers in minibuffer window.
13796 In that case, redisplay the window normally. */
13797 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13799 /* W is a mini-buffer window, but it's not active, so clear
13801 int yb
= window_text_bottom_y (w
);
13802 struct glyph_row
*row
;
13805 for (y
= 0, row
= w
->desired_matrix
->rows
;
13807 y
+= row
->height
, ++row
)
13808 blank_row (w
, row
, y
);
13809 goto finish_scroll_bars
;
13812 clear_glyph_matrix (w
->desired_matrix
);
13815 /* Otherwise set up data on this window; select its buffer and point
13817 /* Really select the buffer, for the sake of buffer-local
13819 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13821 current_matrix_up_to_date_p
13822 = (!NILP (w
->window_end_valid
)
13823 && !current_buffer
->clip_changed
13824 && !current_buffer
->prevent_redisplay_optimizations_p
13825 && XFASTINT (w
->last_modified
) >= MODIFF
13826 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13828 /* Run the window-bottom-change-functions
13829 if it is possible that the text on the screen has changed
13830 (either due to modification of the text, or any other reason). */
13831 if (!current_matrix_up_to_date_p
13832 && !NILP (Vwindow_text_change_functions
))
13834 safe_run_hooks (Qwindow_text_change_functions
);
13838 beg_unchanged
= BEG_UNCHANGED
;
13839 end_unchanged
= END_UNCHANGED
;
13841 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13843 specbind (Qinhibit_point_motion_hooks
, Qt
);
13846 = (!NILP (w
->window_end_valid
)
13847 && !current_buffer
->clip_changed
13848 && XFASTINT (w
->last_modified
) >= MODIFF
13849 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13851 /* When windows_or_buffers_changed is non-zero, we can't rely on
13852 the window end being valid, so set it to nil there. */
13853 if (windows_or_buffers_changed
)
13855 /* If window starts on a continuation line, maybe adjust the
13856 window start in case the window's width changed. */
13857 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13858 compute_window_start_on_continuation_line (w
);
13860 w
->window_end_valid
= Qnil
;
13863 /* Some sanity checks. */
13864 CHECK_WINDOW_END (w
);
13865 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13867 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13870 /* If %c is in mode line, update it if needed. */
13871 if (!NILP (w
->column_number_displayed
)
13872 /* This alternative quickly identifies a common case
13873 where no change is needed. */
13874 && !(PT
== XFASTINT (w
->last_point
)
13875 && XFASTINT (w
->last_modified
) >= MODIFF
13876 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13877 && (XFASTINT (w
->column_number_displayed
)
13878 != (int) current_column ())) /* iftc */
13879 update_mode_line
= 1;
13881 /* Count number of windows showing the selected buffer. An indirect
13882 buffer counts as its base buffer. */
13883 if (!just_this_one_p
)
13885 struct buffer
*current_base
, *window_base
;
13886 current_base
= current_buffer
;
13887 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13888 if (current_base
->base_buffer
)
13889 current_base
= current_base
->base_buffer
;
13890 if (window_base
->base_buffer
)
13891 window_base
= window_base
->base_buffer
;
13892 if (current_base
== window_base
)
13896 /* Point refers normally to the selected window. For any other
13897 window, set up appropriate value. */
13898 if (!EQ (window
, selected_window
))
13900 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13901 int new_pt_byte
= marker_byte_position (w
->pointm
);
13905 new_pt_byte
= BEGV_BYTE
;
13906 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13908 else if (new_pt
> (ZV
- 1))
13911 new_pt_byte
= ZV_BYTE
;
13912 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13915 /* We don't use SET_PT so that the point-motion hooks don't run. */
13916 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13919 /* If any of the character widths specified in the display table
13920 have changed, invalidate the width run cache. It's true that
13921 this may be a bit late to catch such changes, but the rest of
13922 redisplay goes (non-fatally) haywire when the display table is
13923 changed, so why should we worry about doing any better? */
13924 if (current_buffer
->width_run_cache
)
13926 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13928 if (! disptab_matches_widthtab (disptab
,
13929 XVECTOR (current_buffer
->width_table
)))
13931 invalidate_region_cache (current_buffer
,
13932 current_buffer
->width_run_cache
,
13934 recompute_width_table (current_buffer
, disptab
);
13938 /* If window-start is screwed up, choose a new one. */
13939 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13942 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13944 /* If someone specified a new starting point but did not insist,
13945 check whether it can be used. */
13946 if (!NILP (w
->optional_new_start
)
13947 && CHARPOS (startp
) >= BEGV
13948 && CHARPOS (startp
) <= ZV
)
13950 w
->optional_new_start
= Qnil
;
13951 start_display (&it
, w
, startp
);
13952 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13953 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13954 if (IT_CHARPOS (it
) == PT
)
13955 w
->force_start
= Qt
;
13956 /* IT may overshoot PT if text at PT is invisible. */
13957 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13958 w
->force_start
= Qt
;
13963 /* Handle case where place to start displaying has been specified,
13964 unless the specified location is outside the accessible range. */
13965 if (!NILP (w
->force_start
)
13966 || w
->frozen_window_start_p
)
13968 /* We set this later on if we have to adjust point. */
13971 w
->force_start
= Qnil
;
13973 w
->window_end_valid
= Qnil
;
13975 /* Forget any recorded base line for line number display. */
13976 if (!buffer_unchanged_p
)
13977 w
->base_line_number
= Qnil
;
13979 /* Redisplay the mode line. Select the buffer properly for that.
13980 Also, run the hook window-scroll-functions
13981 because we have scrolled. */
13982 /* Note, we do this after clearing force_start because
13983 if there's an error, it is better to forget about force_start
13984 than to get into an infinite loop calling the hook functions
13985 and having them get more errors. */
13986 if (!update_mode_line
13987 || ! NILP (Vwindow_scroll_functions
))
13989 update_mode_line
= 1;
13990 w
->update_mode_line
= Qt
;
13991 startp
= run_window_scroll_functions (window
, startp
);
13994 w
->last_modified
= make_number (0);
13995 w
->last_overlay_modified
= make_number (0);
13996 if (CHARPOS (startp
) < BEGV
)
13997 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13998 else if (CHARPOS (startp
) > ZV
)
13999 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14001 /* Redisplay, then check if cursor has been set during the
14002 redisplay. Give up if new fonts were loaded. */
14003 /* We used to issue a CHECK_MARGINS argument to try_window here,
14004 but this causes scrolling to fail when point begins inside
14005 the scroll margin (bug#148) -- cyd */
14006 if (!try_window (window
, startp
, 0))
14008 w
->force_start
= Qt
;
14009 clear_glyph_matrix (w
->desired_matrix
);
14010 goto need_larger_matrices
;
14013 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14015 /* If point does not appear, try to move point so it does
14016 appear. The desired matrix has been built above, so we
14017 can use it here. */
14018 new_vpos
= window_box_height (w
) / 2;
14021 if (!cursor_row_fully_visible_p (w
, 0, 0))
14023 /* Point does appear, but on a line partly visible at end of window.
14024 Move it back to a fully-visible line. */
14025 new_vpos
= window_box_height (w
);
14028 /* If we need to move point for either of the above reasons,
14029 now actually do it. */
14032 struct glyph_row
*row
;
14034 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14035 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14038 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14039 MATRIX_ROW_START_BYTEPOS (row
));
14041 if (w
!= XWINDOW (selected_window
))
14042 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14043 else if (current_buffer
== old
)
14044 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14046 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14048 /* If we are highlighting the region, then we just changed
14049 the region, so redisplay to show it. */
14050 if (!NILP (Vtransient_mark_mode
)
14051 && !NILP (current_buffer
->mark_active
))
14053 clear_glyph_matrix (w
->desired_matrix
);
14054 if (!try_window (window
, startp
, 0))
14055 goto need_larger_matrices
;
14060 debug_method_add (w
, "forced window start");
14065 /* Handle case where text has not changed, only point, and it has
14066 not moved off the frame, and we are not retrying after hscroll.
14067 (current_matrix_up_to_date_p is nonzero when retrying.) */
14068 if (current_matrix_up_to_date_p
14069 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14070 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14074 case CURSOR_MOVEMENT_SUCCESS
:
14075 used_current_matrix_p
= 1;
14078 case CURSOR_MOVEMENT_MUST_SCROLL
:
14079 goto try_to_scroll
;
14085 /* If current starting point was originally the beginning of a line
14086 but no longer is, find a new starting point. */
14087 else if (!NILP (w
->start_at_line_beg
)
14088 && !(CHARPOS (startp
) <= BEGV
14089 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14092 debug_method_add (w
, "recenter 1");
14097 /* Try scrolling with try_window_id. Value is > 0 if update has
14098 been done, it is -1 if we know that the same window start will
14099 not work. It is 0 if unsuccessful for some other reason. */
14100 else if ((tem
= try_window_id (w
)) != 0)
14103 debug_method_add (w
, "try_window_id %d", tem
);
14106 if (fonts_changed_p
)
14107 goto need_larger_matrices
;
14111 /* Otherwise try_window_id has returned -1 which means that we
14112 don't want the alternative below this comment to execute. */
14114 else if (CHARPOS (startp
) >= BEGV
14115 && CHARPOS (startp
) <= ZV
14116 && PT
>= CHARPOS (startp
)
14117 && (CHARPOS (startp
) < ZV
14118 /* Avoid starting at end of buffer. */
14119 || CHARPOS (startp
) == BEGV
14120 || (XFASTINT (w
->last_modified
) >= MODIFF
14121 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14124 /* If first window line is a continuation line, and window start
14125 is inside the modified region, but the first change is before
14126 current window start, we must select a new window start.
14128 However, if this is the result of a down-mouse event (e.g. by
14129 extending the mouse-drag-overlay), we don't want to select a
14130 new window start, since that would change the position under
14131 the mouse, resulting in an unwanted mouse-movement rather
14132 than a simple mouse-click. */
14133 if (NILP (w
->start_at_line_beg
)
14134 && NILP (do_mouse_tracking
)
14135 && CHARPOS (startp
) > BEGV
14136 && CHARPOS (startp
) > BEG
+ beg_unchanged
14137 && CHARPOS (startp
) <= Z
- end_unchanged
14138 /* Even if w->start_at_line_beg is nil, a new window may
14139 start at a line_beg, since that's how set_buffer_window
14140 sets it. So, we need to check the return value of
14141 compute_window_start_on_continuation_line. (See also
14143 && XMARKER (w
->start
)->buffer
== current_buffer
14144 && compute_window_start_on_continuation_line (w
))
14146 w
->force_start
= Qt
;
14147 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14152 debug_method_add (w
, "same window start");
14155 /* Try to redisplay starting at same place as before.
14156 If point has not moved off frame, accept the results. */
14157 if (!current_matrix_up_to_date_p
14158 /* Don't use try_window_reusing_current_matrix in this case
14159 because a window scroll function can have changed the
14161 || !NILP (Vwindow_scroll_functions
)
14162 || MINI_WINDOW_P (w
)
14163 || !(used_current_matrix_p
14164 = try_window_reusing_current_matrix (w
)))
14166 IF_DEBUG (debug_method_add (w
, "1"));
14167 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14168 /* -1 means we need to scroll.
14169 0 means we need new matrices, but fonts_changed_p
14170 is set in that case, so we will detect it below. */
14171 goto try_to_scroll
;
14174 if (fonts_changed_p
)
14175 goto need_larger_matrices
;
14177 if (w
->cursor
.vpos
>= 0)
14179 if (!just_this_one_p
14180 || current_buffer
->clip_changed
14181 || BEG_UNCHANGED
< CHARPOS (startp
))
14182 /* Forget any recorded base line for line number display. */
14183 w
->base_line_number
= Qnil
;
14185 if (!cursor_row_fully_visible_p (w
, 1, 0))
14187 clear_glyph_matrix (w
->desired_matrix
);
14188 last_line_misfit
= 1;
14190 /* Drop through and scroll. */
14195 clear_glyph_matrix (w
->desired_matrix
);
14200 w
->last_modified
= make_number (0);
14201 w
->last_overlay_modified
= make_number (0);
14203 /* Redisplay the mode line. Select the buffer properly for that. */
14204 if (!update_mode_line
)
14206 update_mode_line
= 1;
14207 w
->update_mode_line
= Qt
;
14210 /* Try to scroll by specified few lines. */
14211 if ((scroll_conservatively
14213 || temp_scroll_step
14214 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14215 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14216 && !current_buffer
->clip_changed
14217 && CHARPOS (startp
) >= BEGV
14218 && CHARPOS (startp
) <= ZV
)
14220 /* The function returns -1 if new fonts were loaded, 1 if
14221 successful, 0 if not successful. */
14222 int rc
= try_scrolling (window
, just_this_one_p
,
14223 scroll_conservatively
,
14225 temp_scroll_step
, last_line_misfit
);
14228 case SCROLLING_SUCCESS
:
14231 case SCROLLING_NEED_LARGER_MATRICES
:
14232 goto need_larger_matrices
;
14234 case SCROLLING_FAILED
:
14242 /* Finally, just choose place to start which centers point */
14245 if (centering_position
< 0)
14246 centering_position
= window_box_height (w
) / 2;
14249 debug_method_add (w
, "recenter");
14252 /* w->vscroll = 0; */
14254 /* Forget any previously recorded base line for line number display. */
14255 if (!buffer_unchanged_p
)
14256 w
->base_line_number
= Qnil
;
14258 /* Move backward half the height of the window. */
14259 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14260 it
.current_y
= it
.last_visible_y
;
14261 move_it_vertically_backward (&it
, centering_position
);
14262 xassert (IT_CHARPOS (it
) >= BEGV
);
14264 /* The function move_it_vertically_backward may move over more
14265 than the specified y-distance. If it->w is small, e.g. a
14266 mini-buffer window, we may end up in front of the window's
14267 display area. Start displaying at the start of the line
14268 containing PT in this case. */
14269 if (it
.current_y
<= 0)
14271 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14272 move_it_vertically_backward (&it
, 0);
14276 it
.current_x
= it
.hpos
= 0;
14278 /* Set startp here explicitly in case that helps avoid an infinite loop
14279 in case the window-scroll-functions functions get errors. */
14280 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14282 /* Run scroll hooks. */
14283 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14285 /* Redisplay the window. */
14286 if (!current_matrix_up_to_date_p
14287 || windows_or_buffers_changed
14288 || cursor_type_changed
14289 /* Don't use try_window_reusing_current_matrix in this case
14290 because it can have changed the buffer. */
14291 || !NILP (Vwindow_scroll_functions
)
14292 || !just_this_one_p
14293 || MINI_WINDOW_P (w
)
14294 || !(used_current_matrix_p
14295 = try_window_reusing_current_matrix (w
)))
14296 try_window (window
, startp
, 0);
14298 /* If new fonts have been loaded (due to fontsets), give up. We
14299 have to start a new redisplay since we need to re-adjust glyph
14301 if (fonts_changed_p
)
14302 goto need_larger_matrices
;
14304 /* If cursor did not appear assume that the middle of the window is
14305 in the first line of the window. Do it again with the next line.
14306 (Imagine a window of height 100, displaying two lines of height
14307 60. Moving back 50 from it->last_visible_y will end in the first
14309 if (w
->cursor
.vpos
< 0)
14311 if (!NILP (w
->window_end_valid
)
14312 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14314 clear_glyph_matrix (w
->desired_matrix
);
14315 move_it_by_lines (&it
, 1, 0);
14316 try_window (window
, it
.current
.pos
, 0);
14318 else if (PT
< IT_CHARPOS (it
))
14320 clear_glyph_matrix (w
->desired_matrix
);
14321 move_it_by_lines (&it
, -1, 0);
14322 try_window (window
, it
.current
.pos
, 0);
14326 /* Not much we can do about it. */
14330 /* Consider the following case: Window starts at BEGV, there is
14331 invisible, intangible text at BEGV, so that display starts at
14332 some point START > BEGV. It can happen that we are called with
14333 PT somewhere between BEGV and START. Try to handle that case. */
14334 if (w
->cursor
.vpos
< 0)
14336 struct glyph_row
*row
= w
->current_matrix
->rows
;
14337 if (row
->mode_line_p
)
14339 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14342 if (!cursor_row_fully_visible_p (w
, 0, 0))
14344 /* If vscroll is enabled, disable it and try again. */
14348 clear_glyph_matrix (w
->desired_matrix
);
14352 /* If centering point failed to make the whole line visible,
14353 put point at the top instead. That has to make the whole line
14354 visible, if it can be done. */
14355 if (centering_position
== 0)
14358 clear_glyph_matrix (w
->desired_matrix
);
14359 centering_position
= 0;
14365 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14366 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14367 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14370 /* Display the mode line, if we must. */
14371 if ((update_mode_line
14372 /* If window not full width, must redo its mode line
14373 if (a) the window to its side is being redone and
14374 (b) we do a frame-based redisplay. This is a consequence
14375 of how inverted lines are drawn in frame-based redisplay. */
14376 || (!just_this_one_p
14377 && !FRAME_WINDOW_P (f
)
14378 && !WINDOW_FULL_WIDTH_P (w
))
14379 /* Line number to display. */
14380 || INTEGERP (w
->base_line_pos
)
14381 /* Column number is displayed and different from the one displayed. */
14382 || (!NILP (w
->column_number_displayed
)
14383 && (XFASTINT (w
->column_number_displayed
)
14384 != (int) current_column ()))) /* iftc */
14385 /* This means that the window has a mode line. */
14386 && (WINDOW_WANTS_MODELINE_P (w
)
14387 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14389 display_mode_lines (w
);
14391 /* If mode line height has changed, arrange for a thorough
14392 immediate redisplay using the correct mode line height. */
14393 if (WINDOW_WANTS_MODELINE_P (w
)
14394 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14396 fonts_changed_p
= 1;
14397 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14398 = DESIRED_MODE_LINE_HEIGHT (w
);
14401 /* If header line height has changed, arrange for a thorough
14402 immediate redisplay using the correct header line height. */
14403 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14404 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14406 fonts_changed_p
= 1;
14407 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14408 = DESIRED_HEADER_LINE_HEIGHT (w
);
14411 if (fonts_changed_p
)
14412 goto need_larger_matrices
;
14415 if (!line_number_displayed
14416 && !BUFFERP (w
->base_line_pos
))
14418 w
->base_line_pos
= Qnil
;
14419 w
->base_line_number
= Qnil
;
14424 /* When we reach a frame's selected window, redo the frame's menu bar. */
14425 if (update_mode_line
14426 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14428 int redisplay_menu_p
= 0;
14429 int redisplay_tool_bar_p
= 0;
14431 if (FRAME_WINDOW_P (f
))
14433 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14434 || defined (HAVE_NS) || defined (USE_GTK)
14435 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14437 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14441 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14443 if (redisplay_menu_p
)
14444 display_menu_bar (w
);
14446 #ifdef HAVE_WINDOW_SYSTEM
14447 if (FRAME_WINDOW_P (f
))
14449 #if defined (USE_GTK) || defined (HAVE_NS)
14450 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14452 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14453 && (FRAME_TOOL_BAR_LINES (f
) > 0
14454 || !NILP (Vauto_resize_tool_bars
));
14457 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14459 ignore_mouse_drag_p
= 1;
14465 #ifdef HAVE_WINDOW_SYSTEM
14466 if (FRAME_WINDOW_P (f
)
14467 && update_window_fringes (w
, (just_this_one_p
14468 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14469 || w
->pseudo_window_p
)))
14473 if (draw_window_fringes (w
, 1))
14474 x_draw_vertical_border (w
);
14478 #endif /* HAVE_WINDOW_SYSTEM */
14480 /* We go to this label, with fonts_changed_p nonzero,
14481 if it is necessary to try again using larger glyph matrices.
14482 We have to redeem the scroll bar even in this case,
14483 because the loop in redisplay_internal expects that. */
14484 need_larger_matrices
:
14486 finish_scroll_bars
:
14488 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14490 /* Set the thumb's position and size. */
14491 set_vertical_scroll_bar (w
);
14493 /* Note that we actually used the scroll bar attached to this
14494 window, so it shouldn't be deleted at the end of redisplay. */
14495 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14496 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14499 /* Restore current_buffer and value of point in it. The window
14500 update may have changed the buffer, so first make sure `opoint'
14501 is still valid (Bug#6177). */
14502 if (CHARPOS (opoint
) < BEGV
)
14503 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14504 else if (CHARPOS (opoint
) > ZV
)
14505 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14507 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14509 set_buffer_internal_1 (old
);
14510 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14511 shorter. This can be caused by log truncation in *Messages*. */
14512 if (CHARPOS (lpoint
) <= ZV
)
14513 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14515 unbind_to (count
, Qnil
);
14519 /* Build the complete desired matrix of WINDOW with a window start
14520 buffer position POS.
14522 Value is 1 if successful. It is zero if fonts were loaded during
14523 redisplay which makes re-adjusting glyph matrices necessary, and -1
14524 if point would appear in the scroll margins.
14525 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14526 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14530 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14532 struct window
*w
= XWINDOW (window
);
14534 struct glyph_row
*last_text_row
= NULL
;
14535 struct frame
*f
= XFRAME (w
->frame
);
14537 /* Make POS the new window start. */
14538 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14540 /* Mark cursor position as unknown. No overlay arrow seen. */
14541 w
->cursor
.vpos
= -1;
14542 overlay_arrow_seen
= 0;
14544 /* Initialize iterator and info to start at POS. */
14545 start_display (&it
, w
, pos
);
14547 /* Display all lines of W. */
14548 while (it
.current_y
< it
.last_visible_y
)
14550 if (display_line (&it
))
14551 last_text_row
= it
.glyph_row
- 1;
14552 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14556 /* Don't let the cursor end in the scroll margins. */
14557 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14558 && !MINI_WINDOW_P (w
))
14560 int this_scroll_margin
;
14562 if (scroll_margin
> 0)
14564 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14565 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14568 this_scroll_margin
= 0;
14570 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14571 && w
->cursor
.y
< this_scroll_margin
14572 && CHARPOS (pos
) > BEGV
14573 && IT_CHARPOS (it
) < ZV
)
14574 /* rms: considering make_cursor_line_fully_visible_p here
14575 seems to give wrong results. We don't want to recenter
14576 when the last line is partly visible, we want to allow
14577 that case to be handled in the usual way. */
14578 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14580 w
->cursor
.vpos
= -1;
14581 clear_glyph_matrix (w
->desired_matrix
);
14586 /* If bottom moved off end of frame, change mode line percentage. */
14587 if (XFASTINT (w
->window_end_pos
) <= 0
14588 && Z
!= IT_CHARPOS (it
))
14589 w
->update_mode_line
= Qt
;
14591 /* Set window_end_pos to the offset of the last character displayed
14592 on the window from the end of current_buffer. Set
14593 window_end_vpos to its row number. */
14596 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14597 w
->window_end_bytepos
14598 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14600 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14602 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14603 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14604 ->displays_text_p
);
14608 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14609 w
->window_end_pos
= make_number (Z
- ZV
);
14610 w
->window_end_vpos
= make_number (0);
14613 /* But that is not valid info until redisplay finishes. */
14614 w
->window_end_valid
= Qnil
;
14620 /************************************************************************
14621 Window redisplay reusing current matrix when buffer has not changed
14622 ************************************************************************/
14624 /* Try redisplay of window W showing an unchanged buffer with a
14625 different window start than the last time it was displayed by
14626 reusing its current matrix. Value is non-zero if successful.
14627 W->start is the new window start. */
14630 try_window_reusing_current_matrix (struct window
*w
)
14632 struct frame
*f
= XFRAME (w
->frame
);
14633 struct glyph_row
*row
, *bottom_row
;
14636 struct text_pos start
, new_start
;
14637 int nrows_scrolled
, i
;
14638 struct glyph_row
*last_text_row
;
14639 struct glyph_row
*last_reused_text_row
;
14640 struct glyph_row
*start_row
;
14641 int start_vpos
, min_y
, max_y
;
14644 if (inhibit_try_window_reusing
)
14648 if (/* This function doesn't handle terminal frames. */
14649 !FRAME_WINDOW_P (f
)
14650 /* Don't try to reuse the display if windows have been split
14652 || windows_or_buffers_changed
14653 || cursor_type_changed
)
14656 /* Can't do this if region may have changed. */
14657 if ((!NILP (Vtransient_mark_mode
)
14658 && !NILP (current_buffer
->mark_active
))
14659 || !NILP (w
->region_showing
)
14660 || !NILP (Vshow_trailing_whitespace
))
14663 /* If top-line visibility has changed, give up. */
14664 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14665 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14668 /* Give up if old or new display is scrolled vertically. We could
14669 make this function handle this, but right now it doesn't. */
14670 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14671 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14674 /* The variable new_start now holds the new window start. The old
14675 start `start' can be determined from the current matrix. */
14676 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14677 start
= start_row
->minpos
;
14678 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14680 /* Clear the desired matrix for the display below. */
14681 clear_glyph_matrix (w
->desired_matrix
);
14683 if (CHARPOS (new_start
) <= CHARPOS (start
))
14687 /* Don't use this method if the display starts with an ellipsis
14688 displayed for invisible text. It's not easy to handle that case
14689 below, and it's certainly not worth the effort since this is
14690 not a frequent case. */
14691 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14694 IF_DEBUG (debug_method_add (w
, "twu1"));
14696 /* Display up to a row that can be reused. The variable
14697 last_text_row is set to the last row displayed that displays
14698 text. Note that it.vpos == 0 if or if not there is a
14699 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14700 start_display (&it
, w
, new_start
);
14701 first_row_y
= it
.current_y
;
14702 w
->cursor
.vpos
= -1;
14703 last_text_row
= last_reused_text_row
= NULL
;
14705 while (it
.current_y
< it
.last_visible_y
14706 && !fonts_changed_p
)
14708 /* If we have reached into the characters in the START row,
14709 that means the line boundaries have changed. So we
14710 can't start copying with the row START. Maybe it will
14711 work to start copying with the following row. */
14712 while (IT_CHARPOS (it
) > CHARPOS (start
))
14714 /* Advance to the next row as the "start". */
14716 start
= start_row
->minpos
;
14717 /* If there are no more rows to try, or just one, give up. */
14718 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14719 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14720 || CHARPOS (start
) == ZV
)
14722 clear_glyph_matrix (w
->desired_matrix
);
14726 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14728 /* If we have reached alignment,
14729 we can copy the rest of the rows. */
14730 if (IT_CHARPOS (it
) == CHARPOS (start
))
14733 if (display_line (&it
))
14734 last_text_row
= it
.glyph_row
- 1;
14737 /* A value of current_y < last_visible_y means that we stopped
14738 at the previous window start, which in turn means that we
14739 have at least one reusable row. */
14740 if (it
.current_y
< it
.last_visible_y
)
14742 /* IT.vpos always starts from 0; it counts text lines. */
14743 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14745 /* Find PT if not already found in the lines displayed. */
14746 if (w
->cursor
.vpos
< 0)
14748 int dy
= it
.current_y
- start_row
->y
;
14750 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14751 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14753 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14754 dy
, nrows_scrolled
);
14757 clear_glyph_matrix (w
->desired_matrix
);
14762 /* Scroll the display. Do it before the current matrix is
14763 changed. The problem here is that update has not yet
14764 run, i.e. part of the current matrix is not up to date.
14765 scroll_run_hook will clear the cursor, and use the
14766 current matrix to get the height of the row the cursor is
14768 run
.current_y
= start_row
->y
;
14769 run
.desired_y
= it
.current_y
;
14770 run
.height
= it
.last_visible_y
- it
.current_y
;
14772 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14775 FRAME_RIF (f
)->update_window_begin_hook (w
);
14776 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14777 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14778 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14782 /* Shift current matrix down by nrows_scrolled lines. */
14783 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14784 rotate_matrix (w
->current_matrix
,
14786 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14789 /* Disable lines that must be updated. */
14790 for (i
= 0; i
< nrows_scrolled
; ++i
)
14791 (start_row
+ i
)->enabled_p
= 0;
14793 /* Re-compute Y positions. */
14794 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14795 max_y
= it
.last_visible_y
;
14796 for (row
= start_row
+ nrows_scrolled
;
14800 row
->y
= it
.current_y
;
14801 row
->visible_height
= row
->height
;
14803 if (row
->y
< min_y
)
14804 row
->visible_height
-= min_y
- row
->y
;
14805 if (row
->y
+ row
->height
> max_y
)
14806 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14807 row
->redraw_fringe_bitmaps_p
= 1;
14809 it
.current_y
+= row
->height
;
14811 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14812 last_reused_text_row
= row
;
14813 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14817 /* Disable lines in the current matrix which are now
14818 below the window. */
14819 for (++row
; row
< bottom_row
; ++row
)
14820 row
->enabled_p
= row
->mode_line_p
= 0;
14823 /* Update window_end_pos etc.; last_reused_text_row is the last
14824 reused row from the current matrix containing text, if any.
14825 The value of last_text_row is the last displayed line
14826 containing text. */
14827 if (last_reused_text_row
)
14829 w
->window_end_bytepos
14830 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14832 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14834 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14835 w
->current_matrix
));
14837 else if (last_text_row
)
14839 w
->window_end_bytepos
14840 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14842 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14844 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14848 /* This window must be completely empty. */
14849 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14850 w
->window_end_pos
= make_number (Z
- ZV
);
14851 w
->window_end_vpos
= make_number (0);
14853 w
->window_end_valid
= Qnil
;
14855 /* Update hint: don't try scrolling again in update_window. */
14856 w
->desired_matrix
->no_scrolling_p
= 1;
14859 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14863 else if (CHARPOS (new_start
) > CHARPOS (start
))
14865 struct glyph_row
*pt_row
, *row
;
14866 struct glyph_row
*first_reusable_row
;
14867 struct glyph_row
*first_row_to_display
;
14869 int yb
= window_text_bottom_y (w
);
14871 /* Find the row starting at new_start, if there is one. Don't
14872 reuse a partially visible line at the end. */
14873 first_reusable_row
= start_row
;
14874 while (first_reusable_row
->enabled_p
14875 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14876 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14877 < CHARPOS (new_start
)))
14878 ++first_reusable_row
;
14880 /* Give up if there is no row to reuse. */
14881 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14882 || !first_reusable_row
->enabled_p
14883 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14884 != CHARPOS (new_start
)))
14887 /* We can reuse fully visible rows beginning with
14888 first_reusable_row to the end of the window. Set
14889 first_row_to_display to the first row that cannot be reused.
14890 Set pt_row to the row containing point, if there is any. */
14892 for (first_row_to_display
= first_reusable_row
;
14893 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14894 ++first_row_to_display
)
14896 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14897 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14898 pt_row
= first_row_to_display
;
14901 /* Start displaying at the start of first_row_to_display. */
14902 xassert (first_row_to_display
->y
< yb
);
14903 init_to_row_start (&it
, w
, first_row_to_display
);
14905 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14907 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14909 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14910 + WINDOW_HEADER_LINE_HEIGHT (w
));
14912 /* Display lines beginning with first_row_to_display in the
14913 desired matrix. Set last_text_row to the last row displayed
14914 that displays text. */
14915 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14916 if (pt_row
== NULL
)
14917 w
->cursor
.vpos
= -1;
14918 last_text_row
= NULL
;
14919 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14920 if (display_line (&it
))
14921 last_text_row
= it
.glyph_row
- 1;
14923 /* If point is in a reused row, adjust y and vpos of the cursor
14927 w
->cursor
.vpos
-= nrows_scrolled
;
14928 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14931 /* Give up if point isn't in a row displayed or reused. (This
14932 also handles the case where w->cursor.vpos < nrows_scrolled
14933 after the calls to display_line, which can happen with scroll
14934 margins. See bug#1295.) */
14935 if (w
->cursor
.vpos
< 0)
14937 clear_glyph_matrix (w
->desired_matrix
);
14941 /* Scroll the display. */
14942 run
.current_y
= first_reusable_row
->y
;
14943 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14944 run
.height
= it
.last_visible_y
- run
.current_y
;
14945 dy
= run
.current_y
- run
.desired_y
;
14950 FRAME_RIF (f
)->update_window_begin_hook (w
);
14951 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14952 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14953 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14957 /* Adjust Y positions of reused rows. */
14958 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14959 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14960 max_y
= it
.last_visible_y
;
14961 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14964 row
->visible_height
= row
->height
;
14965 if (row
->y
< min_y
)
14966 row
->visible_height
-= min_y
- row
->y
;
14967 if (row
->y
+ row
->height
> max_y
)
14968 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14969 row
->redraw_fringe_bitmaps_p
= 1;
14972 /* Scroll the current matrix. */
14973 xassert (nrows_scrolled
> 0);
14974 rotate_matrix (w
->current_matrix
,
14976 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14979 /* Disable rows not reused. */
14980 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14981 row
->enabled_p
= 0;
14983 /* Point may have moved to a different line, so we cannot assume that
14984 the previous cursor position is valid; locate the correct row. */
14987 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14988 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14992 w
->cursor
.y
= row
->y
;
14994 if (row
< bottom_row
)
14996 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14997 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14999 /* Can't use this optimization with bidi-reordered glyph
15000 rows, unless cursor is already at point. */
15001 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15003 if (!(w
->cursor
.hpos
>= 0
15004 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15005 && BUFFERP (glyph
->object
)
15006 && glyph
->charpos
== PT
))
15011 && (!BUFFERP (glyph
->object
)
15012 || glyph
->charpos
< PT
);
15016 w
->cursor
.x
+= glyph
->pixel_width
;
15021 /* Adjust window end. A null value of last_text_row means that
15022 the window end is in reused rows which in turn means that
15023 only its vpos can have changed. */
15026 w
->window_end_bytepos
15027 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15029 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15031 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15036 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15039 w
->window_end_valid
= Qnil
;
15040 w
->desired_matrix
->no_scrolling_p
= 1;
15043 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15053 /************************************************************************
15054 Window redisplay reusing current matrix when buffer has changed
15055 ************************************************************************/
15057 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15058 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15060 static struct glyph_row
*
15061 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15062 struct glyph_row
*);
15065 /* Return the last row in MATRIX displaying text. If row START is
15066 non-null, start searching with that row. IT gives the dimensions
15067 of the display. Value is null if matrix is empty; otherwise it is
15068 a pointer to the row found. */
15070 static struct glyph_row
*
15071 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15072 struct glyph_row
*start
)
15074 struct glyph_row
*row
, *row_found
;
15076 /* Set row_found to the last row in IT->w's current matrix
15077 displaying text. The loop looks funny but think of partially
15080 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15081 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15083 xassert (row
->enabled_p
);
15085 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15094 /* Return the last row in the current matrix of W that is not affected
15095 by changes at the start of current_buffer that occurred since W's
15096 current matrix was built. Value is null if no such row exists.
15098 BEG_UNCHANGED us the number of characters unchanged at the start of
15099 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15100 first changed character in current_buffer. Characters at positions <
15101 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15102 when the current matrix was built. */
15104 static struct glyph_row
*
15105 find_last_unchanged_at_beg_row (struct window
*w
)
15107 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15108 struct glyph_row
*row
;
15109 struct glyph_row
*row_found
= NULL
;
15110 int yb
= window_text_bottom_y (w
);
15112 /* Find the last row displaying unchanged text. */
15113 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15114 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15115 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15118 if (/* If row ends before first_changed_pos, it is unchanged,
15119 except in some case. */
15120 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15121 /* When row ends in ZV and we write at ZV it is not
15123 && !row
->ends_at_zv_p
15124 /* When first_changed_pos is the end of a continued line,
15125 row is not unchanged because it may be no longer
15127 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15128 && (row
->continued_p
15129 || row
->exact_window_width_line_p
)))
15132 /* Stop if last visible row. */
15133 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15141 /* Find the first glyph row in the current matrix of W that is not
15142 affected by changes at the end of current_buffer since the
15143 time W's current matrix was built.
15145 Return in *DELTA the number of chars by which buffer positions in
15146 unchanged text at the end of current_buffer must be adjusted.
15148 Return in *DELTA_BYTES the corresponding number of bytes.
15150 Value is null if no such row exists, i.e. all rows are affected by
15153 static struct glyph_row
*
15154 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15156 struct glyph_row
*row
;
15157 struct glyph_row
*row_found
= NULL
;
15159 *delta
= *delta_bytes
= 0;
15161 /* Display must not have been paused, otherwise the current matrix
15162 is not up to date. */
15163 eassert (!NILP (w
->window_end_valid
));
15165 /* A value of window_end_pos >= END_UNCHANGED means that the window
15166 end is in the range of changed text. If so, there is no
15167 unchanged row at the end of W's current matrix. */
15168 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15171 /* Set row to the last row in W's current matrix displaying text. */
15172 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15174 /* If matrix is entirely empty, no unchanged row exists. */
15175 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15177 /* The value of row is the last glyph row in the matrix having a
15178 meaningful buffer position in it. The end position of row
15179 corresponds to window_end_pos. This allows us to translate
15180 buffer positions in the current matrix to current buffer
15181 positions for characters not in changed text. */
15182 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15183 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15184 int last_unchanged_pos
, last_unchanged_pos_old
;
15185 struct glyph_row
*first_text_row
15186 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15188 *delta
= Z
- Z_old
;
15189 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15191 /* Set last_unchanged_pos to the buffer position of the last
15192 character in the buffer that has not been changed. Z is the
15193 index + 1 of the last character in current_buffer, i.e. by
15194 subtracting END_UNCHANGED we get the index of the last
15195 unchanged character, and we have to add BEG to get its buffer
15197 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15198 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15200 /* Search backward from ROW for a row displaying a line that
15201 starts at a minimum position >= last_unchanged_pos_old. */
15202 for (; row
> first_text_row
; --row
)
15204 /* This used to abort, but it can happen.
15205 It is ok to just stop the search instead here. KFS. */
15206 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15209 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15214 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15220 /* Make sure that glyph rows in the current matrix of window W
15221 reference the same glyph memory as corresponding rows in the
15222 frame's frame matrix. This function is called after scrolling W's
15223 current matrix on a terminal frame in try_window_id and
15224 try_window_reusing_current_matrix. */
15227 sync_frame_with_window_matrix_rows (struct window
*w
)
15229 struct frame
*f
= XFRAME (w
->frame
);
15230 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15232 /* Preconditions: W must be a leaf window and full-width. Its frame
15233 must have a frame matrix. */
15234 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15235 xassert (WINDOW_FULL_WIDTH_P (w
));
15236 xassert (!FRAME_WINDOW_P (f
));
15238 /* If W is a full-width window, glyph pointers in W's current matrix
15239 have, by definition, to be the same as glyph pointers in the
15240 corresponding frame matrix. Note that frame matrices have no
15241 marginal areas (see build_frame_matrix). */
15242 window_row
= w
->current_matrix
->rows
;
15243 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15244 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15245 while (window_row
< window_row_end
)
15247 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15248 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15250 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15251 frame_row
->glyphs
[TEXT_AREA
] = start
;
15252 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15253 frame_row
->glyphs
[LAST_AREA
] = end
;
15255 /* Disable frame rows whose corresponding window rows have
15256 been disabled in try_window_id. */
15257 if (!window_row
->enabled_p
)
15258 frame_row
->enabled_p
= 0;
15260 ++window_row
, ++frame_row
;
15265 /* Find the glyph row in window W containing CHARPOS. Consider all
15266 rows between START and END (not inclusive). END null means search
15267 all rows to the end of the display area of W. Value is the row
15268 containing CHARPOS or null. */
15271 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15272 struct glyph_row
*end
, int dy
)
15274 struct glyph_row
*row
= start
;
15275 struct glyph_row
*best_row
= NULL
;
15276 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15279 /* If we happen to start on a header-line, skip that. */
15280 if (row
->mode_line_p
)
15283 if ((end
&& row
>= end
) || !row
->enabled_p
)
15286 last_y
= window_text_bottom_y (w
) - dy
;
15290 /* Give up if we have gone too far. */
15291 if (end
&& row
>= end
)
15293 /* This formerly returned if they were equal.
15294 I think that both quantities are of a "last plus one" type;
15295 if so, when they are equal, the row is within the screen. -- rms. */
15296 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15299 /* If it is in this row, return this row. */
15300 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15301 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15302 /* The end position of a row equals the start
15303 position of the next row. If CHARPOS is there, we
15304 would rather display it in the next line, except
15305 when this line ends in ZV. */
15306 && !row
->ends_at_zv_p
15307 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15308 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15312 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15314 /* In bidi-reordered rows, there could be several rows
15315 occluding point. We need to find the one which fits
15316 CHARPOS the best. */
15317 for (g
= row
->glyphs
[TEXT_AREA
];
15318 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15321 if (!STRINGP (g
->object
))
15323 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15325 mindif
= eabs (g
->charpos
- charpos
);
15338 /* Try to redisplay window W by reusing its existing display. W's
15339 current matrix must be up to date when this function is called,
15340 i.e. window_end_valid must not be nil.
15344 1 if display has been updated
15345 0 if otherwise unsuccessful
15346 -1 if redisplay with same window start is known not to succeed
15348 The following steps are performed:
15350 1. Find the last row in the current matrix of W that is not
15351 affected by changes at the start of current_buffer. If no such row
15354 2. Find the first row in W's current matrix that is not affected by
15355 changes at the end of current_buffer. Maybe there is no such row.
15357 3. Display lines beginning with the row + 1 found in step 1 to the
15358 row found in step 2 or, if step 2 didn't find a row, to the end of
15361 4. If cursor is not known to appear on the window, give up.
15363 5. If display stopped at the row found in step 2, scroll the
15364 display and current matrix as needed.
15366 6. Maybe display some lines at the end of W, if we must. This can
15367 happen under various circumstances, like a partially visible line
15368 becoming fully visible, or because newly displayed lines are displayed
15369 in smaller font sizes.
15371 7. Update W's window end information. */
15374 try_window_id (struct window
*w
)
15376 struct frame
*f
= XFRAME (w
->frame
);
15377 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15378 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15379 struct glyph_row
*last_unchanged_at_beg_row
;
15380 struct glyph_row
*first_unchanged_at_end_row
;
15381 struct glyph_row
*row
;
15382 struct glyph_row
*bottom_row
;
15385 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15386 struct text_pos start_pos
;
15388 int first_unchanged_at_end_vpos
= 0;
15389 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15390 struct text_pos start
;
15391 int first_changed_charpos
, last_changed_charpos
;
15394 if (inhibit_try_window_id
)
15398 /* This is handy for debugging. */
15400 #define GIVE_UP(X) \
15402 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15406 #define GIVE_UP(X) return 0
15409 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15411 /* Don't use this for mini-windows because these can show
15412 messages and mini-buffers, and we don't handle that here. */
15413 if (MINI_WINDOW_P (w
))
15416 /* This flag is used to prevent redisplay optimizations. */
15417 if (windows_or_buffers_changed
|| cursor_type_changed
)
15420 /* Verify that narrowing has not changed.
15421 Also verify that we were not told to prevent redisplay optimizations.
15422 It would be nice to further
15423 reduce the number of cases where this prevents try_window_id. */
15424 if (current_buffer
->clip_changed
15425 || current_buffer
->prevent_redisplay_optimizations_p
)
15428 /* Window must either use window-based redisplay or be full width. */
15429 if (!FRAME_WINDOW_P (f
)
15430 && (!FRAME_LINE_INS_DEL_OK (f
)
15431 || !WINDOW_FULL_WIDTH_P (w
)))
15434 /* Give up if point is known NOT to appear in W. */
15435 if (PT
< CHARPOS (start
))
15438 /* Another way to prevent redisplay optimizations. */
15439 if (XFASTINT (w
->last_modified
) == 0)
15442 /* Verify that window is not hscrolled. */
15443 if (XFASTINT (w
->hscroll
) != 0)
15446 /* Verify that display wasn't paused. */
15447 if (NILP (w
->window_end_valid
))
15450 /* Can't use this if highlighting a region because a cursor movement
15451 will do more than just set the cursor. */
15452 if (!NILP (Vtransient_mark_mode
)
15453 && !NILP (current_buffer
->mark_active
))
15456 /* Likewise if highlighting trailing whitespace. */
15457 if (!NILP (Vshow_trailing_whitespace
))
15460 /* Likewise if showing a region. */
15461 if (!NILP (w
->region_showing
))
15464 /* Can't use this if overlay arrow position and/or string have
15466 if (overlay_arrows_changed_p ())
15469 /* When word-wrap is on, adding a space to the first word of a
15470 wrapped line can change the wrap position, altering the line
15471 above it. It might be worthwhile to handle this more
15472 intelligently, but for now just redisplay from scratch. */
15473 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15476 /* Under bidi reordering, adding or deleting a character in the
15477 beginning of a paragraph, before the first strong directional
15478 character, can change the base direction of the paragraph (unless
15479 the buffer specifies a fixed paragraph direction), which will
15480 require to redisplay the whole paragraph. It might be worthwhile
15481 to find the paragraph limits and widen the range of redisplayed
15482 lines to that, but for now just give up this optimization and
15483 redisplay from scratch. */
15484 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15485 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15488 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15489 only if buffer has really changed. The reason is that the gap is
15490 initially at Z for freshly visited files. The code below would
15491 set end_unchanged to 0 in that case. */
15492 if (MODIFF
> SAVE_MODIFF
15493 /* This seems to happen sometimes after saving a buffer. */
15494 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15496 if (GPT
- BEG
< BEG_UNCHANGED
)
15497 BEG_UNCHANGED
= GPT
- BEG
;
15498 if (Z
- GPT
< END_UNCHANGED
)
15499 END_UNCHANGED
= Z
- GPT
;
15502 /* The position of the first and last character that has been changed. */
15503 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15504 last_changed_charpos
= Z
- END_UNCHANGED
;
15506 /* If window starts after a line end, and the last change is in
15507 front of that newline, then changes don't affect the display.
15508 This case happens with stealth-fontification. Note that although
15509 the display is unchanged, glyph positions in the matrix have to
15510 be adjusted, of course. */
15511 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15512 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15513 && ((last_changed_charpos
< CHARPOS (start
)
15514 && CHARPOS (start
) == BEGV
)
15515 || (last_changed_charpos
< CHARPOS (start
) - 1
15516 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15518 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15519 struct glyph_row
*r0
;
15521 /* Compute how many chars/bytes have been added to or removed
15522 from the buffer. */
15523 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15524 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15526 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15528 /* Give up if PT is not in the window. Note that it already has
15529 been checked at the start of try_window_id that PT is not in
15530 front of the window start. */
15531 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15534 /* If window start is unchanged, we can reuse the whole matrix
15535 as is, after adjusting glyph positions. No need to compute
15536 the window end again, since its offset from Z hasn't changed. */
15537 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15538 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15539 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15540 /* PT must not be in a partially visible line. */
15541 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15542 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15544 /* Adjust positions in the glyph matrix. */
15545 if (delta
|| delta_bytes
)
15547 struct glyph_row
*r1
15548 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15549 increment_matrix_positions (w
->current_matrix
,
15550 MATRIX_ROW_VPOS (r0
, current_matrix
),
15551 MATRIX_ROW_VPOS (r1
, current_matrix
),
15552 delta
, delta_bytes
);
15555 /* Set the cursor. */
15556 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15558 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15565 /* Handle the case that changes are all below what is displayed in
15566 the window, and that PT is in the window. This shortcut cannot
15567 be taken if ZV is visible in the window, and text has been added
15568 there that is visible in the window. */
15569 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15570 /* ZV is not visible in the window, or there are no
15571 changes at ZV, actually. */
15572 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15573 || first_changed_charpos
== last_changed_charpos
))
15575 struct glyph_row
*r0
;
15577 /* Give up if PT is not in the window. Note that it already has
15578 been checked at the start of try_window_id that PT is not in
15579 front of the window start. */
15580 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15583 /* If window start is unchanged, we can reuse the whole matrix
15584 as is, without changing glyph positions since no text has
15585 been added/removed in front of the window end. */
15586 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15587 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15588 /* PT must not be in a partially visible line. */
15589 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15590 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15592 /* We have to compute the window end anew since text
15593 could have been added/removed after it. */
15595 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15596 w
->window_end_bytepos
15597 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15599 /* Set the cursor. */
15600 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15602 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15609 /* Give up if window start is in the changed area.
15611 The condition used to read
15613 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15615 but why that was tested escapes me at the moment. */
15616 if (CHARPOS (start
) >= first_changed_charpos
15617 && CHARPOS (start
) <= last_changed_charpos
)
15620 /* Check that window start agrees with the start of the first glyph
15621 row in its current matrix. Check this after we know the window
15622 start is not in changed text, otherwise positions would not be
15624 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15625 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15628 /* Give up if the window ends in strings. Overlay strings
15629 at the end are difficult to handle, so don't try. */
15630 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15631 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15634 /* Compute the position at which we have to start displaying new
15635 lines. Some of the lines at the top of the window might be
15636 reusable because they are not displaying changed text. Find the
15637 last row in W's current matrix not affected by changes at the
15638 start of current_buffer. Value is null if changes start in the
15639 first line of window. */
15640 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15641 if (last_unchanged_at_beg_row
)
15643 /* Avoid starting to display in the moddle of a character, a TAB
15644 for instance. This is easier than to set up the iterator
15645 exactly, and it's not a frequent case, so the additional
15646 effort wouldn't really pay off. */
15647 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15648 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15649 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15650 --last_unchanged_at_beg_row
;
15652 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15655 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15657 start_pos
= it
.current
.pos
;
15659 /* Start displaying new lines in the desired matrix at the same
15660 vpos we would use in the current matrix, i.e. below
15661 last_unchanged_at_beg_row. */
15662 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15664 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15665 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15667 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15671 /* There are no reusable lines at the start of the window.
15672 Start displaying in the first text line. */
15673 start_display (&it
, w
, start
);
15674 it
.vpos
= it
.first_vpos
;
15675 start_pos
= it
.current
.pos
;
15678 /* Find the first row that is not affected by changes at the end of
15679 the buffer. Value will be null if there is no unchanged row, in
15680 which case we must redisplay to the end of the window. delta
15681 will be set to the value by which buffer positions beginning with
15682 first_unchanged_at_end_row have to be adjusted due to text
15684 first_unchanged_at_end_row
15685 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15686 IF_DEBUG (debug_delta
= delta
);
15687 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15689 /* Set stop_pos to the buffer position up to which we will have to
15690 display new lines. If first_unchanged_at_end_row != NULL, this
15691 is the buffer position of the start of the line displayed in that
15692 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15693 that we don't stop at a buffer position. */
15695 if (first_unchanged_at_end_row
)
15697 xassert (last_unchanged_at_beg_row
== NULL
15698 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15700 /* If this is a continuation line, move forward to the next one
15701 that isn't. Changes in lines above affect this line.
15702 Caution: this may move first_unchanged_at_end_row to a row
15703 not displaying text. */
15704 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15705 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15706 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15707 < it
.last_visible_y
))
15708 ++first_unchanged_at_end_row
;
15710 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15711 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15712 >= it
.last_visible_y
))
15713 first_unchanged_at_end_row
= NULL
;
15716 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15718 first_unchanged_at_end_vpos
15719 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15720 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15723 else if (last_unchanged_at_beg_row
== NULL
)
15729 /* Either there is no unchanged row at the end, or the one we have
15730 now displays text. This is a necessary condition for the window
15731 end pos calculation at the end of this function. */
15732 xassert (first_unchanged_at_end_row
== NULL
15733 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15735 debug_last_unchanged_at_beg_vpos
15736 = (last_unchanged_at_beg_row
15737 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15739 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15741 #endif /* GLYPH_DEBUG != 0 */
15744 /* Display new lines. Set last_text_row to the last new line
15745 displayed which has text on it, i.e. might end up as being the
15746 line where the window_end_vpos is. */
15747 w
->cursor
.vpos
= -1;
15748 last_text_row
= NULL
;
15749 overlay_arrow_seen
= 0;
15750 while (it
.current_y
< it
.last_visible_y
15751 && !fonts_changed_p
15752 && (first_unchanged_at_end_row
== NULL
15753 || IT_CHARPOS (it
) < stop_pos
))
15755 if (display_line (&it
))
15756 last_text_row
= it
.glyph_row
- 1;
15759 if (fonts_changed_p
)
15763 /* Compute differences in buffer positions, y-positions etc. for
15764 lines reused at the bottom of the window. Compute what we can
15766 if (first_unchanged_at_end_row
15767 /* No lines reused because we displayed everything up to the
15768 bottom of the window. */
15769 && it
.current_y
< it
.last_visible_y
)
15772 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15774 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15775 run
.current_y
= first_unchanged_at_end_row
->y
;
15776 run
.desired_y
= run
.current_y
+ dy
;
15777 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15781 delta
= delta_bytes
= dvpos
= dy
15782 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15783 first_unchanged_at_end_row
= NULL
;
15785 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15788 /* Find the cursor if not already found. We have to decide whether
15789 PT will appear on this window (it sometimes doesn't, but this is
15790 not a very frequent case.) This decision has to be made before
15791 the current matrix is altered. A value of cursor.vpos < 0 means
15792 that PT is either in one of the lines beginning at
15793 first_unchanged_at_end_row or below the window. Don't care for
15794 lines that might be displayed later at the window end; as
15795 mentioned, this is not a frequent case. */
15796 if (w
->cursor
.vpos
< 0)
15798 /* Cursor in unchanged rows at the top? */
15799 if (PT
< CHARPOS (start_pos
)
15800 && last_unchanged_at_beg_row
)
15802 row
= row_containing_pos (w
, PT
,
15803 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15804 last_unchanged_at_beg_row
+ 1, 0);
15806 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15809 /* Start from first_unchanged_at_end_row looking for PT. */
15810 else if (first_unchanged_at_end_row
)
15812 row
= row_containing_pos (w
, PT
- delta
,
15813 first_unchanged_at_end_row
, NULL
, 0);
15815 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15816 delta_bytes
, dy
, dvpos
);
15819 /* Give up if cursor was not found. */
15820 if (w
->cursor
.vpos
< 0)
15822 clear_glyph_matrix (w
->desired_matrix
);
15827 /* Don't let the cursor end in the scroll margins. */
15829 int this_scroll_margin
, cursor_height
;
15831 this_scroll_margin
= max (0, scroll_margin
);
15832 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15833 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15834 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15836 if ((w
->cursor
.y
< this_scroll_margin
15837 && CHARPOS (start
) > BEGV
)
15838 /* Old redisplay didn't take scroll margin into account at the bottom,
15839 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15840 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15841 ? cursor_height
+ this_scroll_margin
15842 : 1)) > it
.last_visible_y
)
15844 w
->cursor
.vpos
= -1;
15845 clear_glyph_matrix (w
->desired_matrix
);
15850 /* Scroll the display. Do it before changing the current matrix so
15851 that xterm.c doesn't get confused about where the cursor glyph is
15853 if (dy
&& run
.height
)
15857 if (FRAME_WINDOW_P (f
))
15859 FRAME_RIF (f
)->update_window_begin_hook (w
);
15860 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15861 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15862 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15866 /* Terminal frame. In this case, dvpos gives the number of
15867 lines to scroll by; dvpos < 0 means scroll up. */
15868 int first_unchanged_at_end_vpos
15869 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15870 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15871 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15872 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15873 + window_internal_height (w
));
15875 /* Perform the operation on the screen. */
15878 /* Scroll last_unchanged_at_beg_row to the end of the
15879 window down dvpos lines. */
15880 set_terminal_window (f
, end
);
15882 /* On dumb terminals delete dvpos lines at the end
15883 before inserting dvpos empty lines. */
15884 if (!FRAME_SCROLL_REGION_OK (f
))
15885 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15887 /* Insert dvpos empty lines in front of
15888 last_unchanged_at_beg_row. */
15889 ins_del_lines (f
, from
, dvpos
);
15891 else if (dvpos
< 0)
15893 /* Scroll up last_unchanged_at_beg_vpos to the end of
15894 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15895 set_terminal_window (f
, end
);
15897 /* Delete dvpos lines in front of
15898 last_unchanged_at_beg_vpos. ins_del_lines will set
15899 the cursor to the given vpos and emit |dvpos| delete
15901 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15903 /* On a dumb terminal insert dvpos empty lines at the
15905 if (!FRAME_SCROLL_REGION_OK (f
))
15906 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15909 set_terminal_window (f
, 0);
15915 /* Shift reused rows of the current matrix to the right position.
15916 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15918 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15919 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15922 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15923 bottom_vpos
, dvpos
);
15924 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15927 else if (dvpos
> 0)
15929 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15930 bottom_vpos
, dvpos
);
15931 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15932 first_unchanged_at_end_vpos
+ dvpos
, 0);
15935 /* For frame-based redisplay, make sure that current frame and window
15936 matrix are in sync with respect to glyph memory. */
15937 if (!FRAME_WINDOW_P (f
))
15938 sync_frame_with_window_matrix_rows (w
);
15940 /* Adjust buffer positions in reused rows. */
15941 if (delta
|| delta_bytes
)
15942 increment_matrix_positions (current_matrix
,
15943 first_unchanged_at_end_vpos
+ dvpos
,
15944 bottom_vpos
, delta
, delta_bytes
);
15946 /* Adjust Y positions. */
15948 shift_glyph_matrix (w
, current_matrix
,
15949 first_unchanged_at_end_vpos
+ dvpos
,
15952 if (first_unchanged_at_end_row
)
15954 first_unchanged_at_end_row
+= dvpos
;
15955 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15956 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15957 first_unchanged_at_end_row
= NULL
;
15960 /* If scrolling up, there may be some lines to display at the end of
15962 last_text_row_at_end
= NULL
;
15965 /* Scrolling up can leave for example a partially visible line
15966 at the end of the window to be redisplayed. */
15967 /* Set last_row to the glyph row in the current matrix where the
15968 window end line is found. It has been moved up or down in
15969 the matrix by dvpos. */
15970 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15971 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15973 /* If last_row is the window end line, it should display text. */
15974 xassert (last_row
->displays_text_p
);
15976 /* If window end line was partially visible before, begin
15977 displaying at that line. Otherwise begin displaying with the
15978 line following it. */
15979 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15981 init_to_row_start (&it
, w
, last_row
);
15982 it
.vpos
= last_vpos
;
15983 it
.current_y
= last_row
->y
;
15987 init_to_row_end (&it
, w
, last_row
);
15988 it
.vpos
= 1 + last_vpos
;
15989 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15993 /* We may start in a continuation line. If so, we have to
15994 get the right continuation_lines_width and current_x. */
15995 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15996 it
.hpos
= it
.current_x
= 0;
15998 /* Display the rest of the lines at the window end. */
15999 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16000 while (it
.current_y
< it
.last_visible_y
16001 && !fonts_changed_p
)
16003 /* Is it always sure that the display agrees with lines in
16004 the current matrix? I don't think so, so we mark rows
16005 displayed invalid in the current matrix by setting their
16006 enabled_p flag to zero. */
16007 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16008 if (display_line (&it
))
16009 last_text_row_at_end
= it
.glyph_row
- 1;
16013 /* Update window_end_pos and window_end_vpos. */
16014 if (first_unchanged_at_end_row
16015 && !last_text_row_at_end
)
16017 /* Window end line if one of the preserved rows from the current
16018 matrix. Set row to the last row displaying text in current
16019 matrix starting at first_unchanged_at_end_row, after
16021 xassert (first_unchanged_at_end_row
->displays_text_p
);
16022 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16023 first_unchanged_at_end_row
);
16024 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16026 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16027 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16029 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16030 xassert (w
->window_end_bytepos
>= 0);
16031 IF_DEBUG (debug_method_add (w
, "A"));
16033 else if (last_text_row_at_end
)
16036 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16037 w
->window_end_bytepos
16038 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16040 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16041 xassert (w
->window_end_bytepos
>= 0);
16042 IF_DEBUG (debug_method_add (w
, "B"));
16044 else if (last_text_row
)
16046 /* We have displayed either to the end of the window or at the
16047 end of the window, i.e. the last row with text is to be found
16048 in the desired matrix. */
16050 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16051 w
->window_end_bytepos
16052 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16054 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16055 xassert (w
->window_end_bytepos
>= 0);
16057 else if (first_unchanged_at_end_row
== NULL
16058 && last_text_row
== NULL
16059 && last_text_row_at_end
== NULL
)
16061 /* Displayed to end of window, but no line containing text was
16062 displayed. Lines were deleted at the end of the window. */
16063 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16064 int vpos
= XFASTINT (w
->window_end_vpos
);
16065 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16066 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16069 row
== NULL
&& vpos
>= first_vpos
;
16070 --vpos
, --current_row
, --desired_row
)
16072 if (desired_row
->enabled_p
)
16074 if (desired_row
->displays_text_p
)
16077 else if (current_row
->displays_text_p
)
16081 xassert (row
!= NULL
);
16082 w
->window_end_vpos
= make_number (vpos
+ 1);
16083 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16084 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16085 xassert (w
->window_end_bytepos
>= 0);
16086 IF_DEBUG (debug_method_add (w
, "C"));
16091 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16092 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16094 /* Record that display has not been completed. */
16095 w
->window_end_valid
= Qnil
;
16096 w
->desired_matrix
->no_scrolling_p
= 1;
16104 /***********************************************************************
16105 More debugging support
16106 ***********************************************************************/
16110 void dump_glyph_row (struct glyph_row
*, int, int);
16111 void dump_glyph_matrix (struct glyph_matrix
*, int);
16112 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16115 /* Dump the contents of glyph matrix MATRIX on stderr.
16117 GLYPHS 0 means don't show glyph contents.
16118 GLYPHS 1 means show glyphs in short form
16119 GLYPHS > 1 means show glyphs in long form. */
16122 dump_glyph_matrix (matrix
, glyphs
)
16123 struct glyph_matrix
*matrix
;
16127 for (i
= 0; i
< matrix
->nrows
; ++i
)
16128 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16132 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16133 the glyph row and area where the glyph comes from. */
16136 dump_glyph (row
, glyph
, area
)
16137 struct glyph_row
*row
;
16138 struct glyph
*glyph
;
16141 if (glyph
->type
== CHAR_GLYPH
)
16144 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16145 glyph
- row
->glyphs
[TEXT_AREA
],
16148 (BUFFERP (glyph
->object
)
16150 : (STRINGP (glyph
->object
)
16153 glyph
->pixel_width
,
16155 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16159 glyph
->left_box_line_p
,
16160 glyph
->right_box_line_p
);
16162 else if (glyph
->type
== STRETCH_GLYPH
)
16165 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16166 glyph
- row
->glyphs
[TEXT_AREA
],
16169 (BUFFERP (glyph
->object
)
16171 : (STRINGP (glyph
->object
)
16174 glyph
->pixel_width
,
16178 glyph
->left_box_line_p
,
16179 glyph
->right_box_line_p
);
16181 else if (glyph
->type
== IMAGE_GLYPH
)
16184 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16185 glyph
- row
->glyphs
[TEXT_AREA
],
16188 (BUFFERP (glyph
->object
)
16190 : (STRINGP (glyph
->object
)
16193 glyph
->pixel_width
,
16197 glyph
->left_box_line_p
,
16198 glyph
->right_box_line_p
);
16200 else if (glyph
->type
== COMPOSITE_GLYPH
)
16203 " %5d %4c %6d %c %3d 0x%05x",
16204 glyph
- row
->glyphs
[TEXT_AREA
],
16207 (BUFFERP (glyph
->object
)
16209 : (STRINGP (glyph
->object
)
16212 glyph
->pixel_width
,
16214 if (glyph
->u
.cmp
.automatic
)
16217 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16218 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16220 glyph
->left_box_line_p
,
16221 glyph
->right_box_line_p
);
16226 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16227 GLYPHS 0 means don't show glyph contents.
16228 GLYPHS 1 means show glyphs in short form
16229 GLYPHS > 1 means show glyphs in long form. */
16232 dump_glyph_row (row
, vpos
, glyphs
)
16233 struct glyph_row
*row
;
16238 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16239 fprintf (stderr
, "======================================================================\n");
16241 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16242 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16244 MATRIX_ROW_START_CHARPOS (row
),
16245 MATRIX_ROW_END_CHARPOS (row
),
16246 row
->used
[TEXT_AREA
],
16247 row
->contains_overlapping_glyphs_p
,
16249 row
->truncated_on_left_p
,
16250 row
->truncated_on_right_p
,
16252 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16253 row
->displays_text_p
,
16256 row
->ends_in_middle_of_char_p
,
16257 row
->starts_in_middle_of_char_p
,
16263 row
->visible_height
,
16266 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16267 row
->end
.overlay_string_index
,
16268 row
->continuation_lines_width
);
16269 fprintf (stderr
, "%9d %5d\n",
16270 CHARPOS (row
->start
.string_pos
),
16271 CHARPOS (row
->end
.string_pos
));
16272 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16273 row
->end
.dpvec_index
);
16280 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16282 struct glyph
*glyph
= row
->glyphs
[area
];
16283 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16285 /* Glyph for a line end in text. */
16286 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16289 if (glyph
< glyph_end
)
16290 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16292 for (; glyph
< glyph_end
; ++glyph
)
16293 dump_glyph (row
, glyph
, area
);
16296 else if (glyphs
== 1)
16300 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16302 char *s
= (char *) alloca (row
->used
[area
] + 1);
16305 for (i
= 0; i
< row
->used
[area
]; ++i
)
16307 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16308 if (glyph
->type
== CHAR_GLYPH
16309 && glyph
->u
.ch
< 0x80
16310 && glyph
->u
.ch
>= ' ')
16311 s
[i
] = glyph
->u
.ch
;
16317 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16323 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16324 Sdump_glyph_matrix
, 0, 1, "p",
16325 doc
: /* Dump the current matrix of the selected window to stderr.
16326 Shows contents of glyph row structures. With non-nil
16327 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16328 glyphs in short form, otherwise show glyphs in long form. */)
16329 (Lisp_Object glyphs
)
16331 struct window
*w
= XWINDOW (selected_window
);
16332 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16334 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16335 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16336 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16337 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16338 fprintf (stderr
, "=============================================\n");
16339 dump_glyph_matrix (w
->current_matrix
,
16340 NILP (glyphs
) ? 0 : XINT (glyphs
));
16345 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16346 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16349 struct frame
*f
= XFRAME (selected_frame
);
16350 dump_glyph_matrix (f
->current_matrix
, 1);
16355 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16356 doc
: /* Dump glyph row ROW to stderr.
16357 GLYPH 0 means don't dump glyphs.
16358 GLYPH 1 means dump glyphs in short form.
16359 GLYPH > 1 or omitted means dump glyphs in long form. */)
16360 (Lisp_Object row
, Lisp_Object glyphs
)
16362 struct glyph_matrix
*matrix
;
16365 CHECK_NUMBER (row
);
16366 matrix
= XWINDOW (selected_window
)->current_matrix
;
16368 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16369 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16371 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16376 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16377 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16378 GLYPH 0 means don't dump glyphs.
16379 GLYPH 1 means dump glyphs in short form.
16380 GLYPH > 1 or omitted means dump glyphs in long form. */)
16381 (Lisp_Object row
, Lisp_Object glyphs
)
16383 struct frame
*sf
= SELECTED_FRAME ();
16384 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16387 CHECK_NUMBER (row
);
16389 if (vpos
>= 0 && vpos
< m
->nrows
)
16390 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16391 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16396 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16397 doc
: /* Toggle tracing of redisplay.
16398 With ARG, turn tracing on if and only if ARG is positive. */)
16402 trace_redisplay_p
= !trace_redisplay_p
;
16405 arg
= Fprefix_numeric_value (arg
);
16406 trace_redisplay_p
= XINT (arg
) > 0;
16413 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16414 doc
: /* Like `format', but print result to stderr.
16415 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16416 (int nargs
, Lisp_Object
*args
)
16418 Lisp_Object s
= Fformat (nargs
, args
);
16419 fprintf (stderr
, "%s", SDATA (s
));
16423 #endif /* GLYPH_DEBUG */
16427 /***********************************************************************
16428 Building Desired Matrix Rows
16429 ***********************************************************************/
16431 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16432 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16434 static struct glyph_row
*
16435 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16437 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16438 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16439 struct buffer
*old
= current_buffer
;
16440 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16441 int arrow_len
= SCHARS (overlay_arrow_string
);
16442 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16443 const unsigned char *p
;
16446 int n_glyphs_before
;
16448 set_buffer_temp (buffer
);
16449 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16450 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16451 SET_TEXT_POS (it
.position
, 0, 0);
16453 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16455 while (p
< arrow_end
)
16457 Lisp_Object face
, ilisp
;
16459 /* Get the next character. */
16461 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16464 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16465 if (! ASCII_CHAR_P (it
.c
))
16466 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16470 /* Get its face. */
16471 ilisp
= make_number (p
- arrow_string
);
16472 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16473 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16475 /* Compute its width, get its glyphs. */
16476 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16477 SET_TEXT_POS (it
.position
, -1, -1);
16478 PRODUCE_GLYPHS (&it
);
16480 /* If this character doesn't fit any more in the line, we have
16481 to remove some glyphs. */
16482 if (it
.current_x
> it
.last_visible_x
)
16484 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16489 set_buffer_temp (old
);
16490 return it
.glyph_row
;
16494 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16495 glyphs are only inserted for terminal frames since we can't really
16496 win with truncation glyphs when partially visible glyphs are
16497 involved. Which glyphs to insert is determined by
16498 produce_special_glyphs. */
16501 insert_left_trunc_glyphs (struct it
*it
)
16503 struct it truncate_it
;
16504 struct glyph
*from
, *end
, *to
, *toend
;
16506 xassert (!FRAME_WINDOW_P (it
->f
));
16508 /* Get the truncation glyphs. */
16510 truncate_it
.current_x
= 0;
16511 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16512 truncate_it
.glyph_row
= &scratch_glyph_row
;
16513 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16514 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16515 truncate_it
.object
= make_number (0);
16516 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16518 /* Overwrite glyphs from IT with truncation glyphs. */
16519 if (!it
->glyph_row
->reversed_p
)
16521 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16522 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16523 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16524 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16529 /* There may be padding glyphs left over. Overwrite them too. */
16530 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16532 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16538 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16542 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16543 that back to front. */
16544 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16545 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16546 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16547 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16549 while (from
>= end
&& to
>= toend
)
16551 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16554 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16555 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16556 while (from
>= end
&& to
>= toend
)
16561 /* Need to free some room before prepending additional
16563 int move_by
= from
- end
+ 1;
16564 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16565 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16567 for ( ; g
>= g0
; g
--)
16569 while (from
>= end
)
16571 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16577 /* Compute the pixel height and width of IT->glyph_row.
16579 Most of the time, ascent and height of a display line will be equal
16580 to the max_ascent and max_height values of the display iterator
16581 structure. This is not the case if
16583 1. We hit ZV without displaying anything. In this case, max_ascent
16584 and max_height will be zero.
16586 2. We have some glyphs that don't contribute to the line height.
16587 (The glyph row flag contributes_to_line_height_p is for future
16588 pixmap extensions).
16590 The first case is easily covered by using default values because in
16591 these cases, the line height does not really matter, except that it
16592 must not be zero. */
16595 compute_line_metrics (struct it
*it
)
16597 struct glyph_row
*row
= it
->glyph_row
;
16600 if (FRAME_WINDOW_P (it
->f
))
16602 int i
, min_y
, max_y
;
16604 /* The line may consist of one space only, that was added to
16605 place the cursor on it. If so, the row's height hasn't been
16607 if (row
->height
== 0)
16609 if (it
->max_ascent
+ it
->max_descent
== 0)
16610 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16611 row
->ascent
= it
->max_ascent
;
16612 row
->height
= it
->max_ascent
+ it
->max_descent
;
16613 row
->phys_ascent
= it
->max_phys_ascent
;
16614 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16615 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16618 /* Compute the width of this line. */
16619 row
->pixel_width
= row
->x
;
16620 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16621 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16623 xassert (row
->pixel_width
>= 0);
16624 xassert (row
->ascent
>= 0 && row
->height
> 0);
16626 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16627 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16629 /* If first line's physical ascent is larger than its logical
16630 ascent, use the physical ascent, and make the row taller.
16631 This makes accented characters fully visible. */
16632 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16633 && row
->phys_ascent
> row
->ascent
)
16635 row
->height
+= row
->phys_ascent
- row
->ascent
;
16636 row
->ascent
= row
->phys_ascent
;
16639 /* Compute how much of the line is visible. */
16640 row
->visible_height
= row
->height
;
16642 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16643 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16645 if (row
->y
< min_y
)
16646 row
->visible_height
-= min_y
- row
->y
;
16647 if (row
->y
+ row
->height
> max_y
)
16648 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16652 row
->pixel_width
= row
->used
[TEXT_AREA
];
16653 if (row
->continued_p
)
16654 row
->pixel_width
-= it
->continuation_pixel_width
;
16655 else if (row
->truncated_on_right_p
)
16656 row
->pixel_width
-= it
->truncation_pixel_width
;
16657 row
->ascent
= row
->phys_ascent
= 0;
16658 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16659 row
->extra_line_spacing
= 0;
16662 /* Compute a hash code for this row. */
16664 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16665 for (i
= 0; i
< row
->used
[area
]; ++i
)
16666 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16667 + row
->glyphs
[area
][i
].u
.val
16668 + row
->glyphs
[area
][i
].face_id
16669 + row
->glyphs
[area
][i
].padding_p
16670 + (row
->glyphs
[area
][i
].type
<< 2));
16672 it
->max_ascent
= it
->max_descent
= 0;
16673 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16677 /* Append one space to the glyph row of iterator IT if doing a
16678 window-based redisplay. The space has the same face as
16679 IT->face_id. Value is non-zero if a space was added.
16681 This function is called to make sure that there is always one glyph
16682 at the end of a glyph row that the cursor can be set on under
16683 window-systems. (If there weren't such a glyph we would not know
16684 how wide and tall a box cursor should be displayed).
16686 At the same time this space let's a nicely handle clearing to the
16687 end of the line if the row ends in italic text. */
16690 append_space_for_newline (struct it
*it
, int default_face_p
)
16692 if (FRAME_WINDOW_P (it
->f
))
16694 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16696 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16697 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16699 /* Save some values that must not be changed.
16700 Must save IT->c and IT->len because otherwise
16701 ITERATOR_AT_END_P wouldn't work anymore after
16702 append_space_for_newline has been called. */
16703 enum display_element_type saved_what
= it
->what
;
16704 int saved_c
= it
->c
, saved_len
= it
->len
;
16705 int saved_char_to_display
= it
->char_to_display
;
16706 int saved_x
= it
->current_x
;
16707 int saved_face_id
= it
->face_id
;
16708 struct text_pos saved_pos
;
16709 Lisp_Object saved_object
;
16712 saved_object
= it
->object
;
16713 saved_pos
= it
->position
;
16715 it
->what
= IT_CHARACTER
;
16716 memset (&it
->position
, 0, sizeof it
->position
);
16717 it
->object
= make_number (0);
16718 it
->c
= it
->char_to_display
= ' ';
16721 if (default_face_p
)
16722 it
->face_id
= DEFAULT_FACE_ID
;
16723 else if (it
->face_before_selective_p
)
16724 it
->face_id
= it
->saved_face_id
;
16725 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16726 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16728 PRODUCE_GLYPHS (it
);
16730 it
->override_ascent
= -1;
16731 it
->constrain_row_ascent_descent_p
= 0;
16732 it
->current_x
= saved_x
;
16733 it
->object
= saved_object
;
16734 it
->position
= saved_pos
;
16735 it
->what
= saved_what
;
16736 it
->face_id
= saved_face_id
;
16737 it
->len
= saved_len
;
16739 it
->char_to_display
= saved_char_to_display
;
16748 /* Extend the face of the last glyph in the text area of IT->glyph_row
16749 to the end of the display line. Called from display_line. If the
16750 glyph row is empty, add a space glyph to it so that we know the
16751 face to draw. Set the glyph row flag fill_line_p. If the glyph
16752 row is R2L, prepend a stretch glyph to cover the empty space to the
16753 left of the leftmost glyph. */
16756 extend_face_to_end_of_line (struct it
*it
)
16759 struct frame
*f
= it
->f
;
16761 /* If line is already filled, do nothing. Non window-system frames
16762 get a grace of one more ``pixel'' because their characters are
16763 1-``pixel'' wide, so they hit the equality too early. This grace
16764 is needed only for R2L rows that are not continued, to produce
16765 one extra blank where we could display the cursor. */
16766 if (it
->current_x
>= it
->last_visible_x
16767 + (!FRAME_WINDOW_P (f
)
16768 && it
->glyph_row
->reversed_p
16769 && !it
->glyph_row
->continued_p
))
16772 /* Face extension extends the background and box of IT->face_id
16773 to the end of the line. If the background equals the background
16774 of the frame, we don't have to do anything. */
16775 if (it
->face_before_selective_p
)
16776 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16778 face
= FACE_FROM_ID (f
, it
->face_id
);
16780 if (FRAME_WINDOW_P (f
)
16781 && it
->glyph_row
->displays_text_p
16782 && face
->box
== FACE_NO_BOX
16783 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16785 && !it
->glyph_row
->reversed_p
)
16788 /* Set the glyph row flag indicating that the face of the last glyph
16789 in the text area has to be drawn to the end of the text area. */
16790 it
->glyph_row
->fill_line_p
= 1;
16792 /* If current character of IT is not ASCII, make sure we have the
16793 ASCII face. This will be automatically undone the next time
16794 get_next_display_element returns a multibyte character. Note
16795 that the character will always be single byte in unibyte
16797 if (!ASCII_CHAR_P (it
->c
))
16799 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16802 if (FRAME_WINDOW_P (f
))
16804 /* If the row is empty, add a space with the current face of IT,
16805 so that we know which face to draw. */
16806 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16808 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16809 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16810 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16812 #ifdef HAVE_WINDOW_SYSTEM
16813 if (it
->glyph_row
->reversed_p
)
16815 /* Prepend a stretch glyph to the row, such that the
16816 rightmost glyph will be drawn flushed all the way to the
16817 right margin of the window. The stretch glyph that will
16818 occupy the empty space, if any, to the left of the
16820 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16821 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16822 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16824 int row_width
, stretch_ascent
, stretch_width
;
16825 struct text_pos saved_pos
;
16826 int saved_face_id
, saved_avoid_cursor
;
16828 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16829 row_width
+= g
->pixel_width
;
16830 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16831 if (stretch_width
> 0)
16834 (((it
->ascent
+ it
->descent
)
16835 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16836 saved_pos
= it
->position
;
16837 memset (&it
->position
, 0, sizeof it
->position
);
16838 saved_avoid_cursor
= it
->avoid_cursor_p
;
16839 it
->avoid_cursor_p
= 1;
16840 saved_face_id
= it
->face_id
;
16841 /* The last row's stretch glyph should get the default
16842 face, to avoid painting the rest of the window with
16843 the region face, if the region ends at ZV. */
16844 if (it
->glyph_row
->ends_at_zv_p
)
16845 it
->face_id
= DEFAULT_FACE_ID
;
16847 it
->face_id
= face
->id
;
16848 append_stretch_glyph (it
, make_number (0), stretch_width
,
16849 it
->ascent
+ it
->descent
, stretch_ascent
);
16850 it
->position
= saved_pos
;
16851 it
->avoid_cursor_p
= saved_avoid_cursor
;
16852 it
->face_id
= saved_face_id
;
16855 #endif /* HAVE_WINDOW_SYSTEM */
16859 /* Save some values that must not be changed. */
16860 int saved_x
= it
->current_x
;
16861 struct text_pos saved_pos
;
16862 Lisp_Object saved_object
;
16863 enum display_element_type saved_what
= it
->what
;
16864 int saved_face_id
= it
->face_id
;
16866 saved_object
= it
->object
;
16867 saved_pos
= it
->position
;
16869 it
->what
= IT_CHARACTER
;
16870 memset (&it
->position
, 0, sizeof it
->position
);
16871 it
->object
= make_number (0);
16872 it
->c
= it
->char_to_display
= ' ';
16874 /* The last row's blank glyphs should get the default face, to
16875 avoid painting the rest of the window with the region face,
16876 if the region ends at ZV. */
16877 if (it
->glyph_row
->ends_at_zv_p
)
16878 it
->face_id
= DEFAULT_FACE_ID
;
16880 it
->face_id
= face
->id
;
16882 PRODUCE_GLYPHS (it
);
16884 while (it
->current_x
<= it
->last_visible_x
)
16885 PRODUCE_GLYPHS (it
);
16887 /* Don't count these blanks really. It would let us insert a left
16888 truncation glyph below and make us set the cursor on them, maybe. */
16889 it
->current_x
= saved_x
;
16890 it
->object
= saved_object
;
16891 it
->position
= saved_pos
;
16892 it
->what
= saved_what
;
16893 it
->face_id
= saved_face_id
;
16898 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16899 trailing whitespace. */
16902 trailing_whitespace_p (int charpos
)
16904 int bytepos
= CHAR_TO_BYTE (charpos
);
16907 while (bytepos
< ZV_BYTE
16908 && (c
= FETCH_CHAR (bytepos
),
16909 c
== ' ' || c
== '\t'))
16912 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16914 if (bytepos
!= PT_BYTE
)
16921 /* Highlight trailing whitespace, if any, in ROW. */
16924 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16926 int used
= row
->used
[TEXT_AREA
];
16930 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16931 struct glyph
*glyph
= start
+ used
- 1;
16933 if (row
->reversed_p
)
16935 /* Right-to-left rows need to be processed in the opposite
16936 direction, so swap the edge pointers. */
16938 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16941 /* Skip over glyphs inserted to display the cursor at the
16942 end of a line, for extending the face of the last glyph
16943 to the end of the line on terminals, and for truncation
16944 and continuation glyphs. */
16945 if (!row
->reversed_p
)
16947 while (glyph
>= start
16948 && glyph
->type
== CHAR_GLYPH
16949 && INTEGERP (glyph
->object
))
16954 while (glyph
<= start
16955 && glyph
->type
== CHAR_GLYPH
16956 && INTEGERP (glyph
->object
))
16960 /* If last glyph is a space or stretch, and it's trailing
16961 whitespace, set the face of all trailing whitespace glyphs in
16962 IT->glyph_row to `trailing-whitespace'. */
16963 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16964 && BUFFERP (glyph
->object
)
16965 && (glyph
->type
== STRETCH_GLYPH
16966 || (glyph
->type
== CHAR_GLYPH
16967 && glyph
->u
.ch
== ' '))
16968 && trailing_whitespace_p (glyph
->charpos
))
16970 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16974 if (!row
->reversed_p
)
16976 while (glyph
>= start
16977 && BUFFERP (glyph
->object
)
16978 && (glyph
->type
== STRETCH_GLYPH
16979 || (glyph
->type
== CHAR_GLYPH
16980 && glyph
->u
.ch
== ' ')))
16981 (glyph
--)->face_id
= face_id
;
16985 while (glyph
<= start
16986 && BUFFERP (glyph
->object
)
16987 && (glyph
->type
== STRETCH_GLYPH
16988 || (glyph
->type
== CHAR_GLYPH
16989 && glyph
->u
.ch
== ' ')))
16990 (glyph
++)->face_id
= face_id
;
16997 /* Value is non-zero if glyph row ROW in window W should be
16998 used to hold the cursor. */
17001 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17003 int cursor_row_p
= 1;
17005 if (PT
== CHARPOS (row
->end
.pos
))
17007 /* Suppose the row ends on a string.
17008 Unless the row is continued, that means it ends on a newline
17009 in the string. If it's anything other than a display string
17010 (e.g. a before-string from an overlay), we don't want the
17011 cursor there. (This heuristic seems to give the optimal
17012 behavior for the various types of multi-line strings.) */
17013 if (CHARPOS (row
->end
.string_pos
) >= 0)
17015 if (row
->continued_p
)
17019 /* Check for `display' property. */
17020 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17021 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17022 struct glyph
*glyph
;
17025 for (glyph
= end
; glyph
>= beg
; --glyph
)
17026 if (STRINGP (glyph
->object
))
17029 = Fget_char_property (make_number (PT
),
17033 && display_prop_string_p (prop
, glyph
->object
));
17038 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17040 /* If the row ends in middle of a real character,
17041 and the line is continued, we want the cursor here.
17042 That's because CHARPOS (ROW->end.pos) would equal
17043 PT if PT is before the character. */
17044 if (!row
->ends_in_ellipsis_p
)
17045 cursor_row_p
= row
->continued_p
;
17047 /* If the row ends in an ellipsis, then
17048 CHARPOS (ROW->end.pos) will equal point after the
17049 invisible text. We want that position to be displayed
17050 after the ellipsis. */
17053 /* If the row ends at ZV, display the cursor at the end of that
17054 row instead of at the start of the row below. */
17055 else if (row
->ends_at_zv_p
)
17061 return cursor_row_p
;
17066 /* Push the display property PROP so that it will be rendered at the
17067 current position in IT. Return 1 if PROP was successfully pushed,
17071 push_display_prop (struct it
*it
, Lisp_Object prop
)
17075 if (STRINGP (prop
))
17077 if (SCHARS (prop
) == 0)
17084 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17085 it
->current
.overlay_string_index
= -1;
17086 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17087 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17088 it
->method
= GET_FROM_STRING
;
17089 it
->stop_charpos
= 0;
17091 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17093 it
->method
= GET_FROM_STRETCH
;
17096 #ifdef HAVE_WINDOW_SYSTEM
17097 else if (IMAGEP (prop
))
17099 it
->what
= IT_IMAGE
;
17100 it
->image_id
= lookup_image (it
->f
, prop
);
17101 it
->method
= GET_FROM_IMAGE
;
17103 #endif /* HAVE_WINDOW_SYSTEM */
17106 pop_it (it
); /* bogus display property, give up */
17113 /* Return the character-property PROP at the current position in IT. */
17116 get_it_property (struct it
*it
, Lisp_Object prop
)
17118 Lisp_Object position
;
17120 if (STRINGP (it
->object
))
17121 position
= make_number (IT_STRING_CHARPOS (*it
));
17122 else if (BUFFERP (it
->object
))
17123 position
= make_number (IT_CHARPOS (*it
));
17127 return Fget_char_property (position
, prop
, it
->object
);
17130 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17133 handle_line_prefix (struct it
*it
)
17135 Lisp_Object prefix
;
17136 if (it
->continuation_lines_width
> 0)
17138 prefix
= get_it_property (it
, Qwrap_prefix
);
17140 prefix
= Vwrap_prefix
;
17144 prefix
= get_it_property (it
, Qline_prefix
);
17146 prefix
= Vline_prefix
;
17148 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17150 /* If the prefix is wider than the window, and we try to wrap
17151 it, it would acquire its own wrap prefix, and so on till the
17152 iterator stack overflows. So, don't wrap the prefix. */
17153 it
->line_wrap
= TRUNCATE
;
17154 it
->avoid_cursor_p
= 1;
17160 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17161 only for R2L lines from display_line, when it decides that too many
17162 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17165 unproduce_glyphs (struct it
*it
, int n
)
17167 struct glyph
*glyph
, *end
;
17169 xassert (it
->glyph_row
);
17170 xassert (it
->glyph_row
->reversed_p
);
17171 xassert (it
->area
== TEXT_AREA
);
17172 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17174 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17175 n
= it
->glyph_row
->used
[TEXT_AREA
];
17176 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17177 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17178 for ( ; glyph
< end
; glyph
++)
17179 glyph
[-n
] = *glyph
;
17182 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17183 and ROW->maxpos. */
17185 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17186 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17187 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17189 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17190 lines' rows is implemented for bidi-reordered rows. */
17192 /* ROW->minpos is the value of min_pos, the minimal buffer position
17195 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17198 /* We didn't find _any_ valid buffer positions in any of the
17199 glyphs, so we must trust the iterator's computed
17201 row
->minpos
= row
->start
.pos
;
17202 max_pos
= CHARPOS (it
->current
.pos
);
17203 max_bpos
= BYTEPOS (it
->current
.pos
);
17209 /* Here are the various use-cases for ending the row, and the
17210 corresponding values for ROW->maxpos:
17212 Line ends in a newline from buffer eol_pos + 1
17213 Line is continued from buffer max_pos + 1
17214 Line is truncated on right it->current.pos
17215 Line ends in a newline from string max_pos
17216 Line is continued from string max_pos
17217 Line is continued from display vector max_pos
17218 Line is entirely from a string min_pos == max_pos
17219 Line is entirely from a display vector min_pos == max_pos
17220 Line that ends at ZV ZV
17222 If you discover other use-cases, please add them here as
17224 if (row
->ends_at_zv_p
)
17225 row
->maxpos
= it
->current
.pos
;
17226 else if (row
->used
[TEXT_AREA
])
17228 if (row
->ends_in_newline_from_string_p
)
17229 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17230 else if (CHARPOS (it
->eol_pos
) > 0)
17231 SET_TEXT_POS (row
->maxpos
,
17232 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17233 else if (row
->continued_p
)
17235 /* If max_pos is different from IT's current position, it
17236 means IT->method does not belong to the display element
17237 at max_pos. However, it also means that the display
17238 element at max_pos was displayed in its entirety on this
17239 line, which is equivalent to saying that the next line
17240 starts at the next buffer position. */
17241 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17242 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17245 INC_BOTH (max_pos
, max_bpos
);
17246 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17249 else if (row
->truncated_on_right_p
)
17250 /* display_line already called reseat_at_next_visible_line_start,
17251 which puts the iterator at the beginning of the next line, in
17252 the logical order. */
17253 row
->maxpos
= it
->current
.pos
;
17254 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17255 /* A line that is entirely from a string/image/stretch... */
17256 row
->maxpos
= row
->minpos
;
17261 row
->maxpos
= it
->current
.pos
;
17264 /* Construct the glyph row IT->glyph_row in the desired matrix of
17265 IT->w from text at the current position of IT. See dispextern.h
17266 for an overview of struct it. Value is non-zero if
17267 IT->glyph_row displays text, as opposed to a line displaying ZV
17271 display_line (struct it
*it
)
17273 struct glyph_row
*row
= it
->glyph_row
;
17274 Lisp_Object overlay_arrow_string
;
17276 int may_wrap
= 0, wrap_x
;
17277 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17278 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17279 int wrap_row_extra_line_spacing
;
17280 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17281 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17283 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17285 /* We always start displaying at hpos zero even if hscrolled. */
17286 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17288 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17289 >= it
->w
->desired_matrix
->nrows
)
17291 it
->w
->nrows_scale_factor
++;
17292 fonts_changed_p
= 1;
17296 /* Is IT->w showing the region? */
17297 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17299 /* Clear the result glyph row and enable it. */
17300 prepare_desired_row (row
);
17302 row
->y
= it
->current_y
;
17303 row
->start
= it
->start
;
17304 row
->continuation_lines_width
= it
->continuation_lines_width
;
17305 row
->displays_text_p
= 1;
17306 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17307 it
->starts_in_middle_of_char_p
= 0;
17309 /* Arrange the overlays nicely for our purposes. Usually, we call
17310 display_line on only one line at a time, in which case this
17311 can't really hurt too much, or we call it on lines which appear
17312 one after another in the buffer, in which case all calls to
17313 recenter_overlay_lists but the first will be pretty cheap. */
17314 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17316 /* Move over display elements that are not visible because we are
17317 hscrolled. This may stop at an x-position < IT->first_visible_x
17318 if the first glyph is partially visible or if we hit a line end. */
17319 if (it
->current_x
< it
->first_visible_x
)
17321 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17322 MOVE_TO_POS
| MOVE_TO_X
);
17326 /* We only do this when not calling `move_it_in_display_line_to'
17327 above, because move_it_in_display_line_to calls
17328 handle_line_prefix itself. */
17329 handle_line_prefix (it
);
17332 /* Get the initial row height. This is either the height of the
17333 text hscrolled, if there is any, or zero. */
17334 row
->ascent
= it
->max_ascent
;
17335 row
->height
= it
->max_ascent
+ it
->max_descent
;
17336 row
->phys_ascent
= it
->max_phys_ascent
;
17337 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17338 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17340 /* Utility macro to record max and min buffer positions seen until now. */
17341 #define RECORD_MAX_MIN_POS(IT) \
17344 if (IT_CHARPOS (*(IT)) < min_pos) \
17346 min_pos = IT_CHARPOS (*(IT)); \
17347 min_bpos = IT_BYTEPOS (*(IT)); \
17349 if (IT_CHARPOS (*(IT)) > max_pos) \
17351 max_pos = IT_CHARPOS (*(IT)); \
17352 max_bpos = IT_BYTEPOS (*(IT)); \
17357 /* Loop generating characters. The loop is left with IT on the next
17358 character to display. */
17361 int n_glyphs_before
, hpos_before
, x_before
;
17363 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17365 /* Retrieve the next thing to display. Value is zero if end of
17367 if (!get_next_display_element (it
))
17369 /* Maybe add a space at the end of this line that is used to
17370 display the cursor there under X. Set the charpos of the
17371 first glyph of blank lines not corresponding to any text
17373 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17374 row
->exact_window_width_line_p
= 1;
17375 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17376 || row
->used
[TEXT_AREA
] == 0)
17378 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17379 row
->displays_text_p
= 0;
17381 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17382 && (!MINI_WINDOW_P (it
->w
)
17383 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17384 row
->indicate_empty_line_p
= 1;
17387 it
->continuation_lines_width
= 0;
17388 row
->ends_at_zv_p
= 1;
17389 /* A row that displays right-to-left text must always have
17390 its last face extended all the way to the end of line,
17391 even if this row ends in ZV, because we still write to
17392 the screen left to right. */
17393 if (row
->reversed_p
)
17394 extend_face_to_end_of_line (it
);
17398 /* Now, get the metrics of what we want to display. This also
17399 generates glyphs in `row' (which is IT->glyph_row). */
17400 n_glyphs_before
= row
->used
[TEXT_AREA
];
17403 /* Remember the line height so far in case the next element doesn't
17404 fit on the line. */
17405 if (it
->line_wrap
!= TRUNCATE
)
17407 ascent
= it
->max_ascent
;
17408 descent
= it
->max_descent
;
17409 phys_ascent
= it
->max_phys_ascent
;
17410 phys_descent
= it
->max_phys_descent
;
17412 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17414 if (IT_DISPLAYING_WHITESPACE (it
))
17420 wrap_row_used
= row
->used
[TEXT_AREA
];
17421 wrap_row_ascent
= row
->ascent
;
17422 wrap_row_height
= row
->height
;
17423 wrap_row_phys_ascent
= row
->phys_ascent
;
17424 wrap_row_phys_height
= row
->phys_height
;
17425 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17426 wrap_row_min_pos
= min_pos
;
17427 wrap_row_min_bpos
= min_bpos
;
17428 wrap_row_max_pos
= max_pos
;
17429 wrap_row_max_bpos
= max_bpos
;
17435 PRODUCE_GLYPHS (it
);
17437 /* If this display element was in marginal areas, continue with
17439 if (it
->area
!= TEXT_AREA
)
17441 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17442 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17443 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17444 row
->phys_height
= max (row
->phys_height
,
17445 it
->max_phys_ascent
+ it
->max_phys_descent
);
17446 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17447 it
->max_extra_line_spacing
);
17448 set_iterator_to_next (it
, 1);
17452 /* Does the display element fit on the line? If we truncate
17453 lines, we should draw past the right edge of the window. If
17454 we don't truncate, we want to stop so that we can display the
17455 continuation glyph before the right margin. If lines are
17456 continued, there are two possible strategies for characters
17457 resulting in more than 1 glyph (e.g. tabs): Display as many
17458 glyphs as possible in this line and leave the rest for the
17459 continuation line, or display the whole element in the next
17460 line. Original redisplay did the former, so we do it also. */
17461 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17462 hpos_before
= it
->hpos
;
17465 if (/* Not a newline. */
17467 /* Glyphs produced fit entirely in the line. */
17468 && it
->current_x
< it
->last_visible_x
)
17470 it
->hpos
+= nglyphs
;
17471 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17472 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17473 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17474 row
->phys_height
= max (row
->phys_height
,
17475 it
->max_phys_ascent
+ it
->max_phys_descent
);
17476 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17477 it
->max_extra_line_spacing
);
17478 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17479 row
->x
= x
- it
->first_visible_x
;
17480 /* Record the maximum and minimum buffer positions seen so
17481 far in glyphs that will be displayed by this row. */
17483 RECORD_MAX_MIN_POS (it
);
17488 struct glyph
*glyph
;
17490 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17492 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17493 new_x
= x
+ glyph
->pixel_width
;
17495 if (/* Lines are continued. */
17496 it
->line_wrap
!= TRUNCATE
17497 && (/* Glyph doesn't fit on the line. */
17498 new_x
> it
->last_visible_x
17499 /* Or it fits exactly on a window system frame. */
17500 || (new_x
== it
->last_visible_x
17501 && FRAME_WINDOW_P (it
->f
))))
17503 /* End of a continued line. */
17506 || (new_x
== it
->last_visible_x
17507 && FRAME_WINDOW_P (it
->f
)))
17509 /* Current glyph is the only one on the line or
17510 fits exactly on the line. We must continue
17511 the line because we can't draw the cursor
17512 after the glyph. */
17513 row
->continued_p
= 1;
17514 it
->current_x
= new_x
;
17515 it
->continuation_lines_width
+= new_x
;
17517 /* Record the maximum and minimum buffer
17518 positions seen so far in glyphs that will be
17519 displayed by this row. */
17521 RECORD_MAX_MIN_POS (it
);
17522 if (i
== nglyphs
- 1)
17524 /* If line-wrap is on, check if a previous
17525 wrap point was found. */
17526 if (wrap_row_used
> 0
17527 /* Even if there is a previous wrap
17528 point, continue the line here as
17529 usual, if (i) the previous character
17530 was a space or tab AND (ii) the
17531 current character is not. */
17533 || IT_DISPLAYING_WHITESPACE (it
)))
17536 set_iterator_to_next (it
, 1);
17537 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17539 if (!get_next_display_element (it
))
17541 row
->exact_window_width_line_p
= 1;
17542 it
->continuation_lines_width
= 0;
17543 row
->continued_p
= 0;
17544 row
->ends_at_zv_p
= 1;
17546 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17548 row
->continued_p
= 0;
17549 row
->exact_window_width_line_p
= 1;
17554 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17555 && !FRAME_WINDOW_P (it
->f
))
17557 /* A padding glyph that doesn't fit on this line.
17558 This means the whole character doesn't fit
17560 if (row
->reversed_p
)
17561 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17562 - n_glyphs_before
);
17563 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17565 /* Fill the rest of the row with continuation
17566 glyphs like in 20.x. */
17567 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17568 < row
->glyphs
[1 + TEXT_AREA
])
17569 produce_special_glyphs (it
, IT_CONTINUATION
);
17571 row
->continued_p
= 1;
17572 it
->current_x
= x_before
;
17573 it
->continuation_lines_width
+= x_before
;
17575 /* Restore the height to what it was before the
17576 element not fitting on the line. */
17577 it
->max_ascent
= ascent
;
17578 it
->max_descent
= descent
;
17579 it
->max_phys_ascent
= phys_ascent
;
17580 it
->max_phys_descent
= phys_descent
;
17582 else if (wrap_row_used
> 0)
17585 if (row
->reversed_p
)
17586 unproduce_glyphs (it
,
17587 row
->used
[TEXT_AREA
] - wrap_row_used
);
17589 it
->continuation_lines_width
+= wrap_x
;
17590 row
->used
[TEXT_AREA
] = wrap_row_used
;
17591 row
->ascent
= wrap_row_ascent
;
17592 row
->height
= wrap_row_height
;
17593 row
->phys_ascent
= wrap_row_phys_ascent
;
17594 row
->phys_height
= wrap_row_phys_height
;
17595 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17596 min_pos
= wrap_row_min_pos
;
17597 min_bpos
= wrap_row_min_bpos
;
17598 max_pos
= wrap_row_max_pos
;
17599 max_bpos
= wrap_row_max_bpos
;
17600 row
->continued_p
= 1;
17601 row
->ends_at_zv_p
= 0;
17602 row
->exact_window_width_line_p
= 0;
17603 it
->continuation_lines_width
+= x
;
17605 /* Make sure that a non-default face is extended
17606 up to the right margin of the window. */
17607 extend_face_to_end_of_line (it
);
17609 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17611 /* A TAB that extends past the right edge of the
17612 window. This produces a single glyph on
17613 window system frames. We leave the glyph in
17614 this row and let it fill the row, but don't
17615 consume the TAB. */
17616 it
->continuation_lines_width
+= it
->last_visible_x
;
17617 row
->ends_in_middle_of_char_p
= 1;
17618 row
->continued_p
= 1;
17619 glyph
->pixel_width
= it
->last_visible_x
- x
;
17620 it
->starts_in_middle_of_char_p
= 1;
17624 /* Something other than a TAB that draws past
17625 the right edge of the window. Restore
17626 positions to values before the element. */
17627 if (row
->reversed_p
)
17628 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17629 - (n_glyphs_before
+ i
));
17630 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17632 /* Display continuation glyphs. */
17633 if (!FRAME_WINDOW_P (it
->f
))
17634 produce_special_glyphs (it
, IT_CONTINUATION
);
17635 row
->continued_p
= 1;
17637 it
->current_x
= x_before
;
17638 it
->continuation_lines_width
+= x
;
17639 extend_face_to_end_of_line (it
);
17641 if (nglyphs
> 1 && i
> 0)
17643 row
->ends_in_middle_of_char_p
= 1;
17644 it
->starts_in_middle_of_char_p
= 1;
17647 /* Restore the height to what it was before the
17648 element not fitting on the line. */
17649 it
->max_ascent
= ascent
;
17650 it
->max_descent
= descent
;
17651 it
->max_phys_ascent
= phys_ascent
;
17652 it
->max_phys_descent
= phys_descent
;
17657 else if (new_x
> it
->first_visible_x
)
17659 /* Increment number of glyphs actually displayed. */
17662 /* Record the maximum and minimum buffer positions
17663 seen so far in glyphs that will be displayed by
17666 RECORD_MAX_MIN_POS (it
);
17668 if (x
< it
->first_visible_x
)
17669 /* Glyph is partially visible, i.e. row starts at
17670 negative X position. */
17671 row
->x
= x
- it
->first_visible_x
;
17675 /* Glyph is completely off the left margin of the
17676 window. This should not happen because of the
17677 move_it_in_display_line at the start of this
17678 function, unless the text display area of the
17679 window is empty. */
17680 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17684 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17685 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17686 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17687 row
->phys_height
= max (row
->phys_height
,
17688 it
->max_phys_ascent
+ it
->max_phys_descent
);
17689 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17690 it
->max_extra_line_spacing
);
17692 /* End of this display line if row is continued. */
17693 if (row
->continued_p
|| row
->ends_at_zv_p
)
17698 /* Is this a line end? If yes, we're also done, after making
17699 sure that a non-default face is extended up to the right
17700 margin of the window. */
17701 if (ITERATOR_AT_END_OF_LINE_P (it
))
17703 int used_before
= row
->used
[TEXT_AREA
];
17705 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17707 /* Add a space at the end of the line that is used to
17708 display the cursor there. */
17709 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17710 append_space_for_newline (it
, 0);
17712 /* Extend the face to the end of the line. */
17713 extend_face_to_end_of_line (it
);
17715 /* Make sure we have the position. */
17716 if (used_before
== 0)
17717 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17719 /* Record the position of the newline, for use in
17721 it
->eol_pos
= it
->current
.pos
;
17723 /* Consume the line end. This skips over invisible lines. */
17724 set_iterator_to_next (it
, 1);
17725 it
->continuation_lines_width
= 0;
17729 /* Proceed with next display element. Note that this skips
17730 over lines invisible because of selective display. */
17731 set_iterator_to_next (it
, 1);
17733 /* If we truncate lines, we are done when the last displayed
17734 glyphs reach past the right margin of the window. */
17735 if (it
->line_wrap
== TRUNCATE
17736 && (FRAME_WINDOW_P (it
->f
)
17737 ? (it
->current_x
>= it
->last_visible_x
)
17738 : (it
->current_x
> it
->last_visible_x
)))
17740 /* Maybe add truncation glyphs. */
17741 if (!FRAME_WINDOW_P (it
->f
))
17745 if (!row
->reversed_p
)
17747 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17748 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17753 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17754 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17756 /* Remove any padding glyphs at the front of ROW, to
17757 make room for the truncation glyphs we will be
17758 adding below. The loop below always inserts at
17759 least one truncation glyph, so also remove the
17760 last glyph added to ROW. */
17761 unproduce_glyphs (it
, i
+ 1);
17762 /* Adjust i for the loop below. */
17763 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17766 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17768 row
->used
[TEXT_AREA
] = i
;
17769 produce_special_glyphs (it
, IT_TRUNCATION
);
17772 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17774 /* Don't truncate if we can overflow newline into fringe. */
17775 if (!get_next_display_element (it
))
17777 it
->continuation_lines_width
= 0;
17778 row
->ends_at_zv_p
= 1;
17779 row
->exact_window_width_line_p
= 1;
17782 if (ITERATOR_AT_END_OF_LINE_P (it
))
17784 row
->exact_window_width_line_p
= 1;
17785 goto at_end_of_line
;
17789 row
->truncated_on_right_p
= 1;
17790 it
->continuation_lines_width
= 0;
17791 reseat_at_next_visible_line_start (it
, 0);
17792 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17793 it
->hpos
= hpos_before
;
17794 it
->current_x
= x_before
;
17799 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17800 at the left window margin. */
17801 if (it
->first_visible_x
17802 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17804 if (!FRAME_WINDOW_P (it
->f
))
17805 insert_left_trunc_glyphs (it
);
17806 row
->truncated_on_left_p
= 1;
17809 /* Remember the position at which this line ends.
17811 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17812 cannot be before the call to find_row_edges below, since that is
17813 where these positions are determined. */
17814 row
->end
= it
->current
;
17817 row
->minpos
= row
->start
.pos
;
17818 row
->maxpos
= row
->end
.pos
;
17822 /* ROW->minpos and ROW->maxpos must be the smallest and
17823 `1 + the largest' buffer positions in ROW. But if ROW was
17824 bidi-reordered, these two positions can be anywhere in the
17825 row, so we must determine them now. */
17826 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17829 /* If the start of this line is the overlay arrow-position, then
17830 mark this glyph row as the one containing the overlay arrow.
17831 This is clearly a mess with variable size fonts. It would be
17832 better to let it be displayed like cursors under X. */
17833 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17834 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17835 !NILP (overlay_arrow_string
)))
17837 /* Overlay arrow in window redisplay is a fringe bitmap. */
17838 if (STRINGP (overlay_arrow_string
))
17840 struct glyph_row
*arrow_row
17841 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17842 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17843 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17844 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17845 struct glyph
*p2
, *end
;
17847 /* Copy the arrow glyphs. */
17848 while (glyph
< arrow_end
)
17851 /* Throw away padding glyphs. */
17853 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17854 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17860 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17865 xassert (INTEGERP (overlay_arrow_string
));
17866 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17868 overlay_arrow_seen
= 1;
17871 /* Compute pixel dimensions of this line. */
17872 compute_line_metrics (it
);
17874 /* Record whether this row ends inside an ellipsis. */
17875 row
->ends_in_ellipsis_p
17876 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17877 && it
->ellipsis_p
);
17879 /* Save fringe bitmaps in this row. */
17880 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17881 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17882 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17883 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17885 it
->left_user_fringe_bitmap
= 0;
17886 it
->left_user_fringe_face_id
= 0;
17887 it
->right_user_fringe_bitmap
= 0;
17888 it
->right_user_fringe_face_id
= 0;
17890 /* Maybe set the cursor. */
17891 cvpos
= it
->w
->cursor
.vpos
;
17893 /* In bidi-reordered rows, keep checking for proper cursor
17894 position even if one has been found already, because buffer
17895 positions in such rows change non-linearly with ROW->VPOS,
17896 when a line is continued. One exception: when we are at ZV,
17897 display cursor on the first suitable glyph row, since all
17898 the empty rows after that also have their position set to ZV. */
17899 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17900 lines' rows is implemented for bidi-reordered rows. */
17902 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17903 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17904 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17905 && cursor_row_p (it
->w
, row
))
17906 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17908 /* Highlight trailing whitespace. */
17909 if (!NILP (Vshow_trailing_whitespace
))
17910 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17912 /* Prepare for the next line. This line starts horizontally at (X
17913 HPOS) = (0 0). Vertical positions are incremented. As a
17914 convenience for the caller, IT->glyph_row is set to the next
17916 it
->current_x
= it
->hpos
= 0;
17917 it
->current_y
+= row
->height
;
17918 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17921 /* The next row should by default use the same value of the
17922 reversed_p flag as this one. set_iterator_to_next decides when
17923 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17924 the flag accordingly. */
17925 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17926 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17927 it
->start
= row
->end
;
17928 return row
->displays_text_p
;
17930 #undef RECORD_MAX_MIN_POS
17933 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17934 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17935 doc
: /* Return paragraph direction at point in BUFFER.
17936 Value is either `left-to-right' or `right-to-left'.
17937 If BUFFER is omitted or nil, it defaults to the current buffer.
17939 Paragraph direction determines how the text in the paragraph is displayed.
17940 In left-to-right paragraphs, text begins at the left margin of the window
17941 and the reading direction is generally left to right. In right-to-left
17942 paragraphs, text begins at the right margin and is read from right to left.
17944 See also `bidi-paragraph-direction'. */)
17945 (Lisp_Object buffer
)
17947 struct buffer
*buf
;
17948 struct buffer
*old
;
17951 buf
= current_buffer
;
17954 CHECK_BUFFER (buffer
);
17955 buf
= XBUFFER (buffer
);
17956 old
= current_buffer
;
17959 if (NILP (buf
->bidi_display_reordering
))
17960 return Qleft_to_right
;
17961 else if (!NILP (buf
->bidi_paragraph_direction
))
17962 return buf
->bidi_paragraph_direction
;
17965 /* Determine the direction from buffer text. We could try to
17966 use current_matrix if it is up to date, but this seems fast
17967 enough as it is. */
17968 struct bidi_it itb
;
17969 EMACS_INT pos
= BUF_PT (buf
);
17970 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17973 if (buf
!= current_buffer
)
17974 set_buffer_temp (buf
);
17975 /* bidi_paragraph_init finds the base direction of the paragraph
17976 by searching forward from paragraph start. We need the base
17977 direction of the current or _previous_ paragraph, so we need
17978 to make sure we are within that paragraph. To that end, find
17979 the previous non-empty line. */
17980 if (pos
>= ZV
&& pos
> BEGV
)
17983 bytepos
= CHAR_TO_BYTE (pos
);
17985 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17986 || c
== ' ' || c
== '\t' || c
== '\f')
17988 if (bytepos
<= BEGV_BYTE
)
17993 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17996 itb
.bytepos
= bytepos
;
17998 itb
.separator_limit
= -1;
17999 itb
.paragraph_dir
= NEUTRAL_DIR
;
18001 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18002 if (buf
!= current_buffer
)
18003 set_buffer_temp (old
);
18004 switch (itb
.paragraph_dir
)
18007 return Qleft_to_right
;
18010 return Qright_to_left
;
18020 /***********************************************************************
18022 ***********************************************************************/
18024 /* Redisplay the menu bar in the frame for window W.
18026 The menu bar of X frames that don't have X toolkit support is
18027 displayed in a special window W->frame->menu_bar_window.
18029 The menu bar of terminal frames is treated specially as far as
18030 glyph matrices are concerned. Menu bar lines are not part of
18031 windows, so the update is done directly on the frame matrix rows
18032 for the menu bar. */
18035 display_menu_bar (struct window
*w
)
18037 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18042 /* Don't do all this for graphical frames. */
18044 if (FRAME_W32_P (f
))
18047 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18053 if (FRAME_NS_P (f
))
18055 #endif /* HAVE_NS */
18057 #ifdef USE_X_TOOLKIT
18058 xassert (!FRAME_WINDOW_P (f
));
18059 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18060 it
.first_visible_x
= 0;
18061 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18062 #else /* not USE_X_TOOLKIT */
18063 if (FRAME_WINDOW_P (f
))
18065 /* Menu bar lines are displayed in the desired matrix of the
18066 dummy window menu_bar_window. */
18067 struct window
*menu_w
;
18068 xassert (WINDOWP (f
->menu_bar_window
));
18069 menu_w
= XWINDOW (f
->menu_bar_window
);
18070 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18072 it
.first_visible_x
= 0;
18073 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18077 /* This is a TTY frame, i.e. character hpos/vpos are used as
18079 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18081 it
.first_visible_x
= 0;
18082 it
.last_visible_x
= FRAME_COLS (f
);
18084 #endif /* not USE_X_TOOLKIT */
18086 if (! mode_line_inverse_video
)
18087 /* Force the menu-bar to be displayed in the default face. */
18088 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18090 /* Clear all rows of the menu bar. */
18091 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18093 struct glyph_row
*row
= it
.glyph_row
+ i
;
18094 clear_glyph_row (row
);
18095 row
->enabled_p
= 1;
18096 row
->full_width_p
= 1;
18099 /* Display all items of the menu bar. */
18100 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18101 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18103 Lisp_Object string
;
18105 /* Stop at nil string. */
18106 string
= AREF (items
, i
+ 1);
18110 /* Remember where item was displayed. */
18111 ASET (items
, i
+ 3, make_number (it
.hpos
));
18113 /* Display the item, pad with one space. */
18114 if (it
.current_x
< it
.last_visible_x
)
18115 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18116 SCHARS (string
) + 1, 0, 0, -1);
18119 /* Fill out the line with spaces. */
18120 if (it
.current_x
< it
.last_visible_x
)
18121 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18123 /* Compute the total height of the lines. */
18124 compute_line_metrics (&it
);
18129 /***********************************************************************
18131 ***********************************************************************/
18133 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18134 FORCE is non-zero, redisplay mode lines unconditionally.
18135 Otherwise, redisplay only mode lines that are garbaged. Value is
18136 the number of windows whose mode lines were redisplayed. */
18139 redisplay_mode_lines (Lisp_Object window
, int force
)
18143 while (!NILP (window
))
18145 struct window
*w
= XWINDOW (window
);
18147 if (WINDOWP (w
->hchild
))
18148 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18149 else if (WINDOWP (w
->vchild
))
18150 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18152 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18153 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18155 struct text_pos lpoint
;
18156 struct buffer
*old
= current_buffer
;
18158 /* Set the window's buffer for the mode line display. */
18159 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18160 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18162 /* Point refers normally to the selected window. For any
18163 other window, set up appropriate value. */
18164 if (!EQ (window
, selected_window
))
18166 struct text_pos pt
;
18168 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18169 if (CHARPOS (pt
) < BEGV
)
18170 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18171 else if (CHARPOS (pt
) > (ZV
- 1))
18172 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18174 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18177 /* Display mode lines. */
18178 clear_glyph_matrix (w
->desired_matrix
);
18179 if (display_mode_lines (w
))
18182 w
->must_be_updated_p
= 1;
18185 /* Restore old settings. */
18186 set_buffer_internal_1 (old
);
18187 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18197 /* Display the mode and/or header line of window W. Value is the
18198 sum number of mode lines and header lines displayed. */
18201 display_mode_lines (struct window
*w
)
18203 Lisp_Object old_selected_window
, old_selected_frame
;
18206 old_selected_frame
= selected_frame
;
18207 selected_frame
= w
->frame
;
18208 old_selected_window
= selected_window
;
18209 XSETWINDOW (selected_window
, w
);
18211 /* These will be set while the mode line specs are processed. */
18212 line_number_displayed
= 0;
18213 w
->column_number_displayed
= Qnil
;
18215 if (WINDOW_WANTS_MODELINE_P (w
))
18217 struct window
*sel_w
= XWINDOW (old_selected_window
);
18219 /* Select mode line face based on the real selected window. */
18220 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18221 current_buffer
->mode_line_format
);
18225 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18227 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18228 current_buffer
->header_line_format
);
18232 selected_frame
= old_selected_frame
;
18233 selected_window
= old_selected_window
;
18238 /* Display mode or header line of window W. FACE_ID specifies which
18239 line to display; it is either MODE_LINE_FACE_ID or
18240 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18241 display. Value is the pixel height of the mode/header line
18245 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18249 int count
= SPECPDL_INDEX ();
18251 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18252 /* Don't extend on a previously drawn mode-line.
18253 This may happen if called from pos_visible_p. */
18254 it
.glyph_row
->enabled_p
= 0;
18255 prepare_desired_row (it
.glyph_row
);
18257 it
.glyph_row
->mode_line_p
= 1;
18259 if (! mode_line_inverse_video
)
18260 /* Force the mode-line to be displayed in the default face. */
18261 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18263 record_unwind_protect (unwind_format_mode_line
,
18264 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18266 mode_line_target
= MODE_LINE_DISPLAY
;
18268 /* Temporarily make frame's keyboard the current kboard so that
18269 kboard-local variables in the mode_line_format will get the right
18271 push_kboard (FRAME_KBOARD (it
.f
));
18272 record_unwind_save_match_data ();
18273 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18276 unbind_to (count
, Qnil
);
18278 /* Fill up with spaces. */
18279 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18281 compute_line_metrics (&it
);
18282 it
.glyph_row
->full_width_p
= 1;
18283 it
.glyph_row
->continued_p
= 0;
18284 it
.glyph_row
->truncated_on_left_p
= 0;
18285 it
.glyph_row
->truncated_on_right_p
= 0;
18287 /* Make a 3D mode-line have a shadow at its right end. */
18288 face
= FACE_FROM_ID (it
.f
, face_id
);
18289 extend_face_to_end_of_line (&it
);
18290 if (face
->box
!= FACE_NO_BOX
)
18292 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18293 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18294 last
->right_box_line_p
= 1;
18297 return it
.glyph_row
->height
;
18300 /* Move element ELT in LIST to the front of LIST.
18301 Return the updated list. */
18304 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18306 register Lisp_Object tail
, prev
;
18307 register Lisp_Object tem
;
18311 while (CONSP (tail
))
18317 /* Splice out the link TAIL. */
18319 list
= XCDR (tail
);
18321 Fsetcdr (prev
, XCDR (tail
));
18323 /* Now make it the first. */
18324 Fsetcdr (tail
, list
);
18329 tail
= XCDR (tail
);
18333 /* Not found--return unchanged LIST. */
18337 /* Contribute ELT to the mode line for window IT->w. How it
18338 translates into text depends on its data type.
18340 IT describes the display environment in which we display, as usual.
18342 DEPTH is the depth in recursion. It is used to prevent
18343 infinite recursion here.
18345 FIELD_WIDTH is the number of characters the display of ELT should
18346 occupy in the mode line, and PRECISION is the maximum number of
18347 characters to display from ELT's representation. See
18348 display_string for details.
18350 Returns the hpos of the end of the text generated by ELT.
18352 PROPS is a property list to add to any string we encounter.
18354 If RISKY is nonzero, remove (disregard) any properties in any string
18355 we encounter, and ignore :eval and :propertize.
18357 The global variable `mode_line_target' determines whether the
18358 output is passed to `store_mode_line_noprop',
18359 `store_mode_line_string', or `display_string'. */
18362 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18363 Lisp_Object elt
, Lisp_Object props
, int risky
)
18365 int n
= 0, field
, prec
;
18370 elt
= build_string ("*too-deep*");
18374 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18378 /* A string: output it and check for %-constructs within it. */
18382 if (SCHARS (elt
) > 0
18383 && (!NILP (props
) || risky
))
18385 Lisp_Object oprops
, aelt
;
18386 oprops
= Ftext_properties_at (make_number (0), elt
);
18388 /* If the starting string's properties are not what
18389 we want, translate the string. Also, if the string
18390 is risky, do that anyway. */
18392 if (NILP (Fequal (props
, oprops
)) || risky
)
18394 /* If the starting string has properties,
18395 merge the specified ones onto the existing ones. */
18396 if (! NILP (oprops
) && !risky
)
18400 oprops
= Fcopy_sequence (oprops
);
18402 while (CONSP (tem
))
18404 oprops
= Fplist_put (oprops
, XCAR (tem
),
18405 XCAR (XCDR (tem
)));
18406 tem
= XCDR (XCDR (tem
));
18411 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18412 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18414 /* AELT is what we want. Move it to the front
18415 without consing. */
18417 mode_line_proptrans_alist
18418 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18424 /* If AELT has the wrong props, it is useless.
18425 so get rid of it. */
18427 mode_line_proptrans_alist
18428 = Fdelq (aelt
, mode_line_proptrans_alist
);
18430 elt
= Fcopy_sequence (elt
);
18431 Fset_text_properties (make_number (0), Flength (elt
),
18433 /* Add this item to mode_line_proptrans_alist. */
18434 mode_line_proptrans_alist
18435 = Fcons (Fcons (elt
, props
),
18436 mode_line_proptrans_alist
);
18437 /* Truncate mode_line_proptrans_alist
18438 to at most 50 elements. */
18439 tem
= Fnthcdr (make_number (50),
18440 mode_line_proptrans_alist
);
18442 XSETCDR (tem
, Qnil
);
18451 prec
= precision
- n
;
18452 switch (mode_line_target
)
18454 case MODE_LINE_NOPROP
:
18455 case MODE_LINE_TITLE
:
18456 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18458 case MODE_LINE_STRING
:
18459 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18461 case MODE_LINE_DISPLAY
:
18462 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18463 0, prec
, 0, STRING_MULTIBYTE (elt
));
18470 /* Handle the non-literal case. */
18472 while ((precision
<= 0 || n
< precision
)
18473 && SREF (elt
, offset
) != 0
18474 && (mode_line_target
!= MODE_LINE_DISPLAY
18475 || it
->current_x
< it
->last_visible_x
))
18477 int last_offset
= offset
;
18479 /* Advance to end of string or next format specifier. */
18480 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18483 if (offset
- 1 != last_offset
)
18485 int nchars
, nbytes
;
18487 /* Output to end of string or up to '%'. Field width
18488 is length of string. Don't output more than
18489 PRECISION allows us. */
18492 prec
= c_string_width (SDATA (elt
) + last_offset
,
18493 offset
- last_offset
, precision
- n
,
18496 switch (mode_line_target
)
18498 case MODE_LINE_NOPROP
:
18499 case MODE_LINE_TITLE
:
18500 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18502 case MODE_LINE_STRING
:
18504 int bytepos
= last_offset
;
18505 int charpos
= string_byte_to_char (elt
, bytepos
);
18506 int endpos
= (precision
<= 0
18507 ? string_byte_to_char (elt
, offset
)
18508 : charpos
+ nchars
);
18510 n
+= store_mode_line_string (NULL
,
18511 Fsubstring (elt
, make_number (charpos
),
18512 make_number (endpos
)),
18516 case MODE_LINE_DISPLAY
:
18518 int bytepos
= last_offset
;
18519 int charpos
= string_byte_to_char (elt
, bytepos
);
18521 if (precision
<= 0)
18522 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18523 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18525 STRING_MULTIBYTE (elt
));
18530 else /* c == '%' */
18532 int percent_position
= offset
;
18534 /* Get the specified minimum width. Zero means
18537 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18538 field
= field
* 10 + c
- '0';
18540 /* Don't pad beyond the total padding allowed. */
18541 if (field_width
- n
> 0 && field
> field_width
- n
)
18542 field
= field_width
- n
;
18544 /* Note that either PRECISION <= 0 or N < PRECISION. */
18545 prec
= precision
- n
;
18548 n
+= display_mode_element (it
, depth
, field
, prec
,
18549 Vglobal_mode_string
, props
,
18554 int bytepos
, charpos
;
18555 const unsigned char *spec
;
18556 Lisp_Object string
;
18558 bytepos
= percent_position
;
18559 charpos
= (STRING_MULTIBYTE (elt
)
18560 ? string_byte_to_char (elt
, bytepos
)
18562 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18563 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18565 switch (mode_line_target
)
18567 case MODE_LINE_NOPROP
:
18568 case MODE_LINE_TITLE
:
18569 n
+= store_mode_line_noprop (spec
, field
, prec
);
18571 case MODE_LINE_STRING
:
18573 int len
= strlen (spec
);
18574 Lisp_Object tem
= make_string (spec
, len
);
18575 props
= Ftext_properties_at (make_number (charpos
), elt
);
18576 /* Should only keep face property in props */
18577 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18580 case MODE_LINE_DISPLAY
:
18582 int nglyphs_before
, nwritten
;
18584 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18585 nwritten
= display_string (spec
, string
, elt
,
18590 /* Assign to the glyphs written above the
18591 string where the `%x' came from, position
18595 struct glyph
*glyph
18596 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18600 for (i
= 0; i
< nwritten
; ++i
)
18602 glyph
[i
].object
= elt
;
18603 glyph
[i
].charpos
= charpos
;
18620 /* A symbol: process the value of the symbol recursively
18621 as if it appeared here directly. Avoid error if symbol void.
18622 Special case: if value of symbol is a string, output the string
18625 register Lisp_Object tem
;
18627 /* If the variable is not marked as risky to set
18628 then its contents are risky to use. */
18629 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18632 tem
= Fboundp (elt
);
18635 tem
= Fsymbol_value (elt
);
18636 /* If value is a string, output that string literally:
18637 don't check for % within it. */
18641 if (!EQ (tem
, elt
))
18643 /* Give up right away for nil or t. */
18653 register Lisp_Object car
, tem
;
18655 /* A cons cell: five distinct cases.
18656 If first element is :eval or :propertize, do something special.
18657 If first element is a string or a cons, process all the elements
18658 and effectively concatenate them.
18659 If first element is a negative number, truncate displaying cdr to
18660 at most that many characters. If positive, pad (with spaces)
18661 to at least that many characters.
18662 If first element is a symbol, process the cadr or caddr recursively
18663 according to whether the symbol's value is non-nil or nil. */
18665 if (EQ (car
, QCeval
))
18667 /* An element of the form (:eval FORM) means evaluate FORM
18668 and use the result as mode line elements. */
18673 if (CONSP (XCDR (elt
)))
18676 spec
= safe_eval (XCAR (XCDR (elt
)));
18677 n
+= display_mode_element (it
, depth
, field_width
- n
,
18678 precision
- n
, spec
, props
,
18682 else if (EQ (car
, QCpropertize
))
18684 /* An element of the form (:propertize ELT PROPS...)
18685 means display ELT but applying properties PROPS. */
18690 if (CONSP (XCDR (elt
)))
18691 n
+= display_mode_element (it
, depth
, field_width
- n
,
18692 precision
- n
, XCAR (XCDR (elt
)),
18693 XCDR (XCDR (elt
)), risky
);
18695 else if (SYMBOLP (car
))
18697 tem
= Fboundp (car
);
18701 /* elt is now the cdr, and we know it is a cons cell.
18702 Use its car if CAR has a non-nil value. */
18705 tem
= Fsymbol_value (car
);
18712 /* Symbol's value is nil (or symbol is unbound)
18713 Get the cddr of the original list
18714 and if possible find the caddr and use that. */
18718 else if (!CONSP (elt
))
18723 else if (INTEGERP (car
))
18725 register int lim
= XINT (car
);
18729 /* Negative int means reduce maximum width. */
18730 if (precision
<= 0)
18733 precision
= min (precision
, -lim
);
18737 /* Padding specified. Don't let it be more than
18738 current maximum. */
18740 lim
= min (precision
, lim
);
18742 /* If that's more padding than already wanted, queue it.
18743 But don't reduce padding already specified even if
18744 that is beyond the current truncation point. */
18745 field_width
= max (lim
, field_width
);
18749 else if (STRINGP (car
) || CONSP (car
))
18751 Lisp_Object halftail
= elt
;
18755 && (precision
<= 0 || n
< precision
))
18757 n
+= display_mode_element (it
, depth
,
18758 /* Do padding only after the last
18759 element in the list. */
18760 (! CONSP (XCDR (elt
))
18763 precision
- n
, XCAR (elt
),
18767 if ((len
& 1) == 0)
18768 halftail
= XCDR (halftail
);
18769 /* Check for cycle. */
18770 if (EQ (halftail
, elt
))
18779 elt
= build_string ("*invalid*");
18783 /* Pad to FIELD_WIDTH. */
18784 if (field_width
> 0 && n
< field_width
)
18786 switch (mode_line_target
)
18788 case MODE_LINE_NOPROP
:
18789 case MODE_LINE_TITLE
:
18790 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18792 case MODE_LINE_STRING
:
18793 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18795 case MODE_LINE_DISPLAY
:
18796 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18805 /* Store a mode-line string element in mode_line_string_list.
18807 If STRING is non-null, display that C string. Otherwise, the Lisp
18808 string LISP_STRING is displayed.
18810 FIELD_WIDTH is the minimum number of output glyphs to produce.
18811 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18812 with spaces. FIELD_WIDTH <= 0 means don't pad.
18814 PRECISION is the maximum number of characters to output from
18815 STRING. PRECISION <= 0 means don't truncate the string.
18817 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18818 properties to the string.
18820 PROPS are the properties to add to the string.
18821 The mode_line_string_face face property is always added to the string.
18825 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18826 int field_width
, int precision
, Lisp_Object props
)
18831 if (string
!= NULL
)
18833 len
= strlen (string
);
18834 if (precision
> 0 && len
> precision
)
18836 lisp_string
= make_string (string
, len
);
18838 props
= mode_line_string_face_prop
;
18839 else if (!NILP (mode_line_string_face
))
18841 Lisp_Object face
= Fplist_get (props
, Qface
);
18842 props
= Fcopy_sequence (props
);
18844 face
= mode_line_string_face
;
18846 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18847 props
= Fplist_put (props
, Qface
, face
);
18849 Fadd_text_properties (make_number (0), make_number (len
),
18850 props
, lisp_string
);
18854 len
= XFASTINT (Flength (lisp_string
));
18855 if (precision
> 0 && len
> precision
)
18858 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18861 if (!NILP (mode_line_string_face
))
18865 props
= Ftext_properties_at (make_number (0), lisp_string
);
18866 face
= Fplist_get (props
, Qface
);
18868 face
= mode_line_string_face
;
18870 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18871 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18873 lisp_string
= Fcopy_sequence (lisp_string
);
18876 Fadd_text_properties (make_number (0), make_number (len
),
18877 props
, lisp_string
);
18882 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18886 if (field_width
> len
)
18888 field_width
-= len
;
18889 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18891 Fadd_text_properties (make_number (0), make_number (field_width
),
18892 props
, lisp_string
);
18893 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18901 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18903 doc
: /* Format a string out of a mode line format specification.
18904 First arg FORMAT specifies the mode line format (see `mode-line-format'
18905 for details) to use.
18907 Optional second arg FACE specifies the face property to put
18908 on all characters for which no face is specified.
18909 The value t means whatever face the window's mode line currently uses
18910 \(either `mode-line' or `mode-line-inactive', depending).
18911 A value of nil means the default is no face property.
18912 If FACE is an integer, the value string has no text properties.
18914 Optional third and fourth args WINDOW and BUFFER specify the window
18915 and buffer to use as the context for the formatting (defaults
18916 are the selected window and the window's buffer). */)
18917 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18922 struct buffer
*old_buffer
= NULL
;
18924 int no_props
= INTEGERP (face
);
18925 int count
= SPECPDL_INDEX ();
18927 int string_start
= 0;
18930 window
= selected_window
;
18931 CHECK_WINDOW (window
);
18932 w
= XWINDOW (window
);
18935 buffer
= w
->buffer
;
18936 CHECK_BUFFER (buffer
);
18938 /* Make formatting the modeline a non-op when noninteractive, otherwise
18939 there will be problems later caused by a partially initialized frame. */
18940 if (NILP (format
) || noninteractive
)
18941 return empty_unibyte_string
;
18949 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18950 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18954 face_id
= DEFAULT_FACE_ID
;
18956 if (XBUFFER (buffer
) != current_buffer
)
18957 old_buffer
= current_buffer
;
18959 /* Save things including mode_line_proptrans_alist,
18960 and set that to nil so that we don't alter the outer value. */
18961 record_unwind_protect (unwind_format_mode_line
,
18962 format_mode_line_unwind_data
18963 (old_buffer
, selected_window
, 1));
18964 mode_line_proptrans_alist
= Qnil
;
18966 Fselect_window (window
, Qt
);
18968 set_buffer_internal_1 (XBUFFER (buffer
));
18970 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18974 mode_line_target
= MODE_LINE_NOPROP
;
18975 mode_line_string_face_prop
= Qnil
;
18976 mode_line_string_list
= Qnil
;
18977 string_start
= MODE_LINE_NOPROP_LEN (0);
18981 mode_line_target
= MODE_LINE_STRING
;
18982 mode_line_string_list
= Qnil
;
18983 mode_line_string_face
= face
;
18984 mode_line_string_face_prop
18985 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18988 push_kboard (FRAME_KBOARD (it
.f
));
18989 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18994 len
= MODE_LINE_NOPROP_LEN (string_start
);
18995 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18999 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19000 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19001 empty_unibyte_string
);
19004 unbind_to (count
, Qnil
);
19008 /* Write a null-terminated, right justified decimal representation of
19009 the positive integer D to BUF using a minimal field width WIDTH. */
19012 pint2str (register char *buf
, register int width
, register int d
)
19014 register char *p
= buf
;
19022 *p
++ = d
% 10 + '0';
19027 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19038 /* Write a null-terminated, right justified decimal and "human
19039 readable" representation of the nonnegative integer D to BUF using
19040 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19042 static const char power_letter
[] =
19056 pint2hrstr (char *buf
, int width
, int d
)
19058 /* We aim to represent the nonnegative integer D as
19059 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19062 /* -1 means: do not use TENTHS. */
19066 /* Length of QUOTIENT.TENTHS as a string. */
19072 if (1000 <= quotient
)
19074 /* Scale to the appropriate EXPONENT. */
19077 remainder
= quotient
% 1000;
19081 while (1000 <= quotient
);
19083 /* Round to nearest and decide whether to use TENTHS or not. */
19086 tenths
= remainder
/ 100;
19087 if (50 <= remainder
% 100)
19094 if (quotient
== 10)
19102 if (500 <= remainder
)
19104 if (quotient
< 999)
19115 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19116 if (tenths
== -1 && quotient
<= 99)
19123 p
= psuffix
= buf
+ max (width
, length
);
19125 /* Print EXPONENT. */
19127 *psuffix
++ = power_letter
[exponent
];
19130 /* Print TENTHS. */
19133 *--p
= '0' + tenths
;
19137 /* Print QUOTIENT. */
19140 int digit
= quotient
% 10;
19141 *--p
= '0' + digit
;
19143 while ((quotient
/= 10) != 0);
19145 /* Print leading spaces. */
19150 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19151 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19152 type of CODING_SYSTEM. Return updated pointer into BUF. */
19154 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19157 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19160 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19161 const unsigned char *eol_str
;
19163 /* The EOL conversion we are using. */
19164 Lisp_Object eoltype
;
19166 val
= CODING_SYSTEM_SPEC (coding_system
);
19169 if (!VECTORP (val
)) /* Not yet decided. */
19174 eoltype
= eol_mnemonic_undecided
;
19175 /* Don't mention EOL conversion if it isn't decided. */
19180 Lisp_Object eolvalue
;
19182 attrs
= AREF (val
, 0);
19183 eolvalue
= AREF (val
, 2);
19186 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19190 /* The EOL conversion that is normal on this system. */
19192 if (NILP (eolvalue
)) /* Not yet decided. */
19193 eoltype
= eol_mnemonic_undecided
;
19194 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19195 eoltype
= eol_mnemonic_undecided
;
19196 else /* eolvalue is Qunix, Qdos, or Qmac. */
19197 eoltype
= (EQ (eolvalue
, Qunix
)
19198 ? eol_mnemonic_unix
19199 : (EQ (eolvalue
, Qdos
) == 1
19200 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19206 /* Mention the EOL conversion if it is not the usual one. */
19207 if (STRINGP (eoltype
))
19209 eol_str
= SDATA (eoltype
);
19210 eol_str_len
= SBYTES (eoltype
);
19212 else if (CHARACTERP (eoltype
))
19214 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19215 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19220 eol_str
= invalid_eol_type
;
19221 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19223 memcpy (buf
, eol_str
, eol_str_len
);
19224 buf
+= eol_str_len
;
19230 /* Return a string for the output of a mode line %-spec for window W,
19231 generated by character C. PRECISION >= 0 means don't return a
19232 string longer than that value. FIELD_WIDTH > 0 means pad the
19233 string returned with spaces to that value. Return a Lisp string in
19234 *STRING if the resulting string is taken from that Lisp string.
19236 Note we operate on the current buffer for most purposes,
19237 the exception being w->base_line_pos. */
19239 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19241 static const char *
19242 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19243 int precision
, Lisp_Object
*string
)
19246 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19247 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19248 struct buffer
*b
= current_buffer
;
19256 if (!NILP (b
->read_only
))
19258 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19263 /* This differs from %* only for a modified read-only buffer. */
19264 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19266 if (!NILP (b
->read_only
))
19271 /* This differs from %* in ignoring read-only-ness. */
19272 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19284 if (command_loop_level
> 5)
19286 p
= decode_mode_spec_buf
;
19287 for (i
= 0; i
< command_loop_level
; i
++)
19290 return decode_mode_spec_buf
;
19298 if (command_loop_level
> 5)
19300 p
= decode_mode_spec_buf
;
19301 for (i
= 0; i
< command_loop_level
; i
++)
19304 return decode_mode_spec_buf
;
19311 /* Let lots_of_dashes be a string of infinite length. */
19312 if (mode_line_target
== MODE_LINE_NOPROP
||
19313 mode_line_target
== MODE_LINE_STRING
)
19315 if (field_width
<= 0
19316 || field_width
> sizeof (lots_of_dashes
))
19318 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19319 decode_mode_spec_buf
[i
] = '-';
19320 decode_mode_spec_buf
[i
] = '\0';
19321 return decode_mode_spec_buf
;
19324 return lots_of_dashes
;
19332 /* %c and %l are ignored in `frame-title-format'.
19333 (In redisplay_internal, the frame title is drawn _before_ the
19334 windows are updated, so the stuff which depends on actual
19335 window contents (such as %l) may fail to render properly, or
19336 even crash emacs.) */
19337 if (mode_line_target
== MODE_LINE_TITLE
)
19341 int col
= (int) current_column (); /* iftc */
19342 w
->column_number_displayed
= make_number (col
);
19343 pint2str (decode_mode_spec_buf
, field_width
, col
);
19344 return decode_mode_spec_buf
;
19348 #ifndef SYSTEM_MALLOC
19350 if (NILP (Vmemory_full
))
19353 return "!MEM FULL! ";
19360 /* %F displays the frame name. */
19361 if (!NILP (f
->title
))
19362 return (char *) SDATA (f
->title
);
19363 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19364 return (char *) SDATA (f
->name
);
19373 int size
= ZV
- BEGV
;
19374 pint2str (decode_mode_spec_buf
, field_width
, size
);
19375 return decode_mode_spec_buf
;
19380 int size
= ZV
- BEGV
;
19381 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19382 return decode_mode_spec_buf
;
19387 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19388 int topline
, nlines
, junk
, height
;
19390 /* %c and %l are ignored in `frame-title-format'. */
19391 if (mode_line_target
== MODE_LINE_TITLE
)
19394 startpos
= XMARKER (w
->start
)->charpos
;
19395 startpos_byte
= marker_byte_position (w
->start
);
19396 height
= WINDOW_TOTAL_LINES (w
);
19398 /* If we decided that this buffer isn't suitable for line numbers,
19399 don't forget that too fast. */
19400 if (EQ (w
->base_line_pos
, w
->buffer
))
19402 /* But do forget it, if the window shows a different buffer now. */
19403 else if (BUFFERP (w
->base_line_pos
))
19404 w
->base_line_pos
= Qnil
;
19406 /* If the buffer is very big, don't waste time. */
19407 if (INTEGERP (Vline_number_display_limit
)
19408 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19410 w
->base_line_pos
= Qnil
;
19411 w
->base_line_number
= Qnil
;
19415 if (INTEGERP (w
->base_line_number
)
19416 && INTEGERP (w
->base_line_pos
)
19417 && XFASTINT (w
->base_line_pos
) <= startpos
)
19419 line
= XFASTINT (w
->base_line_number
);
19420 linepos
= XFASTINT (w
->base_line_pos
);
19421 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19426 linepos
= BUF_BEGV (b
);
19427 linepos_byte
= BUF_BEGV_BYTE (b
);
19430 /* Count lines from base line to window start position. */
19431 nlines
= display_count_lines (linepos
, linepos_byte
,
19435 topline
= nlines
+ line
;
19437 /* Determine a new base line, if the old one is too close
19438 or too far away, or if we did not have one.
19439 "Too close" means it's plausible a scroll-down would
19440 go back past it. */
19441 if (startpos
== BUF_BEGV (b
))
19443 w
->base_line_number
= make_number (topline
);
19444 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19446 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19447 || linepos
== BUF_BEGV (b
))
19449 int limit
= BUF_BEGV (b
);
19450 int limit_byte
= BUF_BEGV_BYTE (b
);
19452 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19454 if (startpos
- distance
> limit
)
19456 limit
= startpos
- distance
;
19457 limit_byte
= CHAR_TO_BYTE (limit
);
19460 nlines
= display_count_lines (startpos
, startpos_byte
,
19462 - (height
* 2 + 30),
19464 /* If we couldn't find the lines we wanted within
19465 line_number_display_limit_width chars per line,
19466 give up on line numbers for this window. */
19467 if (position
== limit_byte
&& limit
== startpos
- distance
)
19469 w
->base_line_pos
= w
->buffer
;
19470 w
->base_line_number
= Qnil
;
19474 w
->base_line_number
= make_number (topline
- nlines
);
19475 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19478 /* Now count lines from the start pos to point. */
19479 nlines
= display_count_lines (startpos
, startpos_byte
,
19480 PT_BYTE
, PT
, &junk
);
19482 /* Record that we did display the line number. */
19483 line_number_displayed
= 1;
19485 /* Make the string to show. */
19486 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19487 return decode_mode_spec_buf
;
19490 char* p
= decode_mode_spec_buf
;
19491 int pad
= field_width
- 2;
19497 return decode_mode_spec_buf
;
19503 obj
= b
->mode_name
;
19507 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19513 int pos
= marker_position (w
->start
);
19514 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19516 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19518 if (pos
<= BUF_BEGV (b
))
19523 else if (pos
<= BUF_BEGV (b
))
19527 if (total
> 1000000)
19528 /* Do it differently for a large value, to avoid overflow. */
19529 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19531 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19532 /* We can't normally display a 3-digit number,
19533 so get us a 2-digit number that is close. */
19536 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19537 return decode_mode_spec_buf
;
19541 /* Display percentage of size above the bottom of the screen. */
19544 int toppos
= marker_position (w
->start
);
19545 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19546 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19548 if (botpos
>= BUF_ZV (b
))
19550 if (toppos
<= BUF_BEGV (b
))
19557 if (total
> 1000000)
19558 /* Do it differently for a large value, to avoid overflow. */
19559 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19561 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19562 /* We can't normally display a 3-digit number,
19563 so get us a 2-digit number that is close. */
19566 if (toppos
<= BUF_BEGV (b
))
19567 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19569 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19570 return decode_mode_spec_buf
;
19575 /* status of process */
19576 obj
= Fget_buffer_process (Fcurrent_buffer ());
19578 return "no process";
19580 obj
= Fsymbol_name (Fprocess_status (obj
));
19586 int count
= inhibit_garbage_collection ();
19587 Lisp_Object val
= call1 (intern ("file-remote-p"),
19588 current_buffer
->directory
);
19589 unbind_to (count
, Qnil
);
19597 case 't': /* indicate TEXT or BINARY */
19598 #ifdef MODE_LINE_BINARY_TEXT
19599 return MODE_LINE_BINARY_TEXT (b
);
19605 /* coding-system (not including end-of-line format) */
19607 /* coding-system (including end-of-line type) */
19609 int eol_flag
= (c
== 'Z');
19610 char *p
= decode_mode_spec_buf
;
19612 if (! FRAME_WINDOW_P (f
))
19614 /* No need to mention EOL here--the terminal never needs
19615 to do EOL conversion. */
19616 p
= decode_mode_spec_coding (CODING_ID_NAME
19617 (FRAME_KEYBOARD_CODING (f
)->id
),
19619 p
= decode_mode_spec_coding (CODING_ID_NAME
19620 (FRAME_TERMINAL_CODING (f
)->id
),
19623 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19626 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19627 #ifdef subprocesses
19628 obj
= Fget_buffer_process (Fcurrent_buffer ());
19629 if (PROCESSP (obj
))
19631 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19633 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19636 #endif /* subprocesses */
19639 return decode_mode_spec_buf
;
19646 return (char *) SDATA (obj
);
19653 /* Count up to COUNT lines starting from START / START_BYTE.
19654 But don't go beyond LIMIT_BYTE.
19655 Return the number of lines thus found (always nonnegative).
19657 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19660 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19663 register unsigned char *cursor
;
19664 unsigned char *base
;
19666 register int ceiling
;
19667 register unsigned char *ceiling_addr
;
19668 int orig_count
= count
;
19670 /* If we are not in selective display mode,
19671 check only for newlines. */
19672 int selective_display
= (!NILP (current_buffer
->selective_display
)
19673 && !INTEGERP (current_buffer
->selective_display
));
19677 while (start_byte
< limit_byte
)
19679 ceiling
= BUFFER_CEILING_OF (start_byte
);
19680 ceiling
= min (limit_byte
- 1, ceiling
);
19681 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19682 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19685 if (selective_display
)
19686 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19689 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19692 if (cursor
!= ceiling_addr
)
19696 start_byte
+= cursor
- base
+ 1;
19697 *byte_pos_ptr
= start_byte
;
19701 if (++cursor
== ceiling_addr
)
19707 start_byte
+= cursor
- base
;
19712 while (start_byte
> limit_byte
)
19714 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19715 ceiling
= max (limit_byte
, ceiling
);
19716 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19717 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19720 if (selective_display
)
19721 while (--cursor
!= ceiling_addr
19722 && *cursor
!= '\n' && *cursor
!= 015)
19725 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19728 if (cursor
!= ceiling_addr
)
19732 start_byte
+= cursor
- base
+ 1;
19733 *byte_pos_ptr
= start_byte
;
19734 /* When scanning backwards, we should
19735 not count the newline posterior to which we stop. */
19736 return - orig_count
- 1;
19742 /* Here we add 1 to compensate for the last decrement
19743 of CURSOR, which took it past the valid range. */
19744 start_byte
+= cursor
- base
+ 1;
19748 *byte_pos_ptr
= limit_byte
;
19751 return - orig_count
+ count
;
19752 return orig_count
- count
;
19758 /***********************************************************************
19760 ***********************************************************************/
19762 /* Display a NUL-terminated string, starting with index START.
19764 If STRING is non-null, display that C string. Otherwise, the Lisp
19765 string LISP_STRING is displayed. There's a case that STRING is
19766 non-null and LISP_STRING is not nil. It means STRING is a string
19767 data of LISP_STRING. In that case, we display LISP_STRING while
19768 ignoring its text properties.
19770 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19771 FACE_STRING. Display STRING or LISP_STRING with the face at
19772 FACE_STRING_POS in FACE_STRING:
19774 Display the string in the environment given by IT, but use the
19775 standard display table, temporarily.
19777 FIELD_WIDTH is the minimum number of output glyphs to produce.
19778 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19779 with spaces. If STRING has more characters, more than FIELD_WIDTH
19780 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19782 PRECISION is the maximum number of characters to output from
19783 STRING. PRECISION < 0 means don't truncate the string.
19785 This is roughly equivalent to printf format specifiers:
19787 FIELD_WIDTH PRECISION PRINTF
19788 ----------------------------------------
19794 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19795 display them, and < 0 means obey the current buffer's value of
19796 enable_multibyte_characters.
19798 Value is the number of columns displayed. */
19801 display_string (const unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19802 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19803 int field_width
, int precision
, int max_x
, int multibyte
)
19805 int hpos_at_start
= it
->hpos
;
19806 int saved_face_id
= it
->face_id
;
19807 struct glyph_row
*row
= it
->glyph_row
;
19809 /* Initialize the iterator IT for iteration over STRING beginning
19810 with index START. */
19811 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19812 precision
, field_width
, multibyte
);
19813 if (string
&& STRINGP (lisp_string
))
19814 /* LISP_STRING is the one returned by decode_mode_spec. We should
19815 ignore its text properties. */
19816 it
->stop_charpos
= -1;
19818 /* If displaying STRING, set up the face of the iterator
19819 from LISP_STRING, if that's given. */
19820 if (STRINGP (face_string
))
19826 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19827 0, it
->region_beg_charpos
,
19828 it
->region_end_charpos
,
19829 &endptr
, it
->base_face_id
, 0);
19830 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19831 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19834 /* Set max_x to the maximum allowed X position. Don't let it go
19835 beyond the right edge of the window. */
19837 max_x
= it
->last_visible_x
;
19839 max_x
= min (max_x
, it
->last_visible_x
);
19841 /* Skip over display elements that are not visible. because IT->w is
19843 if (it
->current_x
< it
->first_visible_x
)
19844 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19845 MOVE_TO_POS
| MOVE_TO_X
);
19847 row
->ascent
= it
->max_ascent
;
19848 row
->height
= it
->max_ascent
+ it
->max_descent
;
19849 row
->phys_ascent
= it
->max_phys_ascent
;
19850 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19851 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19853 /* This condition is for the case that we are called with current_x
19854 past last_visible_x. */
19855 while (it
->current_x
< max_x
)
19857 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19859 /* Get the next display element. */
19860 if (!get_next_display_element (it
))
19863 /* Produce glyphs. */
19864 x_before
= it
->current_x
;
19865 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19866 PRODUCE_GLYPHS (it
);
19868 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19871 while (i
< nglyphs
)
19873 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19875 if (it
->line_wrap
!= TRUNCATE
19876 && x
+ glyph
->pixel_width
> max_x
)
19878 /* End of continued line or max_x reached. */
19879 if (CHAR_GLYPH_PADDING_P (*glyph
))
19881 /* A wide character is unbreakable. */
19882 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19883 it
->current_x
= x_before
;
19887 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19892 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19894 /* Glyph is at least partially visible. */
19896 if (x
< it
->first_visible_x
)
19897 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19901 /* Glyph is off the left margin of the display area.
19902 Should not happen. */
19906 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19907 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19908 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19909 row
->phys_height
= max (row
->phys_height
,
19910 it
->max_phys_ascent
+ it
->max_phys_descent
);
19911 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19912 it
->max_extra_line_spacing
);
19913 x
+= glyph
->pixel_width
;
19917 /* Stop if max_x reached. */
19921 /* Stop at line ends. */
19922 if (ITERATOR_AT_END_OF_LINE_P (it
))
19924 it
->continuation_lines_width
= 0;
19928 set_iterator_to_next (it
, 1);
19930 /* Stop if truncating at the right edge. */
19931 if (it
->line_wrap
== TRUNCATE
19932 && it
->current_x
>= it
->last_visible_x
)
19934 /* Add truncation mark, but don't do it if the line is
19935 truncated at a padding space. */
19936 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19938 if (!FRAME_WINDOW_P (it
->f
))
19942 if (it
->current_x
> it
->last_visible_x
)
19944 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19945 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19947 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19949 row
->used
[TEXT_AREA
] = i
;
19950 produce_special_glyphs (it
, IT_TRUNCATION
);
19953 produce_special_glyphs (it
, IT_TRUNCATION
);
19955 it
->glyph_row
->truncated_on_right_p
= 1;
19961 /* Maybe insert a truncation at the left. */
19962 if (it
->first_visible_x
19963 && IT_CHARPOS (*it
) > 0)
19965 if (!FRAME_WINDOW_P (it
->f
))
19966 insert_left_trunc_glyphs (it
);
19967 it
->glyph_row
->truncated_on_left_p
= 1;
19970 it
->face_id
= saved_face_id
;
19972 /* Value is number of columns displayed. */
19973 return it
->hpos
- hpos_at_start
;
19978 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19979 appears as an element of LIST or as the car of an element of LIST.
19980 If PROPVAL is a list, compare each element against LIST in that
19981 way, and return 1/2 if any element of PROPVAL is found in LIST.
19982 Otherwise return 0. This function cannot quit.
19983 The return value is 2 if the text is invisible but with an ellipsis
19984 and 1 if it's invisible and without an ellipsis. */
19987 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19989 register Lisp_Object tail
, proptail
;
19991 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19993 register Lisp_Object tem
;
19995 if (EQ (propval
, tem
))
19997 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19998 return NILP (XCDR (tem
)) ? 1 : 2;
20001 if (CONSP (propval
))
20003 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20005 Lisp_Object propelt
;
20006 propelt
= XCAR (proptail
);
20007 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20009 register Lisp_Object tem
;
20011 if (EQ (propelt
, tem
))
20013 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20014 return NILP (XCDR (tem
)) ? 1 : 2;
20022 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20023 doc
: /* Non-nil if the property makes the text invisible.
20024 POS-OR-PROP can be a marker or number, in which case it is taken to be
20025 a position in the current buffer and the value of the `invisible' property
20026 is checked; or it can be some other value, which is then presumed to be the
20027 value of the `invisible' property of the text of interest.
20028 The non-nil value returned can be t for truly invisible text or something
20029 else if the text is replaced by an ellipsis. */)
20030 (Lisp_Object pos_or_prop
)
20033 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20034 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20036 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20037 return (invis
== 0 ? Qnil
20039 : make_number (invis
));
20042 /* Calculate a width or height in pixels from a specification using
20043 the following elements:
20046 NUM - a (fractional) multiple of the default font width/height
20047 (NUM) - specifies exactly NUM pixels
20048 UNIT - a fixed number of pixels, see below.
20049 ELEMENT - size of a display element in pixels, see below.
20050 (NUM . SPEC) - equals NUM * SPEC
20051 (+ SPEC SPEC ...) - add pixel values
20052 (- SPEC SPEC ...) - subtract pixel values
20053 (- SPEC) - negate pixel value
20056 INT or FLOAT - a number constant
20057 SYMBOL - use symbol's (buffer local) variable binding.
20060 in - pixels per inch *)
20061 mm - pixels per 1/1000 meter *)
20062 cm - pixels per 1/100 meter *)
20063 width - width of current font in pixels.
20064 height - height of current font in pixels.
20066 *) using the ratio(s) defined in display-pixels-per-inch.
20070 left-fringe - left fringe width in pixels
20071 right-fringe - right fringe width in pixels
20073 left-margin - left margin width in pixels
20074 right-margin - right margin width in pixels
20076 scroll-bar - scroll-bar area width in pixels
20080 Pixels corresponding to 5 inches:
20083 Total width of non-text areas on left side of window (if scroll-bar is on left):
20084 '(space :width (+ left-fringe left-margin scroll-bar))
20086 Align to first text column (in header line):
20087 '(space :align-to 0)
20089 Align to middle of text area minus half the width of variable `my-image'
20090 containing a loaded image:
20091 '(space :align-to (0.5 . (- text my-image)))
20093 Width of left margin minus width of 1 character in the default font:
20094 '(space :width (- left-margin 1))
20096 Width of left margin minus width of 2 characters in the current font:
20097 '(space :width (- left-margin (2 . width)))
20099 Center 1 character over left-margin (in header line):
20100 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20102 Different ways to express width of left fringe plus left margin minus one pixel:
20103 '(space :width (- (+ left-fringe left-margin) (1)))
20104 '(space :width (+ left-fringe left-margin (- (1))))
20105 '(space :width (+ left-fringe left-margin (-1)))
20109 #define NUMVAL(X) \
20110 ((INTEGERP (X) || FLOATP (X)) \
20115 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20116 struct font
*font
, int width_p
, int *align_to
)
20120 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20121 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20124 return OK_PIXELS (0);
20126 xassert (FRAME_LIVE_P (it
->f
));
20128 if (SYMBOLP (prop
))
20130 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20132 char *unit
= SDATA (SYMBOL_NAME (prop
));
20134 if (unit
[0] == 'i' && unit
[1] == 'n')
20136 else if (unit
[0] == 'm' && unit
[1] == 'm')
20138 else if (unit
[0] == 'c' && unit
[1] == 'm')
20145 #ifdef HAVE_WINDOW_SYSTEM
20146 if (FRAME_WINDOW_P (it
->f
)
20148 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20149 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20151 return OK_PIXELS (ppi
/ pixels
);
20154 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20155 || (CONSP (Vdisplay_pixels_per_inch
)
20157 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20158 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20160 return OK_PIXELS (ppi
/ pixels
);
20166 #ifdef HAVE_WINDOW_SYSTEM
20167 if (EQ (prop
, Qheight
))
20168 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20169 if (EQ (prop
, Qwidth
))
20170 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20172 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20173 return OK_PIXELS (1);
20176 if (EQ (prop
, Qtext
))
20177 return OK_PIXELS (width_p
20178 ? window_box_width (it
->w
, TEXT_AREA
)
20179 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20181 if (align_to
&& *align_to
< 0)
20184 if (EQ (prop
, Qleft
))
20185 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20186 if (EQ (prop
, Qright
))
20187 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20188 if (EQ (prop
, Qcenter
))
20189 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20190 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20191 if (EQ (prop
, Qleft_fringe
))
20192 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20193 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20194 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20195 if (EQ (prop
, Qright_fringe
))
20196 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20197 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20198 : window_box_right_offset (it
->w
, TEXT_AREA
));
20199 if (EQ (prop
, Qleft_margin
))
20200 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20201 if (EQ (prop
, Qright_margin
))
20202 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20203 if (EQ (prop
, Qscroll_bar
))
20204 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20206 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20207 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20208 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20213 if (EQ (prop
, Qleft_fringe
))
20214 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20215 if (EQ (prop
, Qright_fringe
))
20216 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20217 if (EQ (prop
, Qleft_margin
))
20218 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20219 if (EQ (prop
, Qright_margin
))
20220 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20221 if (EQ (prop
, Qscroll_bar
))
20222 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20225 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20228 if (INTEGERP (prop
) || FLOATP (prop
))
20230 int base_unit
= (width_p
20231 ? FRAME_COLUMN_WIDTH (it
->f
)
20232 : FRAME_LINE_HEIGHT (it
->f
));
20233 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20238 Lisp_Object car
= XCAR (prop
);
20239 Lisp_Object cdr
= XCDR (prop
);
20243 #ifdef HAVE_WINDOW_SYSTEM
20244 if (FRAME_WINDOW_P (it
->f
)
20245 && valid_image_p (prop
))
20247 int id
= lookup_image (it
->f
, prop
);
20248 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20250 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20253 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20259 while (CONSP (cdr
))
20261 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20262 font
, width_p
, align_to
))
20265 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20270 if (EQ (car
, Qminus
))
20272 return OK_PIXELS (pixels
);
20275 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20278 if (INTEGERP (car
) || FLOATP (car
))
20281 pixels
= XFLOATINT (car
);
20283 return OK_PIXELS (pixels
);
20284 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20285 font
, width_p
, align_to
))
20286 return OK_PIXELS (pixels
* fact
);
20297 /***********************************************************************
20299 ***********************************************************************/
20301 #ifdef HAVE_WINDOW_SYSTEM
20306 dump_glyph_string (s
)
20307 struct glyph_string
*s
;
20309 fprintf (stderr
, "glyph string\n");
20310 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20311 s
->x
, s
->y
, s
->width
, s
->height
);
20312 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20313 fprintf (stderr
, " hl = %d\n", s
->hl
);
20314 fprintf (stderr
, " left overhang = %d, right = %d\n",
20315 s
->left_overhang
, s
->right_overhang
);
20316 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20317 fprintf (stderr
, " extends to end of line = %d\n",
20318 s
->extends_to_end_of_line_p
);
20319 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20320 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20323 #endif /* GLYPH_DEBUG */
20325 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20326 of XChar2b structures for S; it can't be allocated in
20327 init_glyph_string because it must be allocated via `alloca'. W
20328 is the window on which S is drawn. ROW and AREA are the glyph row
20329 and area within the row from which S is constructed. START is the
20330 index of the first glyph structure covered by S. HL is a
20331 face-override for drawing S. */
20334 #define OPTIONAL_HDC(hdc) HDC hdc,
20335 #define DECLARE_HDC(hdc) HDC hdc;
20336 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20337 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20340 #ifndef OPTIONAL_HDC
20341 #define OPTIONAL_HDC(hdc)
20342 #define DECLARE_HDC(hdc)
20343 #define ALLOCATE_HDC(hdc, f)
20344 #define RELEASE_HDC(hdc, f)
20348 init_glyph_string (struct glyph_string
*s
,
20350 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20351 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20353 memset (s
, 0, sizeof *s
);
20355 s
->f
= XFRAME (w
->frame
);
20359 s
->display
= FRAME_X_DISPLAY (s
->f
);
20360 s
->window
= FRAME_X_WINDOW (s
->f
);
20361 s
->char2b
= char2b
;
20365 s
->first_glyph
= row
->glyphs
[area
] + start
;
20366 s
->height
= row
->height
;
20367 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20368 s
->ybase
= s
->y
+ row
->ascent
;
20372 /* Append the list of glyph strings with head H and tail T to the list
20373 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20376 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20377 struct glyph_string
*h
, struct glyph_string
*t
)
20391 /* Prepend the list of glyph strings with head H and tail T to the
20392 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20396 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20397 struct glyph_string
*h
, struct glyph_string
*t
)
20411 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20412 Set *HEAD and *TAIL to the resulting list. */
20415 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20416 struct glyph_string
*s
)
20418 s
->next
= s
->prev
= NULL
;
20419 append_glyph_string_lists (head
, tail
, s
, s
);
20423 /* Get face and two-byte form of character C in face FACE_ID on frame
20424 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20425 means we want to display multibyte text. DISPLAY_P non-zero means
20426 make sure that X resources for the face returned are allocated.
20427 Value is a pointer to a realized face that is ready for display if
20428 DISPLAY_P is non-zero. */
20430 static INLINE
struct face
*
20431 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20432 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20434 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20438 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20440 if (code
!= FONT_INVALID_CODE
)
20441 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20443 STORE_XCHAR2B (char2b
, 0, 0);
20446 /* Make sure X resources of the face are allocated. */
20447 #ifdef HAVE_X_WINDOWS
20451 xassert (face
!= NULL
);
20452 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20459 /* Get face and two-byte form of character glyph GLYPH on frame F.
20460 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20461 a pointer to a realized face that is ready for display. */
20463 static INLINE
struct face
*
20464 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20465 XChar2b
*char2b
, int *two_byte_p
)
20469 xassert (glyph
->type
== CHAR_GLYPH
);
20470 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20479 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20480 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20482 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20484 if (code
!= FONT_INVALID_CODE
)
20485 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20487 STORE_XCHAR2B (char2b
, 0, 0);
20490 /* Make sure X resources of the face are allocated. */
20491 xassert (face
!= NULL
);
20492 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20497 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20498 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20501 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20505 if (CHAR_BYTE8_P (c
))
20506 code
= CHAR_TO_BYTE8 (c
);
20508 code
= font
->driver
->encode_char (font
, c
);
20510 if (code
== FONT_INVALID_CODE
)
20512 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20517 /* Fill glyph string S with composition components specified by S->cmp.
20519 BASE_FACE is the base face of the composition.
20520 S->cmp_from is the index of the first component for S.
20522 OVERLAPS non-zero means S should draw the foreground only, and use
20523 its physical height for clipping. See also draw_glyphs.
20525 Value is the index of a component not in S. */
20528 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20532 /* For all glyphs of this composition, starting at the offset
20533 S->cmp_from, until we reach the end of the definition or encounter a
20534 glyph that requires the different face, add it to S. */
20539 s
->for_overlaps
= overlaps
;
20542 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20544 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20548 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20551 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20552 s
->char2b
+ i
, 1, 1);
20558 s
->font
= s
->face
->font
;
20560 else if (s
->face
!= face
)
20568 /* All glyph strings for the same composition has the same width,
20569 i.e. the width set for the first component of the composition. */
20570 s
->width
= s
->first_glyph
->pixel_width
;
20572 /* If the specified font could not be loaded, use the frame's
20573 default font, but record the fact that we couldn't load it in
20574 the glyph string so that we can draw rectangles for the
20575 characters of the glyph string. */
20576 if (s
->font
== NULL
)
20578 s
->font_not_found_p
= 1;
20579 s
->font
= FRAME_FONT (s
->f
);
20582 /* Adjust base line for subscript/superscript text. */
20583 s
->ybase
+= s
->first_glyph
->voffset
;
20585 /* This glyph string must always be drawn with 16-bit functions. */
20592 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20593 int start
, int end
, int overlaps
)
20595 struct glyph
*glyph
, *last
;
20596 Lisp_Object lgstring
;
20599 s
->for_overlaps
= overlaps
;
20600 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20601 last
= s
->row
->glyphs
[s
->area
] + end
;
20602 s
->cmp_id
= glyph
->u
.cmp
.id
;
20603 s
->cmp_from
= glyph
->u
.cmp
.from
;
20604 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20605 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20606 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20607 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20609 while (glyph
< last
20610 && glyph
->u
.cmp
.automatic
20611 && glyph
->u
.cmp
.id
== s
->cmp_id
20612 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20613 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20615 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20617 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20618 unsigned code
= LGLYPH_CODE (lglyph
);
20620 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20622 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20623 return glyph
- s
->row
->glyphs
[s
->area
];
20627 /* Fill glyph string S from a sequence of character glyphs.
20629 FACE_ID is the face id of the string. START is the index of the
20630 first glyph to consider, END is the index of the last + 1.
20631 OVERLAPS non-zero means S should draw the foreground only, and use
20632 its physical height for clipping. See also draw_glyphs.
20634 Value is the index of the first glyph not in S. */
20637 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20638 int start
, int end
, int overlaps
)
20640 struct glyph
*glyph
, *last
;
20642 int glyph_not_available_p
;
20644 xassert (s
->f
== XFRAME (s
->w
->frame
));
20645 xassert (s
->nchars
== 0);
20646 xassert (start
>= 0 && end
> start
);
20648 s
->for_overlaps
= overlaps
;
20649 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20650 last
= s
->row
->glyphs
[s
->area
] + end
;
20651 voffset
= glyph
->voffset
;
20652 s
->padding_p
= glyph
->padding_p
;
20653 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20655 while (glyph
< last
20656 && glyph
->type
== CHAR_GLYPH
20657 && glyph
->voffset
== voffset
20658 /* Same face id implies same font, nowadays. */
20659 && glyph
->face_id
== face_id
20660 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20664 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20665 s
->char2b
+ s
->nchars
,
20667 s
->two_byte_p
= two_byte_p
;
20669 xassert (s
->nchars
<= end
- start
);
20670 s
->width
+= glyph
->pixel_width
;
20671 if (glyph
++->padding_p
!= s
->padding_p
)
20675 s
->font
= s
->face
->font
;
20677 /* If the specified font could not be loaded, use the frame's font,
20678 but record the fact that we couldn't load it in
20679 S->font_not_found_p so that we can draw rectangles for the
20680 characters of the glyph string. */
20681 if (s
->font
== NULL
|| glyph_not_available_p
)
20683 s
->font_not_found_p
= 1;
20684 s
->font
= FRAME_FONT (s
->f
);
20687 /* Adjust base line for subscript/superscript text. */
20688 s
->ybase
+= voffset
;
20690 xassert (s
->face
&& s
->face
->gc
);
20691 return glyph
- s
->row
->glyphs
[s
->area
];
20695 /* Fill glyph string S from image glyph S->first_glyph. */
20698 fill_image_glyph_string (struct glyph_string
*s
)
20700 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20701 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20703 s
->slice
= s
->first_glyph
->slice
;
20704 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20705 s
->font
= s
->face
->font
;
20706 s
->width
= s
->first_glyph
->pixel_width
;
20708 /* Adjust base line for subscript/superscript text. */
20709 s
->ybase
+= s
->first_glyph
->voffset
;
20713 /* Fill glyph string S from a sequence of stretch glyphs.
20715 ROW is the glyph row in which the glyphs are found, AREA is the
20716 area within the row. START is the index of the first glyph to
20717 consider, END is the index of the last + 1.
20719 Value is the index of the first glyph not in S. */
20722 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20723 enum glyph_row_area area
, int start
, int end
)
20725 struct glyph
*glyph
, *last
;
20726 int voffset
, face_id
;
20728 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20730 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20731 last
= s
->row
->glyphs
[s
->area
] + end
;
20732 face_id
= glyph
->face_id
;
20733 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20734 s
->font
= s
->face
->font
;
20735 s
->width
= glyph
->pixel_width
;
20737 voffset
= glyph
->voffset
;
20741 && glyph
->type
== STRETCH_GLYPH
20742 && glyph
->voffset
== voffset
20743 && glyph
->face_id
== face_id
);
20745 s
->width
+= glyph
->pixel_width
;
20747 /* Adjust base line for subscript/superscript text. */
20748 s
->ybase
+= voffset
;
20750 /* The case that face->gc == 0 is handled when drawing the glyph
20751 string by calling PREPARE_FACE_FOR_DISPLAY. */
20753 return glyph
- s
->row
->glyphs
[s
->area
];
20756 static struct font_metrics
*
20757 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20759 static struct font_metrics metrics
;
20760 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20762 if (! font
|| code
== FONT_INVALID_CODE
)
20764 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20769 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20770 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20771 assumed to be zero. */
20774 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20776 *left
= *right
= 0;
20778 if (glyph
->type
== CHAR_GLYPH
)
20782 struct font_metrics
*pcm
;
20784 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20785 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20787 if (pcm
->rbearing
> pcm
->width
)
20788 *right
= pcm
->rbearing
- pcm
->width
;
20789 if (pcm
->lbearing
< 0)
20790 *left
= -pcm
->lbearing
;
20793 else if (glyph
->type
== COMPOSITE_GLYPH
)
20795 if (! glyph
->u
.cmp
.automatic
)
20797 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20799 if (cmp
->rbearing
> cmp
->pixel_width
)
20800 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20801 if (cmp
->lbearing
< 0)
20802 *left
= - cmp
->lbearing
;
20806 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20807 struct font_metrics metrics
;
20809 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20810 glyph
->u
.cmp
.to
+ 1, &metrics
);
20811 if (metrics
.rbearing
> metrics
.width
)
20812 *right
= metrics
.rbearing
- metrics
.width
;
20813 if (metrics
.lbearing
< 0)
20814 *left
= - metrics
.lbearing
;
20820 /* Return the index of the first glyph preceding glyph string S that
20821 is overwritten by S because of S's left overhang. Value is -1
20822 if no glyphs are overwritten. */
20825 left_overwritten (struct glyph_string
*s
)
20829 if (s
->left_overhang
)
20832 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20833 int first
= s
->first_glyph
- glyphs
;
20835 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20836 x
-= glyphs
[i
].pixel_width
;
20847 /* Return the index of the first glyph preceding glyph string S that
20848 is overwriting S because of its right overhang. Value is -1 if no
20849 glyph in front of S overwrites S. */
20852 left_overwriting (struct glyph_string
*s
)
20855 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20856 int first
= s
->first_glyph
- glyphs
;
20860 for (i
= first
- 1; i
>= 0; --i
)
20863 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20866 x
-= glyphs
[i
].pixel_width
;
20873 /* Return the index of the last glyph following glyph string S that is
20874 overwritten by S because of S's right overhang. Value is -1 if
20875 no such glyph is found. */
20878 right_overwritten (struct glyph_string
*s
)
20882 if (s
->right_overhang
)
20885 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20886 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20887 int end
= s
->row
->used
[s
->area
];
20889 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20890 x
+= glyphs
[i
].pixel_width
;
20899 /* Return the index of the last glyph following glyph string S that
20900 overwrites S because of its left overhang. Value is negative
20901 if no such glyph is found. */
20904 right_overwriting (struct glyph_string
*s
)
20907 int end
= s
->row
->used
[s
->area
];
20908 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20909 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20913 for (i
= first
; i
< end
; ++i
)
20916 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20919 x
+= glyphs
[i
].pixel_width
;
20926 /* Set background width of glyph string S. START is the index of the
20927 first glyph following S. LAST_X is the right-most x-position + 1
20928 in the drawing area. */
20931 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20933 /* If the face of this glyph string has to be drawn to the end of
20934 the drawing area, set S->extends_to_end_of_line_p. */
20936 if (start
== s
->row
->used
[s
->area
]
20937 && s
->area
== TEXT_AREA
20938 && ((s
->row
->fill_line_p
20939 && (s
->hl
== DRAW_NORMAL_TEXT
20940 || s
->hl
== DRAW_IMAGE_RAISED
20941 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20942 || s
->hl
== DRAW_MOUSE_FACE
))
20943 s
->extends_to_end_of_line_p
= 1;
20945 /* If S extends its face to the end of the line, set its
20946 background_width to the distance to the right edge of the drawing
20948 if (s
->extends_to_end_of_line_p
)
20949 s
->background_width
= last_x
- s
->x
+ 1;
20951 s
->background_width
= s
->width
;
20955 /* Compute overhangs and x-positions for glyph string S and its
20956 predecessors, or successors. X is the starting x-position for S.
20957 BACKWARD_P non-zero means process predecessors. */
20960 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20966 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20967 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20977 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20978 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20988 /* The following macros are only called from draw_glyphs below.
20989 They reference the following parameters of that function directly:
20990 `w', `row', `area', and `overlap_p'
20991 as well as the following local variables:
20992 `s', `f', and `hdc' (in W32) */
20995 /* On W32, silently add local `hdc' variable to argument list of
20996 init_glyph_string. */
20997 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20998 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21000 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21001 init_glyph_string (s, char2b, w, row, area, start, hl)
21004 /* Add a glyph string for a stretch glyph to the list of strings
21005 between HEAD and TAIL. START is the index of the stretch glyph in
21006 row area AREA of glyph row ROW. END is the index of the last glyph
21007 in that glyph row area. X is the current output position assigned
21008 to the new glyph string constructed. HL overrides that face of the
21009 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21010 is the right-most x-position of the drawing area. */
21012 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21013 and below -- keep them on one line. */
21014 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21017 s = (struct glyph_string *) alloca (sizeof *s); \
21018 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21019 START = fill_stretch_glyph_string (s, row, area, START, END); \
21020 append_glyph_string (&HEAD, &TAIL, s); \
21026 /* Add a glyph string for an image glyph to the list of strings
21027 between HEAD and TAIL. START is the index of the image glyph in
21028 row area AREA of glyph row ROW. END is the index of the last glyph
21029 in that glyph row area. X is the current output position assigned
21030 to the new glyph string constructed. HL overrides that face of the
21031 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21032 is the right-most x-position of the drawing area. */
21034 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21037 s = (struct glyph_string *) alloca (sizeof *s); \
21038 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21039 fill_image_glyph_string (s); \
21040 append_glyph_string (&HEAD, &TAIL, s); \
21047 /* Add a glyph string for a sequence of character glyphs to the list
21048 of strings between HEAD and TAIL. START is the index of the first
21049 glyph in row area AREA of glyph row ROW that is part of the new
21050 glyph string. END is the index of the last glyph in that glyph row
21051 area. X is the current output position assigned to the new glyph
21052 string constructed. HL overrides that face of the glyph; e.g. it
21053 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21054 right-most x-position of the drawing area. */
21056 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21062 face_id = (row)->glyphs[area][START].face_id; \
21064 s = (struct glyph_string *) alloca (sizeof *s); \
21065 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21066 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21067 append_glyph_string (&HEAD, &TAIL, s); \
21069 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21074 /* Add a glyph string for a composite sequence to the list of strings
21075 between HEAD and TAIL. START is the index of the first glyph in
21076 row area AREA of glyph row ROW that is part of the new glyph
21077 string. END is the index of the last glyph in that glyph row area.
21078 X is the current output position assigned to the new glyph string
21079 constructed. HL overrides that face of the glyph; e.g. it is
21080 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21081 x-position of the drawing area. */
21083 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21085 int face_id = (row)->glyphs[area][START].face_id; \
21086 struct face *base_face = FACE_FROM_ID (f, face_id); \
21087 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21088 struct composition *cmp = composition_table[cmp_id]; \
21090 struct glyph_string *first_s; \
21093 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21095 /* Make glyph_strings for each glyph sequence that is drawable by \
21096 the same face, and append them to HEAD/TAIL. */ \
21097 for (n = 0; n < cmp->glyph_len;) \
21099 s = (struct glyph_string *) alloca (sizeof *s); \
21100 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21101 append_glyph_string (&(HEAD), &(TAIL), s); \
21107 n = fill_composite_glyph_string (s, base_face, overlaps); \
21115 /* Add a glyph string for a glyph-string sequence to the list of strings
21116 between HEAD and TAIL. */
21118 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21122 Lisp_Object gstring; \
21124 face_id = (row)->glyphs[area][START].face_id; \
21125 gstring = (composition_gstring_from_id \
21126 ((row)->glyphs[area][START].u.cmp.id)); \
21127 s = (struct glyph_string *) alloca (sizeof *s); \
21128 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21129 * LGSTRING_GLYPH_LEN (gstring)); \
21130 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21131 append_glyph_string (&(HEAD), &(TAIL), s); \
21133 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21137 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21138 of AREA of glyph row ROW on window W between indices START and END.
21139 HL overrides the face for drawing glyph strings, e.g. it is
21140 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21141 x-positions of the drawing area.
21143 This is an ugly monster macro construct because we must use alloca
21144 to allocate glyph strings (because draw_glyphs can be called
21145 asynchronously). */
21147 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21150 HEAD = TAIL = NULL; \
21151 while (START < END) \
21153 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21154 switch (first_glyph->type) \
21157 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21161 case COMPOSITE_GLYPH: \
21162 if (first_glyph->u.cmp.automatic) \
21163 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21166 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21170 case STRETCH_GLYPH: \
21171 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21175 case IMAGE_GLYPH: \
21176 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21186 set_glyph_string_background_width (s, START, LAST_X); \
21193 /* Draw glyphs between START and END in AREA of ROW on window W,
21194 starting at x-position X. X is relative to AREA in W. HL is a
21195 face-override with the following meaning:
21197 DRAW_NORMAL_TEXT draw normally
21198 DRAW_CURSOR draw in cursor face
21199 DRAW_MOUSE_FACE draw in mouse face.
21200 DRAW_INVERSE_VIDEO draw in mode line face
21201 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21202 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21204 If OVERLAPS is non-zero, draw only the foreground of characters and
21205 clip to the physical height of ROW. Non-zero value also defines
21206 the overlapping part to be drawn:
21208 OVERLAPS_PRED overlap with preceding rows
21209 OVERLAPS_SUCC overlap with succeeding rows
21210 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21211 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21213 Value is the x-position reached, relative to AREA of W. */
21216 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21217 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21218 enum draw_glyphs_face hl
, int overlaps
)
21220 struct glyph_string
*head
, *tail
;
21221 struct glyph_string
*s
;
21222 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21223 int i
, j
, x_reached
, last_x
, area_left
= 0;
21224 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21227 ALLOCATE_HDC (hdc
, f
);
21229 /* Let's rather be paranoid than getting a SEGV. */
21230 end
= min (end
, row
->used
[area
]);
21231 start
= max (0, start
);
21232 start
= min (end
, start
);
21234 /* Translate X to frame coordinates. Set last_x to the right
21235 end of the drawing area. */
21236 if (row
->full_width_p
)
21238 /* X is relative to the left edge of W, without scroll bars
21240 area_left
= WINDOW_LEFT_EDGE_X (w
);
21241 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21245 area_left
= window_box_left (w
, area
);
21246 last_x
= area_left
+ window_box_width (w
, area
);
21250 /* Build a doubly-linked list of glyph_string structures between
21251 head and tail from what we have to draw. Note that the macro
21252 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21253 the reason we use a separate variable `i'. */
21255 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21257 x_reached
= tail
->x
+ tail
->background_width
;
21261 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21262 the row, redraw some glyphs in front or following the glyph
21263 strings built above. */
21264 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21266 struct glyph_string
*h
, *t
;
21267 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21268 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21271 /* If mouse highlighting is on, we may need to draw adjacent
21272 glyphs using mouse-face highlighting. */
21273 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21275 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21277 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21278 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21280 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21282 check_mouse_face
= 1;
21283 mouse_beg_col
= (row
== mouse_beg_row
)
21284 ? dpyinfo
->mouse_face_beg_col
: 0;
21285 mouse_end_col
= (row
== mouse_end_row
)
21286 ? dpyinfo
->mouse_face_end_col
21287 : row
->used
[TEXT_AREA
];
21291 /* Compute overhangs for all glyph strings. */
21292 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21293 for (s
= head
; s
; s
= s
->next
)
21294 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21296 /* Prepend glyph strings for glyphs in front of the first glyph
21297 string that are overwritten because of the first glyph
21298 string's left overhang. The background of all strings
21299 prepended must be drawn because the first glyph string
21301 i
= left_overwritten (head
);
21304 enum draw_glyphs_face overlap_hl
;
21306 /* If this row contains mouse highlighting, attempt to draw
21307 the overlapped glyphs with the correct highlight. This
21308 code fails if the overlap encompasses more than one glyph
21309 and mouse-highlight spans only some of these glyphs.
21310 However, making it work perfectly involves a lot more
21311 code, and I don't know if the pathological case occurs in
21312 practice, so we'll stick to this for now. --- cyd */
21313 if (check_mouse_face
21314 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21315 overlap_hl
= DRAW_MOUSE_FACE
;
21317 overlap_hl
= DRAW_NORMAL_TEXT
;
21320 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21321 overlap_hl
, dummy_x
, last_x
);
21323 compute_overhangs_and_x (t
, head
->x
, 1);
21324 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21328 /* Prepend glyph strings for glyphs in front of the first glyph
21329 string that overwrite that glyph string because of their
21330 right overhang. For these strings, only the foreground must
21331 be drawn, because it draws over the glyph string at `head'.
21332 The background must not be drawn because this would overwrite
21333 right overhangs of preceding glyphs for which no glyph
21335 i
= left_overwriting (head
);
21338 enum draw_glyphs_face overlap_hl
;
21340 if (check_mouse_face
21341 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21342 overlap_hl
= DRAW_MOUSE_FACE
;
21344 overlap_hl
= DRAW_NORMAL_TEXT
;
21347 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21348 overlap_hl
, dummy_x
, last_x
);
21349 for (s
= h
; s
; s
= s
->next
)
21350 s
->background_filled_p
= 1;
21351 compute_overhangs_and_x (t
, head
->x
, 1);
21352 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21355 /* Append glyphs strings for glyphs following the last glyph
21356 string tail that are overwritten by tail. The background of
21357 these strings has to be drawn because tail's foreground draws
21359 i
= right_overwritten (tail
);
21362 enum draw_glyphs_face overlap_hl
;
21364 if (check_mouse_face
21365 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21366 overlap_hl
= DRAW_MOUSE_FACE
;
21368 overlap_hl
= DRAW_NORMAL_TEXT
;
21370 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21371 overlap_hl
, x
, last_x
);
21372 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21373 we don't have `end = i;' here. */
21374 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21375 append_glyph_string_lists (&head
, &tail
, h
, t
);
21379 /* Append glyph strings for glyphs following the last glyph
21380 string tail that overwrite tail. The foreground of such
21381 glyphs has to be drawn because it writes into the background
21382 of tail. The background must not be drawn because it could
21383 paint over the foreground of following glyphs. */
21384 i
= right_overwriting (tail
);
21387 enum draw_glyphs_face overlap_hl
;
21388 if (check_mouse_face
21389 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21390 overlap_hl
= DRAW_MOUSE_FACE
;
21392 overlap_hl
= DRAW_NORMAL_TEXT
;
21395 i
++; /* We must include the Ith glyph. */
21396 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21397 overlap_hl
, x
, last_x
);
21398 for (s
= h
; s
; s
= s
->next
)
21399 s
->background_filled_p
= 1;
21400 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21401 append_glyph_string_lists (&head
, &tail
, h
, t
);
21403 if (clip_head
|| clip_tail
)
21404 for (s
= head
; s
; s
= s
->next
)
21406 s
->clip_head
= clip_head
;
21407 s
->clip_tail
= clip_tail
;
21411 /* Draw all strings. */
21412 for (s
= head
; s
; s
= s
->next
)
21413 FRAME_RIF (f
)->draw_glyph_string (s
);
21416 /* When focus a sole frame and move horizontally, this sets on_p to 0
21417 causing a failure to erase prev cursor position. */
21418 if (area
== TEXT_AREA
21419 && !row
->full_width_p
21420 /* When drawing overlapping rows, only the glyph strings'
21421 foreground is drawn, which doesn't erase a cursor
21425 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21426 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21427 : (tail
? tail
->x
+ tail
->background_width
: x
));
21431 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21432 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21436 /* Value is the x-position up to which drawn, relative to AREA of W.
21437 This doesn't include parts drawn because of overhangs. */
21438 if (row
->full_width_p
)
21439 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21441 x_reached
-= area_left
;
21443 RELEASE_HDC (hdc
, f
);
21448 /* Expand row matrix if too narrow. Don't expand if area
21451 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21453 if (!fonts_changed_p \
21454 && (it->glyph_row->glyphs[area] \
21455 < it->glyph_row->glyphs[area + 1])) \
21457 it->w->ncols_scale_factor++; \
21458 fonts_changed_p = 1; \
21462 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21463 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21466 append_glyph (struct it
*it
)
21468 struct glyph
*glyph
;
21469 enum glyph_row_area area
= it
->area
;
21471 xassert (it
->glyph_row
);
21472 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21474 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21475 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21477 /* If the glyph row is reversed, we need to prepend the glyph
21478 rather than append it. */
21479 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21483 /* Make room for the additional glyph. */
21484 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21486 glyph
= it
->glyph_row
->glyphs
[area
];
21488 glyph
->charpos
= CHARPOS (it
->position
);
21489 glyph
->object
= it
->object
;
21490 if (it
->pixel_width
> 0)
21492 glyph
->pixel_width
= it
->pixel_width
;
21493 glyph
->padding_p
= 0;
21497 /* Assure at least 1-pixel width. Otherwise, cursor can't
21498 be displayed correctly. */
21499 glyph
->pixel_width
= 1;
21500 glyph
->padding_p
= 1;
21502 glyph
->ascent
= it
->ascent
;
21503 glyph
->descent
= it
->descent
;
21504 glyph
->voffset
= it
->voffset
;
21505 glyph
->type
= CHAR_GLYPH
;
21506 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21507 glyph
->multibyte_p
= it
->multibyte_p
;
21508 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21509 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21510 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21511 || it
->phys_descent
> it
->descent
);
21512 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21513 glyph
->face_id
= it
->face_id
;
21514 glyph
->u
.ch
= it
->char_to_display
;
21515 glyph
->slice
= null_glyph_slice
;
21516 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21519 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21520 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21522 glyph
->bidi_type
= it
->bidi_it
.type
;
21526 glyph
->resolved_level
= 0;
21527 glyph
->bidi_type
= UNKNOWN_BT
;
21529 ++it
->glyph_row
->used
[area
];
21532 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21535 /* Store one glyph for the composition IT->cmp_it.id in
21536 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21540 append_composite_glyph (struct it
*it
)
21542 struct glyph
*glyph
;
21543 enum glyph_row_area area
= it
->area
;
21545 xassert (it
->glyph_row
);
21547 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21548 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21550 /* If the glyph row is reversed, we need to prepend the glyph
21551 rather than append it. */
21552 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21556 /* Make room for the new glyph. */
21557 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21559 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21561 glyph
->charpos
= it
->cmp_it
.charpos
;
21562 glyph
->object
= it
->object
;
21563 glyph
->pixel_width
= it
->pixel_width
;
21564 glyph
->ascent
= it
->ascent
;
21565 glyph
->descent
= it
->descent
;
21566 glyph
->voffset
= it
->voffset
;
21567 glyph
->type
= COMPOSITE_GLYPH
;
21568 if (it
->cmp_it
.ch
< 0)
21570 glyph
->u
.cmp
.automatic
= 0;
21571 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21575 glyph
->u
.cmp
.automatic
= 1;
21576 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21577 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21578 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21580 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21581 glyph
->multibyte_p
= it
->multibyte_p
;
21582 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21583 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21584 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21585 || it
->phys_descent
> it
->descent
);
21586 glyph
->padding_p
= 0;
21587 glyph
->glyph_not_available_p
= 0;
21588 glyph
->face_id
= it
->face_id
;
21589 glyph
->slice
= null_glyph_slice
;
21590 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21593 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21594 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21596 glyph
->bidi_type
= it
->bidi_it
.type
;
21598 ++it
->glyph_row
->used
[area
];
21601 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21605 /* Change IT->ascent and IT->height according to the setting of
21609 take_vertical_position_into_account (struct it
*it
)
21613 if (it
->voffset
< 0)
21614 /* Increase the ascent so that we can display the text higher
21616 it
->ascent
-= it
->voffset
;
21618 /* Increase the descent so that we can display the text lower
21620 it
->descent
+= it
->voffset
;
21625 /* Produce glyphs/get display metrics for the image IT is loaded with.
21626 See the description of struct display_iterator in dispextern.h for
21627 an overview of struct display_iterator. */
21630 produce_image_glyph (struct it
*it
)
21634 int glyph_ascent
, crop
;
21635 struct glyph_slice slice
;
21637 xassert (it
->what
== IT_IMAGE
);
21639 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21641 /* Make sure X resources of the face is loaded. */
21642 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21644 if (it
->image_id
< 0)
21646 /* Fringe bitmap. */
21647 it
->ascent
= it
->phys_ascent
= 0;
21648 it
->descent
= it
->phys_descent
= 0;
21649 it
->pixel_width
= 0;
21654 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21656 /* Make sure X resources of the image is loaded. */
21657 prepare_image_for_display (it
->f
, img
);
21659 slice
.x
= slice
.y
= 0;
21660 slice
.width
= img
->width
;
21661 slice
.height
= img
->height
;
21663 if (INTEGERP (it
->slice
.x
))
21664 slice
.x
= XINT (it
->slice
.x
);
21665 else if (FLOATP (it
->slice
.x
))
21666 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21668 if (INTEGERP (it
->slice
.y
))
21669 slice
.y
= XINT (it
->slice
.y
);
21670 else if (FLOATP (it
->slice
.y
))
21671 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21673 if (INTEGERP (it
->slice
.width
))
21674 slice
.width
= XINT (it
->slice
.width
);
21675 else if (FLOATP (it
->slice
.width
))
21676 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21678 if (INTEGERP (it
->slice
.height
))
21679 slice
.height
= XINT (it
->slice
.height
);
21680 else if (FLOATP (it
->slice
.height
))
21681 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21683 if (slice
.x
>= img
->width
)
21684 slice
.x
= img
->width
;
21685 if (slice
.y
>= img
->height
)
21686 slice
.y
= img
->height
;
21687 if (slice
.x
+ slice
.width
>= img
->width
)
21688 slice
.width
= img
->width
- slice
.x
;
21689 if (slice
.y
+ slice
.height
> img
->height
)
21690 slice
.height
= img
->height
- slice
.y
;
21692 if (slice
.width
== 0 || slice
.height
== 0)
21695 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21697 it
->descent
= slice
.height
- glyph_ascent
;
21699 it
->descent
+= img
->vmargin
;
21700 if (slice
.y
+ slice
.height
== img
->height
)
21701 it
->descent
+= img
->vmargin
;
21702 it
->phys_descent
= it
->descent
;
21704 it
->pixel_width
= slice
.width
;
21706 it
->pixel_width
+= img
->hmargin
;
21707 if (slice
.x
+ slice
.width
== img
->width
)
21708 it
->pixel_width
+= img
->hmargin
;
21710 /* It's quite possible for images to have an ascent greater than
21711 their height, so don't get confused in that case. */
21712 if (it
->descent
< 0)
21717 if (face
->box
!= FACE_NO_BOX
)
21719 if (face
->box_line_width
> 0)
21722 it
->ascent
+= face
->box_line_width
;
21723 if (slice
.y
+ slice
.height
== img
->height
)
21724 it
->descent
+= face
->box_line_width
;
21727 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21728 it
->pixel_width
+= eabs (face
->box_line_width
);
21729 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21730 it
->pixel_width
+= eabs (face
->box_line_width
);
21733 take_vertical_position_into_account (it
);
21735 /* Automatically crop wide image glyphs at right edge so we can
21736 draw the cursor on same display row. */
21737 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21738 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21740 it
->pixel_width
-= crop
;
21741 slice
.width
-= crop
;
21746 struct glyph
*glyph
;
21747 enum glyph_row_area area
= it
->area
;
21749 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21750 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21752 glyph
->charpos
= CHARPOS (it
->position
);
21753 glyph
->object
= it
->object
;
21754 glyph
->pixel_width
= it
->pixel_width
;
21755 glyph
->ascent
= glyph_ascent
;
21756 glyph
->descent
= it
->descent
;
21757 glyph
->voffset
= it
->voffset
;
21758 glyph
->type
= IMAGE_GLYPH
;
21759 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21760 glyph
->multibyte_p
= it
->multibyte_p
;
21761 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21762 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21763 glyph
->overlaps_vertically_p
= 0;
21764 glyph
->padding_p
= 0;
21765 glyph
->glyph_not_available_p
= 0;
21766 glyph
->face_id
= it
->face_id
;
21767 glyph
->u
.img_id
= img
->id
;
21768 glyph
->slice
= slice
;
21769 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21772 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21773 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21775 glyph
->bidi_type
= it
->bidi_it
.type
;
21777 ++it
->glyph_row
->used
[area
];
21780 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21785 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21786 of the glyph, WIDTH and HEIGHT are the width and height of the
21787 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21790 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21791 int width
, int height
, int ascent
)
21793 struct glyph
*glyph
;
21794 enum glyph_row_area area
= it
->area
;
21796 xassert (ascent
>= 0 && ascent
<= height
);
21798 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21799 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21801 /* If the glyph row is reversed, we need to prepend the glyph
21802 rather than append it. */
21803 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21807 /* Make room for the additional glyph. */
21808 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21810 glyph
= it
->glyph_row
->glyphs
[area
];
21812 glyph
->charpos
= CHARPOS (it
->position
);
21813 glyph
->object
= object
;
21814 glyph
->pixel_width
= width
;
21815 glyph
->ascent
= ascent
;
21816 glyph
->descent
= height
- ascent
;
21817 glyph
->voffset
= it
->voffset
;
21818 glyph
->type
= STRETCH_GLYPH
;
21819 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21820 glyph
->multibyte_p
= it
->multibyte_p
;
21821 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21822 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21823 glyph
->overlaps_vertically_p
= 0;
21824 glyph
->padding_p
= 0;
21825 glyph
->glyph_not_available_p
= 0;
21826 glyph
->face_id
= it
->face_id
;
21827 glyph
->u
.stretch
.ascent
= ascent
;
21828 glyph
->u
.stretch
.height
= height
;
21829 glyph
->slice
= null_glyph_slice
;
21830 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21833 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21834 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21836 glyph
->bidi_type
= it
->bidi_it
.type
;
21840 glyph
->resolved_level
= 0;
21841 glyph
->bidi_type
= UNKNOWN_BT
;
21843 ++it
->glyph_row
->used
[area
];
21846 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21850 /* Produce a stretch glyph for iterator IT. IT->object is the value
21851 of the glyph property displayed. The value must be a list
21852 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21855 1. `:width WIDTH' specifies that the space should be WIDTH *
21856 canonical char width wide. WIDTH may be an integer or floating
21859 2. `:relative-width FACTOR' specifies that the width of the stretch
21860 should be computed from the width of the first character having the
21861 `glyph' property, and should be FACTOR times that width.
21863 3. `:align-to HPOS' specifies that the space should be wide enough
21864 to reach HPOS, a value in canonical character units.
21866 Exactly one of the above pairs must be present.
21868 4. `:height HEIGHT' specifies that the height of the stretch produced
21869 should be HEIGHT, measured in canonical character units.
21871 5. `:relative-height FACTOR' specifies that the height of the
21872 stretch should be FACTOR times the height of the characters having
21873 the glyph property.
21875 Either none or exactly one of 4 or 5 must be present.
21877 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21878 of the stretch should be used for the ascent of the stretch.
21879 ASCENT must be in the range 0 <= ASCENT <= 100. */
21882 produce_stretch_glyph (struct it
*it
)
21884 /* (space :width WIDTH :height HEIGHT ...) */
21885 Lisp_Object prop
, plist
;
21886 int width
= 0, height
= 0, align_to
= -1;
21887 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21891 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21893 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21895 /* List should start with `space'. */
21896 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21897 plist
= XCDR (it
->object
);
21899 /* Compute the width of the stretch. */
21900 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21901 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21903 /* Absolute width `:width WIDTH' specified and valid. */
21904 zero_width_ok_p
= 1;
21907 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21910 /* Relative width `:relative-width FACTOR' specified and valid.
21911 Compute the width of the characters having the `glyph'
21914 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21917 if (it
->multibyte_p
)
21919 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21920 - IT_BYTEPOS (*it
));
21921 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21925 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21926 if (! ASCII_CHAR_P (it2
.c
))
21927 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21930 it2
.glyph_row
= NULL
;
21931 it2
.what
= IT_CHARACTER
;
21932 x_produce_glyphs (&it2
);
21933 width
= NUMVAL (prop
) * it2
.pixel_width
;
21935 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21936 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21938 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21939 align_to
= (align_to
< 0
21941 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21942 else if (align_to
< 0)
21943 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21944 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21945 zero_width_ok_p
= 1;
21948 /* Nothing specified -> width defaults to canonical char width. */
21949 width
= FRAME_COLUMN_WIDTH (it
->f
);
21951 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21954 /* Compute height. */
21955 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21956 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21959 zero_height_ok_p
= 1;
21961 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21963 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21965 height
= FONT_HEIGHT (font
);
21967 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21970 /* Compute percentage of height used for ascent. If
21971 `:ascent ASCENT' is present and valid, use that. Otherwise,
21972 derive the ascent from the font in use. */
21973 if (prop
= Fplist_get (plist
, QCascent
),
21974 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21975 ascent
= height
* NUMVAL (prop
) / 100.0;
21976 else if (!NILP (prop
)
21977 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21978 ascent
= min (max (0, (int)tem
), height
);
21980 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21982 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21983 && it
->current_x
+ width
> it
->last_visible_x
)
21984 width
= it
->last_visible_x
- it
->current_x
- 1;
21986 if (width
> 0 && height
> 0 && it
->glyph_row
)
21988 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21989 if (!STRINGP (object
))
21990 object
= it
->w
->buffer
;
21991 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21994 it
->pixel_width
= width
;
21995 it
->ascent
= it
->phys_ascent
= ascent
;
21996 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21997 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21999 take_vertical_position_into_account (it
);
22002 /* Calculate line-height and line-spacing properties.
22003 An integer value specifies explicit pixel value.
22004 A float value specifies relative value to current face height.
22005 A cons (float . face-name) specifies relative value to
22006 height of specified face font.
22008 Returns height in pixels, or nil. */
22012 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22013 int boff
, int override
)
22015 Lisp_Object face_name
= Qnil
;
22016 int ascent
, descent
, height
;
22018 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22023 face_name
= XCAR (val
);
22025 if (!NUMBERP (val
))
22026 val
= make_number (1);
22027 if (NILP (face_name
))
22029 height
= it
->ascent
+ it
->descent
;
22034 if (NILP (face_name
))
22036 font
= FRAME_FONT (it
->f
);
22037 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22039 else if (EQ (face_name
, Qt
))
22048 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22050 return make_number (-1);
22052 face
= FACE_FROM_ID (it
->f
, face_id
);
22055 return make_number (-1);
22056 boff
= font
->baseline_offset
;
22057 if (font
->vertical_centering
)
22058 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22061 ascent
= FONT_BASE (font
) + boff
;
22062 descent
= FONT_DESCENT (font
) - boff
;
22066 it
->override_ascent
= ascent
;
22067 it
->override_descent
= descent
;
22068 it
->override_boff
= boff
;
22071 height
= ascent
+ descent
;
22075 height
= (int)(XFLOAT_DATA (val
) * height
);
22076 else if (INTEGERP (val
))
22077 height
*= XINT (val
);
22079 return make_number (height
);
22084 Produce glyphs/get display metrics for the display element IT is
22085 loaded with. See the description of struct it in dispextern.h
22086 for an overview of struct it. */
22089 x_produce_glyphs (struct it
*it
)
22091 int extra_line_spacing
= it
->extra_line_spacing
;
22093 it
->glyph_not_available_p
= 0;
22095 if (it
->what
== IT_CHARACTER
)
22098 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22099 struct font
*font
= face
->font
;
22100 int font_not_found_p
= font
== NULL
;
22101 struct font_metrics
*pcm
= NULL
;
22102 int boff
; /* baseline offset */
22104 if (font_not_found_p
)
22106 /* When no suitable font found, display an empty box based
22107 on the metrics of the font of the default face (or what
22109 struct face
*no_font_face
22110 = FACE_FROM_ID (it
->f
,
22111 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22112 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22113 font
= no_font_face
->font
;
22114 boff
= font
->baseline_offset
;
22118 boff
= font
->baseline_offset
;
22119 if (font
->vertical_centering
)
22120 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22123 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22129 if (it
->override_ascent
>= 0)
22131 it
->ascent
= it
->override_ascent
;
22132 it
->descent
= it
->override_descent
;
22133 boff
= it
->override_boff
;
22137 it
->ascent
= FONT_BASE (font
) + boff
;
22138 it
->descent
= FONT_DESCENT (font
) - boff
;
22141 if (! font_not_found_p
22142 && get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22144 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22145 if (pcm
->width
== 0
22146 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22152 it
->phys_ascent
= pcm
->ascent
+ boff
;
22153 it
->phys_descent
= pcm
->descent
- boff
;
22154 it
->pixel_width
= pcm
->width
;
22158 it
->glyph_not_available_p
= 1;
22159 it
->phys_ascent
= it
->ascent
;
22160 it
->phys_descent
= it
->descent
;
22161 it
->pixel_width
= font
->space_width
;
22164 if (it
->constrain_row_ascent_descent_p
)
22166 if (it
->descent
> it
->max_descent
)
22168 it
->ascent
+= it
->descent
- it
->max_descent
;
22169 it
->descent
= it
->max_descent
;
22171 if (it
->ascent
> it
->max_ascent
)
22173 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22174 it
->ascent
= it
->max_ascent
;
22176 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22177 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22178 extra_line_spacing
= 0;
22181 /* If this is a space inside a region of text with
22182 `space-width' property, change its width. */
22183 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22185 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22187 /* If face has a box, add the box thickness to the character
22188 height. If character has a box line to the left and/or
22189 right, add the box line width to the character's width. */
22190 if (face
->box
!= FACE_NO_BOX
)
22192 int thick
= face
->box_line_width
;
22196 it
->ascent
+= thick
;
22197 it
->descent
+= thick
;
22202 if (it
->start_of_box_run_p
)
22203 it
->pixel_width
+= thick
;
22204 if (it
->end_of_box_run_p
)
22205 it
->pixel_width
+= thick
;
22208 /* If face has an overline, add the height of the overline
22209 (1 pixel) and a 1 pixel margin to the character height. */
22210 if (face
->overline_p
)
22211 it
->ascent
+= overline_margin
;
22213 if (it
->constrain_row_ascent_descent_p
)
22215 if (it
->ascent
> it
->max_ascent
)
22216 it
->ascent
= it
->max_ascent
;
22217 if (it
->descent
> it
->max_descent
)
22218 it
->descent
= it
->max_descent
;
22221 take_vertical_position_into_account (it
);
22223 /* If we have to actually produce glyphs, do it. */
22228 /* Translate a space with a `space-width' property
22229 into a stretch glyph. */
22230 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22231 / FONT_HEIGHT (font
));
22232 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22233 it
->ascent
+ it
->descent
, ascent
);
22238 /* If characters with lbearing or rbearing are displayed
22239 in this line, record that fact in a flag of the
22240 glyph row. This is used to optimize X output code. */
22241 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22242 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22244 if (! stretched_p
&& it
->pixel_width
== 0)
22245 /* We assure that all visible glyphs have at least 1-pixel
22247 it
->pixel_width
= 1;
22249 else if (it
->char_to_display
== '\n')
22251 /* A newline has no width, but we need the height of the
22252 line. But if previous part of the line sets a height,
22253 don't increase that height */
22255 Lisp_Object height
;
22256 Lisp_Object total_height
= Qnil
;
22258 it
->override_ascent
= -1;
22259 it
->pixel_width
= 0;
22262 height
= get_it_property (it
, Qline_height
);
22263 /* Split (line-height total-height) list */
22265 && CONSP (XCDR (height
))
22266 && NILP (XCDR (XCDR (height
))))
22268 total_height
= XCAR (XCDR (height
));
22269 height
= XCAR (height
);
22271 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22273 if (it
->override_ascent
>= 0)
22275 it
->ascent
= it
->override_ascent
;
22276 it
->descent
= it
->override_descent
;
22277 boff
= it
->override_boff
;
22281 it
->ascent
= FONT_BASE (font
) + boff
;
22282 it
->descent
= FONT_DESCENT (font
) - boff
;
22285 if (EQ (height
, Qt
))
22287 if (it
->descent
> it
->max_descent
)
22289 it
->ascent
+= it
->descent
- it
->max_descent
;
22290 it
->descent
= it
->max_descent
;
22292 if (it
->ascent
> it
->max_ascent
)
22294 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22295 it
->ascent
= it
->max_ascent
;
22297 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22298 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22299 it
->constrain_row_ascent_descent_p
= 1;
22300 extra_line_spacing
= 0;
22304 Lisp_Object spacing
;
22306 it
->phys_ascent
= it
->ascent
;
22307 it
->phys_descent
= it
->descent
;
22309 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22310 && face
->box
!= FACE_NO_BOX
22311 && face
->box_line_width
> 0)
22313 it
->ascent
+= face
->box_line_width
;
22314 it
->descent
+= face
->box_line_width
;
22317 && XINT (height
) > it
->ascent
+ it
->descent
)
22318 it
->ascent
= XINT (height
) - it
->descent
;
22320 if (!NILP (total_height
))
22321 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22324 spacing
= get_it_property (it
, Qline_spacing
);
22325 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22327 if (INTEGERP (spacing
))
22329 extra_line_spacing
= XINT (spacing
);
22330 if (!NILP (total_height
))
22331 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22335 else /* i.e. (it->char_to_display == '\t') */
22337 if (font
->space_width
> 0)
22339 int tab_width
= it
->tab_width
* font
->space_width
;
22340 int x
= it
->current_x
+ it
->continuation_lines_width
;
22341 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22343 /* If the distance from the current position to the next tab
22344 stop is less than a space character width, use the
22345 tab stop after that. */
22346 if (next_tab_x
- x
< font
->space_width
)
22347 next_tab_x
+= tab_width
;
22349 it
->pixel_width
= next_tab_x
- x
;
22351 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22352 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22356 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22357 it
->ascent
+ it
->descent
, it
->ascent
);
22362 it
->pixel_width
= 0;
22367 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22369 /* A static composition.
22371 Note: A composition is represented as one glyph in the
22372 glyph matrix. There are no padding glyphs.
22374 Important note: pixel_width, ascent, and descent are the
22375 values of what is drawn by draw_glyphs (i.e. the values of
22376 the overall glyphs composed). */
22377 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22378 int boff
; /* baseline offset */
22379 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22380 int glyph_len
= cmp
->glyph_len
;
22381 struct font
*font
= face
->font
;
22385 /* If we have not yet calculated pixel size data of glyphs of
22386 the composition for the current face font, calculate them
22387 now. Theoretically, we have to check all fonts for the
22388 glyphs, but that requires much time and memory space. So,
22389 here we check only the font of the first glyph. This may
22390 lead to incorrect display, but it's very rare, and C-l
22391 (recenter-top-bottom) can correct the display anyway. */
22392 if (! cmp
->font
|| cmp
->font
!= font
)
22394 /* Ascent and descent of the font of the first character
22395 of this composition (adjusted by baseline offset).
22396 Ascent and descent of overall glyphs should not be less
22397 than these, respectively. */
22398 int font_ascent
, font_descent
, font_height
;
22399 /* Bounding box of the overall glyphs. */
22400 int leftmost
, rightmost
, lowest
, highest
;
22401 int lbearing
, rbearing
;
22402 int i
, width
, ascent
, descent
;
22403 int left_padded
= 0, right_padded
= 0;
22406 struct font_metrics
*pcm
;
22407 int font_not_found_p
;
22410 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22411 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22413 if (glyph_len
< cmp
->glyph_len
)
22415 for (i
= 0; i
< glyph_len
; i
++)
22417 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22419 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22424 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22425 : IT_CHARPOS (*it
));
22426 /* If no suitable font is found, use the default font. */
22427 font_not_found_p
= font
== NULL
;
22428 if (font_not_found_p
)
22430 face
= face
->ascii_face
;
22433 boff
= font
->baseline_offset
;
22434 if (font
->vertical_centering
)
22435 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22436 font_ascent
= FONT_BASE (font
) + boff
;
22437 font_descent
= FONT_DESCENT (font
) - boff
;
22438 font_height
= FONT_HEIGHT (font
);
22440 cmp
->font
= (void *) font
;
22443 if (! font_not_found_p
)
22445 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22446 &char2b
, it
->multibyte_p
, 0);
22447 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22450 /* Initialize the bounding box. */
22453 width
= pcm
->width
;
22454 ascent
= pcm
->ascent
;
22455 descent
= pcm
->descent
;
22456 lbearing
= pcm
->lbearing
;
22457 rbearing
= pcm
->rbearing
;
22461 width
= font
->space_width
;
22462 ascent
= FONT_BASE (font
);
22463 descent
= FONT_DESCENT (font
);
22470 lowest
= - descent
+ boff
;
22471 highest
= ascent
+ boff
;
22473 if (! font_not_found_p
22474 && font
->default_ascent
22475 && CHAR_TABLE_P (Vuse_default_ascent
)
22476 && !NILP (Faref (Vuse_default_ascent
,
22477 make_number (it
->char_to_display
))))
22478 highest
= font
->default_ascent
+ boff
;
22480 /* Draw the first glyph at the normal position. It may be
22481 shifted to right later if some other glyphs are drawn
22483 cmp
->offsets
[i
* 2] = 0;
22484 cmp
->offsets
[i
* 2 + 1] = boff
;
22485 cmp
->lbearing
= lbearing
;
22486 cmp
->rbearing
= rbearing
;
22488 /* Set cmp->offsets for the remaining glyphs. */
22489 for (i
++; i
< glyph_len
; i
++)
22491 int left
, right
, btm
, top
;
22492 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22494 struct face
*this_face
;
22499 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22500 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22501 font
= this_face
->font
;
22507 this_boff
= font
->baseline_offset
;
22508 if (font
->vertical_centering
)
22509 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22510 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22511 &char2b
, it
->multibyte_p
, 0);
22512 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22515 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22518 width
= pcm
->width
;
22519 ascent
= pcm
->ascent
;
22520 descent
= pcm
->descent
;
22521 lbearing
= pcm
->lbearing
;
22522 rbearing
= pcm
->rbearing
;
22523 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22525 /* Relative composition with or without
22526 alternate chars. */
22527 left
= (leftmost
+ rightmost
- width
) / 2;
22528 btm
= - descent
+ boff
;
22529 if (font
->relative_compose
22530 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22531 || NILP (Faref (Vignore_relative_composition
,
22532 make_number (ch
)))))
22535 if (- descent
>= font
->relative_compose
)
22536 /* One extra pixel between two glyphs. */
22538 else if (ascent
<= 0)
22539 /* One extra pixel between two glyphs. */
22540 btm
= lowest
- 1 - ascent
- descent
;
22545 /* A composition rule is specified by an integer
22546 value that encodes global and new reference
22547 points (GREF and NREF). GREF and NREF are
22548 specified by numbers as below:
22550 0---1---2 -- ascent
22554 9--10--11 -- center
22556 ---3---4---5--- baseline
22558 6---7---8 -- descent
22560 int rule
= COMPOSITION_RULE (cmp
, i
);
22561 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22563 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22564 grefx
= gref
% 3, nrefx
= nref
% 3;
22565 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22567 xoff
= font_height
* (xoff
- 128) / 256;
22569 yoff
= font_height
* (yoff
- 128) / 256;
22572 + grefx
* (rightmost
- leftmost
) / 2
22573 - nrefx
* width
/ 2
22576 btm
= ((grefy
== 0 ? highest
22578 : grefy
== 2 ? lowest
22579 : (highest
+ lowest
) / 2)
22580 - (nrefy
== 0 ? ascent
+ descent
22581 : nrefy
== 1 ? descent
- boff
22583 : (ascent
+ descent
) / 2)
22587 cmp
->offsets
[i
* 2] = left
;
22588 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22590 /* Update the bounding box of the overall glyphs. */
22593 right
= left
+ width
;
22594 if (left
< leftmost
)
22596 if (right
> rightmost
)
22599 top
= btm
+ descent
+ ascent
;
22605 if (cmp
->lbearing
> left
+ lbearing
)
22606 cmp
->lbearing
= left
+ lbearing
;
22607 if (cmp
->rbearing
< left
+ rbearing
)
22608 cmp
->rbearing
= left
+ rbearing
;
22612 /* If there are glyphs whose x-offsets are negative,
22613 shift all glyphs to the right and make all x-offsets
22617 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22618 cmp
->offsets
[i
* 2] -= leftmost
;
22619 rightmost
-= leftmost
;
22620 cmp
->lbearing
-= leftmost
;
22621 cmp
->rbearing
-= leftmost
;
22624 if (left_padded
&& cmp
->lbearing
< 0)
22626 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22627 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22628 rightmost
-= cmp
->lbearing
;
22629 cmp
->rbearing
-= cmp
->lbearing
;
22632 if (right_padded
&& rightmost
< cmp
->rbearing
)
22634 rightmost
= cmp
->rbearing
;
22637 cmp
->pixel_width
= rightmost
;
22638 cmp
->ascent
= highest
;
22639 cmp
->descent
= - lowest
;
22640 if (cmp
->ascent
< font_ascent
)
22641 cmp
->ascent
= font_ascent
;
22642 if (cmp
->descent
< font_descent
)
22643 cmp
->descent
= font_descent
;
22647 && (cmp
->lbearing
< 0
22648 || cmp
->rbearing
> cmp
->pixel_width
))
22649 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22651 it
->pixel_width
= cmp
->pixel_width
;
22652 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22653 it
->descent
= it
->phys_descent
= cmp
->descent
;
22654 if (face
->box
!= FACE_NO_BOX
)
22656 int thick
= face
->box_line_width
;
22660 it
->ascent
+= thick
;
22661 it
->descent
+= thick
;
22666 if (it
->start_of_box_run_p
)
22667 it
->pixel_width
+= thick
;
22668 if (it
->end_of_box_run_p
)
22669 it
->pixel_width
+= thick
;
22672 /* If face has an overline, add the height of the overline
22673 (1 pixel) and a 1 pixel margin to the character height. */
22674 if (face
->overline_p
)
22675 it
->ascent
+= overline_margin
;
22677 take_vertical_position_into_account (it
);
22678 if (it
->ascent
< 0)
22680 if (it
->descent
< 0)
22684 append_composite_glyph (it
);
22686 else if (it
->what
== IT_COMPOSITION
)
22688 /* A dynamic (automatic) composition. */
22689 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22690 Lisp_Object gstring
;
22691 struct font_metrics metrics
;
22693 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22695 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22698 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22699 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22700 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22701 it
->descent
= it
->phys_descent
= metrics
.descent
;
22702 if (face
->box
!= FACE_NO_BOX
)
22704 int thick
= face
->box_line_width
;
22708 it
->ascent
+= thick
;
22709 it
->descent
+= thick
;
22714 if (it
->start_of_box_run_p
)
22715 it
->pixel_width
+= thick
;
22716 if (it
->end_of_box_run_p
)
22717 it
->pixel_width
+= thick
;
22719 /* If face has an overline, add the height of the overline
22720 (1 pixel) and a 1 pixel margin to the character height. */
22721 if (face
->overline_p
)
22722 it
->ascent
+= overline_margin
;
22723 take_vertical_position_into_account (it
);
22724 if (it
->ascent
< 0)
22726 if (it
->descent
< 0)
22730 append_composite_glyph (it
);
22732 else if (it
->what
== IT_IMAGE
)
22733 produce_image_glyph (it
);
22734 else if (it
->what
== IT_STRETCH
)
22735 produce_stretch_glyph (it
);
22737 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22738 because this isn't true for images with `:ascent 100'. */
22739 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22740 if (it
->area
== TEXT_AREA
)
22741 it
->current_x
+= it
->pixel_width
;
22743 if (extra_line_spacing
> 0)
22745 it
->descent
+= extra_line_spacing
;
22746 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22747 it
->max_extra_line_spacing
= extra_line_spacing
;
22750 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22751 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22752 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22753 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22757 Output LEN glyphs starting at START at the nominal cursor position.
22758 Advance the nominal cursor over the text. The global variable
22759 updated_window contains the window being updated, updated_row is
22760 the glyph row being updated, and updated_area is the area of that
22761 row being updated. */
22764 x_write_glyphs (struct glyph
*start
, int len
)
22768 xassert (updated_window
&& updated_row
);
22771 /* Write glyphs. */
22773 hpos
= start
- updated_row
->glyphs
[updated_area
];
22774 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22775 updated_row
, updated_area
,
22777 DRAW_NORMAL_TEXT
, 0);
22779 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22780 if (updated_area
== TEXT_AREA
22781 && updated_window
->phys_cursor_on_p
22782 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22783 && updated_window
->phys_cursor
.hpos
>= hpos
22784 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22785 updated_window
->phys_cursor_on_p
= 0;
22789 /* Advance the output cursor. */
22790 output_cursor
.hpos
+= len
;
22791 output_cursor
.x
= x
;
22796 Insert LEN glyphs from START at the nominal cursor position. */
22799 x_insert_glyphs (struct glyph
*start
, int len
)
22803 int line_height
, shift_by_width
, shifted_region_width
;
22804 struct glyph_row
*row
;
22805 struct glyph
*glyph
;
22806 int frame_x
, frame_y
;
22809 xassert (updated_window
&& updated_row
);
22811 w
= updated_window
;
22812 f
= XFRAME (WINDOW_FRAME (w
));
22814 /* Get the height of the line we are in. */
22816 line_height
= row
->height
;
22818 /* Get the width of the glyphs to insert. */
22819 shift_by_width
= 0;
22820 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22821 shift_by_width
+= glyph
->pixel_width
;
22823 /* Get the width of the region to shift right. */
22824 shifted_region_width
= (window_box_width (w
, updated_area
)
22829 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22830 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22832 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22833 line_height
, shift_by_width
);
22835 /* Write the glyphs. */
22836 hpos
= start
- row
->glyphs
[updated_area
];
22837 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22839 DRAW_NORMAL_TEXT
, 0);
22841 /* Advance the output cursor. */
22842 output_cursor
.hpos
+= len
;
22843 output_cursor
.x
+= shift_by_width
;
22849 Erase the current text line from the nominal cursor position
22850 (inclusive) to pixel column TO_X (exclusive). The idea is that
22851 everything from TO_X onward is already erased.
22853 TO_X is a pixel position relative to updated_area of
22854 updated_window. TO_X == -1 means clear to the end of this area. */
22857 x_clear_end_of_line (int to_x
)
22860 struct window
*w
= updated_window
;
22861 int max_x
, min_y
, max_y
;
22862 int from_x
, from_y
, to_y
;
22864 xassert (updated_window
&& updated_row
);
22865 f
= XFRAME (w
->frame
);
22867 if (updated_row
->full_width_p
)
22868 max_x
= WINDOW_TOTAL_WIDTH (w
);
22870 max_x
= window_box_width (w
, updated_area
);
22871 max_y
= window_text_bottom_y (w
);
22873 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22874 of window. For TO_X > 0, truncate to end of drawing area. */
22880 to_x
= min (to_x
, max_x
);
22882 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22884 /* Notice if the cursor will be cleared by this operation. */
22885 if (!updated_row
->full_width_p
)
22886 notice_overwritten_cursor (w
, updated_area
,
22887 output_cursor
.x
, -1,
22889 MATRIX_ROW_BOTTOM_Y (updated_row
));
22891 from_x
= output_cursor
.x
;
22893 /* Translate to frame coordinates. */
22894 if (updated_row
->full_width_p
)
22896 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22897 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22901 int area_left
= window_box_left (w
, updated_area
);
22902 from_x
+= area_left
;
22906 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22907 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22908 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22910 /* Prevent inadvertently clearing to end of the X window. */
22911 if (to_x
> from_x
&& to_y
> from_y
)
22914 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22915 to_x
- from_x
, to_y
- from_y
);
22920 #endif /* HAVE_WINDOW_SYSTEM */
22924 /***********************************************************************
22926 ***********************************************************************/
22928 /* Value is the internal representation of the specified cursor type
22929 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22930 of the bar cursor. */
22932 static enum text_cursor_kinds
22933 get_specified_cursor_type (Lisp_Object arg
, int *width
)
22935 enum text_cursor_kinds type
;
22940 if (EQ (arg
, Qbox
))
22941 return FILLED_BOX_CURSOR
;
22943 if (EQ (arg
, Qhollow
))
22944 return HOLLOW_BOX_CURSOR
;
22946 if (EQ (arg
, Qbar
))
22953 && EQ (XCAR (arg
), Qbar
)
22954 && INTEGERP (XCDR (arg
))
22955 && XINT (XCDR (arg
)) >= 0)
22957 *width
= XINT (XCDR (arg
));
22961 if (EQ (arg
, Qhbar
))
22964 return HBAR_CURSOR
;
22968 && EQ (XCAR (arg
), Qhbar
)
22969 && INTEGERP (XCDR (arg
))
22970 && XINT (XCDR (arg
)) >= 0)
22972 *width
= XINT (XCDR (arg
));
22973 return HBAR_CURSOR
;
22976 /* Treat anything unknown as "hollow box cursor".
22977 It was bad to signal an error; people have trouble fixing
22978 .Xdefaults with Emacs, when it has something bad in it. */
22979 type
= HOLLOW_BOX_CURSOR
;
22984 /* Set the default cursor types for specified frame. */
22986 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
22991 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22992 FRAME_CURSOR_WIDTH (f
) = width
;
22994 /* By default, set up the blink-off state depending on the on-state. */
22996 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22999 FRAME_BLINK_OFF_CURSOR (f
)
23000 = get_specified_cursor_type (XCDR (tem
), &width
);
23001 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23004 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23008 /* Return the cursor we want to be displayed in window W. Return
23009 width of bar/hbar cursor through WIDTH arg. Return with
23010 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23011 (i.e. if the `system caret' should track this cursor).
23013 In a mini-buffer window, we want the cursor only to appear if we
23014 are reading input from this window. For the selected window, we
23015 want the cursor type given by the frame parameter or buffer local
23016 setting of cursor-type. If explicitly marked off, draw no cursor.
23017 In all other cases, we want a hollow box cursor. */
23019 static enum text_cursor_kinds
23020 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23021 int *active_cursor
)
23023 struct frame
*f
= XFRAME (w
->frame
);
23024 struct buffer
*b
= XBUFFER (w
->buffer
);
23025 int cursor_type
= DEFAULT_CURSOR
;
23026 Lisp_Object alt_cursor
;
23027 int non_selected
= 0;
23029 *active_cursor
= 1;
23032 if (cursor_in_echo_area
23033 && FRAME_HAS_MINIBUF_P (f
)
23034 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23036 if (w
== XWINDOW (echo_area_window
))
23038 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23040 *width
= FRAME_CURSOR_WIDTH (f
);
23041 return FRAME_DESIRED_CURSOR (f
);
23044 return get_specified_cursor_type (b
->cursor_type
, width
);
23047 *active_cursor
= 0;
23051 /* Detect a nonselected window or nonselected frame. */
23052 else if (w
!= XWINDOW (f
->selected_window
)
23053 #ifdef HAVE_WINDOW_SYSTEM
23054 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23058 *active_cursor
= 0;
23060 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23066 /* Never display a cursor in a window in which cursor-type is nil. */
23067 if (NILP (b
->cursor_type
))
23070 /* Get the normal cursor type for this window. */
23071 if (EQ (b
->cursor_type
, Qt
))
23073 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23074 *width
= FRAME_CURSOR_WIDTH (f
);
23077 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23079 /* Use cursor-in-non-selected-windows instead
23080 for non-selected window or frame. */
23083 alt_cursor
= b
->cursor_in_non_selected_windows
;
23084 if (!EQ (Qt
, alt_cursor
))
23085 return get_specified_cursor_type (alt_cursor
, width
);
23086 /* t means modify the normal cursor type. */
23087 if (cursor_type
== FILLED_BOX_CURSOR
)
23088 cursor_type
= HOLLOW_BOX_CURSOR
;
23089 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23091 return cursor_type
;
23094 /* Use normal cursor if not blinked off. */
23095 if (!w
->cursor_off_p
)
23097 #ifdef HAVE_WINDOW_SYSTEM
23098 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23100 if (cursor_type
== FILLED_BOX_CURSOR
)
23102 /* Using a block cursor on large images can be very annoying.
23103 So use a hollow cursor for "large" images.
23104 If image is not transparent (no mask), also use hollow cursor. */
23105 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23106 if (img
!= NULL
&& IMAGEP (img
->spec
))
23108 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23109 where N = size of default frame font size.
23110 This should cover most of the "tiny" icons people may use. */
23112 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23113 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23114 cursor_type
= HOLLOW_BOX_CURSOR
;
23117 else if (cursor_type
!= NO_CURSOR
)
23119 /* Display current only supports BOX and HOLLOW cursors for images.
23120 So for now, unconditionally use a HOLLOW cursor when cursor is
23121 not a solid box cursor. */
23122 cursor_type
= HOLLOW_BOX_CURSOR
;
23126 return cursor_type
;
23129 /* Cursor is blinked off, so determine how to "toggle" it. */
23131 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23132 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23133 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23135 /* Then see if frame has specified a specific blink off cursor type. */
23136 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23138 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23139 return FRAME_BLINK_OFF_CURSOR (f
);
23143 /* Some people liked having a permanently visible blinking cursor,
23144 while others had very strong opinions against it. So it was
23145 decided to remove it. KFS 2003-09-03 */
23147 /* Finally perform built-in cursor blinking:
23148 filled box <-> hollow box
23149 wide [h]bar <-> narrow [h]bar
23150 narrow [h]bar <-> no cursor
23151 other type <-> no cursor */
23153 if (cursor_type
== FILLED_BOX_CURSOR
)
23154 return HOLLOW_BOX_CURSOR
;
23156 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23159 return cursor_type
;
23167 #ifdef HAVE_WINDOW_SYSTEM
23169 /* Notice when the text cursor of window W has been completely
23170 overwritten by a drawing operation that outputs glyphs in AREA
23171 starting at X0 and ending at X1 in the line starting at Y0 and
23172 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23173 the rest of the line after X0 has been written. Y coordinates
23174 are window-relative. */
23177 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23178 int x0
, int x1
, int y0
, int y1
)
23180 int cx0
, cx1
, cy0
, cy1
;
23181 struct glyph_row
*row
;
23183 if (!w
->phys_cursor_on_p
)
23185 if (area
!= TEXT_AREA
)
23188 if (w
->phys_cursor
.vpos
< 0
23189 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23190 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23191 !(row
->enabled_p
&& row
->displays_text_p
)))
23194 if (row
->cursor_in_fringe_p
)
23196 row
->cursor_in_fringe_p
= 0;
23197 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23198 w
->phys_cursor_on_p
= 0;
23202 cx0
= w
->phys_cursor
.x
;
23203 cx1
= cx0
+ w
->phys_cursor_width
;
23204 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23207 /* The cursor image will be completely removed from the
23208 screen if the output area intersects the cursor area in
23209 y-direction. When we draw in [y0 y1[, and some part of
23210 the cursor is at y < y0, that part must have been drawn
23211 before. When scrolling, the cursor is erased before
23212 actually scrolling, so we don't come here. When not
23213 scrolling, the rows above the old cursor row must have
23214 changed, and in this case these rows must have written
23215 over the cursor image.
23217 Likewise if part of the cursor is below y1, with the
23218 exception of the cursor being in the first blank row at
23219 the buffer and window end because update_text_area
23220 doesn't draw that row. (Except when it does, but
23221 that's handled in update_text_area.) */
23223 cy0
= w
->phys_cursor
.y
;
23224 cy1
= cy0
+ w
->phys_cursor_height
;
23225 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23228 w
->phys_cursor_on_p
= 0;
23231 #endif /* HAVE_WINDOW_SYSTEM */
23234 /************************************************************************
23236 ************************************************************************/
23238 #ifdef HAVE_WINDOW_SYSTEM
23241 Fix the display of area AREA of overlapping row ROW in window W
23242 with respect to the overlapping part OVERLAPS. */
23245 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23246 enum glyph_row_area area
, int overlaps
)
23253 for (i
= 0; i
< row
->used
[area
];)
23255 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23257 int start
= i
, start_x
= x
;
23261 x
+= row
->glyphs
[area
][i
].pixel_width
;
23264 while (i
< row
->used
[area
]
23265 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23267 draw_glyphs (w
, start_x
, row
, area
,
23269 DRAW_NORMAL_TEXT
, overlaps
);
23273 x
+= row
->glyphs
[area
][i
].pixel_width
;
23283 Draw the cursor glyph of window W in glyph row ROW. See the
23284 comment of draw_glyphs for the meaning of HL. */
23287 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23288 enum draw_glyphs_face hl
)
23290 /* If cursor hpos is out of bounds, don't draw garbage. This can
23291 happen in mini-buffer windows when switching between echo area
23292 glyphs and mini-buffer. */
23293 if ((row
->reversed_p
23294 ? (w
->phys_cursor
.hpos
>= 0)
23295 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23297 int on_p
= w
->phys_cursor_on_p
;
23299 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23300 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23302 w
->phys_cursor_on_p
= on_p
;
23304 if (hl
== DRAW_CURSOR
)
23305 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23306 /* When we erase the cursor, and ROW is overlapped by other
23307 rows, make sure that these overlapping parts of other rows
23309 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23311 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23313 if (row
> w
->current_matrix
->rows
23314 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23315 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23316 OVERLAPS_ERASED_CURSOR
);
23318 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23319 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23320 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23321 OVERLAPS_ERASED_CURSOR
);
23328 Erase the image of a cursor of window W from the screen. */
23331 erase_phys_cursor (struct window
*w
)
23333 struct frame
*f
= XFRAME (w
->frame
);
23334 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23335 int hpos
= w
->phys_cursor
.hpos
;
23336 int vpos
= w
->phys_cursor
.vpos
;
23337 int mouse_face_here_p
= 0;
23338 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23339 struct glyph_row
*cursor_row
;
23340 struct glyph
*cursor_glyph
;
23341 enum draw_glyphs_face hl
;
23343 /* No cursor displayed or row invalidated => nothing to do on the
23345 if (w
->phys_cursor_type
== NO_CURSOR
)
23346 goto mark_cursor_off
;
23348 /* VPOS >= active_glyphs->nrows means that window has been resized.
23349 Don't bother to erase the cursor. */
23350 if (vpos
>= active_glyphs
->nrows
)
23351 goto mark_cursor_off
;
23353 /* If row containing cursor is marked invalid, there is nothing we
23355 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23356 if (!cursor_row
->enabled_p
)
23357 goto mark_cursor_off
;
23359 /* If line spacing is > 0, old cursor may only be partially visible in
23360 window after split-window. So adjust visible height. */
23361 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23362 window_text_bottom_y (w
) - cursor_row
->y
);
23364 /* If row is completely invisible, don't attempt to delete a cursor which
23365 isn't there. This can happen if cursor is at top of a window, and
23366 we switch to a buffer with a header line in that window. */
23367 if (cursor_row
->visible_height
<= 0)
23368 goto mark_cursor_off
;
23370 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23371 if (cursor_row
->cursor_in_fringe_p
)
23373 cursor_row
->cursor_in_fringe_p
= 0;
23374 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23375 goto mark_cursor_off
;
23378 /* This can happen when the new row is shorter than the old one.
23379 In this case, either draw_glyphs or clear_end_of_line
23380 should have cleared the cursor. Note that we wouldn't be
23381 able to erase the cursor in this case because we don't have a
23382 cursor glyph at hand. */
23383 if ((cursor_row
->reversed_p
23384 ? (w
->phys_cursor
.hpos
< 0)
23385 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23386 goto mark_cursor_off
;
23388 /* If the cursor is in the mouse face area, redisplay that when
23389 we clear the cursor. */
23390 if (! NILP (dpyinfo
->mouse_face_window
)
23391 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23392 && (vpos
> dpyinfo
->mouse_face_beg_row
23393 || (vpos
== dpyinfo
->mouse_face_beg_row
23394 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23395 && (vpos
< dpyinfo
->mouse_face_end_row
23396 || (vpos
== dpyinfo
->mouse_face_end_row
23397 && hpos
< dpyinfo
->mouse_face_end_col
))
23398 /* Don't redraw the cursor's spot in mouse face if it is at the
23399 end of a line (on a newline). The cursor appears there, but
23400 mouse highlighting does not. */
23401 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23402 mouse_face_here_p
= 1;
23404 /* Maybe clear the display under the cursor. */
23405 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23408 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23411 cursor_glyph
= get_phys_cursor_glyph (w
);
23412 if (cursor_glyph
== NULL
)
23413 goto mark_cursor_off
;
23415 width
= cursor_glyph
->pixel_width
;
23416 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23417 x
= w
->phys_cursor
.x
;
23419 width
-= left_x
- x
;
23420 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23421 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23422 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23425 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23428 /* Erase the cursor by redrawing the character underneath it. */
23429 if (mouse_face_here_p
)
23430 hl
= DRAW_MOUSE_FACE
;
23432 hl
= DRAW_NORMAL_TEXT
;
23433 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23436 w
->phys_cursor_on_p
= 0;
23437 w
->phys_cursor_type
= NO_CURSOR
;
23442 Display or clear cursor of window W. If ON is zero, clear the
23443 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23444 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23447 display_and_set_cursor (struct window
*w
, int on
,
23448 int hpos
, int vpos
, int x
, int y
)
23450 struct frame
*f
= XFRAME (w
->frame
);
23451 int new_cursor_type
;
23452 int new_cursor_width
;
23454 struct glyph_row
*glyph_row
;
23455 struct glyph
*glyph
;
23457 /* This is pointless on invisible frames, and dangerous on garbaged
23458 windows and frames; in the latter case, the frame or window may
23459 be in the midst of changing its size, and x and y may be off the
23461 if (! FRAME_VISIBLE_P (f
)
23462 || FRAME_GARBAGED_P (f
)
23463 || vpos
>= w
->current_matrix
->nrows
23464 || hpos
>= w
->current_matrix
->matrix_w
)
23467 /* If cursor is off and we want it off, return quickly. */
23468 if (!on
&& !w
->phys_cursor_on_p
)
23471 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23472 /* If cursor row is not enabled, we don't really know where to
23473 display the cursor. */
23474 if (!glyph_row
->enabled_p
)
23476 w
->phys_cursor_on_p
= 0;
23481 if (!glyph_row
->exact_window_width_line_p
23482 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23483 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23485 xassert (interrupt_input_blocked
);
23487 /* Set new_cursor_type to the cursor we want to be displayed. */
23488 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23489 &new_cursor_width
, &active_cursor
);
23491 /* If cursor is currently being shown and we don't want it to be or
23492 it is in the wrong place, or the cursor type is not what we want,
23494 if (w
->phys_cursor_on_p
23496 || w
->phys_cursor
.x
!= x
23497 || w
->phys_cursor
.y
!= y
23498 || new_cursor_type
!= w
->phys_cursor_type
23499 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23500 && new_cursor_width
!= w
->phys_cursor_width
)))
23501 erase_phys_cursor (w
);
23503 /* Don't check phys_cursor_on_p here because that flag is only set
23504 to zero in some cases where we know that the cursor has been
23505 completely erased, to avoid the extra work of erasing the cursor
23506 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23507 still not be visible, or it has only been partly erased. */
23510 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23511 w
->phys_cursor_height
= glyph_row
->height
;
23513 /* Set phys_cursor_.* before x_draw_.* is called because some
23514 of them may need the information. */
23515 w
->phys_cursor
.x
= x
;
23516 w
->phys_cursor
.y
= glyph_row
->y
;
23517 w
->phys_cursor
.hpos
= hpos
;
23518 w
->phys_cursor
.vpos
= vpos
;
23521 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23522 new_cursor_type
, new_cursor_width
,
23523 on
, active_cursor
);
23527 /* Switch the display of W's cursor on or off, according to the value
23531 update_window_cursor (struct window
*w
, int on
)
23533 /* Don't update cursor in windows whose frame is in the process
23534 of being deleted. */
23535 if (w
->current_matrix
)
23538 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23539 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23545 /* Call update_window_cursor with parameter ON_P on all leaf windows
23546 in the window tree rooted at W. */
23549 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23553 if (!NILP (w
->hchild
))
23554 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23555 else if (!NILP (w
->vchild
))
23556 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23558 update_window_cursor (w
, on_p
);
23560 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23566 Display the cursor on window W, or clear it, according to ON_P.
23567 Don't change the cursor's position. */
23570 x_update_cursor (struct frame
*f
, int on_p
)
23572 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23577 Clear the cursor of window W to background color, and mark the
23578 cursor as not shown. This is used when the text where the cursor
23579 is about to be rewritten. */
23582 x_clear_cursor (struct window
*w
)
23584 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23585 update_window_cursor (w
, 0);
23590 Display the active region described by mouse_face_* according to DRAW. */
23593 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23595 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23596 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23598 if (/* If window is in the process of being destroyed, don't bother
23600 w
->current_matrix
!= NULL
23601 /* Don't update mouse highlight if hidden */
23602 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23603 /* Recognize when we are called to operate on rows that don't exist
23604 anymore. This can happen when a window is split. */
23605 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23607 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23608 struct glyph_row
*row
, *first
, *last
;
23610 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23611 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23613 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23615 int start_hpos
, end_hpos
, start_x
;
23617 /* For all but the first row, the highlight starts at column 0. */
23620 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23621 start_x
= dpyinfo
->mouse_face_beg_x
;
23630 end_hpos
= dpyinfo
->mouse_face_end_col
;
23633 end_hpos
= row
->used
[TEXT_AREA
];
23634 if (draw
== DRAW_NORMAL_TEXT
)
23635 row
->fill_line_p
= 1; /* Clear to end of line */
23638 if (end_hpos
> start_hpos
)
23640 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23641 start_hpos
, end_hpos
,
23645 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23649 /* When we've written over the cursor, arrange for it to
23650 be displayed again. */
23651 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23654 display_and_set_cursor (w
, 1,
23655 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23656 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23661 /* Change the mouse cursor. */
23662 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23663 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23664 else if (draw
== DRAW_MOUSE_FACE
)
23665 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23667 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23671 Clear out the mouse-highlighted active region.
23672 Redraw it un-highlighted first. Value is non-zero if mouse
23673 face was actually drawn unhighlighted. */
23676 clear_mouse_face (Display_Info
*dpyinfo
)
23680 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23682 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23686 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23687 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23688 dpyinfo
->mouse_face_window
= Qnil
;
23689 dpyinfo
->mouse_face_overlay
= Qnil
;
23695 Non-zero if physical cursor of window W is within mouse face. */
23698 cursor_in_mouse_face_p (struct window
*w
)
23700 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23701 int in_mouse_face
= 0;
23703 if (WINDOWP (dpyinfo
->mouse_face_window
)
23704 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23706 int hpos
= w
->phys_cursor
.hpos
;
23707 int vpos
= w
->phys_cursor
.vpos
;
23709 if (vpos
>= dpyinfo
->mouse_face_beg_row
23710 && vpos
<= dpyinfo
->mouse_face_end_row
23711 && (vpos
> dpyinfo
->mouse_face_beg_row
23712 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23713 && (vpos
< dpyinfo
->mouse_face_end_row
23714 || hpos
< dpyinfo
->mouse_face_end_col
23715 || dpyinfo
->mouse_face_past_end
))
23719 return in_mouse_face
;
23725 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23726 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23727 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23728 for the overlay or run of text properties specifying the mouse
23729 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23730 before-string and after-string that must also be highlighted.
23731 DISPLAY_STRING, if non-nil, is a display string that may cover some
23732 or all of the highlighted text. */
23735 mouse_face_from_buffer_pos (Lisp_Object window
,
23736 Display_Info
*dpyinfo
,
23737 EMACS_INT mouse_charpos
,
23738 EMACS_INT start_charpos
,
23739 EMACS_INT end_charpos
,
23740 Lisp_Object before_string
,
23741 Lisp_Object after_string
,
23742 Lisp_Object display_string
)
23744 struct window
*w
= XWINDOW (window
);
23745 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23746 struct glyph_row
*row
;
23747 struct glyph
*glyph
, *end
;
23751 xassert (NILP (display_string
) || STRINGP (display_string
));
23752 xassert (NILP (before_string
) || STRINGP (before_string
));
23753 xassert (NILP (after_string
) || STRINGP (after_string
));
23755 /* Find the first highlighted glyph. */
23756 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23758 dpyinfo
->mouse_face_beg_col
= 0;
23759 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23760 dpyinfo
->mouse_face_beg_x
= first
->x
;
23761 dpyinfo
->mouse_face_beg_y
= first
->y
;
23765 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23767 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23769 /* If the before-string or display-string contains newlines,
23770 row_containing_pos skips to its last row. Move back. */
23771 if (!NILP (before_string
) || !NILP (display_string
))
23773 struct glyph_row
*prev
;
23774 while ((prev
= row
- 1, prev
>= first
)
23775 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23776 && prev
->used
[TEXT_AREA
] > 0)
23778 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23779 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23780 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23782 || !(EQ (glyph
->object
, before_string
)
23783 || EQ (glyph
->object
, display_string
)))
23789 glyph
= row
->glyphs
[TEXT_AREA
];
23790 end
= glyph
+ row
->used
[TEXT_AREA
];
23792 dpyinfo
->mouse_face_beg_y
= row
->y
;
23793 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23795 /* Skip truncation glyphs at the start of the glyph row. */
23796 if (row
->displays_text_p
)
23798 && INTEGERP (glyph
->object
)
23799 && glyph
->charpos
< 0;
23801 x
+= glyph
->pixel_width
;
23803 /* Scan the glyph row, stopping before BEFORE_STRING or
23804 DISPLAY_STRING or START_CHARPOS. */
23806 && !INTEGERP (glyph
->object
)
23807 && !EQ (glyph
->object
, before_string
)
23808 && !EQ (glyph
->object
, display_string
)
23809 && !(BUFFERP (glyph
->object
)
23810 && glyph
->charpos
>= start_charpos
);
23812 x
+= glyph
->pixel_width
;
23814 dpyinfo
->mouse_face_beg_x
= x
;
23815 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23818 /* Find the last highlighted glyph. */
23819 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23822 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23823 dpyinfo
->mouse_face_past_end
= 1;
23825 else if (!NILP (after_string
))
23827 /* If the after-string has newlines, advance to its last row. */
23828 struct glyph_row
*next
;
23829 struct glyph_row
*last
23830 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23832 for (next
= row
+ 1;
23834 && next
->used
[TEXT_AREA
] > 0
23835 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23840 glyph
= row
->glyphs
[TEXT_AREA
];
23841 end
= glyph
+ row
->used
[TEXT_AREA
];
23843 dpyinfo
->mouse_face_end_y
= row
->y
;
23844 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23846 /* Skip truncation glyphs at the start of the row. */
23847 if (row
->displays_text_p
)
23849 && INTEGERP (glyph
->object
)
23850 && glyph
->charpos
< 0;
23852 x
+= glyph
->pixel_width
;
23854 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23857 && !INTEGERP (glyph
->object
)
23858 && !EQ (glyph
->object
, after_string
)
23859 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23861 x
+= glyph
->pixel_width
;
23863 /* If we found AFTER_STRING, consume it and stop. */
23864 if (EQ (glyph
->object
, after_string
))
23866 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23867 x
+= glyph
->pixel_width
;
23871 /* If there's no after-string, we must check if we overshot,
23872 which might be the case if we stopped after a string glyph.
23873 That glyph may belong to a before-string or display-string
23874 associated with the end position, which must not be
23876 Lisp_Object prev_object
;
23879 while (glyph
> row
->glyphs
[TEXT_AREA
])
23881 prev_object
= (glyph
- 1)->object
;
23882 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23885 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23886 if (pos
&& pos
< end_charpos
)
23889 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23890 && EQ ((glyph
- 1)->object
, prev_object
);
23892 x
-= (glyph
- 1)->pixel_width
;
23896 dpyinfo
->mouse_face_end_x
= x
;
23897 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23898 dpyinfo
->mouse_face_window
= window
;
23899 dpyinfo
->mouse_face_face_id
23900 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23902 !dpyinfo
->mouse_face_hidden
, -1);
23903 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23907 /* Find the position of the glyph for position POS in OBJECT in
23908 window W's current matrix, and return in *X, *Y the pixel
23909 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23911 RIGHT_P non-zero means return the position of the right edge of the
23912 glyph, RIGHT_P zero means return the left edge position.
23914 If no glyph for POS exists in the matrix, return the position of
23915 the glyph with the next smaller position that is in the matrix, if
23916 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23917 exists in the matrix, return the position of the glyph with the
23918 next larger position in OBJECT.
23920 Value is non-zero if a glyph was found. */
23923 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
23924 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
23926 int yb
= window_text_bottom_y (w
);
23927 struct glyph_row
*r
;
23928 struct glyph
*best_glyph
= NULL
;
23929 struct glyph_row
*best_row
= NULL
;
23932 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23933 r
->enabled_p
&& r
->y
< yb
;
23936 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23937 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23940 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23941 if (EQ (g
->object
, object
))
23943 if (g
->charpos
== pos
)
23950 else if (best_glyph
== NULL
23951 || ((eabs (g
->charpos
- pos
)
23952 < eabs (best_glyph
->charpos
- pos
))
23955 : g
->charpos
> pos
)))
23969 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23973 *x
+= best_glyph
->pixel_width
;
23978 *vpos
= best_row
- w
->current_matrix
->rows
;
23981 return best_glyph
!= NULL
;
23985 /* See if position X, Y is within a hot-spot of an image. */
23988 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
23990 if (!CONSP (hot_spot
))
23993 if (EQ (XCAR (hot_spot
), Qrect
))
23995 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23996 Lisp_Object rect
= XCDR (hot_spot
);
24000 if (!CONSP (XCAR (rect
)))
24002 if (!CONSP (XCDR (rect
)))
24004 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24006 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24008 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24010 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24014 else if (EQ (XCAR (hot_spot
), Qcircle
))
24016 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24017 Lisp_Object circ
= XCDR (hot_spot
);
24018 Lisp_Object lr
, lx0
, ly0
;
24020 && CONSP (XCAR (circ
))
24021 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24022 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24023 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24025 double r
= XFLOATINT (lr
);
24026 double dx
= XINT (lx0
) - x
;
24027 double dy
= XINT (ly0
) - y
;
24028 return (dx
* dx
+ dy
* dy
<= r
* r
);
24031 else if (EQ (XCAR (hot_spot
), Qpoly
))
24033 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24034 if (VECTORP (XCDR (hot_spot
)))
24036 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24037 Lisp_Object
*poly
= v
->contents
;
24041 Lisp_Object lx
, ly
;
24044 /* Need an even number of coordinates, and at least 3 edges. */
24045 if (n
< 6 || n
& 1)
24048 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24049 If count is odd, we are inside polygon. Pixels on edges
24050 may or may not be included depending on actual geometry of the
24052 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24053 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24055 x0
= XINT (lx
), y0
= XINT (ly
);
24056 for (i
= 0; i
< n
; i
+= 2)
24058 int x1
= x0
, y1
= y0
;
24059 if ((lx
= poly
[i
], !INTEGERP (lx
))
24060 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24062 x0
= XINT (lx
), y0
= XINT (ly
);
24064 /* Does this segment cross the X line? */
24072 if (y
> y0
&& y
> y1
)
24074 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24084 find_hot_spot (Lisp_Object map
, int x
, int y
)
24086 while (CONSP (map
))
24088 if (CONSP (XCAR (map
))
24089 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24097 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24099 doc
: /* Lookup in image map MAP coordinates X and Y.
24100 An image map is an alist where each element has the format (AREA ID PLIST).
24101 An AREA is specified as either a rectangle, a circle, or a polygon:
24102 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24103 pixel coordinates of the upper left and bottom right corners.
24104 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24105 and the radius of the circle; r may be a float or integer.
24106 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24107 vector describes one corner in the polygon.
24108 Returns the alist element for the first matching AREA in MAP. */)
24109 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24117 return find_hot_spot (map
, XINT (x
), XINT (y
));
24121 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24123 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24125 /* Do not change cursor shape while dragging mouse. */
24126 if (!NILP (do_mouse_tracking
))
24129 if (!NILP (pointer
))
24131 if (EQ (pointer
, Qarrow
))
24132 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24133 else if (EQ (pointer
, Qhand
))
24134 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24135 else if (EQ (pointer
, Qtext
))
24136 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24137 else if (EQ (pointer
, intern ("hdrag")))
24138 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24139 #ifdef HAVE_X_WINDOWS
24140 else if (EQ (pointer
, intern ("vdrag")))
24141 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24143 else if (EQ (pointer
, intern ("hourglass")))
24144 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24145 else if (EQ (pointer
, Qmodeline
))
24146 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24148 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24151 if (cursor
!= No_Cursor
)
24152 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24155 /* Take proper action when mouse has moved to the mode or header line
24156 or marginal area AREA of window W, x-position X and y-position Y.
24157 X is relative to the start of the text display area of W, so the
24158 width of bitmap areas and scroll bars must be subtracted to get a
24159 position relative to the start of the mode line. */
24162 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24163 enum window_part area
)
24165 struct window
*w
= XWINDOW (window
);
24166 struct frame
*f
= XFRAME (w
->frame
);
24167 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24168 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24169 Lisp_Object pointer
= Qnil
;
24170 int charpos
, dx
, dy
, width
, height
;
24171 Lisp_Object string
, object
= Qnil
;
24172 Lisp_Object pos
, help
;
24174 Lisp_Object mouse_face
;
24175 int original_x_pixel
= x
;
24176 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24177 struct glyph_row
*row
;
24179 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24184 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24185 &object
, &dx
, &dy
, &width
, &height
);
24187 row
= (area
== ON_MODE_LINE
24188 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24189 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24192 if (row
->mode_line_p
&& row
->enabled_p
)
24194 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24195 end
= glyph
+ row
->used
[TEXT_AREA
];
24197 for (x0
= original_x_pixel
;
24198 glyph
< end
&& x0
>= glyph
->pixel_width
;
24200 x0
-= glyph
->pixel_width
;
24208 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24209 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24210 &object
, &dx
, &dy
, &width
, &height
);
24215 if (IMAGEP (object
))
24217 Lisp_Object image_map
, hotspot
;
24218 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24220 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24222 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24224 Lisp_Object area_id
, plist
;
24226 area_id
= XCAR (hotspot
);
24227 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24228 If so, we could look for mouse-enter, mouse-leave
24229 properties in PLIST (and do something...). */
24230 hotspot
= XCDR (hotspot
);
24231 if (CONSP (hotspot
)
24232 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24234 pointer
= Fplist_get (plist
, Qpointer
);
24235 if (NILP (pointer
))
24237 help
= Fplist_get (plist
, Qhelp_echo
);
24240 help_echo_string
= help
;
24241 /* Is this correct? ++kfs */
24242 XSETWINDOW (help_echo_window
, w
);
24243 help_echo_object
= w
->buffer
;
24244 help_echo_pos
= charpos
;
24248 if (NILP (pointer
))
24249 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24252 if (STRINGP (string
))
24254 pos
= make_number (charpos
);
24255 /* If we're on a string with `help-echo' text property, arrange
24256 for the help to be displayed. This is done by setting the
24257 global variable help_echo_string to the help string. */
24260 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24263 help_echo_string
= help
;
24264 XSETWINDOW (help_echo_window
, w
);
24265 help_echo_object
= string
;
24266 help_echo_pos
= charpos
;
24270 if (NILP (pointer
))
24271 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24273 /* Change the mouse pointer according to what is under X/Y. */
24274 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24277 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24278 if (!KEYMAPP (map
))
24279 map
= Fget_text_property (pos
, Qkeymap
, string
);
24280 if (!KEYMAPP (map
))
24281 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24284 /* Change the mouse face according to what is under X/Y. */
24285 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24286 if (!NILP (mouse_face
)
24287 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24292 struct glyph
* tmp_glyph
;
24296 int total_pixel_width
;
24301 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24302 Qmouse_face
, string
, Qnil
);
24304 b
= make_number (0);
24306 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24308 e
= make_number (SCHARS (string
));
24310 /* Calculate the position(glyph position: GPOS) of GLYPH in
24311 displayed string. GPOS is different from CHARPOS.
24313 CHARPOS is the position of glyph in internal string
24314 object. A mode line string format has structures which
24315 is converted to a flatten by emacs lisp interpreter.
24316 The internal string is an element of the structures.
24317 The displayed string is the flatten string. */
24319 if (glyph
> row_start_glyph
)
24321 tmp_glyph
= glyph
- 1;
24322 while (tmp_glyph
>= row_start_glyph
24323 && tmp_glyph
->charpos
>= XINT (b
)
24324 && EQ (tmp_glyph
->object
, glyph
->object
))
24331 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24332 displayed string holding GLYPH.
24334 GSEQ_LENGTH is different from SCHARS (STRING).
24335 SCHARS (STRING) returns the length of the internal string. */
24336 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24337 tmp_glyph
->charpos
< XINT (e
);
24338 tmp_glyph
++, gseq_length
++)
24340 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24344 total_pixel_width
= 0;
24345 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24346 total_pixel_width
+= tmp_glyph
->pixel_width
;
24348 /* Pre calculation of re-rendering position */
24350 hpos
= (area
== ON_MODE_LINE
24351 ? (w
->current_matrix
)->nrows
- 1
24354 /* If the re-rendering position is included in the last
24355 re-rendering area, we should do nothing. */
24356 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24357 && dpyinfo
->mouse_face_beg_col
<= vpos
24358 && vpos
< dpyinfo
->mouse_face_end_col
24359 && dpyinfo
->mouse_face_beg_row
== hpos
)
24362 if (clear_mouse_face (dpyinfo
))
24363 cursor
= No_Cursor
;
24365 dpyinfo
->mouse_face_beg_col
= vpos
;
24366 dpyinfo
->mouse_face_beg_row
= hpos
;
24368 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24369 dpyinfo
->mouse_face_beg_y
= 0;
24371 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24372 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24374 dpyinfo
->mouse_face_end_x
= 0;
24375 dpyinfo
->mouse_face_end_y
= 0;
24377 dpyinfo
->mouse_face_past_end
= 0;
24378 dpyinfo
->mouse_face_window
= window
;
24380 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24383 glyph
->face_id
, 1);
24384 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24386 if (NILP (pointer
))
24389 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24390 clear_mouse_face (dpyinfo
);
24392 define_frame_cursor1 (f
, cursor
, pointer
);
24397 Take proper action when the mouse has moved to position X, Y on
24398 frame F as regards highlighting characters that have mouse-face
24399 properties. Also de-highlighting chars where the mouse was before.
24400 X and Y can be negative or out of range. */
24403 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24405 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24406 enum window_part part
;
24407 Lisp_Object window
;
24409 Cursor cursor
= No_Cursor
;
24410 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24413 /* When a menu is active, don't highlight because this looks odd. */
24414 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24415 if (popup_activated ())
24419 if (NILP (Vmouse_highlight
)
24420 || !f
->glyphs_initialized_p
24421 || f
->pointer_invisible
)
24424 dpyinfo
->mouse_face_mouse_x
= x
;
24425 dpyinfo
->mouse_face_mouse_y
= y
;
24426 dpyinfo
->mouse_face_mouse_frame
= f
;
24428 if (dpyinfo
->mouse_face_defer
)
24431 if (gc_in_progress
)
24433 dpyinfo
->mouse_face_deferred_gc
= 1;
24437 /* Which window is that in? */
24438 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24440 /* If we were displaying active text in another window, clear that.
24441 Also clear if we move out of text area in same window. */
24442 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24443 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24444 && !NILP (dpyinfo
->mouse_face_window
)))
24445 clear_mouse_face (dpyinfo
);
24447 /* Not on a window -> return. */
24448 if (!WINDOWP (window
))
24451 /* Reset help_echo_string. It will get recomputed below. */
24452 help_echo_string
= Qnil
;
24454 /* Convert to window-relative pixel coordinates. */
24455 w
= XWINDOW (window
);
24456 frame_to_window_pixel_xy (w
, &x
, &y
);
24458 /* Handle tool-bar window differently since it doesn't display a
24460 if (EQ (window
, f
->tool_bar_window
))
24462 note_tool_bar_highlight (f
, x
, y
);
24466 /* Mouse is on the mode, header line or margin? */
24467 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24468 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24470 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24474 if (part
== ON_VERTICAL_BORDER
)
24476 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24477 help_echo_string
= build_string ("drag-mouse-1: resize");
24479 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24480 || part
== ON_SCROLL_BAR
)
24481 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24483 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24485 /* Are we in a window whose display is up to date?
24486 And verify the buffer's text has not changed. */
24487 b
= XBUFFER (w
->buffer
);
24488 if (part
== ON_TEXT
24489 && EQ (w
->window_end_valid
, w
->buffer
)
24490 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24491 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24493 int hpos
, vpos
, i
, dx
, dy
, area
;
24495 struct glyph
*glyph
;
24496 Lisp_Object object
;
24497 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24498 Lisp_Object
*overlay_vec
= NULL
;
24500 struct buffer
*obuf
;
24501 int obegv
, ozv
, same_region
;
24503 /* Find the glyph under X/Y. */
24504 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24506 /* Look for :pointer property on image. */
24507 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24509 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24510 if (img
!= NULL
&& IMAGEP (img
->spec
))
24512 Lisp_Object image_map
, hotspot
;
24513 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24515 && (hotspot
= find_hot_spot (image_map
,
24516 glyph
->slice
.x
+ dx
,
24517 glyph
->slice
.y
+ dy
),
24519 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24521 Lisp_Object area_id
, plist
;
24523 area_id
= XCAR (hotspot
);
24524 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24525 If so, we could look for mouse-enter, mouse-leave
24526 properties in PLIST (and do something...). */
24527 hotspot
= XCDR (hotspot
);
24528 if (CONSP (hotspot
)
24529 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24531 pointer
= Fplist_get (plist
, Qpointer
);
24532 if (NILP (pointer
))
24534 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24535 if (!NILP (help_echo_string
))
24537 help_echo_window
= window
;
24538 help_echo_object
= glyph
->object
;
24539 help_echo_pos
= glyph
->charpos
;
24543 if (NILP (pointer
))
24544 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24548 /* Clear mouse face if X/Y not over text. */
24550 || area
!= TEXT_AREA
24551 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24553 if (clear_mouse_face (dpyinfo
))
24554 cursor
= No_Cursor
;
24555 if (NILP (pointer
))
24557 if (area
!= TEXT_AREA
)
24558 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24560 pointer
= Vvoid_text_area_pointer
;
24565 pos
= glyph
->charpos
;
24566 object
= glyph
->object
;
24567 if (!STRINGP (object
) && !BUFFERP (object
))
24570 /* If we get an out-of-range value, return now; avoid an error. */
24571 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24574 /* Make the window's buffer temporarily current for
24575 overlays_at and compute_char_face. */
24576 obuf
= current_buffer
;
24577 current_buffer
= b
;
24583 /* Is this char mouse-active or does it have help-echo? */
24584 position
= make_number (pos
);
24586 if (BUFFERP (object
))
24588 /* Put all the overlays we want in a vector in overlay_vec. */
24589 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24590 /* Sort overlays into increasing priority order. */
24591 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24596 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24597 && vpos
>= dpyinfo
->mouse_face_beg_row
24598 && vpos
<= dpyinfo
->mouse_face_end_row
24599 && (vpos
> dpyinfo
->mouse_face_beg_row
24600 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24601 && (vpos
< dpyinfo
->mouse_face_end_row
24602 || hpos
< dpyinfo
->mouse_face_end_col
24603 || dpyinfo
->mouse_face_past_end
));
24606 cursor
= No_Cursor
;
24608 /* Check mouse-face highlighting. */
24610 /* If there exists an overlay with mouse-face overlapping
24611 the one we are currently highlighting, we have to
24612 check if we enter the overlapping overlay, and then
24613 highlight only that. */
24614 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24615 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24617 /* Find the highest priority overlay with a mouse-face. */
24619 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24621 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24622 if (!NILP (mouse_face
))
24623 overlay
= overlay_vec
[i
];
24626 /* If we're highlighting the same overlay as before, there's
24627 no need to do that again. */
24628 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24629 goto check_help_echo
;
24630 dpyinfo
->mouse_face_overlay
= overlay
;
24632 /* Clear the display of the old active region, if any. */
24633 if (clear_mouse_face (dpyinfo
))
24634 cursor
= No_Cursor
;
24636 /* If no overlay applies, get a text property. */
24637 if (NILP (overlay
))
24638 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24640 /* Next, compute the bounds of the mouse highlighting and
24642 if (!NILP (mouse_face
) && STRINGP (object
))
24644 /* The mouse-highlighting comes from a display string
24645 with a mouse-face. */
24649 b
= Fprevious_single_property_change
24650 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24651 e
= Fnext_single_property_change
24652 (position
, Qmouse_face
, object
, Qnil
);
24654 b
= make_number (0);
24656 e
= make_number (SCHARS (object
) - 1);
24658 fast_find_string_pos (w
, XINT (b
), object
,
24659 &dpyinfo
->mouse_face_beg_col
,
24660 &dpyinfo
->mouse_face_beg_row
,
24661 &dpyinfo
->mouse_face_beg_x
,
24662 &dpyinfo
->mouse_face_beg_y
, 0);
24663 fast_find_string_pos (w
, XINT (e
), object
,
24664 &dpyinfo
->mouse_face_end_col
,
24665 &dpyinfo
->mouse_face_end_row
,
24666 &dpyinfo
->mouse_face_end_x
,
24667 &dpyinfo
->mouse_face_end_y
, 1);
24668 dpyinfo
->mouse_face_past_end
= 0;
24669 dpyinfo
->mouse_face_window
= window
;
24670 dpyinfo
->mouse_face_face_id
24671 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24672 glyph
->face_id
, 1);
24673 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24674 cursor
= No_Cursor
;
24678 /* The mouse-highlighting, if any, comes from an overlay
24679 or text property in the buffer. */
24680 Lisp_Object buffer
, display_string
;
24682 if (STRINGP (object
))
24684 /* If we are on a display string with no mouse-face,
24685 check if the text under it has one. */
24686 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24687 int start
= MATRIX_ROW_START_CHARPOS (r
);
24688 pos
= string_buffer_position (w
, object
, start
);
24691 mouse_face
= get_char_property_and_overlay
24692 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24693 buffer
= w
->buffer
;
24694 display_string
= object
;
24700 display_string
= Qnil
;
24703 if (!NILP (mouse_face
))
24705 Lisp_Object before
, after
;
24706 Lisp_Object before_string
, after_string
;
24708 if (NILP (overlay
))
24710 /* Handle the text property case. */
24711 before
= Fprevious_single_property_change
24712 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24713 Fmarker_position (w
->start
));
24714 after
= Fnext_single_property_change
24715 (make_number (pos
), Qmouse_face
, buffer
,
24716 make_number (BUF_Z (XBUFFER (buffer
))
24717 - XFASTINT (w
->window_end_pos
)));
24718 before_string
= after_string
= Qnil
;
24722 /* Handle the overlay case. */
24723 before
= Foverlay_start (overlay
);
24724 after
= Foverlay_end (overlay
);
24725 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24726 after_string
= Foverlay_get (overlay
, Qafter_string
);
24728 if (!STRINGP (before_string
)) before_string
= Qnil
;
24729 if (!STRINGP (after_string
)) after_string
= Qnil
;
24732 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24735 before_string
, after_string
,
24737 cursor
= No_Cursor
;
24744 /* Look for a `help-echo' property. */
24745 if (NILP (help_echo_string
)) {
24746 Lisp_Object help
, overlay
;
24748 /* Check overlays first. */
24749 help
= overlay
= Qnil
;
24750 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24752 overlay
= overlay_vec
[i
];
24753 help
= Foverlay_get (overlay
, Qhelp_echo
);
24758 help_echo_string
= help
;
24759 help_echo_window
= window
;
24760 help_echo_object
= overlay
;
24761 help_echo_pos
= pos
;
24765 Lisp_Object object
= glyph
->object
;
24766 int charpos
= glyph
->charpos
;
24768 /* Try text properties. */
24769 if (STRINGP (object
)
24771 && charpos
< SCHARS (object
))
24773 help
= Fget_text_property (make_number (charpos
),
24774 Qhelp_echo
, object
);
24777 /* If the string itself doesn't specify a help-echo,
24778 see if the buffer text ``under'' it does. */
24779 struct glyph_row
*r
24780 = MATRIX_ROW (w
->current_matrix
, vpos
);
24781 int start
= MATRIX_ROW_START_CHARPOS (r
);
24782 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24785 help
= Fget_char_property (make_number (pos
),
24786 Qhelp_echo
, w
->buffer
);
24790 object
= w
->buffer
;
24795 else if (BUFFERP (object
)
24798 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24803 help_echo_string
= help
;
24804 help_echo_window
= window
;
24805 help_echo_object
= object
;
24806 help_echo_pos
= charpos
;
24811 /* Look for a `pointer' property. */
24812 if (NILP (pointer
))
24814 /* Check overlays first. */
24815 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24816 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24818 if (NILP (pointer
))
24820 Lisp_Object object
= glyph
->object
;
24821 int charpos
= glyph
->charpos
;
24823 /* Try text properties. */
24824 if (STRINGP (object
)
24826 && charpos
< SCHARS (object
))
24828 pointer
= Fget_text_property (make_number (charpos
),
24830 if (NILP (pointer
))
24832 /* If the string itself doesn't specify a pointer,
24833 see if the buffer text ``under'' it does. */
24834 struct glyph_row
*r
24835 = MATRIX_ROW (w
->current_matrix
, vpos
);
24836 int start
= MATRIX_ROW_START_CHARPOS (r
);
24837 EMACS_INT pos
= string_buffer_position (w
, object
,
24840 pointer
= Fget_char_property (make_number (pos
),
24841 Qpointer
, w
->buffer
);
24844 else if (BUFFERP (object
)
24847 pointer
= Fget_text_property (make_number (charpos
),
24854 current_buffer
= obuf
;
24859 define_frame_cursor1 (f
, cursor
, pointer
);
24864 Clear any mouse-face on window W. This function is part of the
24865 redisplay interface, and is called from try_window_id and similar
24866 functions to ensure the mouse-highlight is off. */
24869 x_clear_window_mouse_face (struct window
*w
)
24871 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24872 Lisp_Object window
;
24875 XSETWINDOW (window
, w
);
24876 if (EQ (window
, dpyinfo
->mouse_face_window
))
24877 clear_mouse_face (dpyinfo
);
24883 Just discard the mouse face information for frame F, if any.
24884 This is used when the size of F is changed. */
24887 cancel_mouse_face (struct frame
*f
)
24889 Lisp_Object window
;
24890 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24892 window
= dpyinfo
->mouse_face_window
;
24893 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24895 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24896 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24897 dpyinfo
->mouse_face_window
= Qnil
;
24902 #endif /* HAVE_WINDOW_SYSTEM */
24905 /***********************************************************************
24907 ***********************************************************************/
24909 #ifdef HAVE_WINDOW_SYSTEM
24911 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24912 which intersects rectangle R. R is in window-relative coordinates. */
24915 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
24916 enum glyph_row_area area
)
24918 struct glyph
*first
= row
->glyphs
[area
];
24919 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24920 struct glyph
*last
;
24921 int first_x
, start_x
, x
;
24923 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24924 /* If row extends face to end of line write the whole line. */
24925 draw_glyphs (w
, 0, row
, area
,
24926 0, row
->used
[area
],
24927 DRAW_NORMAL_TEXT
, 0);
24930 /* Set START_X to the window-relative start position for drawing glyphs of
24931 AREA. The first glyph of the text area can be partially visible.
24932 The first glyphs of other areas cannot. */
24933 start_x
= window_box_left_offset (w
, area
);
24935 if (area
== TEXT_AREA
)
24938 /* Find the first glyph that must be redrawn. */
24940 && x
+ first
->pixel_width
< r
->x
)
24942 x
+= first
->pixel_width
;
24946 /* Find the last one. */
24950 && x
< r
->x
+ r
->width
)
24952 x
+= last
->pixel_width
;
24958 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24959 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24960 DRAW_NORMAL_TEXT
, 0);
24965 /* Redraw the parts of the glyph row ROW on window W intersecting
24966 rectangle R. R is in window-relative coordinates. Value is
24967 non-zero if mouse-face was overwritten. */
24970 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
24972 xassert (row
->enabled_p
);
24974 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24975 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24976 0, row
->used
[TEXT_AREA
],
24977 DRAW_NORMAL_TEXT
, 0);
24980 if (row
->used
[LEFT_MARGIN_AREA
])
24981 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24982 if (row
->used
[TEXT_AREA
])
24983 expose_area (w
, row
, r
, TEXT_AREA
);
24984 if (row
->used
[RIGHT_MARGIN_AREA
])
24985 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24986 draw_row_fringe_bitmaps (w
, row
);
24989 return row
->mouse_face_p
;
24993 /* Redraw those parts of glyphs rows during expose event handling that
24994 overlap other rows. Redrawing of an exposed line writes over parts
24995 of lines overlapping that exposed line; this function fixes that.
24997 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24998 row in W's current matrix that is exposed and overlaps other rows.
24999 LAST_OVERLAPPING_ROW is the last such row. */
25002 expose_overlaps (struct window
*w
,
25003 struct glyph_row
*first_overlapping_row
,
25004 struct glyph_row
*last_overlapping_row
,
25007 struct glyph_row
*row
;
25009 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25010 if (row
->overlapping_p
)
25012 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25015 if (row
->used
[LEFT_MARGIN_AREA
])
25016 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25018 if (row
->used
[TEXT_AREA
])
25019 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25021 if (row
->used
[RIGHT_MARGIN_AREA
])
25022 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25028 /* Return non-zero if W's cursor intersects rectangle R. */
25031 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25033 XRectangle cr
, result
;
25034 struct glyph
*cursor_glyph
;
25035 struct glyph_row
*row
;
25037 if (w
->phys_cursor
.vpos
>= 0
25038 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25039 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25041 && row
->cursor_in_fringe_p
)
25043 /* Cursor is in the fringe. */
25044 cr
.x
= window_box_right_offset (w
,
25045 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25046 ? RIGHT_MARGIN_AREA
25049 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25050 cr
.height
= row
->height
;
25051 return x_intersect_rectangles (&cr
, r
, &result
);
25054 cursor_glyph
= get_phys_cursor_glyph (w
);
25057 /* r is relative to W's box, but w->phys_cursor.x is relative
25058 to left edge of W's TEXT area. Adjust it. */
25059 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25060 cr
.y
= w
->phys_cursor
.y
;
25061 cr
.width
= cursor_glyph
->pixel_width
;
25062 cr
.height
= w
->phys_cursor_height
;
25063 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25064 I assume the effect is the same -- and this is portable. */
25065 return x_intersect_rectangles (&cr
, r
, &result
);
25067 /* If we don't understand the format, pretend we're not in the hot-spot. */
25073 Draw a vertical window border to the right of window W if W doesn't
25074 have vertical scroll bars. */
25077 x_draw_vertical_border (struct window
*w
)
25079 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25081 /* We could do better, if we knew what type of scroll-bar the adjacent
25082 windows (on either side) have... But we don't :-(
25083 However, I think this works ok. ++KFS 2003-04-25 */
25085 /* Redraw borders between horizontally adjacent windows. Don't
25086 do it for frames with vertical scroll bars because either the
25087 right scroll bar of a window, or the left scroll bar of its
25088 neighbor will suffice as a border. */
25089 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25092 if (!WINDOW_RIGHTMOST_P (w
)
25093 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25095 int x0
, x1
, y0
, y1
;
25097 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25100 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25103 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25105 else if (!WINDOW_LEFTMOST_P (w
)
25106 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25108 int x0
, x1
, y0
, y1
;
25110 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25113 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25116 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25121 /* Redraw the part of window W intersection rectangle FR. Pixel
25122 coordinates in FR are frame-relative. Call this function with
25123 input blocked. Value is non-zero if the exposure overwrites
25127 expose_window (struct window
*w
, XRectangle
*fr
)
25129 struct frame
*f
= XFRAME (w
->frame
);
25131 int mouse_face_overwritten_p
= 0;
25133 /* If window is not yet fully initialized, do nothing. This can
25134 happen when toolkit scroll bars are used and a window is split.
25135 Reconfiguring the scroll bar will generate an expose for a newly
25137 if (w
->current_matrix
== NULL
)
25140 /* When we're currently updating the window, display and current
25141 matrix usually don't agree. Arrange for a thorough display
25143 if (w
== updated_window
)
25145 SET_FRAME_GARBAGED (f
);
25149 /* Frame-relative pixel rectangle of W. */
25150 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25151 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25152 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25153 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25155 if (x_intersect_rectangles (fr
, &wr
, &r
))
25157 int yb
= window_text_bottom_y (w
);
25158 struct glyph_row
*row
;
25159 int cursor_cleared_p
;
25160 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25162 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25163 r
.x
, r
.y
, r
.width
, r
.height
));
25165 /* Convert to window coordinates. */
25166 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25167 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25169 /* Turn off the cursor. */
25170 if (!w
->pseudo_window_p
25171 && phys_cursor_in_rect_p (w
, &r
))
25173 x_clear_cursor (w
);
25174 cursor_cleared_p
= 1;
25177 cursor_cleared_p
= 0;
25179 /* Update lines intersecting rectangle R. */
25180 first_overlapping_row
= last_overlapping_row
= NULL
;
25181 for (row
= w
->current_matrix
->rows
;
25186 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25188 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25189 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25190 || (r
.y
>= y0
&& r
.y
< y1
)
25191 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25193 /* A header line may be overlapping, but there is no need
25194 to fix overlapping areas for them. KFS 2005-02-12 */
25195 if (row
->overlapping_p
&& !row
->mode_line_p
)
25197 if (first_overlapping_row
== NULL
)
25198 first_overlapping_row
= row
;
25199 last_overlapping_row
= row
;
25203 if (expose_line (w
, row
, &r
))
25204 mouse_face_overwritten_p
= 1;
25207 else if (row
->overlapping_p
)
25209 /* We must redraw a row overlapping the exposed area. */
25211 ? y0
+ row
->phys_height
> r
.y
25212 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25214 if (first_overlapping_row
== NULL
)
25215 first_overlapping_row
= row
;
25216 last_overlapping_row
= row
;
25224 /* Display the mode line if there is one. */
25225 if (WINDOW_WANTS_MODELINE_P (w
)
25226 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25228 && row
->y
< r
.y
+ r
.height
)
25230 if (expose_line (w
, row
, &r
))
25231 mouse_face_overwritten_p
= 1;
25234 if (!w
->pseudo_window_p
)
25236 /* Fix the display of overlapping rows. */
25237 if (first_overlapping_row
)
25238 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25241 /* Draw border between windows. */
25242 x_draw_vertical_border (w
);
25244 /* Turn the cursor on again. */
25245 if (cursor_cleared_p
)
25246 update_window_cursor (w
, 1);
25250 return mouse_face_overwritten_p
;
25255 /* Redraw (parts) of all windows in the window tree rooted at W that
25256 intersect R. R contains frame pixel coordinates. Value is
25257 non-zero if the exposure overwrites mouse-face. */
25260 expose_window_tree (struct window
*w
, XRectangle
*r
)
25262 struct frame
*f
= XFRAME (w
->frame
);
25263 int mouse_face_overwritten_p
= 0;
25265 while (w
&& !FRAME_GARBAGED_P (f
))
25267 if (!NILP (w
->hchild
))
25268 mouse_face_overwritten_p
25269 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25270 else if (!NILP (w
->vchild
))
25271 mouse_face_overwritten_p
25272 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25274 mouse_face_overwritten_p
|= expose_window (w
, r
);
25276 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25279 return mouse_face_overwritten_p
;
25284 Redisplay an exposed area of frame F. X and Y are the upper-left
25285 corner of the exposed rectangle. W and H are width and height of
25286 the exposed area. All are pixel values. W or H zero means redraw
25287 the entire frame. */
25290 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25293 int mouse_face_overwritten_p
= 0;
25295 TRACE ((stderr
, "expose_frame "));
25297 /* No need to redraw if frame will be redrawn soon. */
25298 if (FRAME_GARBAGED_P (f
))
25300 TRACE ((stderr
, " garbaged\n"));
25304 /* If basic faces haven't been realized yet, there is no point in
25305 trying to redraw anything. This can happen when we get an expose
25306 event while Emacs is starting, e.g. by moving another window. */
25307 if (FRAME_FACE_CACHE (f
) == NULL
25308 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25310 TRACE ((stderr
, " no faces\n"));
25314 if (w
== 0 || h
== 0)
25317 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25318 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25328 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25329 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25331 if (WINDOWP (f
->tool_bar_window
))
25332 mouse_face_overwritten_p
25333 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25335 #ifdef HAVE_X_WINDOWS
25337 #ifndef USE_X_TOOLKIT
25338 if (WINDOWP (f
->menu_bar_window
))
25339 mouse_face_overwritten_p
25340 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25341 #endif /* not USE_X_TOOLKIT */
25345 /* Some window managers support a focus-follows-mouse style with
25346 delayed raising of frames. Imagine a partially obscured frame,
25347 and moving the mouse into partially obscured mouse-face on that
25348 frame. The visible part of the mouse-face will be highlighted,
25349 then the WM raises the obscured frame. With at least one WM, KDE
25350 2.1, Emacs is not getting any event for the raising of the frame
25351 (even tried with SubstructureRedirectMask), only Expose events.
25352 These expose events will draw text normally, i.e. not
25353 highlighted. Which means we must redo the highlight here.
25354 Subsume it under ``we love X''. --gerd 2001-08-15 */
25355 /* Included in Windows version because Windows most likely does not
25356 do the right thing if any third party tool offers
25357 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25358 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25360 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25361 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25363 int x
= dpyinfo
->mouse_face_mouse_x
;
25364 int y
= dpyinfo
->mouse_face_mouse_y
;
25365 clear_mouse_face (dpyinfo
);
25366 note_mouse_highlight (f
, x
, y
);
25373 Determine the intersection of two rectangles R1 and R2. Return
25374 the intersection in *RESULT. Value is non-zero if RESULT is not
25378 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25380 XRectangle
*left
, *right
;
25381 XRectangle
*upper
, *lower
;
25382 int intersection_p
= 0;
25384 /* Rearrange so that R1 is the left-most rectangle. */
25386 left
= r1
, right
= r2
;
25388 left
= r2
, right
= r1
;
25390 /* X0 of the intersection is right.x0, if this is inside R1,
25391 otherwise there is no intersection. */
25392 if (right
->x
<= left
->x
+ left
->width
)
25394 result
->x
= right
->x
;
25396 /* The right end of the intersection is the minimum of the
25397 the right ends of left and right. */
25398 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25401 /* Same game for Y. */
25403 upper
= r1
, lower
= r2
;
25405 upper
= r2
, lower
= r1
;
25407 /* The upper end of the intersection is lower.y0, if this is inside
25408 of upper. Otherwise, there is no intersection. */
25409 if (lower
->y
<= upper
->y
+ upper
->height
)
25411 result
->y
= lower
->y
;
25413 /* The lower end of the intersection is the minimum of the lower
25414 ends of upper and lower. */
25415 result
->height
= (min (lower
->y
+ lower
->height
,
25416 upper
->y
+ upper
->height
)
25418 intersection_p
= 1;
25422 return intersection_p
;
25425 #endif /* HAVE_WINDOW_SYSTEM */
25428 /***********************************************************************
25430 ***********************************************************************/
25433 syms_of_xdisp (void)
25435 Vwith_echo_area_save_vector
= Qnil
;
25436 staticpro (&Vwith_echo_area_save_vector
);
25438 Vmessage_stack
= Qnil
;
25439 staticpro (&Vmessage_stack
);
25441 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25442 staticpro (&Qinhibit_redisplay
);
25444 message_dolog_marker1
= Fmake_marker ();
25445 staticpro (&message_dolog_marker1
);
25446 message_dolog_marker2
= Fmake_marker ();
25447 staticpro (&message_dolog_marker2
);
25448 message_dolog_marker3
= Fmake_marker ();
25449 staticpro (&message_dolog_marker3
);
25452 defsubr (&Sdump_frame_glyph_matrix
);
25453 defsubr (&Sdump_glyph_matrix
);
25454 defsubr (&Sdump_glyph_row
);
25455 defsubr (&Sdump_tool_bar_row
);
25456 defsubr (&Strace_redisplay
);
25457 defsubr (&Strace_to_stderr
);
25459 #ifdef HAVE_WINDOW_SYSTEM
25460 defsubr (&Stool_bar_lines_needed
);
25461 defsubr (&Slookup_image_map
);
25463 defsubr (&Sformat_mode_line
);
25464 defsubr (&Sinvisible_p
);
25465 defsubr (&Scurrent_bidi_paragraph_direction
);
25467 staticpro (&Qmenu_bar_update_hook
);
25468 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25470 staticpro (&Qoverriding_terminal_local_map
);
25471 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25473 staticpro (&Qoverriding_local_map
);
25474 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25476 staticpro (&Qwindow_scroll_functions
);
25477 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25479 staticpro (&Qwindow_text_change_functions
);
25480 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25482 staticpro (&Qredisplay_end_trigger_functions
);
25483 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25485 staticpro (&Qinhibit_point_motion_hooks
);
25486 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25488 Qeval
= intern_c_string ("eval");
25489 staticpro (&Qeval
);
25491 QCdata
= intern_c_string (":data");
25492 staticpro (&QCdata
);
25493 Qdisplay
= intern_c_string ("display");
25494 staticpro (&Qdisplay
);
25495 Qspace_width
= intern_c_string ("space-width");
25496 staticpro (&Qspace_width
);
25497 Qraise
= intern_c_string ("raise");
25498 staticpro (&Qraise
);
25499 Qslice
= intern_c_string ("slice");
25500 staticpro (&Qslice
);
25501 Qspace
= intern_c_string ("space");
25502 staticpro (&Qspace
);
25503 Qmargin
= intern_c_string ("margin");
25504 staticpro (&Qmargin
);
25505 Qpointer
= intern_c_string ("pointer");
25506 staticpro (&Qpointer
);
25507 Qleft_margin
= intern_c_string ("left-margin");
25508 staticpro (&Qleft_margin
);
25509 Qright_margin
= intern_c_string ("right-margin");
25510 staticpro (&Qright_margin
);
25511 Qcenter
= intern_c_string ("center");
25512 staticpro (&Qcenter
);
25513 Qline_height
= intern_c_string ("line-height");
25514 staticpro (&Qline_height
);
25515 QCalign_to
= intern_c_string (":align-to");
25516 staticpro (&QCalign_to
);
25517 QCrelative_width
= intern_c_string (":relative-width");
25518 staticpro (&QCrelative_width
);
25519 QCrelative_height
= intern_c_string (":relative-height");
25520 staticpro (&QCrelative_height
);
25521 QCeval
= intern_c_string (":eval");
25522 staticpro (&QCeval
);
25523 QCpropertize
= intern_c_string (":propertize");
25524 staticpro (&QCpropertize
);
25525 QCfile
= intern_c_string (":file");
25526 staticpro (&QCfile
);
25527 Qfontified
= intern_c_string ("fontified");
25528 staticpro (&Qfontified
);
25529 Qfontification_functions
= intern_c_string ("fontification-functions");
25530 staticpro (&Qfontification_functions
);
25531 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25532 staticpro (&Qtrailing_whitespace
);
25533 Qescape_glyph
= intern_c_string ("escape-glyph");
25534 staticpro (&Qescape_glyph
);
25535 Qnobreak_space
= intern_c_string ("nobreak-space");
25536 staticpro (&Qnobreak_space
);
25537 Qimage
= intern_c_string ("image");
25538 staticpro (&Qimage
);
25539 Qtext
= intern_c_string ("text");
25540 staticpro (&Qtext
);
25541 Qboth
= intern_c_string ("both");
25542 staticpro (&Qboth
);
25543 Qboth_horiz
= intern_c_string ("both-horiz");
25544 staticpro (&Qboth_horiz
);
25545 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
25546 staticpro (&Qtext_image_horiz
);
25547 QCmap
= intern_c_string (":map");
25548 staticpro (&QCmap
);
25549 QCpointer
= intern_c_string (":pointer");
25550 staticpro (&QCpointer
);
25551 Qrect
= intern_c_string ("rect");
25552 staticpro (&Qrect
);
25553 Qcircle
= intern_c_string ("circle");
25554 staticpro (&Qcircle
);
25555 Qpoly
= intern_c_string ("poly");
25556 staticpro (&Qpoly
);
25557 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25558 staticpro (&Qmessage_truncate_lines
);
25559 Qgrow_only
= intern_c_string ("grow-only");
25560 staticpro (&Qgrow_only
);
25561 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25562 staticpro (&Qinhibit_menubar_update
);
25563 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25564 staticpro (&Qinhibit_eval_during_redisplay
);
25565 Qposition
= intern_c_string ("position");
25566 staticpro (&Qposition
);
25567 Qbuffer_position
= intern_c_string ("buffer-position");
25568 staticpro (&Qbuffer_position
);
25569 Qobject
= intern_c_string ("object");
25570 staticpro (&Qobject
);
25571 Qbar
= intern_c_string ("bar");
25573 Qhbar
= intern_c_string ("hbar");
25574 staticpro (&Qhbar
);
25575 Qbox
= intern_c_string ("box");
25577 Qhollow
= intern_c_string ("hollow");
25578 staticpro (&Qhollow
);
25579 Qhand
= intern_c_string ("hand");
25580 staticpro (&Qhand
);
25581 Qarrow
= intern_c_string ("arrow");
25582 staticpro (&Qarrow
);
25583 Qtext
= intern_c_string ("text");
25584 staticpro (&Qtext
);
25585 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25586 staticpro (&Qrisky_local_variable
);
25587 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25588 staticpro (&Qinhibit_free_realized_faces
);
25590 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25591 Fcons (intern_c_string ("void-variable"), Qnil
)),
25593 staticpro (&list_of_error
);
25595 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25596 staticpro (&Qlast_arrow_position
);
25597 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25598 staticpro (&Qlast_arrow_string
);
25600 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25601 staticpro (&Qoverlay_arrow_string
);
25602 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25603 staticpro (&Qoverlay_arrow_bitmap
);
25605 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25606 staticpro (&echo_buffer
[0]);
25607 staticpro (&echo_buffer
[1]);
25609 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25610 staticpro (&echo_area_buffer
[0]);
25611 staticpro (&echo_area_buffer
[1]);
25613 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25614 staticpro (&Vmessages_buffer_name
);
25616 mode_line_proptrans_alist
= Qnil
;
25617 staticpro (&mode_line_proptrans_alist
);
25618 mode_line_string_list
= Qnil
;
25619 staticpro (&mode_line_string_list
);
25620 mode_line_string_face
= Qnil
;
25621 staticpro (&mode_line_string_face
);
25622 mode_line_string_face_prop
= Qnil
;
25623 staticpro (&mode_line_string_face_prop
);
25624 Vmode_line_unwind_vector
= Qnil
;
25625 staticpro (&Vmode_line_unwind_vector
);
25627 help_echo_string
= Qnil
;
25628 staticpro (&help_echo_string
);
25629 help_echo_object
= Qnil
;
25630 staticpro (&help_echo_object
);
25631 help_echo_window
= Qnil
;
25632 staticpro (&help_echo_window
);
25633 previous_help_echo_string
= Qnil
;
25634 staticpro (&previous_help_echo_string
);
25635 help_echo_pos
= -1;
25637 Qright_to_left
= intern_c_string ("right-to-left");
25638 staticpro (&Qright_to_left
);
25639 Qleft_to_right
= intern_c_string ("left-to-right");
25640 staticpro (&Qleft_to_right
);
25642 #ifdef HAVE_WINDOW_SYSTEM
25643 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25644 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25645 For example, if a block cursor is over a tab, it will be drawn as
25646 wide as that tab on the display. */);
25647 x_stretch_cursor_p
= 0;
25650 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25651 doc
: /* *Non-nil means highlight trailing whitespace.
25652 The face used for trailing whitespace is `trailing-whitespace'. */);
25653 Vshow_trailing_whitespace
= Qnil
;
25655 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25656 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25657 A value of t means highlight the character itself (for nobreak space,
25658 use face `nobreak-space').
25659 A value of nil means no highlighting.
25660 Other values mean display the escape glyph followed by an ordinary
25661 space or ordinary hyphen. */);
25662 Vnobreak_char_display
= Qt
;
25664 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25665 doc
: /* *The pointer shape to show in void text areas.
25666 A value of nil means to show the text pointer. Other options are `arrow',
25667 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25668 Vvoid_text_area_pointer
= Qarrow
;
25670 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25671 doc
: /* Non-nil means don't actually do any redisplay.
25672 This is used for internal purposes. */);
25673 Vinhibit_redisplay
= Qnil
;
25675 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25676 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25677 Vglobal_mode_string
= Qnil
;
25679 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25680 doc
: /* Marker for where to display an arrow on top of the buffer text.
25681 This must be the beginning of a line in order to work.
25682 See also `overlay-arrow-string'. */);
25683 Voverlay_arrow_position
= Qnil
;
25685 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25686 doc
: /* String to display as an arrow in non-window frames.
25687 See also `overlay-arrow-position'. */);
25688 Voverlay_arrow_string
= make_pure_c_string ("=>");
25690 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25691 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25692 The symbols on this list are examined during redisplay to determine
25693 where to display overlay arrows. */);
25694 Voverlay_arrow_variable_list
25695 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25697 DEFVAR_INT ("scroll-step", &scroll_step
,
25698 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25699 If that fails to bring point back on frame, point is centered instead.
25700 If this is zero, point is always centered after it moves off frame.
25701 If you want scrolling to always be a line at a time, you should set
25702 `scroll-conservatively' to a large value rather than set this to 1. */);
25704 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25705 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25706 If point moves off-screen, redisplay will scroll by up to
25707 `scroll-conservatively' lines in order to bring point just barely
25708 onto the screen again. If that cannot be done, then redisplay
25709 recenters point as usual.
25711 A value of zero means always recenter point if it moves off screen. */);
25712 scroll_conservatively
= 0;
25714 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25715 doc
: /* *Number of lines of margin at the top and bottom of a window.
25716 Recenter the window whenever point gets within this many lines
25717 of the top or bottom of the window. */);
25720 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25721 doc
: /* Pixels per inch value for non-window system displays.
25722 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25723 Vdisplay_pixels_per_inch
= make_float (72.0);
25726 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25729 DEFVAR_LISP ("truncate-partial-width-windows",
25730 &Vtruncate_partial_width_windows
,
25731 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25732 For an integer value, truncate lines in each window narrower than the
25733 full frame width, provided the window width is less than that integer;
25734 otherwise, respect the value of `truncate-lines'.
25736 For any other non-nil value, truncate lines in all windows that do
25737 not span the full frame width.
25739 A value of nil means to respect the value of `truncate-lines'.
25741 If `word-wrap' is enabled, you might want to reduce this. */);
25742 Vtruncate_partial_width_windows
= make_number (50);
25744 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25745 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25746 Any other value means to use the appropriate face, `mode-line',
25747 `header-line', or `menu' respectively. */);
25748 mode_line_inverse_video
= 1;
25750 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25751 doc
: /* *Maximum buffer size for which line number should be displayed.
25752 If the buffer is bigger than this, the line number does not appear
25753 in the mode line. A value of nil means no limit. */);
25754 Vline_number_display_limit
= Qnil
;
25756 DEFVAR_INT ("line-number-display-limit-width",
25757 &line_number_display_limit_width
,
25758 doc
: /* *Maximum line width (in characters) for line number display.
25759 If the average length of the lines near point is bigger than this, then the
25760 line number may be omitted from the mode line. */);
25761 line_number_display_limit_width
= 200;
25763 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25764 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25765 highlight_nonselected_windows
= 0;
25767 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25768 doc
: /* Non-nil if more than one frame is visible on this display.
25769 Minibuffer-only frames don't count, but iconified frames do.
25770 This variable is not guaranteed to be accurate except while processing
25771 `frame-title-format' and `icon-title-format'. */);
25773 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25774 doc
: /* Template for displaying the title bar of visible frames.
25775 \(Assuming the window manager supports this feature.)
25777 This variable has the same structure as `mode-line-format', except that
25778 the %c and %l constructs are ignored. It is used only on frames for
25779 which no explicit name has been set \(see `modify-frame-parameters'). */);
25781 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25782 doc
: /* Template for displaying the title bar of an iconified frame.
25783 \(Assuming the window manager supports this feature.)
25784 This variable has the same structure as `mode-line-format' (which see),
25785 and is used only on frames for which no explicit name has been set
25786 \(see `modify-frame-parameters'). */);
25788 = Vframe_title_format
25789 = pure_cons (intern_c_string ("multiple-frames"),
25790 pure_cons (make_pure_c_string ("%b"),
25791 pure_cons (pure_cons (empty_unibyte_string
,
25792 pure_cons (intern_c_string ("invocation-name"),
25793 pure_cons (make_pure_c_string ("@"),
25794 pure_cons (intern_c_string ("system-name"),
25798 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25799 doc
: /* Maximum number of lines to keep in the message log buffer.
25800 If nil, disable message logging. If t, log messages but don't truncate
25801 the buffer when it becomes large. */);
25802 Vmessage_log_max
= make_number (100);
25804 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25805 doc
: /* Functions called before redisplay, if window sizes have changed.
25806 The value should be a list of functions that take one argument.
25807 Just before redisplay, for each frame, if any of its windows have changed
25808 size since the last redisplay, or have been split or deleted,
25809 all the functions in the list are called, with the frame as argument. */);
25810 Vwindow_size_change_functions
= Qnil
;
25812 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25813 doc
: /* List of functions to call before redisplaying a window with scrolling.
25814 Each function is called with two arguments, the window and its new
25815 display-start position. Note that these functions are also called by
25816 `set-window-buffer'. Also note that the value of `window-end' is not
25817 valid when these functions are called. */);
25818 Vwindow_scroll_functions
= Qnil
;
25820 DEFVAR_LISP ("window-text-change-functions",
25821 &Vwindow_text_change_functions
,
25822 doc
: /* Functions to call in redisplay when text in the window might change. */);
25823 Vwindow_text_change_functions
= Qnil
;
25825 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25826 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25827 Each function is called with two arguments, the window and the end trigger value.
25828 See `set-window-redisplay-end-trigger'. */);
25829 Vredisplay_end_trigger_functions
= Qnil
;
25831 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25832 doc
: /* *Non-nil means autoselect window with mouse pointer.
25833 If nil, do not autoselect windows.
25834 A positive number means delay autoselection by that many seconds: a
25835 window is autoselected only after the mouse has remained in that
25836 window for the duration of the delay.
25837 A negative number has a similar effect, but causes windows to be
25838 autoselected only after the mouse has stopped moving. \(Because of
25839 the way Emacs compares mouse events, you will occasionally wait twice
25840 that time before the window gets selected.\)
25841 Any other value means to autoselect window instantaneously when the
25842 mouse pointer enters it.
25844 Autoselection selects the minibuffer only if it is active, and never
25845 unselects the minibuffer if it is active.
25847 When customizing this variable make sure that the actual value of
25848 `focus-follows-mouse' matches the behavior of your window manager. */);
25849 Vmouse_autoselect_window
= Qnil
;
25851 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25852 doc
: /* *Non-nil means automatically resize tool-bars.
25853 This dynamically changes the tool-bar's height to the minimum height
25854 that is needed to make all tool-bar items visible.
25855 If value is `grow-only', the tool-bar's height is only increased
25856 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25857 Vauto_resize_tool_bars
= Qt
;
25859 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25860 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25861 auto_raise_tool_bar_buttons_p
= 1;
25863 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25864 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25865 make_cursor_line_fully_visible_p
= 1;
25867 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25868 doc
: /* *Border below tool-bar in pixels.
25869 If an integer, use it as the height of the border.
25870 If it is one of `internal-border-width' or `border-width', use the
25871 value of the corresponding frame parameter.
25872 Otherwise, no border is added below the tool-bar. */);
25873 Vtool_bar_border
= Qinternal_border_width
;
25875 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25876 doc
: /* *Margin around tool-bar buttons in pixels.
25877 If an integer, use that for both horizontal and vertical margins.
25878 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25879 HORZ specifying the horizontal margin, and VERT specifying the
25880 vertical margin. */);
25881 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25883 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25884 doc
: /* *Relief thickness of tool-bar buttons. */);
25885 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25887 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25888 doc
: /* *Tool bar style to use.
25890 image - show images only
25891 text - show text only
25892 both - show both, text below image
25893 both-horiz - show text to the right of the image
25894 text-image-horiz - show text to the left of the image
25895 any other - use system default or image if no system default. */);
25896 Vtool_bar_style
= Qnil
;
25898 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25899 doc
: /* *Maximum number of characters a label can have to be shown.
25900 The tool bar style must also show labels for this to have any effect, see
25901 `tool-bar-style'. */);
25902 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
25904 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25905 doc
: /* List of functions to call to fontify regions of text.
25906 Each function is called with one argument POS. Functions must
25907 fontify a region starting at POS in the current buffer, and give
25908 fontified regions the property `fontified'. */);
25909 Vfontification_functions
= Qnil
;
25910 Fmake_variable_buffer_local (Qfontification_functions
);
25912 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25913 &unibyte_display_via_language_environment
,
25914 doc
: /* *Non-nil means display unibyte text according to language environment.
25915 Specifically, this means that raw bytes in the range 160-255 decimal
25916 are displayed by converting them to the equivalent multibyte characters
25917 according to the current language environment. As a result, they are
25918 displayed according to the current fontset.
25920 Note that this variable affects only how these bytes are displayed,
25921 but does not change the fact they are interpreted as raw bytes. */);
25922 unibyte_display_via_language_environment
= 0;
25924 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25925 doc
: /* *Maximum height for resizing mini-windows.
25926 If a float, it specifies a fraction of the mini-window frame's height.
25927 If an integer, it specifies a number of lines. */);
25928 Vmax_mini_window_height
= make_float (0.25);
25930 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25931 doc
: /* *How to resize mini-windows.
25932 A value of nil means don't automatically resize mini-windows.
25933 A value of t means resize them to fit the text displayed in them.
25934 A value of `grow-only', the default, means let mini-windows grow
25935 only, until their display becomes empty, at which point the windows
25936 go back to their normal size. */);
25937 Vresize_mini_windows
= Qgrow_only
;
25939 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25940 doc
: /* Alist specifying how to blink the cursor off.
25941 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25942 `cursor-type' frame-parameter or variable equals ON-STATE,
25943 comparing using `equal', Emacs uses OFF-STATE to specify
25944 how to blink it off. ON-STATE and OFF-STATE are values for
25945 the `cursor-type' frame parameter.
25947 If a frame's ON-STATE has no entry in this list,
25948 the frame's other specifications determine how to blink the cursor off. */);
25949 Vblink_cursor_alist
= Qnil
;
25951 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25952 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25953 automatic_hscrolling_p
= 1;
25954 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25955 staticpro (&Qauto_hscroll_mode
);
25957 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25958 doc
: /* *How many columns away from the window edge point is allowed to get
25959 before automatic hscrolling will horizontally scroll the window. */);
25960 hscroll_margin
= 5;
25962 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25963 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25964 When point is less than `hscroll-margin' columns from the window
25965 edge, automatic hscrolling will scroll the window by the amount of columns
25966 determined by this variable. If its value is a positive integer, scroll that
25967 many columns. If it's a positive floating-point number, it specifies the
25968 fraction of the window's width to scroll. If it's nil or zero, point will be
25969 centered horizontally after the scroll. Any other value, including negative
25970 numbers, are treated as if the value were zero.
25972 Automatic hscrolling always moves point outside the scroll margin, so if
25973 point was more than scroll step columns inside the margin, the window will
25974 scroll more than the value given by the scroll step.
25976 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25977 and `scroll-right' overrides this variable's effect. */);
25978 Vhscroll_step
= make_number (0);
25980 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25981 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25982 Bind this around calls to `message' to let it take effect. */);
25983 message_truncate_lines
= 0;
25985 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25986 doc
: /* Normal hook run to update the menu bar definitions.
25987 Redisplay runs this hook before it redisplays the menu bar.
25988 This is used to update submenus such as Buffers,
25989 whose contents depend on various data. */);
25990 Vmenu_bar_update_hook
= Qnil
;
25992 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25993 doc
: /* Frame for which we are updating a menu.
25994 The enable predicate for a menu binding should check this variable. */);
25995 Vmenu_updating_frame
= Qnil
;
25997 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25998 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25999 inhibit_menubar_update
= 0;
26001 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26002 doc
: /* Prefix prepended to all continuation lines at display time.
26003 The value may be a string, an image, or a stretch-glyph; it is
26004 interpreted in the same way as the value of a `display' text property.
26006 This variable is overridden by any `wrap-prefix' text or overlay
26009 To add a prefix to non-continuation lines, use `line-prefix'. */);
26010 Vwrap_prefix
= Qnil
;
26011 staticpro (&Qwrap_prefix
);
26012 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26013 Fmake_variable_buffer_local (Qwrap_prefix
);
26015 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26016 doc
: /* Prefix prepended to all non-continuation lines at display time.
26017 The value may be a string, an image, or a stretch-glyph; it is
26018 interpreted in the same way as the value of a `display' text property.
26020 This variable is overridden by any `line-prefix' text or overlay
26023 To add a prefix to continuation lines, use `wrap-prefix'. */);
26024 Vline_prefix
= Qnil
;
26025 staticpro (&Qline_prefix
);
26026 Qline_prefix
= intern_c_string ("line-prefix");
26027 Fmake_variable_buffer_local (Qline_prefix
);
26029 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26030 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26031 inhibit_eval_during_redisplay
= 0;
26033 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26034 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26035 inhibit_free_realized_faces
= 0;
26038 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26039 doc
: /* Inhibit try_window_id display optimization. */);
26040 inhibit_try_window_id
= 0;
26042 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26043 doc
: /* Inhibit try_window_reusing display optimization. */);
26044 inhibit_try_window_reusing
= 0;
26046 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26047 doc
: /* Inhibit try_cursor_movement display optimization. */);
26048 inhibit_try_cursor_movement
= 0;
26049 #endif /* GLYPH_DEBUG */
26051 DEFVAR_INT ("overline-margin", &overline_margin
,
26052 doc
: /* *Space between overline and text, in pixels.
26053 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26054 margin to the caracter height. */);
26055 overline_margin
= 2;
26057 DEFVAR_INT ("underline-minimum-offset",
26058 &underline_minimum_offset
,
26059 doc
: /* Minimum distance between baseline and underline.
26060 This can improve legibility of underlined text at small font sizes,
26061 particularly when using variable `x-use-underline-position-properties'
26062 with fonts that specify an UNDERLINE_POSITION relatively close to the
26063 baseline. The default value is 1. */);
26064 underline_minimum_offset
= 1;
26066 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26067 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26068 display_hourglass_p
= 1;
26070 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26071 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26072 Value must be an integer or float. */);
26073 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26075 hourglass_atimer
= NULL
;
26076 hourglass_shown_p
= 0;
26080 /* Initialize this module when Emacs starts. */
26085 Lisp_Object root_window
;
26086 struct window
*mini_w
;
26088 current_header_line_height
= current_mode_line_height
= -1;
26090 CHARPOS (this_line_start_pos
) = 0;
26092 mini_w
= XWINDOW (minibuf_window
);
26093 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26095 if (!noninteractive
)
26097 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26100 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26101 set_window_height (root_window
,
26102 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26104 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26105 set_window_height (minibuf_window
, 1, 0);
26107 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26108 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26110 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26111 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26112 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26114 /* The default ellipsis glyphs `...'. */
26115 for (i
= 0; i
< 3; ++i
)
26116 default_invis_vector
[i
] = make_number ('.');
26120 /* Allocate the buffer for frame titles.
26121 Also used for `format-mode-line'. */
26123 mode_line_noprop_buf
= (char *) xmalloc (size
);
26124 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26125 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26126 mode_line_target
= MODE_LINE_DISPLAY
;
26129 help_echo_showing_p
= 0;
26132 /* Since w32 does not support atimers, it defines its own implementation of
26133 the following three functions in w32fns.c. */
26136 /* Platform-independent portion of hourglass implementation. */
26138 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26140 hourglass_started (void)
26142 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26145 /* Cancel a currently active hourglass timer, and start a new one. */
26147 start_hourglass (void)
26149 #if defined (HAVE_WINDOW_SYSTEM)
26151 int secs
, usecs
= 0;
26153 cancel_hourglass ();
26155 if (INTEGERP (Vhourglass_delay
)
26156 && XINT (Vhourglass_delay
) > 0)
26157 secs
= XFASTINT (Vhourglass_delay
);
26158 else if (FLOATP (Vhourglass_delay
)
26159 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26162 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26163 secs
= XFASTINT (tem
);
26164 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26167 secs
= DEFAULT_HOURGLASS_DELAY
;
26169 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26170 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26171 show_hourglass
, NULL
);
26176 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26179 cancel_hourglass (void)
26181 #if defined (HAVE_WINDOW_SYSTEM)
26182 if (hourglass_atimer
)
26184 cancel_atimer (hourglass_atimer
);
26185 hourglass_atimer
= NULL
;
26188 if (hourglass_shown_p
)
26192 #endif /* ! WINDOWSNT */
26194 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26195 (do not change this comment) */